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

Inheritance diagram for inviwo::OrdinalProperty< T >:

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

Public Member Functions
T	clamp (const T &v) const
	clamps the given value against the set min/max range
virtual OrdinalProperty< T > *	clone () const override
virtual void	deserialize (Deserializer &d) override
const 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
virtual bool	isDefaultState () const override
bool	isLinkingMaxBound () const
bool	isLinkingMinBound () const
	operator const T & () const
const T &	operator* () const
const T *	operator-> () const
OrdinalProperty< T > &	operator= (const T &value)
	OrdinalProperty (const OrdinalProperty< T > &rhs)
	OrdinalProperty (std::string_view identifier, std::string_view displayName, const T &value, const T &minValue, const T &maxValue=Defaultvalues< T >::getMax(), const T &increment=Defaultvalues< T >::getInc(), InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=OrdinalPropertyState< T >::defaultSemantics())
	OrdinalProperty (std::string_view identifier, std::string_view displayName, const T &value=Defaultvalues< T >::getVal(), 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=OrdinalPropertyState< T >::defaultSemantics())
	OrdinalProperty (std::string_view identifier, std::string_view displayName, Document help, const T &value=Defaultvalues< T >::getVal(), 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=OrdinalPropertyState< T >::defaultSemantics(), ReadOnly readOnly=ReadOnly::No)
	OrdinalProperty (std::string_view identifier, std::string_view displayName, OrdinalPropertyState< T > state)
virtual OrdinalProperty< 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 OrdinalProperty *srcProperty)
virtual void	set (const Property *src) override
void	set (const T &value)
void	set (const T &value, const T &minVal, const T &maxVal, const T &increment)
	set all parameters of the ordinal property at the same time with only a single validation. The value will be clamped according to the current ConstraintBehaviour
virtual OrdinalProperty< T > &	setCurrentStateAsDefault () override
OrdinalProperty< T > &	setDefault (const T &value)
OrdinalProperty< T > &	setDefault (const T &value, const T &minVal, const T &maxVal, const T &increment)
void	setIncrement (const T &value)
void	setMaxValue (const T &value)
void	setMinValue (const T &value)
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 const std::string &	getDisplayName () const
Document &	getHelp ()
const Document &	getHelp () const
virtual const std::string &	getIdentifier () const
virtual InvalidationLevel	getInvalidationLevel () const
PropertyOwner *	getOwner ()
const PropertyOwner *	getOwner () const
const std::string &	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< PropertyObserver > &	operator= (const Observable< PropertyObserver > &other)
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
template<typename T> requires std::derived_from<T, MetaData>
bool	hasMetaData (std::string_view key) const
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)
virtual void	addObserver (Observer *observer)=0
void	removeObservationHelper (Observer *observer)
virtual void	removeObserver (Observer *observer)=0
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::OrdinalProperty< T >

A property representing an Ordinal value, for example int, floats.

Member Function Documentation

◆ clamp()

template<typename T>

T inviwo::OrdinalProperty< 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

◆ clone()

template<typename T>

OrdinalProperty< T > * inviwo::OrdinalProperty< 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::OrdinalProperty< T >::deserialize ( Deserializer & d )

overridevirtual

Reimplemented from inviwo::Property.

◆ get() [1/3]

template<typename T>

const T & inviwo::OrdinalProperty< T >::get ( ) const

Get the value

◆ get() [2/3]

template<typename T>

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

Get component 'i,j' of the value

◆ get() [3/3]

template<typename T>

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

Get component 'index' of the value

◆ getClassIdentifier()

template<typename T>

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

overridevirtual

Implements inviwo::Property.

◆ getDescription()

template<typename T>

Document inviwo::OrdinalProperty< 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.

◆ isDefaultState()

template<typename T>

bool inviwo::OrdinalProperty< 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>

OrdinalProperty< T > & inviwo::OrdinalProperty< 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::OrdinalProperty< T >::serialize ( Serializer & s ) const

overridevirtual

Reimplemented from inviwo::Property.

◆ set() [1/4]

template<typename T>

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

Set a new value for component 'i,j'. The value will be clamped according to the current ConstraintBehaviour

◆ set() [2/4]

template<typename T>

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

Set a new value for component 'index'. The value will be clamped according to the current ConstraintBehaviour

◆ set() [3/4]

template<typename T>

void inviwo::OrdinalProperty< 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::OrdinalProperty< T >::set ( const T & value )

Set a new value. The value will be clamped according to the current ConstraintBehaviour

◆ setCurrentStateAsDefault()

template<typename T>

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

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

include/inviwo/core/properties/ordinalproperty.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clamp()

◆ clone()

◆ deserialize()

◆ get() [1/3]

◆ get() [2/3]

◆ get() [3/3]

◆ getClassIdentifier()

◆ getDescription()

◆ isDefaultState()

◆ resetToDefaultState()

◆ serialize()

◆ set() [1/4]

◆ set() [2/4]

◆ set() [3/4]

◆ set() [4/4]

◆ setCurrentStateAsDefault()