#include <ordinalrefproperty.h>

Inheritance diagram for inviwo::OrdinalRefProperty< T >:

Public Types
using	value_type = T

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

Public Member Functions
	OrdinalRefProperty (std::string_view identifier, std::string_view displayName, Document help={}, std::function< T()> get=nullptr, std::function< void(const T &)> set=nullptr, 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=OrdinalRefPropertyState< T >::defaultSemantics(), ReadOnly readOnly=ReadOnly::No)

	OrdinalRefProperty (std::string_view identifier, std::string_view displayName, std::function< T()> get, std::function< void(const T &)> set, 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=OrdinalRefPropertyState< T >::defaultSemantics(), ReadOnly readOnly=ReadOnly::No)

	OrdinalRefProperty (std::string_view identifier, std::string_view displayName, std::function< T()> get, std::function< void(const T &)> set, OrdinalRefPropertyState< T > state)

	OrdinalRefProperty (const OrdinalRefProperty< T > &rhs)

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

virtual OrdinalRefProperty< T > *	clone () const override

	operator T () const

T	operator* () const

T	get () const

component_type	get (size_t index) const

component_type	get (size_t i, size_t j) const

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

void	set (component_type val, size_t index)

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

virtual std::string_view	getClassIdentifier () const override

const T &	getMinValue () const

void	setMinValue (const T &value)

ConstraintBehavior	getMinConstraintBehaviour () const

const T &	getMaxValue () const

void	setMaxValue (const T &value)

ConstraintBehavior	getMaxConstraintBehaviour () const

const T &	getIncrement () const

void	setIncrement (const T &value)

void	set (const OrdinalRefProperty *srcProperty)

virtual void	set (const Property *src) override

virtual OrdinalRefProperty< T > &	setCurrentStateAsDefault () override

OrdinalRefProperty< T > &	setDefault (const T &minVal, const T &maxVal, const T &increment)

virtual OrdinalRefProperty< T > &	resetToDefaultState () override

virtual bool	isDefaultState () const override

virtual void	serialize (Serializer &s) const override

virtual void	deserialize (Deserializer &d) override

virtual Document	getDescription () const override

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

bool	isLinkingMinBound () const

bool	isLinkingMaxBound () const

void	setGetAndSet (std::function< T()> get, std::function< void(const T &)> set)

Public Member Functions inherited from inviwo::Property
	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 ()
	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 bool	needsSerialization () 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)

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)

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
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
	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 inherited from inviwo::Property
CallBackList	onChangeCallback_

PropertySerializationMode	serializationMode_

Protected Attributes inherited from inviwo::MetaDataOwner
MetaDataMap	metaData_

Detailed Description

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

A property representing a reference to an ordinal value, for example a int, float, or vec3. The property does not hold or own the value itself. It only contains a set and get callback function. It does handle min/max/increment for the value.

Member Function Documentation

◆ clamp()

template<typename T >

auto inviwo::OrdinalRefProperty< 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 >

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

overridevirtual

Reimplemented from inviwo::Property.

◆ get() [1/3]

template<typename T >

auto inviwo::OrdinalRefProperty< T >::get ( ) const

Get the value

◆ get() [2/3]

template<typename T >

auto inviwo::OrdinalRefProperty< T >::get	(	size_t	i,
		size_t	j ) const

Get component 'i,j' of the value

◆ get() [3/3]

template<typename T >

auto inviwo::OrdinalRefProperty< T >::get ( size_t index ) const

Get component 'index' of the value

◆ getClassIdentifier()

template<typename T >

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

overridevirtual

Implements inviwo::Property.

◆ getDescription()

template<typename T >

Document inviwo::OrdinalRefProperty< 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::OrdinalRefProperty< 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 >

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

overridevirtual

Reimplemented from inviwo::Property.

◆ set() [1/4]

template<typename T >

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

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

◆ setCurrentStateAsDefault()

template<typename T >

OrdinalRefProperty< T > & inviwo::OrdinalRefProperty< 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 files:

ordinalrefproperty.h
ordinalrefpropertyjsonconverter.h
ordinalpropertywidgetqt.h
propertysettingswidgetqt.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()