Medical Imaging Interaction Toolkit  2022.10.99-122321bb
Medical Imaging Interaction Toolkit
mitk::TransferFunctionProperty Class Reference

The TransferFunctionProperty class Property class for the mitk::TransferFunction. More...

#include <mitkTransferFunctionProperty.h>

Inheritance diagram for mitk::TransferFunctionProperty:
Collaboration diagram for mitk::TransferFunctionProperty:

Public Types

typedef mitk::TransferFunction::Pointer ValueType
 
typedef TransferFunctionProperty Self
 
typedef BaseProperty Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- 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 void SetValue (mitk::TransferFunction::Pointer _arg)
 
virtual mitk::TransferFunction::Pointer GetValue () const
 
std::string GetValueAsString () const override
 
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 (mitk::TransferFunction::Pointer _arg)
 
- Static Public Member Functions inherited from mitk::BaseProperty
static const char * GetStaticNameOfClass ()
 

Protected Member Functions

 TransferFunctionProperty ()
 
 TransferFunctionProperty (const TransferFunctionProperty &other)
 
 TransferFunctionProperty (mitk::TransferFunction::Pointer value)
 
- Protected Member Functions inherited from mitk::BaseProperty
 BaseProperty ()
 
 BaseProperty (const BaseProperty &other)
 
 ~BaseProperty () override
 

Protected Attributes

mitk::TransferFunction::Pointer m_Value
 

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

The TransferFunctionProperty class Property class for the mitk::TransferFunction.

Note
If you want to use this property for an mitk::Image, make sure to set the mitk::RenderingModeProperty to a mode which supports transfer functions (e.g. COLORTRANSFERFUNCTION_COLOR). Make sure to check the documentation of the mitk::RenderingModeProperty. For a code example how to use the mitk::TransferFunction check the mitkImageVtkMapper2DTransferFunctionTest.cpp in Core/Code/Testing.

Definition at line 36 of file mitkTransferFunctionProperty.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

◆ ValueType

Constructor & Destructor Documentation

◆ TransferFunctionProperty() [1/3]

mitk::TransferFunctionProperty::TransferFunctionProperty ( )
protected

◆ TransferFunctionProperty() [2/3]

mitk::TransferFunctionProperty::TransferFunctionProperty ( const TransferFunctionProperty other)
protected

◆ TransferFunctionProperty() [3/3]

mitk::TransferFunctionProperty::TransferFunctionProperty ( mitk::TransferFunction::Pointer  value)
protected

Member Function Documentation

◆ Clone()

Pointer mitk::TransferFunctionProperty::Clone ( ) const

◆ GetClassHierarchy()

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

Reimplemented from mitk::BaseProperty.

Definition at line 41 of file mitkTransferFunctionProperty.h.

◆ GetClassName()

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

Reimplemented from mitk::BaseProperty.

◆ GetStaticNameOfClass()

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

Definition at line 41 of file mitkTransferFunctionProperty.h.

◆ GetValue()

virtual mitk::TransferFunction::Pointer mitk::TransferFunctionProperty::GetValue ( ) const
virtual

◆ GetValueAsString()

std::string mitk::TransferFunctionProperty::GetValueAsString ( ) const
overridevirtual

Reimplemented from mitk::BaseProperty.

◆ New() [1/2]

static Pointer mitk::TransferFunctionProperty::New ( )
static

◆ New() [2/2]

static Pointer mitk::TransferFunctionProperty::New ( mitk::TransferFunction::Pointer  _arg)
inlinestatic

Definition at line 46 of file mitkTransferFunctionProperty.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.

◆ SetValue()

virtual void mitk::TransferFunctionProperty::SetValue ( mitk::TransferFunction::Pointer  _arg)
virtual

Member Data Documentation

◆ m_Value

mitk::TransferFunction::Pointer mitk::TransferFunctionProperty::m_Value
protected

Definition at line 56 of file mitkTransferFunctionProperty.h.


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