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

Inheritance diagram for inviwo::OrdinalOptProperty< T >:

Public Types
using	component_type = util::value_type<T>::type

using	value_type = std::optional<T>

Public Member Functions
T	clamp (const T &v) const
	clamps the given value against the set min/max range

void	clear ()

virtual OrdinalOptProperty< T > *	clone () const override

virtual void	deserialize (Deserializer &d) override

const std::optional< T > &	get () const

auto	get (size_t i, size_t j) const -> component_type

auto	get (size_t index) const -> component_type

virtual std::string_view	getClassIdentifier () const override

virtual Document	getDescription () const override

const T &	getIncrement () const

ConstraintBehavior	getMaxConstraintBehaviour () const

const T &	getMaxValue () const

ConstraintBehavior	getMinConstraintBehaviour () const

const T &	getMinValue () const

bool	hasValue () const

virtual bool	isDefaultState () const override

bool	isLinkingMaxBound () const

bool	isLinkingMinBound () const

	operator bool () const

OrdinalOptProperty< T > &	operator= (const OrdinalOptProperty< T > &that)=delete

OrdinalOptProperty< T > &	operator= (const std::optional< T > &value)

OrdinalOptProperty< T > &	operator= (const T &value)

OrdinalOptProperty< T > &	operator= (OrdinalOptProperty< T > &&that)=delete

	OrdinalOptProperty (const OrdinalOptProperty< T > &rhs)=default

	OrdinalOptProperty (OrdinalOptProperty< T > &&rhs)=default

	OrdinalOptProperty (std::string_view identifier, std::string_view displayName, const std::optional< T > &value=std::nullopt, const std::pair< T, ConstraintBehavior > &minValue=std::pair{Defaultvalues< T >::getMin(), ConstraintBehavior::Editable}, const std::pair< T, ConstraintBehavior > &maxValue=std::pair{Defaultvalues< T >::getMax(), ConstraintBehavior::Editable}, const T &increment=Defaultvalues< T >::getInc(), InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=OrdinalOptPropertyState< T >::defaultSemantics())

	OrdinalOptProperty (std::string_view identifier, std::string_view displayName, Document help, const std::optional< T > &value=std::nullopt, const std::pair< T, ConstraintBehavior > &minValue=std::pair{Defaultvalues< T >::getMin(), ConstraintBehavior::Editable}, const std::pair< T, ConstraintBehavior > &maxValue=std::pair{Defaultvalues< T >::getMax(), ConstraintBehavior::Editable}, const T &increment=Defaultvalues< T >::getInc(), InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=OrdinalOptPropertyState< T >::defaultSemantics(), ReadOnly readOnly=ReadOnly::No)

	OrdinalOptProperty (std::string_view identifier, std::string_view displayName, OrdinalOptPropertyState< T > state)

virtual OrdinalOptProperty< T > &	resetToDefaultState () override

virtual void	serialize (Serializer &s) const override

void	set (component_type val, size_t i, size_t j)

void	set (component_type val, size_t index)

void	set (const OrdinalOptProperty *srcProperty)

virtual void	set (const Property *src) override

void	set (const std::optional< T > &value)

void	set (const std::optional< T > &value, const T &minVal, const T &maxVal, const T &increment)
	set the value and all range parameters at the same time with only a single validation. The value will be clamped according to the current ConstraintBehaviour.

void	set (const T &value)

virtual OrdinalOptProperty< T > &	setCurrentStateAsDefault () override

OrdinalOptProperty< T > &	setDefault (const std::optional< T > &value)

void	setIncrement (const T &newInc)

void	setMaxValue (const T &newMaxValue)

void	setMinValue (const T &newMinValue)

T	value () const

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

void	deregisterWidget (PropertyWidget *propertyWidget)

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

Static Public Member Functions
static constexpr uvec2	getDim ()

static bool	isLinkingBound (ConstraintBehavior constraint)

static bool	validRange (const T &min, const T &max)

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

Additional Inherited Members
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

template<typename T>
class inviwo::OrdinalOptProperty< T >

