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

Public Member Functions

 CompositeProperty (CompositeProperty &&rhs)=default
 
 CompositeProperty (const CompositeProperty &rhs)=default
 
 CompositeProperty (std::string_view identifier, std::string_view displayName, Document help, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)
 
 CompositeProperty (std::string_view identifier, std::string_view displayName, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)
 
virtual void update ()=0
 
- Public Member Functions inherited from inviwo::CompositeProperty
virtual void accept (NetworkVisitor &visitor) override
 Accept a NetworkVisitor, the visitor will visit this and then each Property of the CompositeProperty in an undefined order. The Visitor will then visit each Properties's properties and so on.
 
virtual CompositeProperty * clone () const override
 
 CompositeProperty (CompositeProperty &&rhs)=default
 
 CompositeProperty (const CompositeProperty &rhs)=default
 
 CompositeProperty (std::string_view identifier, std::string_view displayName, Document help, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)
 
 CompositeProperty (std::string_view identifier, std::string_view displayName, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)
 
virtual void deserialize (Deserializer &d) override
 
virtual std::string_view getClassIdentifier () const override
 
virtual std::string_view getClassIdentifierForWidget () const override
 Returns which property's widget should be used when the WidgetFactory tries to create a widget. Defaults to getClassIdentifier(), should only be overridden if a subclass want to reuse another property's widget.
 
virtual std::string_view getIdentifier () const override
 
virtual InvalidationLevel getInvalidationLevel () const override
 
virtual InviwoApplication * getInviwoApplication () override
 
virtual const PropertyOwner * getOwner () const override
 
virtual PropertyOwner * getOwner () override
 
virtual const Processor * getProcessor () const override
 
virtual Processor * getProcessor () override
 
virtual void invalidate (InvalidationLevel invalidationLevel, Property *modifiedProperty=0) override
 
virtual bool isCollapsed () const
 
virtual bool isDefaultState () const override
 
virtual bool needsSerialization () const override
 
CompositeProperty & operator= (CompositeProperty &&rhs)=default
 
CompositeProperty & operator= (const CompositeProperty &rhs)=delete
 
virtual CompositeProperty & resetToDefaultState () override
 
virtual void serialize (Serializer &s) const override
 
void set (const CompositeProperty *src)
 
virtual void set (const Property *src) override
 
virtual CompositeProperty & setCollapsed (bool value)
 
CompositeProperty & setCollapsed (CollapseAction action, CollapseTarget target)
 
virtual CompositeProperty & setCurrentStateAsDefault () override
 
virtual void setOwner (PropertyOwner *owner) override
 
virtual CompositeProperty & setReadOnly (bool value) override
 Enable or disable editing of property.
 
virtual void setValid () override
 
- Public Member Functions inherited from inviwo::Property
template<typename P >
Property & autoLinkToProperty (std::string_view propertyPath)
 
void clearInitiatingWidget ()
 
void deregisterWidget (PropertyWidget *propertyWidget)
 
const std::vector< std::pair< std::string, std::string > > & getAutoLinkToProperty () const
 
virtual Document getDescription () const
 
virtual std::string_view getDisplayName () const
 
Document & getHelp ()
 
const Document & getHelp () const
 
PropertyOwner * getOwner ()
 
const PropertyOwner * getOwner () const
 
std::string_view getPath () const
 Get the property path as string.
 
void getPath (std::pmr::string &out) const
 
virtual bool getReadOnly () const
 
virtual PropertySemantics getSemantics () const
 
virtual PropertySerializationMode getSerializationMode () const
 
virtual bool getVisible () const
 
const std::vector< PropertyWidget * > & getWidgets () const
 
bool hasWidgets () const
 
virtual bool isModified () const
 
const BaseCallBack * onChange (std::function< void()> callback)
 
std::shared_ptr< std::function< void()> > onChangeScoped (std::function< void()> callback)
 
 Property (std::string_view identifier, std::string_view displayName, InvalidationLevel invalidationLevel, PropertySemantics semantics=PropertySemantics::Default)
 
 Property (std::string_view identifier="", std::string_view displayName="", Document help={}, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default, ReadOnly readOnly=ReadOnly::No)
 
virtual Property & propertyModified ()
 
template<typename P , typename DecisionFunc >
Property & readonlyDependsOn (P &prop, DecisionFunc callback)
 
void registerWidget (PropertyWidget *propertyWidget)
 
void removeOnChange (const BaseCallBack *callback)
 
virtual Property & setDisplayName (std::string_view displayName)
 A property's name displayed to the user.
 
Property & setHelp (Document help)
 
virtual Property & setIdentifier (std::string_view identifier)
 
void setInitiatingWidget (PropertyWidget *propertyWidget)
 
virtual Property & setInvalidationLevel (InvalidationLevel invalidationLevel)
 
virtual Property & setModified ()
 
virtual Property & setSemantics (const PropertySemantics &semantics)
 
virtual Property & setSerializationMode (PropertySerializationMode mode)
 
virtual Property & setVisible (bool val)
 
void updateWidgets ()
 
template<typename P , typename DecisionFunc >
Property & visibilityDependsOn (P &prop, DecisionFunc callback)
 
virtual ~Property ()
 Removes itself from its PropertyOwner.
 
- Public Member Functions inherited from inviwo::Observable< PropertyObserver >
void addObserver (PropertyObserver *observer)
 
bool isObservedBy (PropertyObserver *observer) const
 
 Observable (const Observable< PropertyObserver > &other)
 
 Observable (Observable< PropertyObserver > &&other) noexcept
 
Observable< PropertyObserver > & operator= (const Observable< PropertyObserver > &other)
 
Observable< PropertyObserver > & operator= (Observable< PropertyObserver > &&other) noexcept
 
void removeObserver (PropertyObserver *observer)
 
virtual void startBlockingNotifications () override final
 
virtual void stopBlockingNotifications () override final
 
- Public Member Functions inherited from inviwo::MetaDataOwner
void copyMetaDataFrom (const MetaDataOwner &src)
 
void copyMetaDataTo (MetaDataOwner &dst)
 
template<typename T >
requires std::derived_from<T, MetaData>
T * createMetaData (std::string_view key)
 
void deserialize (Deserializer &d)
 
template<typename T >
requires std::derived_from<T, MetaData>
T * getMetaData (std::string_view key)
 
template<typename T >
requires std::derived_from<T, MetaData>
const T * getMetaData (std::string_view key) const
 
template<typename T , typename U >
requires std::derived_from<T, MetaData> && Gettable<T, U>
U getMetaData (std::string_view key, U val) const
 
MetaDataMap * getMetaDataMap ()
 
const MetaDataMap * getMetaDataMap () const
 
bool hasMetaData (std::string_view key) const
 
template<typename T >
requires std::derived_from<T, MetaData>
bool hasMetaData (std::string_view key) const
 
 MetaDataOwner (const MetaDataOwner &rhs)=default
 
 MetaDataOwner (MetaDataOwner &rhs)=default
 
MetaDataOwner & operator= (const MetaDataOwner &rhs)=default
 
MetaDataOwner & operator= (MetaDataOwner &)=default
 
void serialize (Serializer &s) const
 
template<typename T , typename U >
requires std::derived_from<T, MetaData> && Settable<T, U>
void setMetaData (std::string_view key, U value)
 
template<typename T >
requires std::derived_from<T, MetaData>
bool unsetMetaData (std::string_view key)
 unset, i.e. remove the metadata entry matching the given key and type
 
- 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)
 
Property * addProperty (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
 
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)
 
Property * getPropertyByIdentifier (std::string_view identifier, bool recursiveSearch=false) const
 
Property * getPropertyByPath (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.
 
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 void invokeEvent (Event *event) override
 
virtual bool isValid () const
 
virtual bool move (Property *property, size_t newIndex)
 
PropertyOwner & operator= (const PropertyOwner &that)=delete
 
Property * operator[] (size_t)
 
const Property * operator[] (size_t) const
 
virtual Property * removeProperty (iterator it)
 
Property * removeProperty (Property &property)
 
Property * removeProperty (Property *property)
 
Property * removeProperty (size_t index)
 remove property referred to by index
 
Property * removeProperty (std::string_view identifier)
 
virtual void resetAllProperties ()
 
virtual void setAllPropertiesCurrentStateAsDefault ()
 
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
 
- Public Member Functions inherited from inviwo::Observable< CompositePropertyObserver >
void addObserver (CompositePropertyObserver *observer)
 
bool isObservedBy (CompositePropertyObserver *observer) const
 
 Observable (const Observable< CompositePropertyObserver > &other)
 
 Observable (Observable< CompositePropertyObserver > &&other) noexcept
 
Observable< CompositePropertyObserver > & operator= (const Observable< CompositePropertyObserver > &other)
 
Observable< CompositePropertyObserver > & operator= (Observable< CompositePropertyObserver > &&other) noexcept
 
void removeObserver (CompositePropertyObserver *observer)
 
virtual void startBlockingNotifications () override final
 
virtual void stopBlockingNotifications () override final
 

Additional Inherited Members

- Public Types inherited from inviwo::CompositeProperty
enum class  CollapseAction { Collapse , Expand }
 
enum class  CollapseTarget { Current , Recursive , Children , Siblings }
 
- Public Types inherited from inviwo::PropertyOwner
using const_iterator = std::vector<Property*>::const_iterator
 
using iterator = std::vector<Property*>::iterator
 
- Static Public Member Functions inherited from inviwo::Property
template<typename T , typename U >
static void setStateAsDefault (T &property, const U &state)
 
- Static Public Attributes inherited from inviwo::CompositeProperty
static constexpr std::string_view classIdentifier {"org.inviwo.CompositeProperty"}
 
- Protected Member Functions inherited from inviwo::Property
void notifyAboutChange ()
 
Property & operator= (const Property &that)=delete
 
Property & operator= (Property &&that)
 
 Property (const Property &rhs)
 
 Property (Property &&rhs)
 
- Protected Member Functions inherited from inviwo::PropertyObservable
void notifyObserversOnSetDisplayName (Property *property, const std::string &displayName)
 
void notifyObserversOnSetIdentifier (Property *property, const std::string &identifier)
 
void notifyObserversOnSetReadOnly (Property *property, bool readonly)
 
void notifyObserversOnSetSemantics (Property *property, const PropertySemantics &semantics)
 
void notifyObserversOnSetVisible (Property *property, bool visible)
 
- Protected Member Functions inherited from inviwo::Observable< PropertyObserver >
void forEachObserver (C callback)
 
- Protected Member Functions inherited from inviwo::ObservableInterface
void addObservationHelper (Observer *observer)
 
void removeObservationHelper (Observer *observer)
 
- Protected Member Functions inherited from inviwo::PropertyOwner
void forEachProperty (std::function< void(Property &)> callback, bool recursiveSearch=false) const
 
PropertyOwner & operator= (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::CompositePropertyObservable
void notifyObserversOnSetCollapsed (bool collapsed)
 
- Protected Member Functions inherited from inviwo::Observable< CompositePropertyObserver >
void forEachObserver (C callback)
 
- Protected Attributes inherited from inviwo::Property
CallBackList onChangeCallback_
 
PropertySerializationMode serializationMode_
 
- Protected Attributes inherited from inviwo::MetaDataOwner
MetaDataMap metaData_
 
- 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_
 

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