A Property represents a parameter to a processor. More...

#include <property.h>

Inheritance diagram for inviwo::Property:

Classes
class	OnChangeBlocker

Public Member Functions
virtual std::string_view	getClassIdentifier () const =0

	Property (std::string_view identifier="", std::string_view displayName="", Document help={}, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default, ReadOnly readOnly=ReadOnly::No)

	Property (std::string_view identifier, std::string_view displayName, InvalidationLevel invalidationLevel, PropertySemantics semantics=PropertySemantics::Default)

virtual Property *	clone () const =0

virtual	~Property ()
	Removes itself from its PropertyOwner.

virtual Property &	setIdentifier (std::string_view identifier)

virtual const std::string &	getIdentifier () const

const std::string &	getPath () const
	Get the property path as string.

void	getPath (std::pmr::string &out) const

virtual Property &	setDisplayName (std::string_view displayName)
	A property's name displayed to the user.

virtual const std::string &	getDisplayName () const

virtual std::string_view	getClassIdentifierForWidget () const
	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 Property &	setSemantics (const PropertySemantics &semantics)

virtual PropertySemantics	getSemantics () const

virtual Property &	setReadOnly (bool value)
	Enable or disable editing of property.

virtual bool	getReadOnly () const

virtual Property &	setInvalidationLevel (InvalidationLevel invalidationLevel)

virtual InvalidationLevel	getInvalidationLevel () const

virtual void	setOwner (PropertyOwner *owner)

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 ()

void	updateWidgets ()

bool	hasWidgets () const

virtual Property &	setSerializationMode (PropertySerializationMode mode)

virtual PropertySerializationMode	getSerializationMode () const

virtual Property &	setCurrentStateAsDefault ()

virtual Property &	resetToDefaultState ()

virtual bool	isDefaultState () const

virtual bool	needsSerialization () const

virtual Property &	propertyModified ()

virtual void	setValid ()

virtual Property &	setModified ()

virtual bool	isModified () const

virtual void	set (const Property *src)

virtual void	serialize (Serializer &s) const override

virtual void	deserialize (Deserializer &d) override

std::shared_ptr< std::function< void()> >	onChangeScoped (std::function< void()> callback)

const BaseCallBack *	onChange (std::function< void()> callback)

void	removeOnChange (const BaseCallBack *callback)

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)

const Document &	getHelp () const

Document &	getHelp ()

Property &	setHelp (Document help)

virtual Document	getDescription () const

template<typename P >
Property &	autoLinkToProperty (std::string_view propertyPath)

const std::vector< std::pair< std::string, std::string > > &	getAutoLinkToProperty () const

virtual void	accept (NetworkVisitor &visitor)
	Accept a NetworkVisitor, the visitor will visit this Property.

Public Member Functions inherited from inviwo::Observable< PropertyObserver >
	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	addObserver (PropertyObserver *observer)

void	removeObserver (PropertyObserver *observer)

virtual void	startBlockingNotifications () override final

virtual void	stopBlockingNotifications () override final

Public Member Functions inherited from inviwo::ObservableInterface
Public Member Functions inherited from inviwo::Serializable
Public Member Functions inherited from inviwo::MetaDataOwner
	MetaDataOwner (const MetaDataOwner &rhs)=default

	MetaDataOwner (MetaDataOwner &rhs)=default

MetaDataOwner &	operator= (const MetaDataOwner &rhs)=default

MetaDataOwner &	operator= (MetaDataOwner &)=default

void	copyMetaDataFrom (const MetaDataOwner &src)

void	copyMetaDataTo (MetaDataOwner &dst)

template<typename T > requires std::derived_from<T, MetaData>
T *	createMetaData (std::string_view key)

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

template<typename T , typename U > requires std::derived_from<T, MetaData> && Gettable<T, U>
U	getMetaData (std::string_view key, U val) const

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

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

void	serialize (Serializer &s) const

void	deserialize (Deserializer &d)

