Inheritance diagram for inviwo::TemplateOptionProperty< T >:

Public Types
using	value_type = T

Public Member Functions
	TemplateOptionProperty (const std::string &identifier, const std::string &displayName, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)

	TemplateOptionProperty (const std::string &identifier, const std::string &displayName, const std::vector< OptionPropertyOption< T >> &options, size_t selectedIndex=0, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)

template<typename U = T, class = typename std::enable_if<util::is_stream_insertable<U>::value, void>::type>
	TemplateOptionProperty (const std::string &identifier, const std::string &displayName, const std::vector< T > &options, size_t selectedIndex=0, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)

	TemplateOptionProperty (const TemplateOptionProperty< T > &rhs)

virtual TemplateOptionProperty< T > *	clone () const override

virtual std::string	getClassIdentifier () const override

	operator const T & () const

TemplateOptionProperty &	addOption (const std::string &identifier, const std::string &displayName, const T &value)
	Adds an option to the property. More...

template<typename U = T, class = typename std::enable_if<std::is_same<U, std::string>::value, void>::type>
TemplateOptionProperty &	addOption (const std::string &identifier, const std::string &displayName)

virtual TemplateOptionProperty &	removeOption (const std::string &identifier)

virtual TemplateOptionProperty &	removeOption (size_t index)

virtual TemplateOptionProperty &	clearOptions () override

virtual size_t	size () const override

virtual size_t	getSelectedIndex () const override

virtual const std::string &	getSelectedIdentifier () const override

virtual const std::string &	getSelectedDisplayName () const override

const T &	getSelectedValue () const

virtual std::vector< std::string >	getIdentifiers () const override

virtual std::vector< std::string >	getDisplayNames () const override

std::vector< T >	getValues () const

const std::vector< OptionPropertyOption< T > > &	getOptions () const

virtual const std::string &	getOptionIdentifier (size_t index) const override

virtual const std::string &	getOptionDisplayName (size_t index) const override

const T &	getOptionValue (size_t index) const

const OptionPropertyOption< T > &	getOptions (size_t index) const

virtual bool	setSelectedIndex (size_t index) override

virtual bool	setSelectedIdentifier (const std::string &identifier) override

virtual bool	setSelectedDisplayName (const std::string &name) override

bool	setSelectedValue (const T &val)

virtual TemplateOptionProperty &	replaceOptions (const std::vector< std::string > &ids, const std::vector< std::string > &displayNames, const std::vector< T > &values)

virtual TemplateOptionProperty &	replaceOptions (std::vector< OptionPropertyOption< T >> options)

template<typename U = T, class = typename std::enable_if<util::is_stream_insertable<U>::value, void>::type>
TemplateOptionProperty &	replaceOptions (const std::vector< T > &options)

virtual bool	isSelectedIndex (size_t index) const override

virtual bool	isSelectedIdentifier (const std::string &identifier) const override

virtual bool	isSelectedDisplayName (const std::string &name) const override

bool	isSelectedValue (const T &val) const

const T &	get () const

const T &	operator * () const

const T *	operator-> () const

void	set (const T &value)

virtual void	set (const Property *srcProperty) override

virtual TemplateOptionProperty &	setCurrentStateAsDefault () override

virtual TemplateOptionProperty &	resetToDefaultState () 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 void	serialize (Serializer &s) const override

virtual void	deserialize (Deserializer &d) override

virtual Document	getDescription () const override

template<typename U , class >
TemplateOptionProperty< T > &	replaceOptions (const std::vector< T > &options)

Public Member Functions inherited from inviwo::BaseOptionProperty
	BaseOptionProperty (const std::string &identifier, const std::string &displayName, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)

	BaseOptionProperty (const BaseOptionProperty &rhs)

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 std::vector< std::string >	getPath () 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 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 ()

bool	hasWidgets () const

virtual Property &	propertyModified ()

virtual void	setValid ()

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)

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

Protected Attributes
size_t	selectedIndex_

std::vector< OptionPropertyOption< T > >	options_

Protected Attributes inherited from inviwo::Property
CallBackList	onChangeCallback_

PropertySerializationMode	serializationMode_

Protected Attributes inherited from inviwo::MetaDataOwner
MetaDataMap	metaData_

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

Member Function Documentation

◆ addOption()

template<typename T>

TemplateOptionProperty< T > & inviwo::TemplateOptionProperty< T >::addOption	(	const std::string &	identifier,
		const std::string &	displayName,
		const T &	value
	)

Adds an option to the property.

Adds a option to the property and stores it as a struct in the options_ The option name is the name of the option that will be displayed in the widget.

◆ clone()

template<typename T >

TemplateOptionProperty< T > * inviwo::TemplateOptionProperty< T >::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::DataFrameColumnProperty.

◆ operator const T &()

template<typename T >

inviwo::TemplateOptionProperty< T >::operator const T & ( ) const

Implicit conversion operator. The OptionProperty will implicitly be converted to T when possible.

◆ resetToDefaultState()

template<typename T >

TemplateOptionProperty< T > & inviwo::TemplateOptionProperty< T >::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.

◆ set()

template<typename T>

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

Reimplemented in inviwo::DataFrameColumnProperty.

◆ setCurrentStateAsDefault()

template<typename T >

TemplateOptionProperty< T > & inviwo::TemplateOptionProperty< T >::setCurrentStateAsDefault ( )

overridevirtual

Sets the default state, since the constructor can't add any default state, you must call this function after adding all the default options, usually in the processor constructor.

See also: Property::setCurrentStateAsDefault()

Reimplemented from inviwo::Property.

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

optionproperty.h

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ addOption()

◆ clone()

◆ operator const T &()

◆ resetToDefaultState()

◆ set()

◆ setCurrentStateAsDefault()