inviwo::WorkspaceAnnotations Class Reference

Inheritance diagram for inviwo::WorkspaceAnnotations:

Classes
struct	Base64Image

Public Types
using	ModifiedDispatcher = Dispatcher<void()>
using	ModifiedCallback = typename ModifiedDispatcher::Callback
using	ModifiedHandle = typename ModifiedDispatcher::Handle
Public Types inherited from inviwo::PropertyOwner
using	iterator = std::vector<Property*>::iterator
using	const_iterator = std::vector<Property*>::const_iterator

Public Member Functions
	WorkspaceAnnotations (InviwoApplication *app=util::getInviwoApplication())
	WorkspaceAnnotations (const std::vector< Base64Image > &canvasImages, InviwoApplication *app=util::getInviwoApplication())
	WorkspaceAnnotations (const std::filesystem::path &path, InviwoApplication *app=util::getInviwoApplication())
void	setTitle (const std::string &title)
const std::string &	getTitle () const
void	setAuthor (const std::string &author)
const std::string &	getAuthor () const
void	setTags (const std::string &tags)
const std::string &	getTags () const
void	setCategories (const std::string &cat)
const std::string &	getCategories () const
void	setDescription (const std::string &desc)
const std::string &	getDescription () const
void	setCanvasImages (const std::vector< Base64Image > &canvases)
size_t	numberOfCanvases () const
const Base64Image &	getCanvasImage (size_t i) const
const Base64Image *	getPrimaryCanvasImage () const
std::optional< size_t >	getPrimaryCanvasIndex () const
const std::vector< Base64Image > &	getCanvasImages () const
virtual void	serialize (Serializer &s) const override
virtual void	deserialize (Deserializer &d) override
virtual InviwoApplication *	getInviwoApplication () override
ModifiedHandle	onModified (const ModifiedCallback &callback)
Public Member Functions inherited from inviwo::PropertyOwner
virtual	~PropertyOwner ()
	Removes all properties and notifies its observers of the removal.
virtual void	addProperty (Property *property, bool owner=true)
virtual void	addProperty (Property &property)
virtual Property *	addProperty (std::unique_ptr< Property > property)
template<typename... Ts>
void	addProperties (Ts &... properties)
virtual void	insertProperty (size_t index, Property *property, bool owner=true)
	insert property property at position index If index is not valid, the property is appended.
virtual void	insertProperty (size_t index, Property &property)
	insert property property at position index If index is not valid, the property is appended.
virtual Property *	insertProperty (size_t index, std::unique_ptr< Property > property)
	insert property property at position index If index is not valid, the property is appended.
virtual Property *	removeProperty (std::string_view identifier)
virtual Property *	removeProperty (Property *property)
virtual Property *	removeProperty (Property &property)
virtual Property *	removeProperty (size_t index)
	remove property referred to by index
virtual bool	move (Property *property, size_t newIndex)
virtual void	clear ()
	Remove all properties; Owned properties will be deleted.
virtual const std::string &	getIdentifier () const
const std::vector< Property * > &	getProperties () const
const std::vector< CompositeProperty * > &	getCompositeProperties () const
std::vector< Property * >	getPropertiesRecursive () const
std::vector< Property * > &	getPropertiesRecursive (std::vector< Property * > &destination) const
Property *	getPropertyByIdentifier (std::string_view identifier, bool recursiveSearch=false) const
Property *	getPropertyByPath (std::string_view path) const
template<class T>
std::vector< T * >	getPropertiesByType (bool recursiveSearch=false) const
bool	empty () const
size_t	size () const
Property *	operator[] (size_t)
const Property *	operator[] (size_t) const
const_iterator	find (Property *property) const
iterator	begin ()
iterator	end ()
const_iterator	begin () const
const_iterator	end () const
const_iterator	cbegin () const
const_iterator	cend () const
virtual bool	isValid () const
virtual void	setValid ()
InvalidationLevel	getInvalidationLevel () const
virtual Processor *	getProcessor ()
virtual const Processor *	getProcessor () const
virtual const PropertyOwner *	getOwner () const
virtual PropertyOwner *	getOwner ()
virtual void	setAllPropertiesCurrentStateAsDefault ()
virtual void	resetAllProperties ()
virtual void	invokeEvent (Event *event) override
Public Member Functions inherited from inviwo::PropertyOwnerObservable
void	notifyObserversWillAddProperty (PropertyOwner *owner, Property *property, size_t index)
void	notifyObserversDidAddProperty (Property *property, size_t index)
void	notifyObserversWillRemoveProperty (Property *property, size_t index)
void	notifyObserversDidRemoveProperty (PropertyOwner *owner, Property *property, size_t index)
Public Member Functions inherited from inviwo::Observable< PropertyOwnerObserver >
Observable< PropertyOwnerObserver > &	operator= (const Observable< PropertyOwnerObserver > &other)
void	addObserver (PropertyOwnerObserver *observer)
void	removeObserver (PropertyOwnerObserver *observer)
virtual void	startBlockingNotifications () override final
virtual void	stopBlockingNotifications () override final

Protected Member Functions
virtual void	invalidate (InvalidationLevel invalidationLevel, Property *modifiedProperty) override
Protected Member Functions inherited from inviwo::PropertyOwner
	PropertyOwner (const PropertyOwner &rhs)
PropertyOwner &	operator= (const PropertyOwner &that)=delete
void	forEachProperty (std::function< void(Property &)> callback, bool recursiveSearch=false) const
Protected Member Functions inherited from inviwo::Observable< PropertyOwnerObserver >
void	forEachObserver (C callback)
Protected Member Functions inherited from inviwo::ObservableInterface
virtual void	addObserver (Observer *observer)=0
virtual void	removeObserver (Observer *observer)=0
void	addObservationHelper (Observer *observer)
void	removeObservationHelper (Observer *observer)

Protected Attributes
StringProperty	title_
StringProperty	author_
StringProperty	tags_
StringProperty	categories_
StringProperty	description_
StringProperty	primaryCanvasId_
std::vector< Base64Image >	canvases_
InviwoApplication *	app_
ModifiedDispatcher	modified_
Protected Attributes inherited from inviwo::PropertyOwner
std::vector< Property * >	properties_
std::vector< EventProperty * >	eventProperties_
std::vector< CompositeProperty * >	compositeProperties_
std::vector< std::unique_ptr< Property > >	ownedProperties_

Member Function Documentation

deserialize()

virtual void inviwo::WorkspaceAnnotations::deserialize ( Deserializer & d )

overridevirtual

Reimplemented from inviwo::PropertyOwner.

getInviwoApplication()

virtual InviwoApplication * inviwo::WorkspaceAnnotations::getInviwoApplication ( )

overridevirtual

Implements inviwo::PropertyOwner.

invalidate()

virtual void inviwo::WorkspaceAnnotations::invalidate ( InvalidationLevel invalidationLevel, Property * modifiedProperty )

overrideprotectedvirtual

Reimplemented from inviwo::PropertyOwner.

serialize()

virtual void inviwo::WorkspaceAnnotations::serialize ( Serializer & s ) const

overridevirtual

Reimplemented from inviwo::PropertyOwner.

---

The documentation for this class was generated from the following file:

• workspaceannotations.h