Public Types |
Public Member Functions |
Static Public Member Functions |
Protected Member Functions |
List of all members
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 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 (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 | |
| 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 | |
| PlanarFigureControlPointStyleProperty () | |
| PlanarFigureControlPointStyleProperty (const PlanarFigureControlPointStyleProperty &other) | |
| PlanarFigureControlPointStyleProperty (const IdType &value) | |
| PlanarFigureControlPointStyleProperty (const std::string &value) | |
| bool | AddEnum (const std::string &name, const IdType &id) override |
| virtual void | AddEnumTypes () |
| mitkCloneMacro (PlanarFigureControlPointStyleProperty) | |
| 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
Defines the rendering style of control points for PlanarFigure objects.
- See also
- mitk::PlanarFigureMapper2D
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
| Enumerator | |
|---|---|
| Square | |
| Circle | |
Definition at line 47 of file mitkPlanarFigureControlPointStyleProperty.h.
Constructor & Destructor Documentation
◆ PlanarFigureControlPointStyleProperty() [1/4]
|
protected |
◆ PlanarFigureControlPointStyleProperty() [2/4]
|
protected |
◆ PlanarFigureControlPointStyleProperty() [3/4]
|
protected |
◆ PlanarFigureControlPointStyleProperty() [4/4]
|
protected |
Constructor. Sets the decoration type to the given value. If it is not valid, the representation is set to none
Member Function Documentation
◆ AddEnum()
|
overrideprotectedvirtual |
this function is overridden as protected, so that the user may not add additional invalid types.
Reimplemented from mitk::EnumerationProperty.
◆ AddEnumTypes()
|
protectedvirtual |
Adds the standard enumeration types with corresponding strings.
◆ Clone()
| Pointer mitk::PlanarFigureControlPointStyleProperty::Clone | ( | ) | const |
◆ GetShape()
|
virtual |
◆ mitkClassMacro()
| mitk::PlanarFigureControlPointStyleProperty::mitkClassMacro | ( | PlanarFigureControlPointStyleProperty | , |
| EnumerationProperty | |||
| ) |
◆ mitkCloneMacro()
|
protected |
◆ mitkNewMacro1Param() [1/2]
| mitk::PlanarFigureControlPointStyleProperty::mitkNewMacro1Param | ( | PlanarFigureControlPointStyleProperty | , |
| const IdType & | |||
| ) |
◆ mitkNewMacro1Param() [2/2]
| mitk::PlanarFigureControlPointStyleProperty::mitkNewMacro1Param | ( | PlanarFigureControlPointStyleProperty | , |
| const std::string & | |||
| ) |
◆ New()
|
static |
◆ SetShape()
|
virtual |
The documentation for this class was generated from the following file:
