Color scale. More...

#include <ecvColorScale.h>

Inheritance diagram for ccColorScale:

Collaboration diagram for ccColorScale:

Classes
struct	Label
	Color scale label (value + optional text) More...

Public Types
typedef QSharedPointer< ccColorScale >	Shared
	Shared pointer type. More...

using	LabelSet = std::set< Label >
	Type of a list of custom labels. More...

Public Types inherited from ccSerializableObject
enum	DeserializationFlags { DF_POINT_COORDS_64_BITS , DF_SCALAR_VAL_32_BITS = 2 }
	Deserialization flags (bit-field) More...

typedef QMultiMap< unsigned, unsigned >	LoadedIDMap
	Map of loaded unique IDs (old ID --> new ID) More...

Public Member Functions
	ccColorScale (const QString &name, const QString &uuid=QString())
	Default constructor. More...

virtual	~ccColorScale ()
	Destructor. More...

ccColorScale::Shared	copy (const QString &uuid=QString()) const
	Creates a copy of this color scale (with a specified unique id) More...

const QString &	getName () const
	Returns name. More...

void	setName (const QString &name)
	Sets name. More...

QString	getUuid () const
	Returns unique ID. More...

void	setUuid (QString uuid)
	Sets unique ID. More...

void	generateNewUuid ()
	Generates a new unique ID. More...

bool	isRelative () const
	Returns whether scale is relative or absoute. More...

void	setRelative ()
	Sets scale as relative. More...

void	setAbsolute (double minVal, double maxVal)
	Sets scale as absolute. More...

void	getAbsoluteBoundaries (double &minVal, double &maxVal) const
	Get absolute scale boundaries. More...

bool	isLocked () const
	Returns whether scale is locked or not. More...

void	setLocked (bool state)
	Sets whether scale is locked or not. More...

LabelSet &	customLabels ()
	Returns the list of custom labels (if any) More...

const LabelSet &	customLabels () const
	Returns the list of custom labels (if any - const version) More...

void	setCustomLabels (const LabelSet &labels)
	Sets the list of custom labels (only if the scale is absolute) More...

int	stepCount () const
	Returns the current number of steps. More...

ccColorScaleElement &	step (int index)
	Access to a given step. More...

const ccColorScaleElement &	step (int index) const
	Access to a given step (const) More...

void	insert (const ccColorScaleElement &step, bool autoUpdate=true)
	Adds a step. More...

void	remove (int index, bool autoUpdate=true)
	Deletes a given step. More...

void	clear ()
	Clears all steps. More...

void	update ()
	Updates internal representation. More...

double	getRelativePosition (double value) const

const ecvColor::Rgb *	getColorByValue (double value, const ecvColor::Rgb *outOfRangeColor=nullptr) const
	Returns color by value. More...

const ecvColor::Rgb *	getColorByRelativePos (double relativePos, const ecvColor::Rgb *outOfRangeColor=nullptr) const
	Returns color by relative position in scale. More...

const ecvColor::Rgb *	getColorByRelativePos (double relativePos, unsigned steps, const ecvColor::Rgb *outOfRangeColor=nullptr) const
	Returns color by relative position in scale with a given 'resolution'. More...

const ecvColor::Rgb &	getColorByIndex (unsigned index) const
	Returns color by index. More...

bool	saveAsXML (QString filename) const
	Saves this color scale as an XML file. More...

bool	isSerializable () const override
	Returns whether object is serializable of not. More...

bool	toFile (QFile &out, short dataVersion) const override
	Saves data to binary stream. More...

short	minimumFileVersion () const override
	Returns the minimum file version required to save this instance. More...

bool	fromFile (QFile &in, short dataVersion, int flags, LoadedIDMap &oldToNewIDMap) override
	Loads data from binary stream. More...

Public Member Functions inherited from ccSerializableObject
virtual	~ccSerializableObject ()=default
	Destructor. More...

Static Public Member Functions
static ccColorScale::Shared	Create (const QString &name)
	Creates a new color scale (with auto-generated unique id) More...

static Shared	LoadFromXML (QString filename)
	Loads a color scale from an XML file. More...

Static Public Member Functions inherited from ccSerializableObject
static bool	WriteError ()
	Sends a custom error message (write error) and returns 'false'. More...

static bool	ReadError ()
	Sends a custom error message (read error) and returns 'false'. More...

static bool	MemoryError ()
	Sends a custom error message (not enough memory) and returns 'false'. More...

static bool	CorruptError ()
	Sends a custom error message (corrupted file) and returns 'false'. More...

Static Public Attributes
static const unsigned	MIN_STEPS = 2
	Minimum number of steps. More...

static const unsigned	DEFAULT_STEPS = 256
	Default number of steps for display. More...

static const unsigned	MAX_STEPS = 1024
	Maximum number of steps (internal representation) More...

