Enumeration property for grid representation types. More...

#include <mitkGridRepresentationProperty.h>

Inheritance diagram for mitk::GridRepresentationProperty:

[legend]

Collaboration diagram for mitk::GridRepresentationProperty:

[legend]

Public Types
enum	RepresentationType { POINTS , WIREFRAME , SURFACE }
	Available representation types for unstructured grids. More...

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

Public Member Functions
	mitkClassMacro (GridRepresentationProperty, EnumerationProperty)

Pointer	Clone () const

	mitkNewMacro1Param (GridRepresentationProperty, const IdType &)

	mitkNewMacro1Param (GridRepresentationProperty, const std::string &)

virtual void	SetRepresentationToPoints ()
	Set the representation type to POINTS. More...

virtual void	SetRepresentationToWireframe ()
	Set the representation type to WIREFRAME. More...

virtual void	SetRepresentationToSurface ()
	Set the representation type to SURFACE. More...

virtual void	SetRepresentationToWireframeSurface ()
	Set the representation type to WIREFRAME_SURFACE (combined). 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
	GridRepresentationProperty ()

	GridRepresentationProperty (const GridRepresentationProperty &other)

	GridRepresentationProperty (const IdType &value)

	GridRepresentationProperty (const std::string &value)

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

virtual void	AddRepresentationTypes ()

	mitkCloneMacro (GridRepresentationProperty)

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

Enumeration property for grid representation types.

Extends EnumerationProperty with the following values:

POINTS (0) – render as points
WIREFRAME (1) – render as wireframe (default)
SURFACE (2) – render as surface

See also: EnumerationProperty, GridVolumeMapperProperty

Definition at line 32 of file mitkGridRepresentationProperty.h.

Member Enumeration Documentation

◆ RepresentationType

enum mitk::GridRepresentationProperty::RepresentationType

Available representation types for unstructured grids.

Enumerator
POINTS	Render grid as points.
WIREFRAME	Render grid as wireframe.
SURFACE	Render grid as filled surface.

Definition at line 38 of file mitkGridRepresentationProperty.h.

Constructor & Destructor Documentation

◆ GridRepresentationProperty() [1/4]

mitk::GridRepresentationProperty::GridRepresentationProperty ( )

protected

Constructor. Sets the representation to a default value of Wireframe(1)

◆ GridRepresentationProperty() [2/4]

mitk::GridRepresentationProperty::GridRepresentationProperty ( const GridRepresentationProperty & other )

protected

◆ GridRepresentationProperty() [3/4]

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

protected

Constructor. Sets the representation to the given value. If it is not valid, the representation is set to Wireframe(1)

Parameters

value the integer representation of the representation

◆ GridRepresentationProperty() [4/4]

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

protected

Constructor. Sets the representation to the given value. If it is not valid, the representation is set to Wireframe(1)

Parameters

value the string representation of the representation

Member Function Documentation

◆ AddEnum()

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

overrideprotectedvirtual

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

Reimplemented from mitk::EnumerationProperty.

◆ AddRepresentationTypes()

virtual void mitk::GridRepresentationProperty::AddRepresentationTypes ( )

protectedvirtual

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

◆ Clone()

Pointer mitk::GridRepresentationProperty::Clone ( ) const

◆ mitkClassMacro()

mitk::GridRepresentationProperty::mitkClassMacro	(	GridRepresentationProperty	,
		EnumerationProperty
	)

◆ mitkCloneMacro()

mitk::GridRepresentationProperty::mitkCloneMacro ( GridRepresentationProperty )

protected

◆ mitkNewMacro1Param() [1/2]

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

◆ mitkNewMacro1Param() [2/2]

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

◆ New()

static Pointer mitk::GridRepresentationProperty::New ( )

static

◆ SetRepresentationToPoints()

virtual void mitk::GridRepresentationProperty::SetRepresentationToPoints ( )

virtual

Set the representation type to POINTS.

◆ SetRepresentationToSurface()

virtual void mitk::GridRepresentationProperty::SetRepresentationToSurface ( )

virtual

Set the representation type to SURFACE.

◆ SetRepresentationToWireframe()

virtual void mitk::GridRepresentationProperty::SetRepresentationToWireframe ( )

virtual

Set the representation type to WIREFRAME.

◆ SetRepresentationToWireframeSurface()

virtual void mitk::GridRepresentationProperty::SetRepresentationToWireframeSurface ( )

virtual

Set the representation type to WIREFRAME_SURFACE (combined).

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

mitkGridRepresentationProperty.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ RepresentationType

Constructor & Destructor Documentation

◆ GridRepresentationProperty() [1/4]

◆ GridRepresentationProperty() [2/4]

◆ GridRepresentationProperty() [3/4]

◆ GridRepresentationProperty() [4/4]

Member Function Documentation

◆ AddEnum()

◆ AddRepresentationTypes()

◆ Clone()

◆ mitkClassMacro()

◆ mitkCloneMacro()

◆ mitkNewMacro1Param() [1/2]

◆ mitkNewMacro1Param() [2/2]

◆ New()

◆ SetRepresentationToPoints()

◆ SetRepresentationToSurface()

◆ SetRepresentationToWireframe()

◆ SetRepresentationToWireframeSurface()