#include <mitkVtkScalarModeProperty.h>

Inheritance diagram for mitk::VtkScalarModeProperty:

[legend]

Collaboration diagram for mitk::VtkScalarModeProperty:

[legend]

Public Types
typedef VtkScalarModeProperty	Self

typedef EnumerationProperty	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

Public Types inherited from mitk::EnumerationProperty
typedef EnumerationProperty	Self

typedef BaseProperty	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

typedef unsigned int	IdType

typedef std::map< IdType, std::string >	EnumIdsContainerType

typedef std::map< std::string, IdType >	EnumStringsContainerType

typedef EnumIdsContainerType::const_iterator	EnumConstIterator

Public Types inherited from mitk::BaseProperty
typedef BaseProperty	Self

typedef itk::Object	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

Public Member Functions
virtual std::vector< std::string >	GetClassHierarchy () const override

virtual const char *	GetClassName () const

Pointer	Clone () const

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
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
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 const char *	GetStaticNameOfClass ()

static Pointer	New ()

static Pointer	New (const IdType &_arg)

static Pointer	New (const std::string &_arg)

Static Public Member Functions inherited from mitk::EnumerationProperty
static const char *	GetStaticNameOfClass ()

static Pointer	New ()

Static Public Member Functions inherited from mitk::BaseProperty
static const char *	GetStaticNameOfClass ()

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

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

	BaseProperty (const BaseProperty &other)

	~BaseProperty () override

Additional Inherited Members
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.

Member Typedef Documentation

◆ ConstPointer

typedef itk::SmartPointer<const Self> mitk::VtkScalarModeProperty::ConstPointer

Definition at line 37 of file mitkVtkScalarModeProperty.h.

◆ Pointer

typedef itk::SmartPointer<Self> mitk::VtkScalarModeProperty::Pointer

Definition at line 37 of file mitkVtkScalarModeProperty.h.

◆ Self

typedef VtkScalarModeProperty mitk::VtkScalarModeProperty::Self

Definition at line 37 of file mitkVtkScalarModeProperty.h.

◆ Superclass

typedef EnumerationProperty mitk::VtkScalarModeProperty::Superclass

Definition at line 37 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

◆ GetClassHierarchy()

virtual std::vector<std::string> mitk::VtkScalarModeProperty::GetClassHierarchy ( ) const

inlineoverridevirtual

Reimplemented from mitk::EnumerationProperty.

Definition at line 37 of file mitkVtkScalarModeProperty.h.

◆ GetClassName()

virtual const char* mitk::VtkScalarModeProperty::GetClassName ( ) const

virtual

Reimplemented from mitk::EnumerationProperty.

◆ GetStaticNameOfClass()

static const char* mitk::VtkScalarModeProperty::GetStaticNameOfClass ( )

inlinestatic

Definition at line 37 of file mitkVtkScalarModeProperty.h.

◆ 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.

◆ New() [1/3]

static Pointer mitk::VtkScalarModeProperty::New ( )

static

◆ New() [2/3]

static Pointer mitk::VtkScalarModeProperty::New ( const IdType & _arg )

inlinestatic

Definition at line 43 of file mitkVtkScalarModeProperty.h.

◆ New() [3/3]

static Pointer mitk::VtkScalarModeProperty::New ( const std::string & _arg )

inlinestatic

Definition at line 45 of file mitkVtkScalarModeProperty.h.

◆ 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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ VtkScalarModeProperty() [1/3]

◆ VtkScalarModeProperty() [2/3]

◆ VtkScalarModeProperty() [3/3]

Member Function Documentation

◆ AddEnum()

◆ AddInterpolationTypes()

◆ Clone()

◆ GetClassHierarchy()

◆ GetClassName()

◆ GetStaticNameOfClass()

◆ GetVtkScalarMode()

◆ New() [1/3]

◆ New() [2/3]

◆ New() [3/3]

◆ operator=()

◆ SetScalarModeToCellData()

◆ SetScalarModeToCellFieldData()

◆ SetScalarModeToDefault()

◆ SetScalarModeToPointData()

◆ SetScalarModeToPointFieldData()