Encapsulates the VTK interpolation enumeration as an EnumerationProperty. More...

#include <mitkVtkInterpolationProperty.h>

Inheritance diagram for mitk::VtkInterpolationProperty:

[legend]

Collaboration diagram for mitk::VtkInterpolationProperty:

[legend]

Public Member Functions
	mitkClassMacro (VtkInterpolationProperty, EnumerationProperty)

Pointer	Clone () const

	mitkNewMacro1Param (VtkInterpolationProperty, const IdType &)

	mitkNewMacro1Param (VtkInterpolationProperty, const std::string &)

virtual int	GetVtkInterpolation ()
	Return the current interpolation value as defined by VTK constants. More...

virtual void	SetInterpolationToFlat ()
	Set the interpolation type to VTK_FLAT. More...

virtual void	SetInterpolationToGouraud ()
	Set the interpolation type to VTK_GOURAUD. More...

virtual void	SetInterpolationToPhong ()
	Set the interpolation type to VTK_PHONG. 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
	VtkInterpolationProperty ()
	Constructor. Sets the interpolation to a default value of Gouraud(1). More...

	VtkInterpolationProperty (const IdType &value)
	Constructor. Sets the interpolation to the given value. More...

	VtkInterpolationProperty (const std::string &value)
	Constructor. Sets the interpolation to the given value. More...

	VtkInterpolationProperty (const VtkInterpolationProperty &other)

bool	AddEnum (const std::string &name, const IdType &id) override
	Overridden as protected to prevent adding invalid interpolation types. More...

virtual void	AddInterpolationTypes ()
	Add the VTK-defined interpolation types to the enumeration. More...

	mitkCloneMacro (VtkInterpolationProperty)

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 interpolation enumeration as an EnumerationProperty.

Valid values are (VTK constant / Id / string representation): VTK_FLAT/0/Flat, VTK_GOURAUD/1/Gouraud, VTK_PHONG/2/Phong. Default is Gouraud interpolation.

Definition at line 27 of file mitkVtkInterpolationProperty.h.

Constructor & Destructor Documentation

◆ VtkInterpolationProperty() [1/4]

mitk::VtkInterpolationProperty::VtkInterpolationProperty ( )

protected

Constructor. Sets the interpolation to a default value of Gouraud(1).

◆ VtkInterpolationProperty() [2/4]

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

protected

Constructor. Sets the interpolation to the given value.

If the value is not valid, the interpolation is set to Gouraud(1).

Parameters

[in] value The integer representation of the interpolation.

◆ VtkInterpolationProperty() [3/4]

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

protected

Constructor. Sets the interpolation to the given value.

If the value is not valid, the interpolation is set to Gouraud(1).

Parameters

[in] value The string representation of the interpolation.

◆ VtkInterpolationProperty() [4/4]

mitk::VtkInterpolationProperty::VtkInterpolationProperty ( const VtkInterpolationProperty & other )

protected

Member Function Documentation

◆ AddEnum()

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

overrideprotectedvirtual

Overridden as protected to prevent adding invalid interpolation types.

Reimplemented from mitk::EnumerationProperty.

◆ AddInterpolationTypes()

virtual void mitk::VtkInterpolationProperty::AddInterpolationTypes ( )

protectedvirtual

Add the VTK-defined interpolation types to the enumeration.

◆ Clone()

Pointer mitk::VtkInterpolationProperty::Clone ( ) const

◆ GetVtkInterpolation()

virtual int mitk::VtkInterpolationProperty::GetVtkInterpolation ( )

virtual

Return the current interpolation value as defined by VTK constants.

Returns: The current interpolation as a VTK constant.

◆ mitkClassMacro()

mitk::VtkInterpolationProperty::mitkClassMacro	(	VtkInterpolationProperty	,
		EnumerationProperty
	)

◆ mitkCloneMacro()

mitk::VtkInterpolationProperty::mitkCloneMacro ( VtkInterpolationProperty )

protected

◆ mitkNewMacro1Param() [1/2]

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

◆ mitkNewMacro1Param() [2/2]

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

◆ New()

static Pointer mitk::VtkInterpolationProperty::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

◆ SetInterpolationToFlat()

virtual void mitk::VtkInterpolationProperty::SetInterpolationToFlat ( )

virtual

Set the interpolation type to VTK_FLAT.

◆ SetInterpolationToGouraud()

virtual void mitk::VtkInterpolationProperty::SetInterpolationToGouraud ( )

virtual

Set the interpolation type to VTK_GOURAUD.

◆ SetInterpolationToPhong()

virtual void mitk::VtkInterpolationProperty::SetInterpolationToPhong ( )

virtual

Set the interpolation type to VTK_PHONG.

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

mitkVtkInterpolationProperty.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VtkInterpolationProperty() [1/4]

◆ VtkInterpolationProperty() [2/4]

◆ VtkInterpolationProperty() [3/4]

◆ VtkInterpolationProperty() [4/4]

Member Function Documentation

◆ AddEnum()

◆ AddInterpolationTypes()

◆ Clone()

◆ GetVtkInterpolation()

◆ mitkClassMacro()

◆ mitkCloneMacro()

◆ mitkNewMacro1Param() [1/2]

◆ mitkNewMacro1Param() [2/2]

◆ New()

◆ operator=()

◆ SetInterpolationToFlat()

◆ SetInterpolationToGouraud()

◆ SetInterpolationToPhong()