mitk::PlaneOrientationProperty Class Reference

#include <mitkPlaneOrientationProperty.h>

Inheritance diagram for mitk::PlaneOrientationProperty:

Collaboration diagram for mitk::PlaneOrientationProperty:

List of all members.

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 Member Functions
virtual const char *	GetClassName () const
virtual int	GetPlaneDecoration ()
virtual void	SetPlaneDecorationToNone ()
virtual void	SetPlaneDecorationToPositiveOrientation ()
virtual void	SetPlaneDecorationToNegativeOrientation ()
Static Public Member Functions
static Pointer	New ()
static Pointer	New (const IdType &_arg)
static Pointer	New (const std::string &_arg)
Protected Member Functions
	PlaneOrientationProperty ()
	PlaneOrientationProperty (const IdType &value)
	PlaneOrientationProperty (const std::string &value)
virtual bool	AddEnum (const std::string &name, const IdType &id)
virtual void	AddDecorationTypes ()

---

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::Geometry2DDataMapper2D::DrawOrientationArrow()

Definition at line 39 of file mitkPlaneOrientationProperty.h.

---

Member Typedef Documentation

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

Reimplemented from mitk::EnumerationProperty.

Definition at line 43 of file mitkPlaneOrientationProperty.h.

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

Reimplemented from mitk::EnumerationProperty.

Definition at line 43 of file mitkPlaneOrientationProperty.h.

typedef PlaneOrientationProperty mitk::PlaneOrientationProperty::Self

Reimplemented from mitk::EnumerationProperty.

Definition at line 43 of file mitkPlaneOrientationProperty.h.

typedef EnumerationProperty mitk::PlaneOrientationProperty::Superclass

Reimplemented from mitk::EnumerationProperty.

Definition at line 43 of file mitkPlaneOrientationProperty.h.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

PLANE_DECORATION_NONE
PLANE_DECORATION_POSITIVE_ORIENTATION
PLANE_DECORATION_NEGATIVE_ORIENTATION

Definition at line 51 of file mitkPlaneOrientationProperty.h.

  {
    PLANE_DECORATION_NONE,
    PLANE_DECORATION_POSITIVE_ORIENTATION,
    PLANE_DECORATION_NEGATIVE_ORIENTATION
  };

---

Constructor & Destructor Documentation

mitk::PlaneOrientationProperty::PlaneOrientationProperty

(

)

[protected]

Constructor. Sets the decoration type to none.

Definition at line 22 of file mitkPlaneOrientationProperty.cpp.

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

{


PlaneOrientationProperty::PlaneOrientationProperty( )
{

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 29 of file mitkPlaneOrientationProperty.cpp.

{
  this->AddDecorationTypes();
  if ( this->IsValidEnumerationValue( value ) )
  {
    this->SetValue( value ) ;
  }
  else
  {

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

{
  this->AddDecorationTypes();
  if ( this->IsValidEnumerationValue( value ) )
  {
    this->SetValue( value );
  }
  else
  {

---

Member Function Documentation

void mitk::PlaneOrientationProperty::AddDecorationTypes

(

)

[protected, virtual]

Adds the standard enumeration types with corresponding strings.

Definition at line 80 of file mitkPlaneOrientationProperty.cpp.

Referenced by PlaneOrientationProperty().

{
  this->AddEnum( "No plane decoration", static_cast<IdType>( PLANE_DECORATION_NONE ) );

bool mitk::PlaneOrientationProperty::AddEnum	(	const std::string &	name,
		const IdType &	id
	)		[protected, virtual]

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

Reimplemented from mitk::EnumerationProperty.

Definition at line 88 of file mitkPlaneOrientationProperty.cpp.

{

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 56 of file mitkPlaneOrientationProperty.cpp.

Referenced by mitk::Geometry2DDataMapper2D::ApplyProperties().

{

static Pointer mitk::PlaneOrientationProperty::New

(

const std::string &

_arg )

[inline, static]

Definition at line 49 of file mitkPlaneOrientationProperty.h.

{

static Pointer mitk::PlaneOrientationProperty::New

(

)

[static]

Reimplemented from mitk::EnumerationProperty.

Referenced by mitkPropertySerializationTest().

static Pointer mitk::PlaneOrientationProperty::New

(

const IdType &

_arg )

[inline, static]

Definition at line 47 of file mitkPlaneOrientationProperty.h.

void mitk::PlaneOrientationProperty::SetPlaneDecorationToNegativeOrientation

(

)

[virtual]

Sets the decoration type to arrows in negative plane direction.

Definition at line 74 of file mitkPlaneOrientationProperty.cpp.

{

void mitk::PlaneOrientationProperty::SetPlaneDecorationToNone

(

)

[virtual]

Sets the decoration type to no decoration.

Definition at line 62 of file mitkPlaneOrientationProperty.cpp.

{

void mitk::PlaneOrientationProperty::SetPlaneDecorationToPositiveOrientation

(

)

[virtual]

Sets the decoration type to arrows in positive plane direction.

Definition at line 68 of file mitkPlaneOrientationProperty.cpp.

{

---

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

• mitkPlaneOrientationProperty.h
• mitkPlaneOrientationProperty.cpp