Medical Imaging Interaction Toolkit  2018.4.99-3e3f1a6e
Medical Imaging Interaction Toolkit
mitk::VtkVolumeRenderingProperty Class Reference

#include <mitkVtkVolumeRenderingProperty.h>

Inheritance diagram for mitk::VtkVolumeRenderingProperty:
Collaboration diagram for mitk::VtkVolumeRenderingProperty:

Public Types

typedef VtkVolumeRenderingProperty 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 GetRenderingType ()
 
virtual void SetRenderingTypeToMIP ()
 
virtual void SetRenderingTypeToComposite ()
 
- 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 ()
 
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 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

 VtkVolumeRenderingProperty ()
 
 VtkVolumeRenderingProperty (const IdType &value)
 
 VtkVolumeRenderingProperty (const std::string &value)
 
bool AddEnum (const std::string &name, const IdType &id) override
 
virtual void AddRenderingTypes ()
 
- 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 for volume rendering. Valid values are (VTK constant/Id/string representation): VTK_VOLUME_RAY_CAST_MIP_FUNCTION VTK_RAY_CAST_COMPOSITE_FUNCTION Default is nullptr

Definition at line 34 of file mitkVtkVolumeRenderingProperty.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ VtkVolumeRenderingProperty() [1/3]

mitk::VtkVolumeRenderingProperty::VtkVolumeRenderingProperty ( )
protected

Sets rendering type to default (VTK_RAY_CAST_COMPOSITE_FUNCTION).

Definition at line 16 of file mitkVtkVolumeRenderingProperty.cpp.

References AddRenderingTypes(), mitk::EnumerationProperty::SetValue(), and VTK_RAY_CAST_COMPOSITE_FUNCTION.

◆ VtkVolumeRenderingProperty() [2/3]

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

Constructor. Sets rendering type to the given value.

Definition at line 22 of file mitkVtkVolumeRenderingProperty.cpp.

References AddRenderingTypes(), mitk::EnumerationProperty::IsValidEnumerationValue(), MITK_INFO, and mitk::EnumerationProperty::SetValue().

◆ VtkVolumeRenderingProperty() [3/3]

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

Constructor. Sets rendering type to the given value.

Definition at line 33 of file mitkVtkVolumeRenderingProperty.cpp.

References AddRenderingTypes(), mitk::EnumerationProperty::IsValidEnumerationValue(), MITK_INFO, and mitk::EnumerationProperty::SetValue().

Member Function Documentation

◆ AddEnum()

bool mitk::VtkVolumeRenderingProperty::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.

Definition at line 65 of file mitkVtkVolumeRenderingProperty.cpp.

References mitk::EnumerationProperty::AddEnum().

Referenced by AddRenderingTypes().

◆ AddRenderingTypes()

void mitk::VtkVolumeRenderingProperty::AddRenderingTypes ( )
protectedvirtual

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

Definition at line 59 of file mitkVtkVolumeRenderingProperty.cpp.

References AddEnum(), VTK_RAY_CAST_COMPOSITE_FUNCTION, and VTK_VOLUME_RAY_CAST_MIP_FUNCTION.

Referenced by VtkVolumeRenderingProperty().

◆ Clone()

Pointer mitk::VtkVolumeRenderingProperty::Clone ( ) const

◆ GetClassHierarchy()

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

Reimplemented from mitk::EnumerationProperty.

Definition at line 37 of file mitkVtkVolumeRenderingProperty.h.

◆ GetClassName()

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

Reimplemented from mitk::EnumerationProperty.

◆ GetRenderingType()

int mitk::VtkVolumeRenderingProperty::GetRenderingType ( )
virtual

Returns the current volume rendering type

Definition at line 44 of file mitkVtkVolumeRenderingProperty.cpp.

References mitk::EnumerationProperty::GetValueAsId().

◆ GetStaticNameOfClass()

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

Definition at line 37 of file mitkVtkVolumeRenderingProperty.h.

◆ New() [1/3]

static Pointer mitk::VtkVolumeRenderingProperty::New ( )
static

◆ New() [2/3]

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

Definition at line 43 of file mitkVtkVolumeRenderingProperty.h.

◆ New() [3/3]

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

Definition at line 45 of file mitkVtkVolumeRenderingProperty.h.

◆ SetRenderingTypeToComposite()

void mitk::VtkVolumeRenderingProperty::SetRenderingTypeToComposite ( )
virtual

Sets the rendering type to VTK_RAY_CAST_COMPOSITE_FUNCTION

Definition at line 54 of file mitkVtkVolumeRenderingProperty.cpp.

References mitk::EnumerationProperty::SetValue(), and VTK_RAY_CAST_COMPOSITE_FUNCTION.

◆ SetRenderingTypeToMIP()

void mitk::VtkVolumeRenderingProperty::SetRenderingTypeToMIP ( )
virtual

Sets the rendering type to VTK_VOLUME_RAY_CAST_MIP_FUNCTION

Definition at line 49 of file mitkVtkVolumeRenderingProperty.cpp.

References mitk::EnumerationProperty::SetValue(), and VTK_VOLUME_RAY_CAST_MIP_FUNCTION.


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