mitk::VtkScalarModeProperty Class Reference

#include <mitkVtkScalarModeProperty.h>

Inheritance diagram for mitk::VtkScalarModeProperty:

Collaboration diagram for mitk::VtkScalarModeProperty:

Public Member Functions
	mitkClassMacro (VtkScalarModeProperty, EnumerationProperty)
Pointer	Clone () const
	mitkNewMacro1Param (VtkScalarModeProperty, const IdType &)
	mitkNewMacro1Param (VtkScalarModeProperty, const std::string &)
virtual int	GetVtkScalarMode ()
virtual void	SetScalarModeToDefault ()
virtual void	SetScalarModeToPointData ()
virtual void	SetScalarModeToCellData ()
virtual void	SetScalarModeToPointFieldData ()
virtual void	SetScalarModeToCellFieldData ()
BaseProperty &	operator= (const BaseProperty &property)
	Assigns property to this BaseProperty instance. More...
Public Member Functions inherited from mitk::EnumerationProperty
	mitkClassMacro (EnumerationProperty, BaseProperty)
Pointer	Clone () const
virtual bool	SetValue (const std::string &name)
virtual bool	SetValue (const IdType &id)
virtual IdType	GetValueAsId () const
std::string	GetValueAsString () const override
virtual void	Clear ()
virtual EnumIdsContainerType::size_type	Size () const
virtual EnumConstIterator	Begin () const
virtual EnumConstIterator	End () const
virtual std::string	GetEnumString (const IdType &id) const
virtual IdType	GetEnumId (const std::string &name) const
virtual bool	IsValidEnumerationValue (const IdType &id) const
virtual bool	IsValidEnumerationValue (const std::string &name) const
const EnumIdsContainerType &	GetEnumIds () const
const EnumStringsContainerType &	GetEnumStrings () const
EnumIdsContainerType &	GetEnumIds ()
EnumStringsContainerType &	GetEnumStrings ()
bool	ToJSON (nlohmann::json &j) const override
bool	FromJSON (const nlohmann::json &j) override
EnumerationProperty &	operator= (const EnumerationProperty &)=delete
BaseProperty &	operator= (const BaseProperty &property)
	Assigns property to this BaseProperty instance. More...
Public Member Functions inherited from mitk::BaseProperty
	mitkClassMacroItkParent (BaseProperty, itk::Object)
Pointer	Clone () const
bool	operator== (const BaseProperty &property) const
	Subclasses must implement IsEqual(const BaseProperty&) to support comparison. More...
BaseProperty &	operator= (const BaseProperty &property)
	Assigns property to this BaseProperty instance. More...
bool	AssignProperty (const BaseProperty &property)
	Assigns property to this BaseProperty instance. More...

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

Protected Member Functions
	VtkScalarModeProperty ()
	VtkScalarModeProperty (const IdType &value)
	Sets the scalar mode to the given value. If it is not valid, the scalar mode is set to default (0). More...
	VtkScalarModeProperty (const std::string &value)
	Sets the scalar mode to the given value. If it is not valid, the representation is set to default (0). More...
bool	AddEnum (const std::string &name, const IdType &id) override
virtual void	AddInterpolationTypes ()
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
typedef std::map< IdType, std::string >	EnumIdsContainerType
typedef std::map< std::string, IdType >	EnumStringsContainerType
typedef EnumIdsContainerType::const_iterator	EnumConstIterator
Static Public Attributes inherited from mitk::BaseProperty
static const std::string	VALUE_CANNOT_BE_CONVERTED_TO_STRING
	Default return value if a property which can not be returned as string. More...

Detailed Description

Encapsulates the enumeration vtkInterpolation. 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 34 of file mitkVtkScalarModeProperty.h.

Constructor & Destructor Documentation

VtkScalarModeProperty() [1/3]

mitk::VtkScalarModeProperty::VtkScalarModeProperty ( )

protected

Constructor. Sets the representation to a default value of surface(2)

VtkScalarModeProperty() [2/3]

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

protected

Sets the scalar mode to the given value. If it is not valid, the scalar mode is set to default (0).

Parameters

value

the integer representation of the scalar mode

VtkScalarModeProperty() [3/3]

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

protected

Sets the scalar mode to the given value. If it is not valid, the representation is set to default (0).

Parameters

value

the string representation of the scalar mode

Member Function Documentation

AddEnum()

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

overrideprotectedvirtual

this function is overridden as protected, so that the user may not add additional invalid scalar mode types.

Reimplemented from mitk::EnumerationProperty.

AddInterpolationTypes()

virtual void mitk::VtkScalarModeProperty::AddInterpolationTypes ( )

protectedvirtual

Adds the enumeration types as defined by vtk to the list of known enumeration values.

Clone()

Pointer mitk::VtkScalarModeProperty::Clone

(

)

const

GetVtkScalarMode()

virtual int mitk::VtkScalarModeProperty::GetVtkScalarMode ( )

virtual

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

Returns

the current scalar mode as VTK constant.

mitkClassMacro()

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

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=

Assigns property to this BaseProperty instance.

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

SetScalarModeToCellData()

virtual void mitk::VtkScalarModeProperty::SetScalarModeToCellData ( )

virtual

SetScalarModeToCellFieldData()

virtual void mitk::VtkScalarModeProperty::SetScalarModeToCellFieldData ( )

virtual

SetScalarModeToDefault()

virtual void mitk::VtkScalarModeProperty::SetScalarModeToDefault ( )

virtual

SetScalarModeToPointData()

virtual void mitk::VtkScalarModeProperty::SetScalarModeToPointData ( )

virtual

SetScalarModeToPointFieldData()

virtual void mitk::VtkScalarModeProperty::SetScalarModeToPointFieldData ( )

virtual

---

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

• mitkVtkScalarModeProperty.h