property managing a collection of isovalues The InvalidationLevel is set to InvalidationLevel::InvalidResources when isovalues are added or removed. Otherwise InvalidationLevel::InvalidOutput is used. More...

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

Inheritance diagram for inviwo::IsoValueProperty:

Public Member Functions
virtual IsoValueProperty *	clone () const override
const TFData &	data () const
virtual void	deserialize (Deserializer &d) override
IsoValueCollection &	get ()
const IsoValueCollection &	get () const
virtual std::string_view	getClassIdentifier () const override
HistogramMode	getHistogramMode () const
HistogramSelection	getHistogramSelection () const
const dvec2 &	getZoomH () const
const dvec2 &	getZoomV () const
	IsoValueProperty (const IsoValueProperty &rhs)
	IsoValueProperty (IsoValueProperty &&rhs)
	IsoValueProperty (std::string_view identifier, std::string_view displayName, const IsoValueCollection &value={}, TFData port={}, PropertySemantics semantics=PropertySemantics::Default)
	IsoValueProperty (std::string_view identifier, std::string_view displayName, Document help, const IsoValueCollection &value={}, TFData port={}, PropertySemantics semantics=PropertySemantics::Default)
	IsoValueProperty (std::string_view identifier, std::string_view displayName, TFData port, PropertySemantics semantics=PropertySemantics::Default)
virtual void	onTFPrimitiveAdded (const TFPrimitiveSet &set, TFPrimitive &p) override
virtual void	onTFPrimitiveChanged (const TFPrimitiveSet &set, const TFPrimitive &p) override
virtual void	onTFPrimitiveRemoved (const TFPrimitiveSet &set, TFPrimitive &p) override
IsoValueCollection &	operator* ()
const IsoValueCollection &	operator* () const
IsoValueCollection *	operator-> ()
const IsoValueCollection *	operator-> () const
IsoValueProperty &	operator= (const IsoValueProperty &rhs)=delete
IsoValueProperty &	operator= (IsoValueProperty &&rhs)
virtual IsoValueProperty &	resetToDefaultState () override
virtual void	serialize (Serializer &s) const override
void	set (const IsoTFProperty *p)
IsoValueProperty &	set (const IsoValueCollection &iso)
void	set (const IsoValueProperty *p)
virtual void	set (const Property *property) override
virtual IsoValueProperty &	setCurrentStateAsDefault () override
IsoValueProperty &	setDefault (const IsoValueCollection &iso)
IsoValueProperty &	setHistogramMode (HistogramMode mode)
IsoValueProperty &	setHistogramSelection (HistogramSelection selection)
void	setZoomH (double zoomHMin, double zoomHMax)
void	setZoomV (double zoomVMin, double zoomVMax)
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 Document	getDescription () const
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	isDefaultState () 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
Public Member Functions inherited from inviwo::TFPrimitiveSetObserver
virtual void	onTFMaskChanged (const TFPrimitiveSet &set, dvec2 mask)
virtual void	onTFTypeChanged (const TFPrimitiveSet &set, TFPrimitiveSetType type)
Public Member Functions inherited from inviwo::Observer
	Observer (const Observer &other)
	Observer (Observer &&other)
Observer &	operator= (const Observer &other)
Observer &	operator= (Observer &&other)
void	removeObservation (ObservableInterface *observable)
void	removeObservations ()
virtual	~Observer ()
Public Member Functions inherited from inviwo::Observable< TFPropertyObserver >
void	addObserver (TFPropertyObserver *observer)
bool	isObservedBy (TFPropertyObserver *observer) const
Observable< TFPropertyObserver > &	operator= (const Observable< TFPropertyObserver > &other)
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.IsoValueProperty"}

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
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 Member Functions inherited from inviwo::Observer
void	addObservation (ObservableInterface *observable)
Protected Member Functions inherited from inviwo::TFPropertyObservable
void	notifyHistogramModeChange (HistogramMode mode)
void	notifyHistogramSelectionChange (HistogramSelection selection)
void	notifyZoomHChange (const dvec2 &zoomH)
void	notifyZoomVChange (const dvec2 &zoomV)
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

property managing a collection of isovalues The InvalidationLevel is set to InvalidationLevel::InvalidResources when isovalues are added or removed. Otherwise InvalidationLevel::InvalidOutput is used.

Member Function Documentation

◆ clone()

virtual 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::Property.

◆ deserialize()

virtual void inviwo::IsoValueProperty::deserialize ( Deserializer & d )

overridevirtual

Reimplemented from inviwo::Property.

◆ getClassIdentifier()

virtual std::string_view inviwo::IsoValueProperty::getClassIdentifier ( ) const

overridevirtual

Implements inviwo::Property.

◆ onTFPrimitiveAdded()

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

overridevirtual

Reimplemented from inviwo::TFPrimitiveSetObserver.

◆ onTFPrimitiveChanged()

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

overridevirtual

Reimplemented from inviwo::TFPrimitiveSetObserver.

◆ onTFPrimitiveRemoved()

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

overridevirtual

Reimplemented from inviwo::TFPrimitiveSetObserver.

◆ resetToDefaultState()

virtual 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::Property.

◆ serialize()

virtual void inviwo::IsoValueProperty::serialize ( Serializer & s ) const

overridevirtual

Reimplemented from inviwo::Property.

◆ set()

virtual 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::Property.

◆ setCurrentStateAsDefault()

virtual 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::Property.

◆ setHistogramMode()

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

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

include/inviwo/core/properties/isovalueproperty.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clone()

◆ deserialize()

◆ getClassIdentifier()

◆ onTFPrimitiveAdded()

◆ onTFPrimitiveChanged()

◆ onTFPrimitiveRemoved()

◆ resetToDefaultState()

◆ serialize()

◆ set()

◆ setCurrentStateAsDefault()

◆ setHistogramMode()

◆ setHistogramSelection()