composite property combining transfer function and isovalue properties More...

#include <isotfproperty.h>

Inheritance diagram for inviwo::IsoTFProperty:

Public Member Functions
virtual std::string_view	getClassIdentifier () const override

	IsoTFProperty (std::string_view identifier, std::string_view displayName, Document help, const IsoValueCollection &isovalues={}, const TransferFunction &tf=TransferFunction({{0.0f, vec4(0.0f)}, {1.0f, vec4(1.0f)}}), TFData port={}, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)

	IsoTFProperty (std::string_view identifier, std::string_view displayName, const IsoValueCollection &isovalues={}, const TransferFunction &tf=TransferFunction({{0.0f, vec4(0.0f)}, {1.0f, vec4(1.0f)}}), TFData port={}, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)

	IsoTFProperty (std::string_view identifier, std::string_view displayName, Document help, TFData port, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)

	IsoTFProperty (std::string_view identifier, std::string_view displayName, TFData port, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)

	IsoTFProperty (const IsoTFProperty &rhs)

virtual IsoTFProperty *	clone () const override

virtual std::string_view	getClassIdentifierForWidget () const override
	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 void	set (const Property *property) override

void	set (const IsoValueProperty *p)
	sets only the isovalue property to `p`. The transfer function property remains unchanged.

void	set (const TransferFunctionProperty *p)
	sets only the transfer function property to `p`. The isovalue property remains unchanged.

void	setMask (double maskMin, double maskMax)

dvec2	getMask () const

void	clearMask ()

void	setZoomH (double zoomHMin, double zoomHMax)

const dvec2 &	getZoomH () const

void	setZoomV (double zoomVMin, double zoomVMax)

const dvec2 &	getZoomV () const

IsoTFProperty &	setHistogramMode (HistogramMode type)

HistogramMode	getHistogramMode () const

IsoTFProperty &	setHistogramSelection (HistogramSelection selection)

HistogramSelection	getHistogramSelection () const

const TFData &	data () const

Public Member Functions inherited from inviwo::CompositeProperty
	CompositeProperty (std::string_view identifier, std::string_view displayName, Document help, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)

	CompositeProperty (std::string_view identifier, std::string_view displayName, InvalidationLevel invalidationLevel=InvalidationLevel::InvalidResources, PropertySemantics semantics=PropertySemantics::Default)

	CompositeProperty (const CompositeProperty &rhs)=default

virtual const std::string &	getIdentifier () const override

virtual bool	isCollapsed () const

virtual CompositeProperty &	setCollapsed (bool value)

CompositeProperty &	setCollapsed (CollapseAction action, CollapseTarget target)

virtual void	setOwner (PropertyOwner *owner) override

void	set (const CompositeProperty *src)

virtual void	setValid () override

virtual InvalidationLevel	getInvalidationLevel () const override

virtual CompositeProperty &	setCurrentStateAsDefault () override

virtual CompositeProperty &	resetToDefaultState () override

virtual bool	isDefaultState () const override

virtual bool	needsSerialization () const override

virtual CompositeProperty &	setReadOnly (bool value) override
	Enable or disable editing of property.

virtual void	invalidate (InvalidationLevel invalidationLevel, Property *modifiedProperty=0) override

virtual Processor *	getProcessor () override

virtual const Processor *	getProcessor () const override

virtual const PropertyOwner *	getOwner () const override

virtual PropertyOwner *	getOwner () override

virtual InviwoApplication *	getInviwoApplication () override

virtual void	accept (NetworkVisitor &visitor) override
	Accept a NetworkVisitor, the visitor will visit this and then each Property of the CompositeProperty in an undefined order. The Visitor will then visit each Properties's properties and so on.

virtual void	serialize (Serializer &s) const override

virtual void	deserialize (Deserializer &d) 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 Property &	setIdentifier (std::string_view identifier)

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 Property &	setSemantics (const PropertySemantics &semantics)

virtual PropertySemantics	getSemantics () const

virtual bool	getReadOnly () const

virtual Property &	setInvalidationLevel (InvalidationLevel invalidationLevel)

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 Property &	propertyModified ()

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)

virtual Document	getDescription () const

template<typename P >
Property &	autoLinkToProperty (std::string_view 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) 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)

Public Member Functions inherited from inviwo::PropertyOwner
virtual	~PropertyOwner ()
	Removes all properties and notifies its observers of the removal.

virtual void	addProperty (Property *property, bool owner=true)

virtual void	addProperty (Property &property)

virtual Property *	addProperty (std::unique_ptr< Property > property)

template<typename... Ts>
void	addProperties (Ts &... properties)

