Medical Imaging Interaction Toolkit  2023.12.00
Medical Imaging Interaction Toolkit
mitk::ColorSequenceCycleH Class Reference

Creates a list of around 36 different colors, where one is easily distinguished from the preceding one. More...

#include <mitkColorSequenceCycleH.h>

Inheritance diagram for mitk::ColorSequenceCycleH:
Collaboration diagram for mitk::ColorSequenceCycleH:

Public Member Functions

 ColorSequenceCycleH ()
 
 ~ColorSequenceCycleH () override
 
Color GetNextColor () override
 Return another color. More...
 
void GoToBegin () override
 Rewind to first color. More...
 
virtual void ChangeHueValueByCycleSteps (int steps)
 Increase the used Hue value. This can be done by steps ( = steps * 60 increase of Hue ) or absolute ( 0.0 < Hue < 360.0). Can also be used to decrease the Hue; Values < 0 are cropped to 0. Note: This does not change the other values, i.e. the color cycle. Therefor, the method can just be used to skip steps (i.e. colors) in a cycle. Use SetColorCycle if you want to change other values. More...
 
virtual void ChangeHueValueByAbsoluteNumber (float number)
 
virtual void SetColorCycle (unsigned short cycle)
 Set the color cycle. The color cycle has to be an integer value between 0 and 5 (see class description for an explanation). Use this in combination with the hue value cahnge to generate your dream colors... More...
 
- Public Member Functions inherited from mitk::ColorSequence
 ColorSequence ()
 
virtual ~ColorSequence ()
 

Protected Attributes

float color_h
 
float color_s
 
float color_v
 
unsigned short color_cycle
 

Detailed Description

Creates a list of around 36 different colors, where one is easily distinguished from the preceding one.

The list of colors starts with a fully saturated, full valued red (Hue = 0 = 360). After that the sequence is generated like this:

  • first cycle through fully saturated colors (increase hue by 60)
  • then cycle through colors with halfed saturation (increase hue by 60)
  • then cycle through colors with halfed value (increase hue by 60)

Finally repeat colors.

Definition at line 33 of file mitkColorSequenceCycleH.h.

Constructor & Destructor Documentation

◆ ColorSequenceCycleH()

mitk::ColorSequenceCycleH::ColorSequenceCycleH ( )

◆ ~ColorSequenceCycleH()

mitk::ColorSequenceCycleH::~ColorSequenceCycleH ( )
override

Member Function Documentation

◆ ChangeHueValueByAbsoluteNumber()

virtual void mitk::ColorSequenceCycleH::ChangeHueValueByAbsoluteNumber ( float  number)
virtual

◆ ChangeHueValueByCycleSteps()

virtual void mitk::ColorSequenceCycleH::ChangeHueValueByCycleSteps ( int  steps)
virtual

Increase the used Hue value. This can be done by steps ( = steps * 60 increase of Hue ) or absolute ( 0.0 < Hue < 360.0). Can also be used to decrease the Hue; Values < 0 are cropped to 0. Note: This does not change the other values, i.e. the color cycle. Therefor, the method can just be used to skip steps (i.e. colors) in a cycle. Use SetColorCycle if you want to change other values.

◆ GetNextColor()

Color mitk::ColorSequenceCycleH::GetNextColor ( )
overridevirtual

Return another color.

Implements mitk::ColorSequence.

◆ GoToBegin()

void mitk::ColorSequenceCycleH::GoToBegin ( )
overridevirtual

Rewind to first color.

Implements mitk::ColorSequence.

◆ SetColorCycle()

virtual void mitk::ColorSequenceCycleH::SetColorCycle ( unsigned short  cycle)
virtual

Set the color cycle. The color cycle has to be an integer value between 0 and 5 (see class description for an explanation). Use this in combination with the hue value cahnge to generate your dream colors...

Member Data Documentation

◆ color_cycle

unsigned short mitk::ColorSequenceCycleH::color_cycle
protected

Definition at line 75 of file mitkColorSequenceCycleH.h.

◆ color_h

float mitk::ColorSequenceCycleH::color_h
protected

Definition at line 71 of file mitkColorSequenceCycleH.h.

◆ color_s

float mitk::ColorSequenceCycleH::color_s
protected

Definition at line 72 of file mitkColorSequenceCycleH.h.

◆ color_v

float mitk::ColorSequenceCycleH::color_v
protected

Definition at line 73 of file mitkColorSequenceCycleH.h.


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