Medical Imaging Interaction Toolkit  2016.11.0
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 ()
 
- 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
 
virtual 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 &val) const
 
virtual bool IsValidEnumerationValue (const std::string &val) const
 
const EnumIdsContainerType & GetEnumIds () const
 
const EnumStringsContainerType & GetEnumStrings () const
 
EnumIdsContainerType & GetEnumIds ()
 
EnumStringsContainerType & GetEnumStrings ()
 
- 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)
 
virtual bool AddEnum (const std::string &name, const IdType &id) override
 
virtual void AddDecorationTypes ()
 
- Protected Member Functions inherited from mitk::EnumerationProperty
 EnumerationProperty ()
 
 EnumerationProperty (const EnumerationProperty &)
 
virtual bool IsEqual (const BaseProperty &property) const override
 
virtual bool Assign (const BaseProperty &property) override
 
itk::LightObject::Pointer InternalClone () const override
 
- Protected Member Functions inherited from mitk::BaseProperty
 BaseProperty ()
 
 BaseProperty (const BaseProperty &other)
 
virtual ~BaseProperty ()
 

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 42 of file mitkPlaneOrientationProperty.h.

Member Typedef Documentation

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

Definition at line 45 of file mitkPlaneOrientationProperty.h.

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

Definition at line 45 of file mitkPlaneOrientationProperty.h.

typedef PlaneOrientationProperty mitk::PlaneOrientationProperty::Self

Definition at line 45 of file mitkPlaneOrientationProperty.h.

typedef EnumerationProperty mitk::PlaneOrientationProperty::Superclass

Definition at line 45 of file mitkPlaneOrientationProperty.h.

Member Enumeration Documentation

anonymous enum
Enumerator
PLANE_DECORATION_NONE 
PLANE_DECORATION_POSITIVE_ORIENTATION 
PLANE_DECORATION_NEGATIVE_ORIENTATION 

Definition at line 53 of file mitkPlaneOrientationProperty.h.

Constructor & Destructor Documentation

mitk::PlaneOrientationProperty::PlaneOrientationProperty ( )
protected

Constructor. Sets the decoration type to none.

Definition at line 21 of file mitkPlaneOrientationProperty.cpp.

References AddDecorationTypes(), PLANE_DECORATION_NONE, and mitk::EnumerationProperty::SetValue().

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

Definition at line 27 of file mitkPlaneOrientationProperty.cpp.

References AddDecorationTypes(), mitk::EnumerationProperty::IsValidEnumerationValue(), PLANE_DECORATION_NONE, and mitk::EnumerationProperty::SetValue().

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

Definition at line 40 of file mitkPlaneOrientationProperty.cpp.

References AddDecorationTypes(), mitk::EnumerationProperty::IsValidEnumerationValue(), PLANE_DECORATION_NONE, and mitk::EnumerationProperty::SetValue().

Member Function Documentation

void mitk::PlaneOrientationProperty::AddDecorationTypes ( )
protectedvirtual

Adds the standard enumeration types with corresponding strings.

Definition at line 69 of file mitkPlaneOrientationProperty.cpp.

References AddEnum(), PLANE_DECORATION_NEGATIVE_ORIENTATION, PLANE_DECORATION_NONE, and PLANE_DECORATION_POSITIVE_ORIENTATION.

Referenced by PlaneOrientationProperty().

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.

Definition at line 76 of file mitkPlaneOrientationProperty.cpp.

References mitk::EnumerationProperty::AddEnum().

Referenced by AddDecorationTypes().

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

Reimplemented from mitk::EnumerationProperty.

Definition at line 45 of file mitkPlaneOrientationProperty.h.

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

Reimplemented from mitk::EnumerationProperty.

int mitk::PlaneOrientationProperty::GetPlaneDecoration ( )
virtual

Returns the state of plane decoration.

Definition at line 53 of file mitkPlaneOrientationProperty.cpp.

References mitk::EnumerationProperty::GetValueAsId().

Referenced by mitk::PlaneGeometryDataMapper2D::ApplyAllProperties().

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

Definition at line 45 of file mitkPlaneOrientationProperty.h.

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

Referenced by mitkPropertySerializationTest(), and mitk::PlaneGeometryDataMapper2D::SetDefaultProperties().

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

Definition at line 49 of file mitkPlaneOrientationProperty.h.

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

Definition at line 51 of file mitkPlaneOrientationProperty.h.

void mitk::PlaneOrientationProperty::SetPlaneDecorationToNegativeOrientation ( )
virtual

Sets the decoration type to arrows in negative plane direction.

Definition at line 64 of file mitkPlaneOrientationProperty.cpp.

References PLANE_DECORATION_NEGATIVE_ORIENTATION, and mitk::EnumerationProperty::SetValue().

void mitk::PlaneOrientationProperty::SetPlaneDecorationToNone ( )
virtual

Sets the decoration type to no decoration.

Definition at line 54 of file mitkPlaneOrientationProperty.cpp.

References PLANE_DECORATION_NONE, and mitk::EnumerationProperty::SetValue().

void mitk::PlaneOrientationProperty::SetPlaneDecorationToPositiveOrientation ( )
virtual

Sets the decoration type to arrows in positive plane direction.

Definition at line 59 of file mitkPlaneOrientationProperty.cpp.

References PLANE_DECORATION_POSITIVE_ORIENTATION, and mitk::EnumerationProperty::SetValue().

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