Encapsulates the VTK scalar mode enumeration as an EnumerationProperty. More...

#include <mitkVtkScalarModeProperty.h>

Inheritance diagram for mitk::VtkScalarModeProperty:

[legend]

Collaboration diagram for mitk::VtkScalarModeProperty:

[legend]

Public Member Functions
	mitkClassMacro (VtkScalarModeProperty, EnumerationProperty)

Pointer	Clone () const

	mitkNewMacro1Param (VtkScalarModeProperty, const IdType &)

	mitkNewMacro1Param (VtkScalarModeProperty, const std::string &)

virtual int	GetVtkScalarMode ()
	Return the current scalar mode value as defined by VTK constants. More...

virtual void	SetScalarModeToDefault ()
	Set the scalar mode to VTK_SCALAR_MODE_DEFAULT. More...

virtual void	SetScalarModeToPointData ()
	Set the scalar mode to VTK_SCALAR_MODE_USE_POINT_DATA. More...

virtual void	SetScalarModeToCellData ()
	Set the scalar mode to VTK_SCALAR_MODE_USE_CELL_DATA. More...

virtual void	SetScalarModeToPointFieldData ()
	Set the scalar mode to VTK_SCALAR_MODE_USE_POINT_FIELD_DATA. More...

virtual void	SetScalarModeToCellFieldData ()
	Set the scalar mode to VTK_SCALAR_MODE_USE_CELL_FIELD_DATA. More...

BaseProperty &	operator= (const BaseProperty &property)
	Assign a property value to this instance. More...

Public Member Functions inherited from mitk::EnumerationProperty
	mitkClassMacro (EnumerationProperty, BaseProperty)

Pointer	Clone () const

virtual bool	SetValue (const std::string &name)
	Set the current value of the enumeration by name. More...

virtual bool	SetValue (const IdType &id)
	Set the current value of the enumeration by id. More...

virtual IdType	GetValueAsId () const
	Get the id of the currently selected enumeration value. More...

std::string	GetValueAsString () const override
	Get the name of the currently selected enumeration value. More...

virtual void	Clear ()
	Remove all enumeration values and reset the current selection. More...

virtual EnumIdsContainerType::size_type	Size () const
	Get the number of defined enumeration values. More...

virtual EnumConstIterator	Begin () const
	Get an iterator to the first enumeration value. More...

virtual EnumConstIterator	End () const
	Get an iterator past the last enumeration value. More...

virtual std::string	GetEnumString (const IdType &id) const
	Get the name string for a given enumeration id. More...

virtual IdType	GetEnumId (const std::string &name) const
	Get the id for a given enumeration name. More...

virtual bool	IsValidEnumerationValue (const IdType &id) const
	Check whether a given id corresponds to a valid enumeration value. More...

virtual bool	IsValidEnumerationValue (const std::string &name) const
	Check whether a given name corresponds to a valid enumeration value. More...

const EnumIdsContainerType &	GetEnumIds () const
	Get a const reference to the id-to-name map. More...

const EnumStringsContainerType &	GetEnumStrings () const
	Get a const reference to the name-to-id map. More...

EnumIdsContainerType &	GetEnumIds ()
	Get a mutable reference to the id-to-name map. More...

EnumStringsContainerType &	GetEnumStrings ()
	Get a mutable reference to the name-to-id map. More...

bool	ToJSON (nlohmann::json &j) const override
	Serialize the current enumeration value to JSON. More...

bool	FromJSON (const nlohmann::json &j) override
	Deserialize the enumeration value from JSON. More...

EnumerationProperty &	operator= (const EnumerationProperty &)=delete

BaseProperty &	operator= (const BaseProperty &property)
	Assign a property value to this instance. More...

Public Member Functions inherited from mitk::BaseProperty
	mitkClassMacroItkParent (BaseProperty, itk::Object)

Pointer	Clone () const

bool	operator== (const BaseProperty &property) const
	Compare two properties for equality. More...

BaseProperty &	operator= (const BaseProperty &property)
	Assign a property value to this instance. More...

bool	AssignProperty (const BaseProperty &property)
	Assign a property value to this instance and report success. More...

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from mitk::EnumerationProperty
static Pointer	New ()

