The TransferFunctionProperty class Property class for the mitk::TransferFunction. More...
#include <mitkTransferFunctionProperty.h>
Public Types | |
| typedef mitk::TransferFunction::Pointer | ValueType |
| typedef TransferFunctionProperty | Self |
| typedef BaseProperty | Superclass |
| typedef itk::SmartPointer< Self > | Pointer |
| typedef itk::SmartPointer< const Self > | ConstPointer |
 Public Types inherited from mitk::BaseProperty | |
| typedef BaseProperty | Self |
| typedef itk::Object | Superclass |
| typedef itk::SmartPointer< Self > | Pointer |
| typedef itk::SmartPointer< const Self > | ConstPointer |
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 |
| bool | ToJSON (nlohmann::json &j) const override |
| Serialize property value(s) to JSON. More... | |
| bool | FromJSON (const nlohmann::json &j) override |
| Deserialize property value(s) from JSON. More... | |
| BaseProperty & | operator= (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... | |
| BaseProperty & | operator= (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
| typedef itk::SmartPointer<const Self> mitk::TransferFunctionProperty::ConstPointer |
Definition at line 41 of file mitkTransferFunctionProperty.h.
◆ Pointer
Definition at line 41 of file mitkTransferFunctionProperty.h.
◆ Self
Definition at line 41 of file mitkTransferFunctionProperty.h.
◆ Superclass
Definition at line 41 of file mitkTransferFunctionProperty.h.
◆ ValueType
Definition at line 39 of file mitkTransferFunctionProperty.h.
Constructor & Destructor Documentation
◆ TransferFunctionProperty() [1/3]
|
protected |
◆ TransferFunctionProperty() [2/3]
|
protected |
◆ TransferFunctionProperty() [3/3]
|
protected |
Member Function Documentation
◆ Clone()
| Pointer mitk::TransferFunctionProperty::Clone | ( | ) | const |
◆ FromJSON()
|
overridevirtual |
Deserialize property value(s) from JSON.
Rely on exceptions for error handling when implementing deserialization.
- Returns
- False if not deserializable by design, true otherwise.
Implements mitk::BaseProperty.
◆ GetClassHierarchy()
|
inlineoverridevirtual |
Reimplemented from mitk::BaseProperty.
Definition at line 41 of file mitkTransferFunctionProperty.h.
◆ GetClassName()
|
virtual |
Reimplemented from mitk::BaseProperty.
◆ GetStaticNameOfClass()
|
inlinestatic |
Definition at line 41 of file mitkTransferFunctionProperty.h.
◆ GetValue()
|
virtual |
◆ GetValueAsString()
|
overridevirtual |
Reimplemented from mitk::BaseProperty.
◆ New() [1/2]
|
static |
◆ New() [2/2]
|
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 |
◆ ToJSON()
|
overridevirtual |
Serialize property value(s) to JSON.
Rely on exceptions for error handling when implementing serialization.
- Returns
- False if not serializable by design, true otherwise.
Implements mitk::BaseProperty.
Member Data Documentation
◆ m_Value
|
protected |
Definition at line 59 of file mitkTransferFunctionProperty.h.
The documentation for this class was generated from the following file:
