Inviwo  0.9.10.1
Inviwo documentation
Public Member Functions | Static Public Attributes | List of all members
inviwo::CompositeProperty Class Reference
Properties

#include <compositeproperty.h>

+ Inheritance diagram for inviwo::CompositeProperty:

Public Member Functions

virtual std::string getClassIdentifier () const override
 
 CompositeProperty (const std::string &identifier, const std::string &displayName, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)
 
 CompositeProperty (const CompositeProperty &rhs)=default
 
virtual CompositeProperty * clone () const override
 
virtual std::string 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 bool isCollapsed () const
 
virtual void setCollapsed (bool value)
 
virtual void setOwner (PropertyOwner *owner) override
 
virtual void set (const Property *src) override
 
void set (const CompositeProperty *src)
 
virtual void setValid () override
 
virtual InvalidationLevel getInvalidationLevel () const override
 
virtual CompositeProperty & setCurrentStateAsDefault () override
 
virtual CompositeProperty & resetToDefaultState () override
 
virtual CompositeProperty & setReadOnly (bool value) override
 Enable or disable editing of property.
 
virtual void invalidate (InvalidationLevel invalidationLevel, Property *modifiedProperty=0) override
 
virtual Processor * getProcessor () override
 
virtual const Processor * getProcessor () const override
 
virtual std::vector< std::string > getPath () const override
 
virtual void serialize (Serializer &s) const override
 
virtual void deserialize (Deserializer &d) override
 
- Public Member Functions inherited from inviwo::Property
 Property (const std::string &identifier="", const std::string &displayName="", InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 
virtual ~Property ()
 Removes itself from its PropertyOwner.
 
virtual Property & setIdentifier (const std::string &identifier)
 
virtual std::string getIdentifier () const
 
virtual Property & setDisplayName (const std::string &displayName)
 A property's name displayed to the user.
 
virtual std::string getDisplayName () const
 
virtual Property & setSemantics (const PropertySemantics &semantics)
 
virtual PropertySemantics getSemantics () const
 
virtual bool getReadOnly () const
 
virtual Property & setInvalidationLevel (InvalidationLevel invalidationLevel)
 
PropertyOwner * getOwner ()
 
const PropertyOwner * getOwner () const
 
void registerWidget (PropertyWidget *propertyWidget)
 
void deregisterWidget (PropertyWidget *propertyWidget)
 
const std::vector< PropertyWidget * > & getWidgets () const
 
void setInitiatingWidget (PropertyWidget *propertyWidget)
 
void clearInitiatingWidget ()
 
bool hasWidgets () const
 
virtual Property & propertyModified ()
 
virtual Property & setModified ()
 
virtual bool isModified () const
 
std::shared_ptr< std::function< void()> > onChangeScoped (std::function< void()> callback)
 
const BaseCallBack * onChange (std::function< void()> callback)
 
void removeOnChange (const BaseCallBack *callback)
 
template<typename T >
const BaseCallBack * onChange (T *object, void(T::*method)())
 
template<typename T >
void removeOnChange (T *object)
 
virtual Property & setUsageMode (UsageMode usageMode)
 
virtual UsageMode getUsageMode () const
 
virtual void setSerializationMode (PropertySerializationMode mode)
 
virtual PropertySerializationMode getSerializationMode () const
 
virtual Property & setVisible (bool val)
 
virtual bool getVisible () const
 
template<typename P , typename DecisionFunc >
Property & visibilityDependsOn (P &prop, DecisionFunc callback)
 
template<typename P , typename DecisionFunc >
Property & readonlyDependsOn (P &prop, DecisionFunc callback)
 
virtual Document getDescription () const
 
template<typename P >
Property & autoLinkToProperty (const std::string &propertyPath)
 
const std::vector< std::pair< std::string, std::string > > & getAutoLinkToProperty () const
 
- Public Member Functions inherited from inviwo::Observable< PropertyObserver >
 Observable (const Observable< PropertyObserver > &other)
 
 Observable (Observable< PropertyObserver > &&other)
 
Observable< PropertyObserver > & operator= (const Observable< PropertyObserver > &other)
 
Observable< PropertyObserver > & operator= (Observable< PropertyObserver > &&other)
 
void addObserver (PropertyObserver *observer)
 
void removeObserver (PropertyObserver *observer)
 
virtual void startBlockingNotifications () override final
 
virtual void stopBlockingNotifications () override final
 
- Public Member Functions inherited from inviwo::MetaDataOwner
 MetaDataOwner (const MetaDataOwner &rhs)=default
 
MetaDataOwner & operator= (const MetaDataOwner &rhs)=default
 
void copyMetaDataFrom (const MetaDataOwner &src)
 
void copyMetaDataTo (MetaDataOwner &dst)
 
template<typename T >
T * createMetaData (const std::string &key)
 
template<typename T , typename U >
void setMetaData (const std::string &key, U value)
 
template<typename T >
bool unsetMetaData (const std::string &key)
 unset, i.e. remove the metadata entry matching the given key and type More...
 
template<typename T , typename U >
U getMetaData (const std::string &key, U val) const
 
template<typename T >
T * getMetaData (const std::string &key)
 
template<typename T >
const T * getMetaData (const std::string &key) const
 
MetaDataMap * getMetaDataMap ()
 
const MetaDataMap * getMetaDataMap () const
 
template<typename T >
bool hasMetaData (const std::string &key) const
 
- 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)
 
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. More...
 