Protected Member Functions
	VtkScalarModeProperty ()
	Default constructor. Sets the scalar mode to VTK_SCALAR_MODE_DEFAULT. More...

	VtkScalarModeProperty (const IdType &value)
	Construct with an integer scalar mode value. More...

	VtkScalarModeProperty (const std::string &value)
	Construct with a string scalar mode value. More...

	VtkScalarModeProperty (const VtkScalarModeProperty &other)
	Copy constructor. More...

bool	AddEnum (const std::string &name, const IdType &id) override
	Add an enumeration value. More...

virtual void	AddInterpolationTypes ()
	Populate the enumeration with the VTK-defined scalar mode types. More...

	mitkCloneMacro (VtkScalarModeProperty)

Protected Member Functions inherited from mitk::EnumerationProperty
	EnumerationProperty ()

	EnumerationProperty (const EnumerationProperty &)

bool	IsEqual (const BaseProperty &property) const override

bool	Assign (const BaseProperty &property) override

	mitkCloneMacro (Self)

Protected Member Functions inherited from mitk::BaseProperty
	BaseProperty ()

	BaseProperty (const BaseProperty &other)

	~BaseProperty () override

Additional Inherited Members
Public Types inherited from mitk::EnumerationProperty
typedef unsigned int	IdType
	Unsigned integer type used as unique enumeration value identifier. More...

typedef std::map< IdType, std::string >	EnumIdsContainerType
	Map type storing id-to-name mappings. More...

typedef std::map< std::string, IdType >	EnumStringsContainerType
	Map type storing name-to-id mappings. More...

typedef EnumIdsContainerType::const_iterator	EnumConstIterator
	Const iterator type for iterating over enumeration values. More...

Static Public Attributes inherited from mitk::BaseProperty
static const std::string	VALUE_CANNOT_BE_CONVERTED_TO_STRING
	Default return value for properties that cannot be converted to a string. More...

Detailed Description

Encapsulates the VTK scalar mode enumeration as an EnumerationProperty.

Valid values are (VTK constant / Id / string representation):

VTK_SCALAR_MODE_DEFAULT / 0 / Default
VTK_SCALAR_MODE_USE_POINT_DATA / 1 / PointData
VTK_SCALAR_MODE_USE_CELL_DATA / 2 / CellData
VTK_SCALAR_MODE_USE_POINT_FIELD_DATA / 3 / PointFieldData
VTK_SCALAR_MODE_USE_CELL_FIELD_DATA / 4 / CellFieldData

Definition at line 30 of file mitkVtkScalarModeProperty.h.

Constructor & Destructor Documentation

◆ VtkScalarModeProperty() [1/4]

mitk::VtkScalarModeProperty::VtkScalarModeProperty ( )

protected

Default constructor. Sets the scalar mode to VTK_SCALAR_MODE_DEFAULT.

◆ VtkScalarModeProperty() [2/4]

mitk::VtkScalarModeProperty::VtkScalarModeProperty ( const IdType & value )

protected

Construct with an integer scalar mode value.

If the value is not a valid enumeration id, the scalar mode is set to VTK_SCALAR_MODE_DEFAULT (0).

Parameters

[in] value The integer representation of the scalar mode.

◆ VtkScalarModeProperty() [3/4]

mitk::VtkScalarModeProperty::VtkScalarModeProperty ( const std::string & value )

protected

Construct with a string scalar mode value.

If the value is not a valid enumeration string, the scalar mode is set to VTK_SCALAR_MODE_DEFAULT (0).

Parameters

[in] value The string representation of the scalar mode.

◆ VtkScalarModeProperty() [4/4]

mitk::VtkScalarModeProperty::VtkScalarModeProperty ( const VtkScalarModeProperty & other )

protected

Copy constructor.

Member Function Documentation

◆ AddEnum()

bool mitk::VtkScalarModeProperty::AddEnum	(	const std::string &	name,
		const IdType &	id
	)

overrideprotectedvirtual

Add an enumeration value.

Overridden as protected so that external code cannot add additional invalid scalar mode types.

Parameters

