mitk::PointSetShapeProperty Class Reference

#include <mitkPointSetShapeProperty.h>

Inheritance diagram for mitk::PointSetShapeProperty:

Collaboration diagram for mitk::PointSetShapeProperty:

Public Types
enum	PointSetShape {   NONE , VERTEX , DASH , CROSS ,   THICK_CROSS , TRIANGLE , SQUARE , CIRCLE ,   DIAMOND , ARROW , THICK_ARROW , HOOKED_ARROW }
Public Types inherited from mitk::EnumerationProperty
typedef unsigned int	IdType
typedef std::map< IdType, std::string >	EnumIdsContainerType
typedef std::map< std::string, IdType >	EnumStringsContainerType
typedef EnumIdsContainerType::const_iterator	EnumConstIterator

Public Member Functions
	mitkClassMacro (PointSetShapeProperty, EnumerationProperty)
Pointer	Clone () const
	mitkNewMacro1Param (PointSetShapeProperty, const IdType &)
	mitkNewMacro1Param (PointSetShapeProperty, const std::string &)
virtual int	GetPointSetShape () const
BaseProperty &	operator= (const BaseProperty &property)
	Assigns property to this BaseProperty instance. More...
Public Member Functions inherited from mitk::EnumerationProperty
	mitkClassMacro (EnumerationProperty, BaseProperty)
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
	mitkClassMacroItkParent (BaseProperty, itk::Object)
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 Pointer	New ()
Static Public Member Functions inherited from mitk::EnumerationProperty
static Pointer	New ()

Protected Member Functions
	PointSetShapeProperty ()
	PointSetShapeProperty (const IdType &value)
	PointSetShapeProperty (const std::string &value)
bool	AddEnum (const std::string &name, const IdType &id) override
virtual void	AddPointSetShapes ()
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 if a property which can not be returned as string. More...

Detailed Description

Encapsulates the enumeration for point set shapes. Valid values are:

• NONE
• VERTEX
• DASH
• CROSS (default)
• THICK_CROSS
• TRIANGLE
• SQUARE
• CIRCLE
• DIAMOND
• ARROW
• THICK_ARROW
• HOOKED_ARROW

This class provides different shapes for the point set rendering (unselected points).

Definition at line 44 of file mitkPointSetShapeProperty.h.

Member Enumeration Documentation

PointSetShape

enum mitk::PointSetShapeProperty::PointSetShape

Enumerator
NONE
VERTEX
DASH
CROSS
THICK_CROSS
TRIANGLE
SQUARE
CIRCLE
DIAMOND
ARROW
THICK_ARROW
HOOKED_ARROW

Definition at line 57 of file mitkPointSetShapeProperty.h.

Constructor & Destructor Documentation

PointSetShapeProperty() [1/3]

mitk::PointSetShapeProperty::PointSetShapeProperty ( )

protected

Sets rendering type to default (VTK_RAY_CAST_COMPOSITE_FUNCTION).

PointSetShapeProperty() [2/3]

mitk::PointSetShapeProperty::PointSetShapeProperty ( const IdType &  value )

protected

Constructor. Sets rendering type to the given value.

PointSetShapeProperty() [3/3]

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

protected

Constructor. Sets rendering type to the given value.

Member Function Documentation

AddEnum()

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

overrideprotectedvirtual

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

Reimplemented from mitk::EnumerationProperty.

AddPointSetShapes()

virtual void mitk::PointSetShapeProperty::AddPointSetShapes ( )

protectedvirtual

Adds the default enumeration types.

Clone()

Pointer mitk::PointSetShapeProperty::Clone

(

)

const

GetPointSetShape()

virtual int mitk::PointSetShapeProperty::GetPointSetShape ( ) const

virtual

Returns the current shape

mitkClassMacro()

mitk::PointSetShapeProperty::mitkClassMacro	(	PointSetShapeProperty	,
		EnumerationProperty
	)

mitkNewMacro1Param() [1/2]

mitk::PointSetShapeProperty::mitkNewMacro1Param	(	PointSetShapeProperty	,
		const IdType &
	)

mitkNewMacro1Param() [2/2]

mitk::PointSetShapeProperty::mitkNewMacro1Param	(	PointSetShapeProperty	,
		const std::string &
	)

New()

static Pointer mitk::PointSetShapeProperty::New ( )

static

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.

---

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

• mitkPointSetShapeProperty.h