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

#include <mitkGridVolumeMapperProperty.h>

Inheritance diagram for mitk::GridVolumeMapperProperty:
Collaboration diagram for mitk::GridVolumeMapperProperty:

Public Types

enum  MapperType { RAYCAST, PT, ZSWEEP }
 
- 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 (GridVolumeMapperProperty, EnumerationProperty)
 
Pointer Clone () const
 
 mitkNewMacro1Param (GridVolumeMapperProperty, const IdType &)
 
 mitkNewMacro1Param (GridVolumeMapperProperty, const std::string &)
 
virtual void SetVolumeMapperToPT ()
 
virtual void SetVolumeMapperToZSweep ()
 
virtual void SetVolumeMapperToRayCast ()
 
- 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 ()
 
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 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

 GridVolumeMapperProperty ()
 
 GridVolumeMapperProperty (const IdType &value)
 
 GridVolumeMapperProperty (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): PT/0/Projected Tetrahedra, ZSWEEP/1/ZSweep, RAYCAST/2/Ray Cast Default is the Wireframe representation

Definition at line 27 of file mitkGridVolumeMapperProperty.h.

Member Enumeration Documentation

◆ MapperType

Enumerator
RAYCAST 
PT 
ZSWEEP 

Definition at line 30 of file mitkGridVolumeMapperProperty.h.

Constructor & Destructor Documentation

◆ GridVolumeMapperProperty() [1/3]

mitk::GridVolumeMapperProperty::GridVolumeMapperProperty ( )
protected

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

◆ GridVolumeMapperProperty() [2/3]

mitk::GridVolumeMapperProperty::GridVolumeMapperProperty ( 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

◆ GridVolumeMapperProperty() [3/3]

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

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

◆ Clone()

Pointer mitk::GridVolumeMapperProperty::Clone ( ) const

◆ mitkClassMacro()

mitk::GridVolumeMapperProperty::mitkClassMacro ( GridVolumeMapperProperty  ,
EnumerationProperty   
)

◆ mitkNewMacro1Param() [1/2]

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

◆ mitkNewMacro1Param() [2/2]

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

◆ New()

static Pointer mitk::GridVolumeMapperProperty::New ( )
static

◆ SetVolumeMapperToPT()

virtual void mitk::GridVolumeMapperProperty::SetVolumeMapperToPT ( )
virtual

Sets the mapper to projected tetrahedra.

◆ SetVolumeMapperToRayCast()

virtual void mitk::GridVolumeMapperProperty::SetVolumeMapperToRayCast ( )
virtual

Sets the mapper to ray casting.

◆ SetVolumeMapperToZSweep()

virtual void mitk::GridVolumeMapperProperty::SetVolumeMapperToZSweep ( )
virtual

Sets the mapper to zsweep.


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