virtual void insertProperty (size_t index, Property &property)
 insert property property at position index If index is not valid, the property is appended. More...
 
virtual Property * removeProperty (const std::string &identifier)
 
virtual Property * removeProperty (Property *property)
 
virtual Property * removeProperty (Property &property)
 
virtual Property * removeProperty (size_t index)
 remove property referred to by index More...
 
const std::vector< Property * > & getProperties () const
 
const std::vector< CompositeProperty * > & getCompositeProperties () const
 
std::vector< Property * > getPropertiesRecursive () const
 
Property * getPropertyByIdentifier (const std::string &identifier, bool recursiveSearch=false) const
 
Property * getPropertyByPath (const std::vector< std::string > &path) const
 
template<class T >
std::vector< T * > getPropertiesByType (bool recursiveSearch=false) const
 
size_t size () const
 
Property * operator[] (size_t)
 
const Property * operator[] (size_t) const
 
iterator begin ()
 
iterator end ()
 
const_iterator cbegin () const
 
const_iterator cend () const
 
virtual bool isValid () const
 
InvalidationLevel getInvalidationLevel () const
 
void setAllPropertiesCurrentStateAsDefault ()
 
void resetAllPoperties ()
 
virtual void invokeEvent (Event *event) override
 
virtual InviwoApplication * getInviwoApplication ()
 
- Public Member Functions inherited from inviwo::PropertyOwnerObservable
void notifyObserversWillAddProperty (Property *property, size_t index)
 
void notifyObserversDidAddProperty (Property *property, size_t index)
 
void notifyObserversWillRemoveProperty (Property *property, size_t index)
 
void notifyObserversDidRemoveProperty (Property *property, size_t index)
 
- Public Member Functions inherited from inviwo::Observable< PropertyOwnerObserver >
 Observable (const Observable< PropertyOwnerObserver > &other)
 
 Observable (Observable< PropertyOwnerObserver > &&other)
 
Observable< PropertyOwnerObserver > & operator= (const Observable< PropertyOwnerObserver > &other)
 
Observable< PropertyOwnerObserver > & operator= (Observable< PropertyOwnerObserver > &&other)
 
void addObserver (PropertyOwnerObserver *observer)
 
void removeObserver (PropertyOwnerObserver *observer)
 
virtual void startBlockingNotifications () override final
 
virtual void stopBlockingNotifications () override final
 
- Public Member Functions inherited from inviwo::Observable< CompositePropertyObserver >
 Observable (const Observable< CompositePropertyObserver > &other)
 
 Observable (Observable< CompositePropertyObserver > &&other)
 
Observable< CompositePropertyObserver > & operator= (const Observable< CompositePropertyObserver > &other)
 
Observable< CompositePropertyObserver > & operator= (Observable< CompositePropertyObserver > &&other)
 
void addObserver (CompositePropertyObserver *observer)
 
void removeObserver (CompositePropertyObserver *observer)
 
virtual void startBlockingNotifications () override final
 
virtual void stopBlockingNotifications () override final
 

Static Public Attributes

static const std::string classIdentifier = "org.inviwo.CompositeProperty"
 

Additional Inherited Members

- Public Types inherited from inviwo::PropertyOwner
using iterator = std::vector< Property * >::iterator
 
using const_iterator = std::vector< Property * >::const_iterator
 
- Static Public Member Functions inherited from inviwo::Property
template<typename T , typename U >
static void setStateAsDefault (T &property, const U &state)
 
- Protected Member Functions inherited from inviwo::Property
 Property (const Property &rhs)
 
