Inviwo  0.9.10.1
Inviwo documentation
inviwo::IsoValueProperty Class Reference

property managing a collection of isovalues More...

#include <isovalueproperty.h>

+ Inheritance diagram for inviwo::IsoValueProperty:

Public Member Functions

virtual std::string getClassIdentifier () const override
 
 IsoValueProperty (const std::string &identifier, const std::string &displayName, const IsoValueCollection &value={}, VolumeInport *volumeInport=nullptr, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)
 
 IsoValueProperty (const std::string &identifier, const std::string &displayName, VolumeInport *volumeInport, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)
 
 IsoValueProperty (const IsoValueProperty &rhs)
 
virtual IsoValuePropertyclone () const override
 
void setZoomH (double zoomHMin, double zoomHMax)
 
const dvec2 & getZoomH () const
 
void setZoomV (double zoomVMin, double zoomVMax)
 
const dvec2 & getZoomV () const
 
void setHistogramMode (HistogramMode mode)
 
HistogramMode getHistogramMode ()
 
VolumeInportgetVolumeInport ()
 
virtual IsoValuePropertysetCurrentStateAsDefault () override
 
virtual IsoValuePropertyresetToDefaultState () override
 
virtual void serialize (Serializer &s) const override
 
virtual void deserialize (Deserializer &d) override
 
virtual void set (const IsoValueCollection &c) override
 
void set (const IsoTFProperty &p)
 
virtual void set (const Property *property) override
 
virtual void onTFPrimitiveAdded (TFPrimitive &p) override
 
virtual void onTFPrimitiveRemoved (TFPrimitive &p) override
 
virtual void onTFPrimitiveChanged (const TFPrimitive &p) override
 
- Public Member Functions inherited from inviwo::TemplateProperty< IsoValueCollection >
 TemplateProperty (const std::string &identifier, const std::string &displayName, const IsoValueCollection &value=IsoValueCollection(), InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 
TemplateProperty< IsoValueCollection > & operator= (const IsoValueCollection &value)
 
virtual operator IsoValueCollection & ()
 
virtual operator const IsoValueCollection & () const
 
virtual IsoValueCollectionget ()
 
virtual const IsoValueCollectionget () const
 
const IsoValueCollectionoperator * () const
 
IsoValueCollectionoperator * ()
 
const IsoValueCollectionoperator-> () const
 
IsoValueCollectionoperator-> ()
 
void set (const TemplateProperty< IsoValueCollection > *srcProperty)
 
- 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 PropertysetIdentifier (const std::string &identifier)
 
virtual std::string getIdentifier () const
 
virtual std::vector< std::string > getPath () const
 
virtual PropertysetDisplayName (const std::string &displayName)
 A property's name displayed to the user.
 
virtual std::string getDisplayName () const
 
virtual std::string 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 ()
 
bool hasWidgets () 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)
 
template<typename T >
const BaseCallBack * onChange (T *object, void(T::*method)())
 
template<typename T >
void removeOnChange (T *object)
 
virtual PropertysetUsageMode (UsageMode usageMode)
 
virtual UsageMode getUsageMode () const
 
virtual void setSerializationMode (PropertySerializationMode mode)
 
virtual PropertySerializationMode getSerializationMode () const
 
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)
 
virtual Document getDescription () const
 
template<typename P >
PropertyautoLinkToProperty (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
 
MetaDataOwneroperator= (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 >
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
 
MetaDataMapgetMetaDataMap ()
 
const MetaDataMapgetMetaDataMap () const
 
template<typename T >
bool hasMetaData (const std::string &key) const
 
- Public Member Functions inherited from inviwo::TFPrimitiveSetObserver
virtual void onTFTypeChanged (const TFPrimitiveSet &primitiveSet)
 
- Public Member Functions inherited from inviwo::Observer
 Observer (const Observer &other)
 
 Observer (Observer &&other)
 
Observeroperator= (Observer &&other)
 
Observeroperator= (const Observer &other)
 
virtual ~Observer ()
 
void removeObservation (ObservableInterface *observable)
 
void removeObservations ()
 
- Public Member Functions inherited from inviwo::Observable< TFPropertyObserver >
 Observable (const Observable< TFPropertyObserver > &other)
 
 Observable (Observable< TFPropertyObserver > &&other)
 
Observable< TFPropertyObserver > & operator= (const Observable< TFPropertyObserver > &other)
 
Observable< TFPropertyObserver > & operator= (Observable< TFPropertyObserver > &&other)
 
void addObserver (TFPropertyObserver *observer)
 
void removeObserver (TFPropertyObserver *observer)
 
virtual void startBlockingNotifications () override final
 
virtual void stopBlockingNotifications () override final
 

Static Public Attributes

static const std::string classIdentifier = "org.inviwo.IsoValueProperty"
 

Additional Inherited Members

- Public Types inherited from inviwo::TemplateProperty< IsoValueCollection >
using value_type = IsoValueCollection
 
- Static Public Member Functions inherited from inviwo::Property
template<typename T , typename U >
static void setStateAsDefault (T &property, const U &state)
 
- Protected Types inherited from inviwo::Observer
using ObservableSet = std::unordered_set< ObservableInterface * >
 
- Protected Member Functions inherited from inviwo::TemplateProperty< IsoValueCollection >
 TemplateProperty (const TemplateProperty &rhs)=default
 
- Protected Member Functions inherited from inviwo::Property
 Property (const Property &rhs)
 
Propertyoperator= (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)
 
- Protected Member Functions inherited from inviwo::Observer
void addObservation (ObservableInterface *observable)
 
- Protected Member Functions inherited from inviwo::TFPropertyObservable
virtual void notifyMaskChange (const dvec2 &mask)
 
virtual void notifyZoomHChange (const dvec2 &zoomH)
 
virtual void notifyZoomVChange (const dvec2 &zoomV)
 
virtual void notifyHistogramModeChange (HistogramMode mode)
 
- Protected Member Functions inherited from inviwo::Observable< TFPropertyObserver >
void forEachObserver (C callback)
 
- Protected Attributes inherited from inviwo::TemplateProperty< IsoValueCollection >
ValueWrapper< IsoValueCollectionvalue_
 
- Protected Attributes inherited from inviwo::Property
CallBackList onChangeCallback_
 
PropertySerializationMode serializationMode_
 
- Protected Attributes inherited from inviwo::MetaDataOwner
MetaDataMap metaData_
 
- Protected Attributes inherited from inviwo::Observer
ObservableSet observables_
 

Detailed Description

property managing a collection of isovalues

Member Function Documentation

◆ clone()

IsoValueProperty * inviwo::IsoValueProperty::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::TemplateProperty< IsoValueCollection >.

◆ resetToDefaultState()

IsoValueProperty & inviwo::IsoValueProperty::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::TemplateProperty< IsoValueCollection >.

◆ set()

void inviwo::IsoValueProperty::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::TemplateProperty< IsoValueCollection >.

◆ setCurrentStateAsDefault()

IsoValueProperty & inviwo::IsoValueProperty::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::TemplateProperty< IsoValueCollection >.


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