Static Public Member Functions
template<typename T , typename U >
static void	setStateAsDefault (T &property, const U &state)

Protected Member Functions
	Property (const Property &rhs)

Property &	operator= (const Property &that)=delete

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)

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 Attributes
CallBackList	onChangeCallback_

PropertySerializationMode	serializationMode_

Protected Attributes inherited from inviwo::MetaDataOwner
MetaDataMap	metaData_

Detailed Description

A Property represents a parameter to a processor.

Concepts:

PropertyOwner: A property can have a owner, usually a Processor or a CompositeProperty. If the property is modified, by calling Property::propertyModified then the property will set it's owner's invalidation level to the property's invalidation level, usually InvalidationLevel::InvalidOutput. This will in turn trigger a network evaluation that will update the processors to a valid state again.
Serializable: A property is serializable to be able to store all the processor parameters for each Processor in the saved ProcessorNetwork
PropertySemantics: A property can be set to one or several different semantics, which is often used to display different PropertyWidets. For example using a color picker for Color Semantic or a text field for Text Semantics.
Reset: A property has a default state specified in the constructor, or optionally be calling Property::setCurrentStateAsDefault. The property can then also be reset to it's default state by calling Property::resetToDefaultState. Both these functions are virtual and all property subclasses that introduce more state should make sure to implement these two function and also in their implementation make sure that to call the base class implementation.
PropertyWidget: A property can have one or multiple PropertyWidgets. The widget are used in the user interface to implement interactivity

Constructor & Destructor Documentation

◆ Property()

inviwo::Property::Property ( const Property & rhs )

protected

Since property is a polymorphic class the copy constructor should only be used internally to implement the clone functionality

See also: clone

Member Function Documentation

◆ accept()

virtual void inviwo::Property::accept ( NetworkVisitor & visitor )

virtual

Accept a NetworkVisitor, the visitor will visit this Property.

Reimplemented in inviwo::CompositeProperty.

◆ clearInitiatingWidget()

void inviwo::Property::clearInitiatingWidget ( )

Clear the initiatingWidget

See also: setInitiatingWidget

◆ clone()

virtual Property * inviwo::Property::clone ( ) const

pure virtual

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.

◆ deregisterWidget()

void inviwo::Property::deregisterWidget ( PropertyWidget * propertyWidget )

Deregister a widget, the widget will no longer receive updateFromProperty calls.

See also: registerProperty; PropertyWidget

◆ deserialize()

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

overridevirtual

Implements inviwo::Serializable.

◆ getClassIdentifierForWidget()

virtual std::string_view inviwo::Property::getClassIdentifierForWidget ( ) const

virtual

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.

◆ getDescription()

virtual Document inviwo::Property::getDescription ( ) const

virtual

This function should describe the state of the property By default this will return a document describing all the state. i.e. Identifier, DisplayName, Help, InvalidationLevel, PropertySemantics, etc. Derived properties should extend this function and add their state, usually values etc. The description is usually shown as a tooltip in the GUI.

◆ getHelp()

const Document & inviwo::Property::getHelp ( ) const

The help should describe what state the property represents and how it is used. This will be shown in the Processor help, and as part of the property description in the property tooltip in the GUI.

◆ getPath()

const std::string & inviwo::Property::getPath ( ) const

Get the property path as string.

Returns: string of dot separated identifiers starting with a processor identifier followed by property identifiers.

◆ getWidgets()

const std::vector< PropertyWidget * > & inviwo::Property::getWidgets ( ) const

Retrieve all registered widgets.

See also: registerProperty

◆ hasWidgets()

bool inviwo::Property::hasWidgets ( ) const

Does the property have any registered widgets.

See also: registerProperty

◆ isDefaultState()

virtual bool inviwo::Property::isDefaultState ( ) const

virtual

Check if the property is in it's default state, i.e. resetToDefaultState would do nothing

See also: setCurrentStateAsDefault; resetToDefaultState