A property representing an optional ordinal value, i.e. std::optional<T> where T is an ordinal value like int, float, or vec3. In contrast to OrdinalProperty the value can be "empty" (std::nullopt) in addition to holding a value. The min, max, and increment are always present and apply to the contained value when the property holds one.

Member Function Documentation

◆ clamp()

template<typename T >

T inviwo::OrdinalOptProperty< T >::clamp ( const T & v ) const

clamps the given value against the set min/max range

Parameters

v	value to be clamped

Returns: the clamped value

◆ clear()

template<typename T >

void inviwo::OrdinalOptProperty< T >::clear ( )

Clear the property, i.e. set it to std::nullopt

◆ clone()

template<typename T >

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

◆ deserialize()

template<typename T >

void inviwo::OrdinalOptProperty< T >::deserialize ( Deserializer & d )

overridevirtual

Reimplemented from inviwo::Property.

◆ get() [1/3]

template<typename T >

const std::optional< T > & inviwo::OrdinalOptProperty< T >::get ( ) const

Get the value, std::nullopt if the property is empty

◆ get() [2/3]

template<typename T >

auto inviwo::OrdinalOptProperty< T >::get	(	size_t	i,
		size_t	j ) const -> component_type

Get component 'i,j' of the contained value (or of the fallback when empty)

◆ get() [3/3]

template<typename T >

auto inviwo::OrdinalOptProperty< T >::get ( size_t index ) const -> component_type

Get component 'index' of the contained value (or of the fallback when empty)

◆ getClassIdentifier()

template<typename T >

std::string_view inviwo::OrdinalOptProperty< T >::getClassIdentifier ( ) const

overridevirtual

Implements inviwo::Property.

◆ getDescription()

template<typename T >

Document inviwo::OrdinalOptProperty< T >::getDescription ( ) const

overridevirtual

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.

Reimplemented from inviwo::Property.

◆ hasValue()

template<typename T >

bool inviwo::OrdinalOptProperty< T >::hasValue ( ) const

Whether the property currently holds a value

◆ isDefaultState()

template<typename T >

bool inviwo::OrdinalOptProperty< T >::isDefaultState ( ) const

overridevirtual

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

See also: setCurrentStateAsDefault; resetToDefaultState

Reimplemented from inviwo::Property.

◆ resetToDefaultState()

template<typename T >

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

◆ serialize()

template<typename T >

void inviwo::OrdinalOptProperty< T >::serialize ( Serializer & s ) const

overridevirtual

Reimplemented from inviwo::Property.

◆ set() [1/4]

template<typename T >

void inviwo::OrdinalOptProperty< T >::set	(	component_type	val,
		size_t	i,
		size_t	j )

Set a new value for component 'i,j'. This will engage the property if it was empty, using the current fallback value for the remaining components.

◆ set() [2/4]

template<typename T >

void inviwo::OrdinalOptProperty< T >::set	(	component_type	val,
		size_t	index )

Set a new value for component 'index'. This will engage the property if it was empty, using the current fallback value for the remaining components. The value will be clamped according to the current ConstraintBehaviour.

◆ set() [3/4]

template<typename T >

void inviwo::OrdinalOptProperty< 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::Property.

◆ set() [4/4]

template<typename T >

void inviwo::OrdinalOptProperty< T >::set ( const std::optional< T > & value )

Set a new value. The value will be clamped according to the current ConstraintBehaviour. Passing std::nullopt clears the property.

◆ setCurrentStateAsDefault()

template<typename T >

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

◆ value()

template<typename T >

T inviwo::OrdinalOptProperty< T >::value ( ) const

Get the contained value or, if empty, a sensible fallback (the default value if set, otherwise the type default). Useful for editing/display purposes.

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

include/inviwo/core/properties/ordinaloptproperty.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clamp()

◆ clear()

◆ clone()

◆ deserialize()

◆ get() [1/3]

◆ get() [2/3]

◆ get() [3/3]

◆ getClassIdentifier()

◆ getDescription()

◆ hasValue()

◆ isDefaultState()

◆ resetToDefaultState()

◆ serialize()

◆ set() [1/4]

◆ set() [2/4]

◆ set() [3/4]

◆ set() [4/4]

◆ setCurrentStateAsDefault()

◆ value()