Medical Imaging Interaction Toolkit  2018.4.99-b20efe7f
Medical Imaging Interaction Toolkit
mitk::PlanarFigureControlPointStyleProperty Class Reference

Defines the rendering style of control points for PlanarFigure objects. More...

#include <mitkPlanarFigureControlPointStyleProperty.h>

Inheritance diagram for mitk::PlanarFigureControlPointStyleProperty:
Collaboration diagram for mitk::PlanarFigureControlPointStyleProperty:

Public Types

enum  Shape { Square, Circle }
- Public Types inherited from mitk::EnumerationProperty
typedef EnumerationProperty Self
typedef BaseProperty Superclass
typedef itk::SmartPointer< SelfPointer
typedef itk::SmartPointer< const SelfConstPointer
typedef unsigned int IdType
typedef std::map< IdType, std::string > EnumIdsContainerType
typedef std::map< std::string, IdTypeEnumStringsContainerType
typedef EnumIdsContainerType::const_iterator EnumConstIterator
- Public Types inherited from mitk::BaseProperty
typedef BaseProperty Self
typedef itk::Object Superclass
typedef itk::SmartPointer< SelfPointer
typedef itk::SmartPointer< const SelfConstPointer

Public Member Functions

 mitkClassMacro (PlanarFigureControlPointStyleProperty, EnumerationProperty)
Pointer Clone () const
 mitkNewMacro1Param (PlanarFigureControlPointStyleProperty, const IdType &)
 mitkNewMacro1Param (PlanarFigureControlPointStyleProperty, const std::string &)
virtual Shape GetShape ()
virtual void SetShape (Shape)
- Public Member Functions inherited from mitk::EnumerationProperty
virtual std::vector< std::string > GetClassHierarchy () const override
virtual const char * GetClassName () const
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 EnumIdsContainerTypeGetEnumIds () const
const EnumStringsContainerTypeGetEnumStrings () const
EnumIdsContainerTypeGetEnumIds ()
EnumStringsContainerTypeGetEnumStrings ()
EnumerationPropertyoperator= (const EnumerationProperty &)=delete
- 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...
BasePropertyoperator= (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 Pointer New ()
- 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

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

Defines the rendering style of control points for PlanarFigure objects.

See also

Used by PlanarFigureMapper2D to determine which of several control point shapes to use. Currently this is basically the choice between squares and circles. If more options are implemented, this class should be enhanced.

After construction, the default shape is a square.

Definition at line 34 of file mitkPlanarFigureControlPointStyleProperty.h.

Member Enumeration Documentation

◆ Shape


Definition at line 47 of file mitkPlanarFigureControlPointStyleProperty.h.

Constructor & Destructor Documentation

◆ PlanarFigureControlPointStyleProperty() [1/3]

mitk::PlanarFigureControlPointStyleProperty::PlanarFigureControlPointStyleProperty ( )

◆ PlanarFigureControlPointStyleProperty() [2/3]

mitk::PlanarFigureControlPointStyleProperty::PlanarFigureControlPointStyleProperty ( const IdType value)

◆ PlanarFigureControlPointStyleProperty() [3/3]

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

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

Definition at line 33 of file mitkPlanarFigureControlPointStyleProperty.cpp.

References AddEnumTypes(), mitk::EnumerationProperty::IsValidEnumerationValue(), mitk::EnumerationProperty::SetValue(), and Square.

Member Function Documentation

◆ AddEnum()

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

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

Reimplemented from mitk::EnumerationProperty.

Definition at line 52 of file mitkPlanarFigureControlPointStyleProperty.cpp.

Referenced by AddEnumTypes().

◆ AddEnumTypes()

void mitk::PlanarFigureControlPointStyleProperty::AddEnumTypes ( )

Adds the standard enumeration types with corresponding strings.

Definition at line 46 of file mitkPlanarFigureControlPointStyleProperty.cpp.

References AddEnum(), Circle, and Square.

Referenced by PlanarFigureControlPointStyleProperty().

◆ Clone()

Pointer mitk::PlanarFigureControlPointStyleProperty::Clone ( ) const

◆ GetShape()

mitk::PlanarFigureControlPointStyleProperty::Shape mitk::PlanarFigureControlPointStyleProperty::GetShape ( )

◆ mitkClassMacro()

mitk::PlanarFigureControlPointStyleProperty::mitkClassMacro ( PlanarFigureControlPointStyleProperty  ,

◆ mitkNewMacro1Param() [1/2]

mitk::PlanarFigureControlPointStyleProperty::mitkNewMacro1Param ( PlanarFigureControlPointStyleProperty  ,
const IdType  

◆ mitkNewMacro1Param() [2/2]

mitk::PlanarFigureControlPointStyleProperty::mitkNewMacro1Param ( PlanarFigureControlPointStyleProperty  ,
const std::string &   

◆ New()

static Pointer mitk::PlanarFigureControlPointStyleProperty::New ( )

◆ SetShape()

void mitk::PlanarFigureControlPointStyleProperty::SetShape ( Shape  shape)

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