Protected Member Functions
void	sort ()
	Sort elements. More...

Protected Attributes
QString	m_name
	Name. More...

QString	m_uuid
	Unique ID. More...

QList< ccColorScaleElement >	m_steps
	Elements. More...

ecvColor::Rgb	m_rgbaScale [MAX_STEPS]
	Internal representation (RGB) More...

bool	m_updated
	Internal representation validity. More...

bool	m_relative
	Whether scale is relative or not. More...

bool	m_locked
	Whether scale is locked or not. More...

double	m_absoluteMinValue
	'Absolute' minimum value More...

double	m_absoluteRange
	'Absolute' range More...

LabelSet	m_customLabels
	List of custom labels. More...

Detailed Description

Color scale.

A color scale is defined by several 'steps' corresponding to given colors. The color between each step is linearly interpolated. A valid color scale must have at least 2 steps, one at relative position 0.0 (scale start) and one at relative position 1.0 (scale end). Steps can't be defined outside this interval.

For faster access, a array of interpolated colors is maintained internally. Be sure that the 'refresh' method has been called after any modification(s) of the scale steps (position or color).

Definition at line 71 of file ecvColorScale.h.

Member Typedef Documentation

◆ LabelSet

using ccColorScale::LabelSet = std::set<Label>

Type of a list of custom labels.

Definition at line 160 of file ecvColorScale.h.

◆ Shared

typedef QSharedPointer<ccColorScale> ccColorScale::Shared

Shared pointer type.

Definition at line 74 of file ecvColorScale.h.

Constructor & Destructor Documentation

◆ ccColorScale()

ccColorScale::ccColorScale	(	const QString &	name,
		const QString &	uuid = `QString()`
	)

Default constructor.

Parameters

name	scale name
uuid	UUID (automatically generated if none is provided) Scale are 'relative' by default (can be changed afterwards, see setAbsolute). On construction they already have the two extreme steps defined (at position 0.0 and 1.0).

◆ ~ccColorScale()

virtual ccColorScale::~ccColorScale ( )

virtual

Destructor.

Member Function Documentation

◆ clear()

void ccColorScale::clear ( )

Clears all steps.

There should be at least 2 steps for the scale to be valid! Scale must not be locked.

in	input file (already opened)
dataVersion	file version (for version-specific deserialization)
flags	deserialization flags (see ccSerializableObject::DeserializationFlags)
oldToNewIDMap	map to link old IDs with new IDs

void ccColorScale::getAbsoluteBoundaries	(	double &	minVal,
		double &	maxVal
	)		const

relativePos	relative position (should be in [0;1])
outOfRangeColor	default color to return if relativePos if out of [0;1]

relativePos	relative position (must be between 0 and 1!)
steps	desired resolution (must be greater than 1 and smaller than MAX_STEPS)
outOfRangeColor	default color to return if relativePos if out of [0;1]

value	value
outOfRangeColor	default color to return if relativePos if out of [0;1]

void ccColorScale::insert	(	const ccColorScaleElement &	step,
		bool	autoUpdate = `true`
	)

void ccColorScale::remove	(	int	index,
		bool	autoUpdate = `true`
	)

void ccColorScale::setAbsolute	(	double	minVal,
		double	maxVal
	)

out	output file (already opened)
dataVersion	target file version (for forward/backward compatibility)

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ LabelSet

◆ Shared

Constructor & Destructor Documentation

◆ ccColorScale()

◆ ~ccColorScale()

Member Function Documentation

◆ clear()

◆ copy()

◆ Create()

◆ customLabels() [1/2]

◆ customLabels() [2/2]

◆ fromFile()

◆ generateNewUuid()

◆ getAbsoluteBoundaries()

◆ getColorByIndex()

◆ getColorByRelativePos() [1/2]

◆ getColorByRelativePos() [2/2]

◆ getColorByValue()

◆ getName()

◆ getRelativePosition()

◆ getUuid()

◆ insert()

◆ isLocked()

◆ isRelative()

◆ isSerializable()

◆ LoadFromXML()

◆ minimumFileVersion()

◆ remove()

◆ saveAsXML()

◆ setAbsolute()

◆ setCustomLabels()

◆ setLocked()

◆ setName()

◆ setRelative()

◆ setUuid()

◆ sort()

◆ step() [1/2]

◆ step() [2/2]

◆ stepCount()

◆ toFile()

◆ update()

Member Data Documentation

◆ DEFAULT_STEPS

◆ m_absoluteMinValue

◆ m_absoluteRange

◆ m_customLabels

◆ m_locked

◆ m_name

◆ m_relative

◆ m_rgbaScale

◆ m_steps

◆ m_updated

◆ m_uuid

◆ MAX_STEPS

◆ MIN_STEPS