Property & operator= (const Property &that)=delete
 
void updateWidgets ()
 
void notifyAboutChange ()
 
- Protected Member Functions inherited from inviwo::PropertyObservable
void notifyObserversOnSetIdentifier (Property *property, const std::string &identifier)
 
void notifyObserversOnSetDisplayName (Property *property, const std::string &displayName)
 
void notifyObserversOnSetSemantics (Property *property, const PropertySemantics &semantics)
 
void notifyObserversOnSetReadOnly (Property *property, bool readonly)
 
void notifyObserversOnSetVisible (Property *property, bool visible)
 
void notifyObserversOnSetUsageMode (Property *property, UsageMode usageMode)
 
- 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
 PropertyOwner (const PropertyOwner &rhs)
 
PropertyOwner & operator= (const PropertyOwner &that)=delete
 
- 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< Property * > properties_
 
std::vector< EventProperty * > eventProperties_
 
std::vector< CompositeProperty * > compositeProperties_
 
std::vector< std::unique_ptr< Property > > ownedProperties_
 

Detailed Description

A grouping property for collecting properties in a hierarchy, CompositeProperties can be nested arbitrarily deep.

Member Function Documentation

◆ clone()

CompositeProperty * inviwo::CompositeProperty::clone ( ) const
overridevirtual

Creates a clone of this property. The clone will have the same identifier, hence the identifier must be changed if the clone should be added to the same owner as this. The new clone does not have any owner set.

Implements inviwo::Property.

Reimplemented in inviwo::plot::PCPAxisSettings, inviwo::ListProperty, inviwo::plot::TickProperty, inviwo::IndexBufferInformationProperty, inviwo::plot::MinorTickProperty, inviwo::ColormapProperty, inviwo::MeshBufferInformationProperty, inviwo::ABufferGLCompositeProperty, inviwo::CameraProperty, inviwo::RaycastingProperty, inviwo::plot::PersistenceDiagramPlotGL::Properties, inviwo::FilePatternProperty, inviwo::IsoTFProperty, inviwo::SimpleLightingProperty, inviwo::AdvancedMaterialProperty, inviwo::plot::ScatterPlotGL::Properties, inviwo::IntegralLineVectorToMesh::ColorByProperty, inviwo::OrdinalAnimationProperty< T >, inviwo::plot::CategoricalAxisProperty, inviwo::GaussianProperty< T >, inviwo::GaussianProperty< double >, inviwo::PositionProperty, inviwo::BasisProperty, inviwo::PlaneProperty, inviwo::Trackball, inviwo::plot::AxisProperty, inviwo::FontProperty, inviwo::plot::MarginProperty, inviwo::VolumeIndicatorProperty, inviwo::plot::AxisStyleProperty, inviwo::plot::PlotTextProperty, inviwo::plot::MajorTickProperty, inviwo::BufferInformationProperty, inviwo::ImageInformationProperty, inviwo::MeshInformationProperty, inviwo::SequenceTimerProperty, inviwo::VolumeInformationProperty, inviwo::BoolCompositeProperty, inviwo::LayerInformationProperty, inviwo::SimpleRaycastingProperty, inviwo::StipplingProperty, inviwo::IntegralLineProperties, inviwo::PathLineProperties, and inviwo::StreamLineProperties.

◆ resetToDefaultState()

CompositeProperty & inviwo::CompositeProperty::resetToDefaultState ( )
overridevirtual

Reset the state of the property back to it's default value. It is important that all overriding properties make sure to call the base class implementation.

Reimplemented from inviwo::Property.

Reimplemented in inviwo::BasisProperty.

◆ set()

void inviwo::CompositeProperty::set ( const Property *  src)
overridevirtual

Set the value of this to that of src. The "value" is in this case considered to be for example the string in a StringProperty or the float value in a FloatProperty. But not things like the identifier of display name.

Reimplemented from inviwo::Property.

Reimplemented in inviwo::ListProperty, inviwo::CameraProperty, and inviwo::IsoTFProperty.

◆ setCurrentStateAsDefault()

CompositeProperty & inviwo::CompositeProperty::setCurrentStateAsDefault ( )
overridevirtual

Save the current state of the property as the default. This state will then be used as a reference when serializing, only state different from the default will be serialized. This method should usually only be called once directly after construction in the processor constructor after setting property specific state. It is important that all overriding properties make sure to call the base class implementation.

Reimplemented from inviwo::Property.

Reimplemented in inviwo::BasisProperty.

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