[in]	name	The string name of the enumeration entry.
[in]	id	The integer id of the enumeration entry.

Returns: True if the entry was added successfully.

Reimplemented from mitk::EnumerationProperty.

◆ AddInterpolationTypes()

virtual void mitk::VtkScalarModeProperty::AddInterpolationTypes ( )

protectedvirtual

Populate the enumeration with the VTK-defined scalar mode types.

◆ Clone()

Pointer mitk::VtkScalarModeProperty::Clone ( ) const

◆ GetVtkScalarMode()

virtual int mitk::VtkScalarModeProperty::GetVtkScalarMode ( )

virtual

Return the current scalar mode value as defined by VTK constants.

Returns: The current scalar mode as a VTK constant (e.g. VTK_SCALAR_MODE_DEFAULT).

◆ mitkClassMacro()

mitk::VtkScalarModeProperty::mitkClassMacro	(	VtkScalarModeProperty	,
		EnumerationProperty
	)

◆ mitkCloneMacro()

mitk::VtkScalarModeProperty::mitkCloneMacro ( VtkScalarModeProperty )

protected

◆ mitkNewMacro1Param() [1/2]

mitk::VtkScalarModeProperty::mitkNewMacro1Param	(	VtkScalarModeProperty	,
		const IdType &
	)

◆ mitkNewMacro1Param() [2/2]

mitk::VtkScalarModeProperty::mitkNewMacro1Param	(	VtkScalarModeProperty	,
		const std::string &
	)

◆ New()

static Pointer mitk::VtkScalarModeProperty::New ( )

static

◆ operator=()

BaseProperty& mitk::BaseProperty::operator=

Assign a property value to this instance.

Performs a polymorphic assignment from the given property. The assignment succeeds only if the source and target properties are of the same type. The subclass-specific Assign() method is called to perform the actual value copy.

Subclasses must implement Assign(const BaseProperty&) and call the superclass Assign method for proper handling. The copy assignment operator of the subclass should be disabled and the base class operator should be made visible using "using" statements.

Parameters

[in] property The property whose value should be assigned to this instance.

Returns: A reference to this property.

See also: AssignProperty; Assign

◆ SetScalarModeToCellData()

virtual void mitk::VtkScalarModeProperty::SetScalarModeToCellData ( )

virtual

Set the scalar mode to VTK_SCALAR_MODE_USE_CELL_DATA.

◆ SetScalarModeToCellFieldData()

virtual void mitk::VtkScalarModeProperty::SetScalarModeToCellFieldData ( )

virtual

Set the scalar mode to VTK_SCALAR_MODE_USE_CELL_FIELD_DATA.

◆ SetScalarModeToDefault()

virtual void mitk::VtkScalarModeProperty::SetScalarModeToDefault ( )

virtual

Set the scalar mode to VTK_SCALAR_MODE_DEFAULT.

◆ SetScalarModeToPointData()

virtual void mitk::VtkScalarModeProperty::SetScalarModeToPointData ( )

virtual

Set the scalar mode to VTK_SCALAR_MODE_USE_POINT_DATA.

◆ SetScalarModeToPointFieldData()

virtual void mitk::VtkScalarModeProperty::SetScalarModeToPointFieldData ( )

virtual

Set the scalar mode to VTK_SCALAR_MODE_USE_POINT_FIELD_DATA.

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

mitkVtkScalarModeProperty.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VtkScalarModeProperty() [1/4]

◆ VtkScalarModeProperty() [2/4]

◆ VtkScalarModeProperty() [3/4]

◆ VtkScalarModeProperty() [4/4]

Member Function Documentation

◆ AddEnum()

◆ AddInterpolationTypes()

◆ Clone()

◆ GetVtkScalarMode()

◆ mitkClassMacro()

◆ mitkCloneMacro()

◆ mitkNewMacro1Param() [1/2]

◆ mitkNewMacro1Param() [2/2]

◆ New()

◆ operator=()

◆ SetScalarModeToCellData()

◆ SetScalarModeToCellFieldData()

◆ SetScalarModeToDefault()

◆ SetScalarModeToPointData()

◆ SetScalarModeToPointFieldData()