virtual void	insertProperty (size_t index, Property *property, bool owner=true)
	insert property `property` at position `index` If `index` is not valid, the property is appended.

virtual void	insertProperty (size_t index, Property &property)
	insert property `property` at position `index` If `index` is not valid, the property is appended.

virtual Property *	insertProperty (size_t index, std::unique_ptr< Property > property)
	insert property `property` at position `index` If `index` is not valid, the property is appended.

virtual Property *	removeProperty (std::string_view identifier)

virtual Property *	removeProperty (Property *property)

virtual Property *	removeProperty (Property &property)

virtual Property *	removeProperty (size_t index)
	remove property referred to by `index`

virtual bool	move (Property *property, size_t newIndex)

virtual void	clear ()
	Remove all properties; Owned properties will be deleted.

const std::vector< Property * > &	getProperties () const

const std::vector< CompositeProperty * > &	getCompositeProperties () const

std::vector< Property * >	getPropertiesRecursive () const

std::vector< Property * > &	getPropertiesRecursive (std::vector< Property * > &destination) const

Property *	getPropertyByIdentifier (std::string_view identifier, bool recursiveSearch=false) const

Property *	getPropertyByPath (std::string_view path) const

template<class T >
std::vector< T * >	getPropertiesByType (bool recursiveSearch=false) const

bool	empty () const

size_t	size () const

Property *	operator[] (size_t)

const Property *	operator[] (size_t) const

const_iterator	find (Property *property) const

iterator	begin ()

iterator	end ()

const_iterator	begin () const

const_iterator	end () const

const_iterator	cbegin () const

const_iterator	cend () const

virtual bool	isValid () const

InvalidationLevel	getInvalidationLevel () const

virtual void	setAllPropertiesCurrentStateAsDefault ()

virtual void	resetAllProperties ()

virtual void	invokeEvent (Event *event) override

Public Member Functions inherited from inviwo::PropertyOwnerObservable
void	notifyObserversWillAddProperty (PropertyOwner owner, Property property, size_t index)

void	notifyObserversDidAddProperty (Property *property, size_t index)

void	notifyObserversWillRemoveProperty (Property *property, size_t index)

void	notifyObserversDidRemoveProperty (PropertyOwner owner, Property property, size_t index)

Public Member Functions inherited from inviwo::Observable< PropertyOwnerObserver >
	Observable (const Observable< PropertyOwnerObserver > &other)

	Observable (Observable< PropertyOwnerObserver > &&other) noexcept

Observable< PropertyOwnerObserver > &	operator= (const Observable< PropertyOwnerObserver > &other)

Observable< PropertyOwnerObserver > &	operator= (Observable< PropertyOwnerObserver > &&other) noexcept

void	addObserver (PropertyOwnerObserver *observer)

void	removeObserver (PropertyOwnerObserver *observer)

virtual void	startBlockingNotifications () override final

virtual void	stopBlockingNotifications () override final

Public Member Functions inherited from inviwo::EventListener
Public Member Functions inherited from inviwo::Observable< CompositePropertyObserver >
	Observable (const Observable< CompositePropertyObserver > &other)

	Observable (Observable< CompositePropertyObserver > &&other) noexcept

Observable< CompositePropertyObserver > &	operator= (const Observable< CompositePropertyObserver > &other)

Observable< CompositePropertyObserver > &	operator= (Observable< CompositePropertyObserver > &&other) noexcept

void	addObserver (CompositePropertyObserver *observer)

void	removeObserver (CompositePropertyObserver *observer)

virtual void	startBlockingNotifications () override final

virtual void	stopBlockingNotifications () override final

Public Member Functions inherited from inviwo::PropertyObserver
virtual void	onSetIdentifier (Property *property, const std::string &identifier)

virtual void	onSetDisplayName (Property *property, const std::string &displayName)

virtual void	onSetSemantics (Property *property, const PropertySemantics &semantics)

virtual void	onSetReadOnly (Property *property, bool readonly)

virtual void	onSetVisible (Property *property, bool visible)

Public Member Functions inherited from inviwo::Observer
	Observer (const Observer &other)

	Observer (Observer &&other)

Observer &	operator= (Observer &&other)

Observer &	operator= (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) noexcept

Observable< TFPropertyObserver > &	operator= (const Observable< TFPropertyObserver > &other)

Observable< TFPropertyObserver > &	operator= (Observable< TFPropertyObserver > &&other) noexcept

void	addObserver (TFPropertyObserver *observer)

void	removeObserver (TFPropertyObserver *observer)

