Medical Imaging Interaction Toolkit  2024.06.00
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
mitk::PlaneOrientationProperty Class Reference

#include <mitkPlaneOrientationProperty.h>

Inheritance diagram for mitk::PlaneOrientationProperty:
Inheritance graph
[legend]
Collaboration diagram for mitk::PlaneOrientationProperty:
Collaboration graph
[legend]

Public Types

enum  { PLANE_DECORATION_NONE, PLANE_DECORATION_POSITIVE_ORIENTATION, PLANE_DECORATION_NEGATIVE_ORIENTATION }
 
typedef PlaneOrientationProperty 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 GetPlaneDecoration ()
 
virtual void SetPlaneDecorationToNone ()
 
virtual void SetPlaneDecorationToPositiveOrientation ()
 
virtual void SetPlaneDecorationToNegativeOrientation ()
 
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

 PlaneOrientationProperty ()
 
 PlaneOrientationProperty (const IdType &value)
 
 PlaneOrientationProperty (const std::string &value)
 
bool AddEnum (const std::string &name, const IdType &id) override
 
virtual void AddDecorationTypes ()
 
- 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

Property which controls whether 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 upwards)
  • PLANE_DECORATION_NEGATIVE_ORIENTATION (arrows pointing downwards)

See also mitk::PlaneGeometryDataMapper2D::DrawOrientationArrow()

Definition at line 38 of file mitkPlaneOrientationProperty.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 41 of file mitkPlaneOrientationProperty.h.

◆ Pointer

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

Definition at line 41 of file mitkPlaneOrientationProperty.h.

◆ Self

typedef PlaneOrientationProperty mitk::PlaneOrientationProperty::Self

Definition at line 41 of file mitkPlaneOrientationProperty.h.

◆ Superclass

typedef EnumerationProperty mitk::PlaneOrientationProperty::Superclass

Definition at line 41 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 51 of file mitkPlaneOrientationProperty.h.

Constructor & Destructor Documentation

◆ PlaneOrientationProperty() [1/3]

mitk::PlaneOrientationProperty::PlaneOrientationProperty ( )
protected

Constructor. Sets the decoration type to none.

◆ PlaneOrientationProperty() [2/3]

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/3]

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

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

◆ GetClassHierarchy()

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

Reimplemented from mitk::EnumerationProperty.

Definition at line 41 of file mitkPlaneOrientationProperty.h.

◆ GetClassName()

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

Reimplemented from mitk::EnumerationProperty.

◆ GetPlaneDecoration()

virtual int mitk::PlaneOrientationProperty::GetPlaneDecoration ( )
virtual

Returns the state of plane decoration.

◆ GetStaticNameOfClass()

static const char* mitk::PlaneOrientationProperty::GetStaticNameOfClass ( )
inlinestatic

Definition at line 41 of file mitkPlaneOrientationProperty.h.

◆ New() [1/3]

static Pointer mitk::PlaneOrientationProperty::New ( )
static

◆ New() [2/3]

static Pointer mitk::PlaneOrientationProperty::New ( const IdType &  _arg)
inlinestatic

Definition at line 47 of file mitkPlaneOrientationProperty.h.

◆ New() [3/3]

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

Definition at line 49 of file mitkPlaneOrientationProperty.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.

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