Medical Imaging Interaction Toolkit  2018.4.99-bd7b41ba
Medical Imaging Interaction Toolkit
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 ColorProperty Self
 
typedef BaseProperty Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef mitk::Color ValueType
 
- 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
 
const mitk::ColorGetColor () const
 
const mitk::ColorGetValue () 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)
 
- 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 float *_arg)
 
static Pointer New (const mitk::Color &_arg)
 
static Pointer New (const float _arga, const float _argb, const float _argc)
 
- Static Public Member Functions inherited from mitk::BaseProperty
static const char * GetStaticNameOfClass ()
 

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.

Definition at line 47 of file mitkColorProperty.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

Definition at line 63 of file mitkColorProperty.h.

◆ Superclass

◆ ValueType

Constructor & Destructor Documentation

◆ ColorProperty() [1/5]

mitk::ColorProperty::ColorProperty ( )
protected

Definition at line 16 of file mitkColorProperty.cpp.

◆ ColorProperty() [2/5]

mitk::ColorProperty::ColorProperty ( const ColorProperty other)
protected

Definition at line 20 of file mitkColorProperty.cpp.

◆ ColorProperty() [3/5]

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

Definition at line 28 of file mitkColorProperty.cpp.

References m_Color.

◆ ColorProperty() [4/5]

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

Definition at line 24 of file mitkColorProperty.cpp.

◆ ColorProperty() [5/5]

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

Definition at line 33 of file mitkColorProperty.cpp.

References m_Color.

Member Function Documentation

◆ Clone()

Pointer mitk::ColorProperty::Clone ( ) const

◆ GetClassHierarchy()

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

Reimplemented from mitk::BaseProperty.

Definition at line 63 of file mitkColorProperty.h.

◆ GetClassName()

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

Reimplemented from mitk::BaseProperty.

◆ GetColor()

◆ GetStaticNameOfClass()

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

Definition at line 63 of file mitkColorProperty.h.

◆ GetValue()

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

Definition at line 80 of file mitkColorProperty.cpp.

References GetColor().

Referenced by GetValueAsString().

◆ GetValueAsString()

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

Reimplemented from mitk::BaseProperty.

Definition at line 73 of file mitkColorProperty.cpp.

References GetValue().

◆ New() [1/4]

static Pointer mitk::ColorProperty::New ( )
static

Referenced by mitk::OtsuTool3D::Activated(), mitk::BinaryThresholdTool::BinaryThresholdTool(), mitk::BinaryThresholdULTool::BinaryThresholdULTool(), QmitkSurfaceBasedInterpolatorWidget::ChangeSurfaceColor(), QmitkSlicesInterpolator::ChangeSurfaceColor(), mitk::LiveWireTool2D::ClearSegmentation(), mitk::PickingTool::ConfirmSegmentation(), mitk::ExampleInteractor::ConnectActionsAndFunctions(), QmitkBoundingObjectWidget::CreateBoundingObject(), mitk::Tool::CreateSegmentationNode(), mitk::AffineBaseDataInteractor3D::DataNodeChanged(), mitk::BoundingShapeInteractor::DataNodeChanged(), mitk::RTStructureSetReaderService::DoRead(), mitk::UnstructuredGridMapper2D::GenerateDataForRenderer(), QmitkScalarBarOverlay::GetProperties(), QmitkDataNodeColorAction::InitializeWithDataNode(), mitk::PointSetDataInteractor::InitMove(), mitk::ContourModelGLMapper2DBase::InternalDrawContour(), mitkImageVtkMapper2DColorTest(), mitkPropertySerializationTest(), mitkViewportRenderingTest(), mitk::PickingTool::PickingTool(), QmitkSlicesInterpolator::QmitkSlicesInterpolator(), QmitkSurfaceBasedInterpolatorWidget::QmitkSurfaceBasedInterpolatorWidget(), mitk::BoundingShapeInteractor::RestoreNodeProperties(), QmitkAdaptiveRegionGrowingToolGUI::RunSegmentation(), SaveSliceOrImageAsPNG(), mitk::Label::SetColor(), mitk::Annotation::SetColor(), mitk::DataNode::SetColor(), mitk::PlanarFigureObjectFactory::SetDefaultProperties(), mitk::ContourModelGLMapper2D::SetDefaultProperties(), mitk::GizmoMapper2D::SetDefaultProperties(), mitk::ContourModelSetGLMapper2D::SetDefaultProperties(), mitk::UnstructuredGridVtkMapper3D::SetDefaultProperties(), mitk::SurfaceVtkMapper2D::SetDefaultProperties(), mitk::EnhancedPointSetVtkMapper3D::SetDefaultProperties(), mitk::ContourModelSetMapper3D::SetDefaultProperties(), mitk::ContourModelMapper2D::SetDefaultProperties(), mitk::ContourModelMapper3D::SetDefaultProperties(), mitk::SurfaceVtkMapper3D::SetDefaultProperties(), mitk::PointSetVtkMapper3D::SetDefaultProperties(), mitk::PlanarFigureMapper2D::SetDefaultProperties(), mitk::RegEvaluationMapper2D::SetDefaultProperties(), mitk::ImageVtkMapper2D::SetDefaultProperties(), mitk::DoseImageVtkMapper2D::SetDefaultProperties(), mitk::FeedbackContourTool::SetFeedbackContourColor(), mitk::FeedbackContourTool::SetFeedbackContourColorDefault(), QmitkInteractiveTransformationWidget::SetToolToEdit(), QmitkNavigationToolCreationWidget::ShowToolPreview(), QmitkSurfaceBasedInterpolatorWidget::StopUpdateInterpolationTimer(), QmitkSlicesInterpolator::StopUpdateInterpolationTimer(), TestDataStorage(), mitk::ShowSegmentationAsSmoothedSurface::ThreadedUpdateSuccessful(), mitk::ShowSegmentationAsSurface::ThreadedUpdateSuccessful(), and QmitkTextOverlay::UpdateFontProperties().

◆ New() [2/4]

static Pointer mitk::ColorProperty::New ( const float *  _arg)
inlinestatic

Definition at line 65 of file mitkColorProperty.h.

◆ New() [3/4]

static Pointer mitk::ColorProperty::New ( const mitk::Color _arg)
inlinestatic

Definition at line 66 of file mitkColorProperty.h.

◆ New() [4/4]

static Pointer mitk::ColorProperty::New ( const float  _arga,
const float  _argb,
const float  _argc 
)
inlinestatic

Definition at line 67 of file mitkColorProperty.h.

◆ SetColor() [1/2]

void mitk::ColorProperty::SetColor ( const mitk::Color color)

◆ SetColor() [2/2]

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

Definition at line 67 of file mitkColorProperty.cpp.

References SetColor().

◆ SetValue()

void mitk::ColorProperty::SetValue ( const mitk::Color color)

Definition at line 62 of file mitkColorProperty.cpp.

References SetColor().

Member Data Documentation

◆ m_Color

mitk::Color mitk::ColorProperty::m_Color
protected

Definition at line 50 of file mitkColorProperty.h.

Referenced by ColorProperty(), GetColor(), and SetColor().


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