Inviwo 0.9.12-pre
Inviwo documentation
Loading...
Searching...
No Matches
inviwo::MinMaxProperty< T > Class Template Reference

#include <minmaxproperty.h>

Inheritance diagram for inviwo::MinMaxProperty< T >:

Public Types

using value_type = glm::tvec2<T, glm::defaultp>

Public Member Functions

virtual std::string_view getClassIdentifier () const override
 MinMaxProperty (std::string_view identifier, std::string_view displayName, Document help, T valueMin=Defaultvalues< T >::getMin(), T valueMax=Defaultvalues< T >::getMax(), T rangeMin=Defaultvalues< T >::getMin(), T rangeMax=Defaultvalues< T >::getMax(), T increment=Defaultvalues< T >::getInc(), T minSeparation=0, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 MinMaxProperty (std::string_view identifier, std::string_view displayName, T valueMin=Defaultvalues< T >::getMin(), T valueMax=Defaultvalues< T >::getMax(), T rangeMin=Defaultvalues< T >::getMin(), T rangeMax=Defaultvalues< T >::getMax(), T increment=Defaultvalues< T >::getInc(), T minSeparation=0, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 MinMaxProperty (const MinMaxProperty &rhs)=default
MinMaxPropertyoperator= (const value_type &value)
virtual MinMaxProperty< T > * clone () const override
const value_type & get () const
MinMaxProperty< T > & set (const value_type &value)
 operator const value_type & () const
const value_type & operator* () const
const value_type * operator-> () const
getRangeMin () const
getRangeMax () const
getIncrement () const
getMinSeparation () const
getStart () const
getEnd () const
value_type getRange () const
virtual void set (const Property *srcProperty) override
void set (const MinMaxProperty< T > *srcProperty)
MinMaxProperty< T > & setStart (const T &value)
MinMaxProperty< T > & setEnd (const T &value)
MinMaxProperty< T > & setRangeMin (const T &value)
MinMaxProperty< T > & setRangeMax (const T &value)
MinMaxProperty< T > & setIncrement (const T &value)
MinMaxProperty< T > & setMinSeparation (const T &value)
MinMaxProperty< T > & setRange (const value_type &value)
MinMaxProperty< T > & set (const value_type &value, const value_type &range, const T &increment, const T &minSep)
 set all parameters of the range property at the same time with only a single validation. This circumvents problems when updating both range and value, e.g. changing them from 0 - 100 to 1000 - 2000.
MinMaxProperty< T > & set (const T &start, const T &end, const T &rangeMin, const T &rangeMax, const T &increment, const T &minSep)
MinMaxProperty< T > & setRangeNormalized (const value_type &newRange)
const BaseCallBack * onRangeChange (std::function< void()> callback)
void removeOnRangeChange (const BaseCallBack *callback)
virtual MinMaxProperty< T > & setCurrentStateAsDefault () override
MinMaxProperty< T > & setDefault (const value_type &value)
MinMaxProperty< T > & setDefault (const value_type &value, const value_type &range, const T &increment, const T &minSep)
virtual MinMaxProperty< T > & resetToDefaultState () override
virtual bool isDefaultState () const override
virtual void serialize (Serializer &s) const override
virtual void deserialize (Deserializer &s) override
virtual Document getDescription () const override
value_type clamp (const value_type &v) const
 clamp the given value against the set min/max range
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 PropertysetIdentifier (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 PropertysetDisplayName (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 PropertysetSemantics (const PropertySemantics &semantics)
virtual PropertySemantics getSemantics () const
virtual PropertysetReadOnly (bool value)
 Enable or disable editing of property.
virtual bool getReadOnly () const
virtual PropertysetInvalidationLevel (InvalidationLevel invalidationLevel)
virtual InvalidationLevel getInvalidationLevel () const
virtual void setOwner (PropertyOwner *owner)
PropertyOwnergetOwner ()
const PropertyOwnergetOwner () 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 PropertysetSerializationMode (PropertySerializationMode mode)
virtual PropertySerializationMode getSerializationMode () const
virtual bool needsSerialization () const
virtual PropertypropertyModified ()
virtual void setValid ()
virtual PropertysetModified ()
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 PropertysetVisible (bool val)
virtual bool getVisible () const
template<typename P, typename DecisionFunc>
PropertyvisibilityDependsOn (P &prop, DecisionFunc callback)
template<typename P, typename DecisionFunc>
PropertyreadonlyDependsOn (P &prop, DecisionFunc callback)
const DocumentgetHelp () const
DocumentgetHelp ()
PropertysetHelp (Document help)
template<typename P>
PropertyautoLinkToProperty (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< PropertyObserver > & operator= (const 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 (MetaDataOwner &rhs)=default
MetaDataOwneroperator= (const MetaDataOwner &rhs)=default
MetaDataOwneroperator= (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>
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
MetaDataMapgetMetaDataMap ()
const MetaDataMapgetMetaDataMap () 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 uvec2 getDim ()
Static Public Member Functions inherited from inviwo::Property
template<typename T, typename U>
static void setStateAsDefault (T &property, const U &state)

Protected Member Functions

limitSeparation (T sep) const
Protected Member Functions inherited from inviwo::Property
 Property (const Property &rhs)
Propertyoperator= (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
virtual void addObserver (Observer *observer)=0
virtual void removeObserver (Observer *observer)=0
void addObservationHelper (Observer *observer)
void removeObservationHelper (Observer *observer)

Additional Inherited Members

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::MinMaxProperty< T >

A property representing a range.

Member Function Documentation

◆ clamp()

template<typename T>
auto inviwo::MinMaxProperty< T >::clamp ( const value_type & v) const

clamp the given value against the set min/max range

Parameters
vvalue to be clamped
Returns
returns a valid value within the min max range

◆ clone()

template<typename T>
MinMaxProperty< T > * inviwo::MinMaxProperty< 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::MinMaxProperty< T >::deserialize ( Deserializer & s)
overridevirtual

Reimplemented from inviwo::Property.

◆ getClassIdentifier()

template<typename T>
std::string_view inviwo::MinMaxProperty< T >::getClassIdentifier ( ) const
overridevirtual

Implements inviwo::Property.

◆ getDescription()

template<typename T>
Document inviwo::MinMaxProperty< 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::MinMaxProperty< T >::isDefaultState ( ) const
inlineoverridevirtual

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

Reimplemented from inviwo::Property.

◆ set()

template<typename T>
void inviwo::MinMaxProperty< 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.

◆ setCurrentStateAsDefault()

template<typename T>
MinMaxProperty< T > & inviwo::MinMaxProperty< 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:
  • minmaxproperty.h