Inviwo 0.9.12-pre
Inviwo documentation
Loading...
Searching...
No Matches
inviwo::WorkspaceAnnotations Class Reference
+ Inheritance diagram for inviwo::WorkspaceAnnotations:

Classes

struct  Base64Image
 

Public Types

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

Public Member Functions

virtual void deserialize (Deserializer &d) override
 
const std::string & getAuthor () const
 
const Base64ImagegetCanvasImage (size_t i) const
 
const std::vector< Base64Image > & getCanvasImages () const
 
const std::string & getCategories () const
 
const std::string & getDescription () const
 
virtual std::string_view getIdentifier () const override
 
virtual InviwoApplicationgetInviwoApplication () override
 
const Base64ImagegetPrimaryCanvasImage () const
 
std::optional< size_t > getPrimaryCanvasIndex () const
 
const std::string & getTags () const
 
const std::string & getTitle () const
 
size_t numberOfCanvases () const
 
ModifiedHandle onModified (const ModifiedCallback &callback)
 
virtual void serialize (Serializer &s) const override
 
void setAuthor (const std::string &author)
 
void setCanvasImages (const std::vector< Base64Image > &canvases)
 
void setCategories (const std::string &cat)
 
void setDescription (const std::string &desc)
 
void setTags (const std::string &tags)
 
void setTitle (const std::string &title)
 
 WorkspaceAnnotations (const std::filesystem::path &path, InviwoApplication *app=util::getInviwoApplication())
 
 WorkspaceAnnotations (const std::vector< Base64Image > &canvasImages, InviwoApplication *app=util::getInviwoApplication())
 
 WorkspaceAnnotations (InviwoApplication *app=util::getInviwoApplication())
 
- Public Member Functions inherited from inviwo::PropertyOwner
template<typename... Ts>
void addProperties (Ts &... properties)
 
void addProperty (Property &property)
 
void addProperty (Property *property, bool owner=true)
 
PropertyaddProperty (std::unique_ptr< Property > property)
 
iterator begin ()
 
const_iterator begin () const
 
const_iterator cbegin () const
 
const_iterator cend () const
 
virtual void clear ()
 Remove all properties; Owned properties will be deleted.
 
bool empty () const
 
iterator end ()
 
const_iterator end () const
 
const_iterator find (Property *property) const
 
const std::vector< CompositeProperty * > & getCompositeProperties () const
 
InvalidationLevel getInvalidationLevel () const
 
virtual PropertyOwnergetOwner ()
 
virtual const PropertyOwnergetOwner () const
 
virtual ProcessorgetProcessor ()
 
virtual const ProcessorgetProcessor () const
 
const std::vector< Property * > & getProperties () const
 
template<class T >
std::vector< T * > getPropertiesByType (bool recursiveSearch=false) const
 
std::vector< Property * > getPropertiesRecursive () const
 
std::vector< Property * > & getPropertiesRecursive (std::vector< Property * > &destination) const
 
template<std::derived_from< Property > T = Property>
T * getProperty (std::string_view identifier)
 
PropertygetPropertyByIdentifier (std::string_view identifier, bool recursiveSearch=false) const
 
PropertygetPropertyByPath (std::string_view path) const
 
void insertProperty (size_t index, Property &property)
 insert property property at position index If index is not valid, the property is appended.
 
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.
 
PropertyinsertProperty (size_t index, std::unique_ptr< Property > property)
 insert property property at position index If index is not valid, the property is appended.
 
virtual void invokeEvent (Event *event) override
 
virtual bool isValid () const
 
virtual bool move (Property *property, size_t newIndex)
 
PropertyOwneroperator= (const PropertyOwner &that)=delete
 
Propertyoperator[] (size_t)
 
const Propertyoperator[] (size_t) const
 
virtual PropertyremoveProperty (iterator it)
 
PropertyremoveProperty (Property &property)
 
PropertyremoveProperty (Property *property)
 
PropertyremoveProperty (size_t index)
 remove property referred to by index
 
PropertyremoveProperty (std::string_view identifier)
 
virtual void resetAllProperties ()
 
virtual void setAllPropertiesCurrentStateAsDefault ()
 
virtual void setValid ()
 
size_t size () const
 
virtual ~PropertyOwner ()
 Removes all properties and notifies its observers of the removal.
 
- Public Member Functions inherited from inviwo::PropertyOwnerObservable
void notifyObserversDidAddProperty (Property *property, size_t index)
 
void notifyObserversDidRemoveProperty (PropertyOwner *owner, Property *property, size_t index)
 
void notifyObserversWillAddProperty (PropertyOwner *owner, Property *property, size_t index)
 
void notifyObserversWillRemoveProperty (Property *property, size_t index)
 
- Public Member Functions inherited from inviwo::Observable< PropertyOwnerObserver >
void addObserver (PropertyOwnerObserver *observer)
 
bool isObservedBy (PropertyOwnerObserver *observer) const
 
 Observable (const Observable< PropertyOwnerObserver > &other)
 
 Observable (Observable< PropertyOwnerObserver > &&other) noexcept
 
Observable< PropertyOwnerObserver > & operator= (const Observable< PropertyOwnerObserver > &other)
 
Observable< PropertyOwnerObserver > & operator= (Observable< PropertyOwnerObserver > &&other) noexcept
 
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
void forEachProperty (std::function< void(Property &)> callback, bool recursiveSearch=false) const
 
PropertyOwneroperator= (PropertyOwner &&that)
 
 PropertyOwner (const PropertyOwner &rhs)
 
 PropertyOwner (PropertyOwner &&rhs)
 
- Protected Member Functions inherited from inviwo::Observable< PropertyOwnerObserver >
void forEachObserver (C callback)
 
- Protected Member Functions inherited from inviwo::ObservableInterface
void addObservationHelper (Observer *observer)
 
void removeObservationHelper (Observer *observer)
 

Protected Attributes

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

Member Function Documentation

◆ deserialize()

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

Reimplemented from inviwo::PropertyOwner.

◆ getIdentifier()

virtual std::string_view inviwo::WorkspaceAnnotations::getIdentifier ( ) const
inlineoverridevirtual

Implements 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: