mitk::ColorProperty Class Reference

The ColorProperty class RGB color property. More...

#include <mitkColorProperty.h>

Inheritance diagram for mitk::ColorProperty:

Collaboration diagram for mitk::ColorProperty:

Public Types
typedef mitk::Color	ValueType

Public Member Functions
	mitkClassMacro (ColorProperty, BaseProperty)
Pointer	Clone () const
	mitkNewMacro1Param (ColorProperty, const float *)
	mitkNewMacro1Param (ColorProperty, const mitk::Color &)
	mitkNewMacro3Param (ColorProperty, const float, const float, const float)
const mitk::Color &	GetColor () const
const mitk::Color &	GetValue () const
std::string	GetValueAsString () const override
void	SetColor (const mitk::Color &color)
void	SetValue (const mitk::Color &color)
void	SetColor (float red, float green, float blue)
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
	mitkClassMacroItkParent (BaseProperty, itk::Object)
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 Pointer	New ()

Protected Member Functions
	ColorProperty ()
	ColorProperty (const ColorProperty &other)
	ColorProperty (const float red, const float green, const float blue)
	ColorProperty (const float color[3])
	ColorProperty (const mitk::Color &color)
Protected Member Functions inherited from mitk::BaseProperty
	BaseProperty ()
	BaseProperty (const BaseProperty &other)
	~BaseProperty () override

Protected Attributes
mitk::Color	m_Color

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 ColorProperty class RGB color property.

Note

If you want to apply the mitk::ColorProperty to an mitk::Image make sure to set the mitk::RenderingModeProperty to a mode which supports color (e.g. LEVELWINDOW_COLOR). For an example how to use the mitk::ColorProperty see mitkImageVtkMapper2DColorTest.cpp in Core/Code/Rendering.

Definition at line 57 of file mitkColorProperty.h.

Member Typedef Documentation

ValueType

typedef mitk::Color mitk::ColorProperty::ValueType

Definition at line 79 of file mitkColorProperty.h.

Constructor & Destructor Documentation

ColorProperty() [1/5]

mitk::ColorProperty::ColorProperty ( )

protected

ColorProperty() [2/5]

mitk::ColorProperty::ColorProperty ( const ColorProperty &  other )

protected

ColorProperty() [3/5]

mitk::ColorProperty::ColorProperty ( const float  red, const float  green, const float  blue  )

protected

ColorProperty() [4/5]

mitk::ColorProperty::ColorProperty ( const float  color[3] )

protected

ColorProperty() [5/5]

mitk::ColorProperty::ColorProperty ( const mitk::Color &  color )

protected

Member Function Documentation

Clone()

Pointer mitk::ColorProperty::Clone

(

)

const

FromJSON()

bool mitk::ColorProperty::FromJSON ( const nlohmann::json &  j )

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.

GetColor()

const mitk::Color& mitk::ColorProperty::GetColor

(

)

const

GetValue()

const mitk::Color& mitk::ColorProperty::GetValue

(

)

const

GetValueAsString()

std::string mitk::ColorProperty::GetValueAsString ( ) const

overridevirtual

Reimplemented from mitk::BaseProperty.

mitkClassMacro()

mitk::ColorProperty::mitkClassMacro	(	ColorProperty	,
		BaseProperty
	)

mitkNewMacro1Param() [1/2]

mitk::ColorProperty::mitkNewMacro1Param	(	ColorProperty	,
		const float *
	)

mitkNewMacro1Param() [2/2]

mitk::ColorProperty::mitkNewMacro1Param	(	ColorProperty	,
		const mitk::Color &
	)

mitkNewMacro3Param()

mitk::ColorProperty::mitkNewMacro3Param	(	ColorProperty	,
		const float	,
		const float	,
		const float
	)

New()

static Pointer mitk::ColorProperty::New ( )

static

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.

SetColor() [1/2]

void mitk::ColorProperty::SetColor

(

const mitk::Color &

color

)

SetColor() [2/2]

void mitk::ColorProperty::SetColor	(	float	red,
		float	green,
		float	blue
	)

SetValue()

void mitk::ColorProperty::SetValue

(

const mitk::Color &

color

)

ToJSON()

bool mitk::ColorProperty::ToJSON ( nlohmann::json &  j ) const

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_Color

mitk::Color mitk::ColorProperty::m_Color

protected

Definition at line 60 of file mitkColorProperty.h.

---

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

• mitkColorProperty.h