Inviwo 0.9.12-pre
Inviwo documentation
Loading...
Searching...
No Matches
inviwo::TransferFunctionProperty Class Reference

#include <transferfunctionproperty.h>

Inheritance diagram for inviwo::TransferFunctionProperty:

Public Member Functions

virtual std::string_view getClassIdentifier () const override
 TransferFunctionProperty (std::string_view identifier, std::string_view displayName, Document help, const TransferFunction &value=TransferFunction({{0.0, vec4(0.0f, 0.0f, 0.0f, 0.0f)}, {1.0, vec4(1.0f, 1.0f, 1.0f, 1.0f)}}), TFData port={}, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 TransferFunctionProperty (std::string_view identifier, std::string_view displayName, const TransferFunction &value=TransferFunction({{0.0, vec4(0.0f, 0.0f, 0.0f, 0.0f)}, {1.0, vec4(1.0f, 1.0f, 1.0f, 1.0f)}}), TFData port={}, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 TransferFunctionProperty (std::string_view identifier, std::string_view displayName, TFData port, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidOutput, PropertySemantics semantics=PropertySemantics::Default)
 TransferFunctionProperty (const TransferFunctionProperty &rhs)
virtual TransferFunctionPropertyclone () const override
TransferFunctionget ()
const TransferFunctionget () const
TransferFunctionPropertyset (const TransferFunction &tf)
const TransferFunctionoperator* () const
TransferFunctionoperator* ()
const TransferFunctionoperator-> () const
TransferFunctionoperator-> ()
TransferFunctionPropertysetMask (double maskMin, double maskMax)
dvec2 getMask () const
TransferFunctionPropertyclearMask ()
TransferFunctionPropertysetZoomH (double zoomHMin, double zoomHMax)
const dvec2 & getZoomH () const
TransferFunctionPropertysetZoomV (double zoomVMin, double zoomVMax)
const dvec2 & getZoomV () const
TransferFunctionPropertysetHistogramMode (HistogramMode mode)
HistogramMode getHistogramMode () const
TransferFunctionPropertysetHistogramSelection (HistogramSelection selection)
HistogramSelection getHistogramSelection () const
const TFDatadata () const
template<typename T>
const T * getRepresentation ()
size_t getLookUpTableSize () const
void setLookUpTableSize (size_t size)
virtual TransferFunctionPropertysetCurrentStateAsDefault () override
TransferFunctionPropertysetDefault (const TransferFunction &tf)
virtual TransferFunctionPropertyresetToDefaultState () override
virtual void serialize (Serializer &s) const override
virtual void deserialize (Deserializer &d) override
virtual void set (const Property *property) override
void set (const TransferFunctionProperty *p)
void set (const IsoTFProperty *p)
virtual void onTFPrimitiveAdded (const TFPrimitiveSet &set, TFPrimitive &p) override
virtual void onTFPrimitiveRemoved (const TFPrimitiveSet &set, TFPrimitive &p) override
virtual void onTFPrimitiveChanged (const TFPrimitiveSet &set, const TFPrimitive &p) override
virtual void onTFTypeChanged (const TFPrimitiveSet &set, TFPrimitiveSetType type) override
virtual void onTFMaskChanged (const TFPrimitiveSet &set, dvec2 mask) override
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 isDefaultState () 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)
virtual Document getDescription () const
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)
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< TFPropertyObserver > & operator= (const 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 constexpr std::string_view classIdentifier {"org.inviwo.TransferFunctionProperty"}

Additional Inherited Members

Static Public Member Functions inherited from inviwo::Property
template<typename T, typename U>
static void setStateAsDefault (T &property, const U &state)
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)
Protected Member Functions inherited from inviwo::Observer
void addObservation (ObservableInterface *observable)
Protected Member Functions inherited from inviwo::TFPropertyObservable
void notifyZoomHChange (const dvec2 &zoomH)
void notifyZoomVChange (const dvec2 &zoomV)
void notifyHistogramModeChange (HistogramMode mode)
void notifyHistogramSelectionChange (HistogramSelection selection)
Protected Member Functions inherited from inviwo::Observable< TFPropertyObserver >
void forEachObserver (C callback)
Protected Attributes inherited from inviwo::Property
CallBackList onChangeCallback_
PropertySerializationMode serializationMode_
Protected Attributes inherited from inviwo::MetaDataOwner
MetaDataMap metaData_
Protected Attributes inherited from inviwo::Observer
std::unordered_set< ObservableInterface * > observables_

Detailed Description

A property holding a TransferFunction data structure

Member Function Documentation

◆ clone()

virtual TransferFunctionProperty * inviwo::TransferFunctionProperty::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()

virtual void inviwo::TransferFunctionProperty::deserialize ( Deserializer & d)
overridevirtual

Reimplemented from inviwo::Property.

◆ getClassIdentifier()

virtual std::string_view inviwo::TransferFunctionProperty::getClassIdentifier ( ) const
overridevirtual

Implements inviwo::Property.

◆ onTFMaskChanged()

virtual void inviwo::TransferFunctionProperty::onTFMaskChanged ( const TFPrimitiveSet & set,
dvec2 mask )
overridevirtual

Reimplemented from inviwo::TFPrimitiveSetObserver.

◆ onTFPrimitiveAdded()

virtual void inviwo::TransferFunctionProperty::onTFPrimitiveAdded ( const TFPrimitiveSet & set,
TFPrimitive & p )
overridevirtual

Reimplemented from inviwo::TFPrimitiveSetObserver.

◆ onTFPrimitiveChanged()

virtual void inviwo::TransferFunctionProperty::onTFPrimitiveChanged ( const TFPrimitiveSet & set,
const TFPrimitive & p )
overridevirtual

Reimplemented from inviwo::TFPrimitiveSetObserver.

◆ onTFPrimitiveRemoved()

virtual void inviwo::TransferFunctionProperty::onTFPrimitiveRemoved ( const TFPrimitiveSet & set,
TFPrimitive & p )
overridevirtual

Reimplemented from inviwo::TFPrimitiveSetObserver.

◆ onTFTypeChanged()

virtual void inviwo::TransferFunctionProperty::onTFTypeChanged ( const TFPrimitiveSet & set,
TFPrimitiveSetType type )
overridevirtual

Reimplemented from inviwo::TFPrimitiveSetObserver.

◆ resetToDefaultState()

virtual TransferFunctionProperty & inviwo::TransferFunctionProperty::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()

virtual void inviwo::TransferFunctionProperty::serialize ( Serializer & s) const
overridevirtual

Reimplemented from inviwo::Property.

◆ set()

virtual void inviwo::TransferFunctionProperty::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()

virtual TransferFunctionProperty & inviwo::TransferFunctionProperty::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.

◆ setHistogramMode()

TransferFunctionProperty & inviwo::TransferFunctionProperty::setHistogramMode ( HistogramMode mode)

Set the HistogramMode to control how to scale the histogram The options are:

  • Off Don't show any histograms
  • All Make sure all the bars are fully visible
  • P99 Make sure 99% of the bars are fully visible
  • P95 Make sure 95% of the bars are fully visible
  • P90 Make sure 90% of the bars are fully visible
  • Log Apply logarithmic scaling to each bar.

◆ setHistogramSelection()

TransferFunctionProperty & inviwo::TransferFunctionProperty::setHistogramSelection ( HistogramSelection selection)

Set the HistogramSelection. The selection determine which of the histograms from the volume in the optional volume port to show. The selection is a bitset, up to 32 histograms are supported. By default all available histograms will be shown.


The documentation for this class was generated from the following file:
  • transferfunctionproperty.h