#include <inviwo/core/properties/optionproperty.h>

Inheritance diagram for inviwo::BaseOptionProperty:

Public Member Functions
	BaseOptionProperty (const BaseOptionProperty &rhs)

	BaseOptionProperty (std::string_view identifier, std::string_view displayName, Document help, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)

virtual BaseOptionProperty &	clearOptions ()=0

bool	empty () const

virtual std::string_view	getClassIdentifier () const override=0

virtual std::vector< std::string >	getDisplayNames () const =0

virtual std::vector< std::string >	getIdentifiers () const =0

virtual const std::string &	getOptionDisplayName (size_t index) const =0

virtual const std::string &	getOptionIdentifier (size_t index) const =0

virtual const std::string &	getSelectedDisplayName () const =0

virtual const std::string &	getSelectedIdentifier () const =0

virtual size_t	getSelectedIndex () const =0

virtual bool	isSelectedDisplayName (std::string_view name) const =0

virtual bool	isSelectedIdentifier (std::string_view identifier) const =0

virtual bool	isSelectedIndex (size_t index) const =0

void	set (const BaseOptionProperty *srcProperty)

virtual void	set (const Property *srcProperty) override

virtual bool	setSelectedDisplayName (std::string_view name)=0

virtual bool	setSelectedIdentifier (std::string_view identifier)=0

virtual bool	setSelectedIndex (size_t index)=0

virtual size_t	size () const =0

Public Member Functions inherited from inviwo::Property
virtual void	accept (NetworkVisitor &visitor)
	Accept a NetworkVisitor, the visitor will visit this Property.

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

void	clearInitiatingWidget ()

virtual Property *	clone () const =0

void	deregisterWidget (PropertyWidget *propertyWidget)

virtual void	deserialize (Deserializer &d) override

const std::vector< std::pair< std::string, std::string > > &	getAutoLinkToProperty () 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 Document	getDescription () const

virtual std::string_view	getDisplayName () const

Document &	getHelp ()

const Document &	getHelp () const

virtual std::string_view	getIdentifier () const

virtual InvalidationLevel	getInvalidationLevel () 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	isDefaultState () const

virtual bool	isModified () const

virtual bool	needsSerialization () 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 &	resetToDefaultState ()

virtual void	serialize (Serializer &s) const override

virtual Property &	setCurrentStateAsDefault ()

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 void	setOwner (PropertyOwner *owner)

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

virtual Property &	setSemantics (const PropertySemantics &semantics)

virtual Property &	setSerializationMode (PropertySerializationMode mode)

virtual void	setValid ()

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

Additional Inherited Members
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
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 Attributes inherited from inviwo::Property
CallBackList	onChangeCallback_

PropertySerializationMode	serializationMode_

Protected Attributes inherited from inviwo::MetaDataOwner
MetaDataMap	metaData_

Detailed Description

Base class for the option properties

See also: OptionProperty

Member Function Documentation

◆ getClassIdentifier()

virtual std::string_view inviwo::BaseOptionProperty::getClassIdentifier ( ) const

overridepure virtual

Implements inviwo::Property.

◆ set()

virtual void inviwo::BaseOptionProperty::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.

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

include/inviwo/core/properties/optionproperty.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getClassIdentifier()

◆ set()