Medical Imaging Interaction Toolkit  2018.4.99-65942676
Medical Imaging Interaction Toolkit
mitk::GridRepresentationProperty Class Reference

#include <mitkGridRepresentationProperty.h>

Inheritance diagram for mitk::GridRepresentationProperty:
Collaboration diagram for mitk::GridRepresentationProperty:

Public Types

enum  RepresentationType { POINTS, WIREFRAME, SURFACE }
 
- 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 (GridRepresentationProperty, EnumerationProperty)
 
Pointer Clone () const
 
 mitkNewMacro1Param (GridRepresentationProperty, const IdType &)
 
 mitkNewMacro1Param (GridRepresentationProperty, const std::string &)
 
virtual void SetRepresentationToPoints ()
 
virtual void SetRepresentationToWireframe ()
 
virtual void SetRepresentationToSurface ()
 
virtual void SetRepresentationToWireframeSurface ()
 
- 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

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

Extends the enumeration prop mitkEnumerationPropery. Adds the value (constant / Id / string representation):

  • POINTS / 0 / Points
  • WIREFRAME / 1 / Wireframe
  • SURFACE / 2 / Surface
  • WIREFRAME_SURFACE / 3 / WireframeSurface

Default is the Wireframe representation

Definition at line 32 of file mitkGridRepresentationProperty.h.

Member Enumeration Documentation

◆ RepresentationType

Enumerator
POINTS 
WIREFRAME 
SURFACE 

Definition at line 35 of file mitkGridRepresentationProperty.h.

Constructor & Destructor Documentation

◆ GridRepresentationProperty() [1/4]

mitk::GridRepresentationProperty::GridRepresentationProperty ( )
protected

Constructor. Sets the representation to a default value of Wireframe(1)

◆ GridRepresentationProperty() [2/4]

mitk::GridRepresentationProperty::GridRepresentationProperty ( const GridRepresentationProperty other)
protected

◆ GridRepresentationProperty() [3/4]

mitk::GridRepresentationProperty::GridRepresentationProperty ( const IdType value)
protected

Constructor. Sets the representation to the given value. If it is not valid, the representation is set to Wireframe(1)

Parameters
valuethe integer representation of the representation

◆ GridRepresentationProperty() [4/4]

mitk::GridRepresentationProperty::GridRepresentationProperty ( const std::string &  value)
protected

Constructor. Sets the representation to the given value. If it is not valid, the representation is set to Wireframe(1)

Parameters
valuethe string representation of the representation

Member Function Documentation

◆ AddEnum()

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

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

Reimplemented from mitk::EnumerationProperty.

◆ AddRepresentationTypes()

virtual void mitk::GridRepresentationProperty::AddRepresentationTypes ( )
protectedvirtual

Adds the enumeration types as defined by vtk to the list of known enumeration values.

◆ Clone()

Pointer mitk::GridRepresentationProperty::Clone ( ) const

◆ mitkClassMacro()

mitk::GridRepresentationProperty::mitkClassMacro ( GridRepresentationProperty  ,
EnumerationProperty   
)

◆ mitkNewMacro1Param() [1/2]

mitk::GridRepresentationProperty::mitkNewMacro1Param ( GridRepresentationProperty  ,
const IdType  
)

◆ mitkNewMacro1Param() [2/2]

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

◆ New()

static Pointer mitk::GridRepresentationProperty::New ( )
static

◆ SetRepresentationToPoints()

virtual void mitk::GridRepresentationProperty::SetRepresentationToPoints ( )
virtual

Sets the representation type to POINTS.

◆ SetRepresentationToSurface()

virtual void mitk::GridRepresentationProperty::SetRepresentationToSurface ( )
virtual

Sets the representation type to SURFACE.

◆ SetRepresentationToWireframe()

virtual void mitk::GridRepresentationProperty::SetRepresentationToWireframe ( )
virtual

Sets the representation type to WIREFRAME.

◆ SetRepresentationToWireframeSurface()

virtual void mitk::GridRepresentationProperty::SetRepresentationToWireframeSurface ( )
virtual

Sets the representation type to WIREFRAME_SURFACE.


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