virtual void	startBlockingNotifications () override final

virtual void	stopBlockingNotifications () override final

Public Member Functions inherited from inviwo::TFPropertyObserver

Public Attributes
IsoValueProperty	isovalues_

TransferFunctionProperty	tf_

Static Public Attributes
static constexpr std::string_view	classIdentifier {"org.inviwo.IsoTFProperty"}

Static Public Attributes inherited from inviwo::CompositeProperty
static constexpr std::string_view	classIdentifier {"org.inviwo.CompositeProperty"}

Protected Member Functions
virtual void	onZoomHChange (const dvec2 &zoomH) override

virtual void	onZoomVChange (const dvec2 &zoomV) override

virtual void	onHistogramModeChange (HistogramMode mode) override

virtual void	onHistogramSelectionChange (HistogramSelection selection) override

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 Member Functions inherited from inviwo::PropertyOwner
	PropertyOwner (const PropertyOwner &rhs)

PropertyOwner &	operator= (const PropertyOwner &that)=delete

void	forEachProperty (std::function< void(Property &)> callback, bool recursiveSearch=false) const

Protected Member Functions inherited from inviwo::Observable< PropertyOwnerObserver >
void	forEachObserver (C callback)

Protected Member Functions inherited from inviwo::CompositePropertyObservable
void	notifyObserversOnSetCollapsed (bool collapsed)

Protected Member Functions inherited from inviwo::Observable< CompositePropertyObserver >
void	forEachObserver (C callback)

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)

Additional Inherited Members
Public Types inherited from inviwo::CompositeProperty
enum class	CollapseAction { Collapse , Expand }

enum class	CollapseTarget { Current , Recursive , Children , Siblings }

Public Types inherited from inviwo::PropertyOwner
using	iterator = std::vector<Property*>::iterator

using	const_iterator = std::vector<Property*>::const_iterator

Static Public Member Functions inherited from inviwo::Property
template<typename T , typename U >
static void	setStateAsDefault (T &property, const U &state)

Protected Attributes inherited from inviwo::Property
CallBackList	onChangeCallback_

PropertySerializationMode	serializationMode_

Protected Attributes inherited from inviwo::MetaDataOwner
MetaDataMap	metaData_

Protected Attributes inherited from inviwo::PropertyOwner
std::vector< Property * >	properties_

std::vector< EventProperty * >	eventProperties_

std::vector< CompositeProperty * >	compositeProperties_

std::vector< std::unique_ptr< Property > >	ownedProperties_

Protected Attributes inherited from inviwo::Observer
std::unordered_set< ObservableInterface * >	observables_

Detailed Description

composite property combining transfer function and isovalue properties

Member Function Documentation

◆ clone()

virtual IsoTFProperty * inviwo::IsoTFProperty::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.

Reimplemented from inviwo::CompositeProperty.

◆ getClassIdentifier()

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

overridevirtual

Reimplemented from inviwo::CompositeProperty.

◆ getClassIdentifierForWidget()

virtual std::string_view inviwo::IsoTFProperty::getClassIdentifierForWidget ( ) const

overridevirtual

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.

Reimplemented from inviwo::CompositeProperty.

◆ onHistogramModeChange()

virtual void inviwo::IsoTFProperty::onHistogramModeChange ( HistogramMode mode )

overrideprotectedvirtual

Reimplemented from inviwo::TFPropertyObserver.

◆ onHistogramSelectionChange()

virtual void inviwo::IsoTFProperty::onHistogramSelectionChange ( HistogramSelection selection )

overrideprotectedvirtual

Reimplemented from inviwo::TFPropertyObserver.

◆ onZoomHChange()

virtual void inviwo::IsoTFProperty::onZoomHChange ( const dvec2 & zoomH )

overrideprotectedvirtual

Reimplemented from inviwo::TFPropertyObserver.

◆ onZoomVChange()

virtual void inviwo::IsoTFProperty::onZoomVChange ( const dvec2 & zoomV )

overrideprotectedvirtual

Reimplemented from inviwo::TFPropertyObserver.

◆ set()

virtual void inviwo::IsoTFProperty::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::CompositeProperty.

◆ setHistogramMode()

IsoTFProperty & inviwo::IsoTFProperty::setHistogramMode ( HistogramMode type )

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()

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

isotfproperty.h

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clone()

◆ getClassIdentifier()

◆ getClassIdentifierForWidget()

◆ onHistogramModeChange()

◆ onHistogramSelectionChange()

◆ onZoomHChange()

◆ onZoomVChange()

◆ set()

◆ setHistogramMode()

◆ setHistogramSelection()