◆ needsSerialization()

virtual bool inviwo::Property::needsSerialization ( ) const

virtual

Determinate if the property should be included in the serialization Depends on the PropertySerializationMode and if the property is in the default state. If the mode is All it always return true, None always returns false, and default delegates to isDefaultState()

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

◆ onChange()

const BaseCallBack * inviwo::Property::onChange ( std::function< void()> callback )

Add an on change callback to the property. The callback is run when ever propertyModified is called. Usually when even the value of property changes. The return value can be passed to removeOnChange to remove the callback. Prefer onChangeScoped when the callback need to be removed. Multiple callbacks can be registered at the same time.

◆ onChangeScoped()

std::shared_ptr< std::function< void()> > inviwo::Property::onChangeScoped ( std::function< void()> callback )

Add an on change callback to the property. The callback is run when ever propertyModified is called. Usually when even the value of property changes. The return value is a RAII guard for the callback and will remove the callback on destruction. Hence one must keep the return value around as long as the callback should be active. To remove the callback one only need to destruct or reset the return value. Multiple callbacks can be registered at the same time.

◆ operator=()

Property & inviwo::Property::operator= ( const Property & that )

protecteddelete

Properties do not support copy assignment. To assign the "value" of a property to an other property the Property::set(const Property* src) function should be used

See also: set

◆ registerWidget()

void inviwo::Property::registerWidget ( PropertyWidget * propertyWidget )

Register a widget for the property. Registered widgets will receive updateFromProperty calls when the value state of the property changes. One Property can have multiple widgets. The property does not take ownership of the widget.

See also: deregisterProperty; PropertyWidget

◆ removeOnChange()

void inviwo::Property::removeOnChange ( const BaseCallBack * callback )

Remove an on change callback registered using onChange.

◆ resetToDefaultState()

virtual Property & inviwo::Property::resetToDefaultState ( )

virtual

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.

◆ serialize()

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

overridevirtual

Implements inviwo::Serializable.

◆ set()

virtual void inviwo::Property::set ( const Property * src )

virtual

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.

◆ setCurrentStateAsDefault()

virtual Property & inviwo::Property::setCurrentStateAsDefault ( )

virtual

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.

◆ setIdentifier()

virtual Property & inviwo::Property::setIdentifier ( std::string_view identifier )

virtual

Property identifier has to be unique within the scope of a PropertyOwner. Property identifiers should only contain alpha numeric characters, "-" and "_".

◆ setInitiatingWidget()

void inviwo::Property::setInitiatingWidget ( PropertyWidget * propertyWidget )

This function should be called by property widgets before they initiate a property change. This is needed because when the property is modified it needs to update all of its widgets. And since it won't know if the change started in one of them we will update the property widget that started the change

See also: registerProperty; PropertyWidget

◆ setReadOnly()

virtual Property & inviwo::Property::setReadOnly ( bool value )

virtual

Enable or disable editing of property.

Reimplemented in inviwo::CompositeProperty.

◆ updateWidgets()

void inviwo::Property::updateWidgets ( )

Update all widgets using the current property state except for the initiating widget.

See also: setInitiatingWidget, clearInitiatingWidget

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

property.h

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Property()

Member Function Documentation

◆ accept()

◆ clearInitiatingWidget()

◆ clone()

◆ deregisterWidget()

◆ deserialize()

◆ getClassIdentifierForWidget()

◆ getDescription()

◆ getHelp()

◆ getPath()

◆ getWidgets()

◆ hasWidgets()

◆ isDefaultState()

◆ needsSerialization()

◆ onChange()

◆ onChangeScoped()

◆ operator=()

◆ registerWidget()

◆ removeOnChange()

◆ resetToDefaultState()

◆ serialize()

◆ set()

◆ setCurrentStateAsDefault()

◆ setIdentifier()

◆ setInitiatingWidget()

◆ setReadOnly()

◆ updateWidgets()