Enumeration property controlling orientation arrows on 2D plane representations. More...

#include <mitkPlaneOrientationProperty.h>

Inheritance diagram for mitk::PlaneOrientationProperty:

[legend]

Collaboration diagram for mitk::PlaneOrientationProperty:

[legend]

Public Types
enum	{ PLANE_DECORATION_NONE , PLANE_DECORATION_POSITIVE_ORIENTATION , PLANE_DECORATION_NEGATIVE_ORIENTATION }

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 (PlaneOrientationProperty, EnumerationProperty)

Pointer	Clone () const

	mitkNewMacro1Param (PlaneOrientationProperty, const IdType &)

	mitkNewMacro1Param (PlaneOrientationProperty, const std::string &)

virtual int	GetPlaneDecoration ()

virtual void	SetPlaneDecorationToNone ()

virtual void	SetPlaneDecorationToPositiveOrientation ()

virtual void	SetPlaneDecorationToNegativeOrientation ()

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
	PlaneOrientationProperty ()

	PlaneOrientationProperty (const IdType &value)

	PlaneOrientationProperty (const std::string &value)

	PlaneOrientationProperty (const PlaneOrientationProperty &other)

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

virtual void	AddDecorationTypes ()

	mitkCloneMacro (PlaneOrientationProperty)

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 controlling orientation arrows on 2D plane representations.

Controls whether the 2D line representation of a PlaneGeometry should have small arrows at both ends to indicate the orientation of the plane, and whether the arrows should be oriented in the direction of the plane's normal or against it.

Valid values of the enumeration property are:

PLANE_DECORATION_NONE (no arrows)
PLANE_DECORATION_POSITIVE_ORIENTATION (arrows pointing in positive normal direction)
PLANE_DECORATION_NEGATIVE_ORIENTATION (arrows pointing in negative normal direction)

See also: PlaneGeometryDataMapper2D::DrawOrientationArrow(); EnumerationProperty

Definition at line 36 of file mitkPlaneOrientationProperty.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
PLANE_DECORATION_NONE
PLANE_DECORATION_POSITIVE_ORIENTATION
PLANE_DECORATION_NEGATIVE_ORIENTATION

Definition at line 49 of file mitkPlaneOrientationProperty.h.

Constructor & Destructor Documentation

◆ PlaneOrientationProperty() [1/4]

mitk::PlaneOrientationProperty::PlaneOrientationProperty ( )

protected

Constructor. Sets the decoration type to none.

◆ PlaneOrientationProperty() [2/4]

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

protected

Constructor. Sets the decoration type to the given value. If it is not valid, the interpolation is set to none

◆ PlaneOrientationProperty() [3/4]

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

protected

Constructor. Sets the decoration type to the given value. If it is not valid, the representation is set to none

◆ PlaneOrientationProperty() [4/4]

mitk::PlaneOrientationProperty::PlaneOrientationProperty ( const PlaneOrientationProperty & other )

protected

Member Function Documentation

◆ AddDecorationTypes()

virtual void mitk::PlaneOrientationProperty::AddDecorationTypes ( )

protectedvirtual

Adds the standard enumeration types with corresponding strings.

◆ AddEnum()

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

overrideprotectedvirtual

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

Reimplemented from mitk::EnumerationProperty.

◆ Clone()

Pointer mitk::PlaneOrientationProperty::Clone ( ) const

◆ GetPlaneDecoration()

virtual int mitk::PlaneOrientationProperty::GetPlaneDecoration ( )

virtual

Returns the state of plane decoration.

◆ mitkClassMacro()

mitk::PlaneOrientationProperty::mitkClassMacro	(	PlaneOrientationProperty	,
		EnumerationProperty
	)

◆ mitkCloneMacro()

mitk::PlaneOrientationProperty::mitkCloneMacro ( PlaneOrientationProperty )

protected

◆ mitkNewMacro1Param() [1/2]

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

◆ mitkNewMacro1Param() [2/2]

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

◆ New()

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

◆ SetPlaneDecorationToNegativeOrientation()

virtual void mitk::PlaneOrientationProperty::SetPlaneDecorationToNegativeOrientation ( )

virtual

Sets the decoration type to arrows in negative plane direction.

◆ SetPlaneDecorationToNone()

virtual void mitk::PlaneOrientationProperty::SetPlaneDecorationToNone ( )

virtual

Sets the decoration type to no decoration.

◆ SetPlaneDecorationToPositiveOrientation()

virtual void mitk::PlaneOrientationProperty::SetPlaneDecorationToPositiveOrientation ( )

virtual

Sets the decoration type to arrows in positive plane direction.

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

mitkPlaneOrientationProperty.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ PlaneOrientationProperty() [1/4]

◆ PlaneOrientationProperty() [2/4]

◆ PlaneOrientationProperty() [3/4]

◆ PlaneOrientationProperty() [4/4]

Member Function Documentation

◆ AddDecorationTypes()

◆ AddEnum()

◆ Clone()

◆ GetPlaneDecoration()

◆ mitkClassMacro()

◆ mitkCloneMacro()

◆ mitkNewMacro1Param() [1/2]

◆ mitkNewMacro1Param() [2/2]

◆ New()

◆ operator=()

◆ SetPlaneDecorationToNegativeOrientation()

◆ SetPlaneDecorationToNone()

◆ SetPlaneDecorationToPositiveOrientation()