Medical Imaging Interaction Toolkit  2024.06.00
Medical Imaging Interaction Toolkit
mitk::VtkRepresentationProperty Class Reference

#include <mitkVtkRepresentationProperty.h>

Inheritance diagram for mitk::VtkRepresentationProperty:
Collaboration diagram for mitk::VtkRepresentationProperty:

Public Types

typedef VtkRepresentationProperty Self
 
typedef EnumerationProperty Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- 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

virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
virtual int GetVtkRepresentation ()
 
virtual void SetRepresentationToPoints ()
 
virtual void SetRepresentationToWireframe ()
 
virtual void SetRepresentationToSurface ()
 
BasePropertyoperator= (const BaseProperty &property)
 Assigns property to this BaseProperty instance. More...
 
- Public Member Functions inherited from mitk::EnumerationProperty
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 ()
 
bool ToJSON (nlohmann::json &j) const override
 
bool FromJSON (const nlohmann::json &j) override
 
EnumerationPropertyoperator= (const EnumerationProperty &)=delete
 
BasePropertyoperator= (const BaseProperty &property)
 Assigns property to this BaseProperty instance. More...
 
- 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 const char * GetStaticNameOfClass ()
 
static Pointer New ()
 
static Pointer New (const IdType &_arg)
 
static Pointer New (const std::string &_arg)
 
- 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

 VtkRepresentationProperty ()
 
 VtkRepresentationProperty (const IdType &value)
 
 VtkRepresentationProperty (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

Encapsulates the enumeration vtkRepresentation. Valid values are (VTK constant/Id/string representation): VTK_POINTS/0/Points, VTK_WIREFRAME/1/Wireframe, VTK_SURFACE/2/Surface Default is the Surface representation

Definition at line 31 of file mitkVtkRepresentationProperty.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ VtkRepresentationProperty() [1/3]

mitk::VtkRepresentationProperty::VtkRepresentationProperty ( )
protected

Constructor. Sets the representation to a default value of Surface(2)

◆ VtkRepresentationProperty() [2/3]

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

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

Parameters
valuethe integer representation of the representation

◆ VtkRepresentationProperty() [3/3]

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

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

Parameters
valuethe string representation of the representation

Member Function Documentation

◆ AddEnum()

bool mitk::VtkRepresentationProperty::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::VtkRepresentationProperty::AddRepresentationTypes ( )
protectedvirtual

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

◆ Clone()

Pointer mitk::VtkRepresentationProperty::Clone ( ) const

◆ GetClassHierarchy()

virtual std::vector<std::string> mitk::VtkRepresentationProperty::GetClassHierarchy ( ) const
inlineoverridevirtual

Reimplemented from mitk::EnumerationProperty.

Definition at line 34 of file mitkVtkRepresentationProperty.h.

◆ GetClassName()

virtual const char* mitk::VtkRepresentationProperty::GetClassName ( ) const
virtual

Reimplemented from mitk::EnumerationProperty.

◆ GetStaticNameOfClass()

static const char* mitk::VtkRepresentationProperty::GetStaticNameOfClass ( )
inlinestatic

Definition at line 34 of file mitkVtkRepresentationProperty.h.

◆ GetVtkRepresentation()

virtual int mitk::VtkRepresentationProperty::GetVtkRepresentation ( )
virtual

Returns the current representation value as defined by VTK constants.

Returns
the current representation as VTK constant.

◆ New() [1/3]

static Pointer mitk::VtkRepresentationProperty::New ( )
static

◆ New() [2/3]

static Pointer mitk::VtkRepresentationProperty::New ( const IdType _arg)
inlinestatic

Definition at line 40 of file mitkVtkRepresentationProperty.h.

◆ New() [3/3]

static Pointer mitk::VtkRepresentationProperty::New ( const std::string &  _arg)
inlinestatic

Definition at line 42 of file mitkVtkRepresentationProperty.h.

◆ 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.

◆ SetRepresentationToPoints()

virtual void mitk::VtkRepresentationProperty::SetRepresentationToPoints ( )
virtual

Sets the representation type to VTK_POINTS.

◆ SetRepresentationToSurface()

virtual void mitk::VtkRepresentationProperty::SetRepresentationToSurface ( )
virtual

Sets the representation type to VTK_SURFACE.

◆ SetRepresentationToWireframe()

virtual void mitk::VtkRepresentationProperty::SetRepresentationToWireframe ( )
virtual

Sets the representation type to VTK_WIREFRAME.


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