Implementation of a color_scale with a discrete input domain and output range using a discrete_color_scheme. More...

#include <color_scale.h>

Inheritance diagram for cgv::media::discrete_color_scale:

Public Member Functions
	discrete_color_scale (const discrete_color_scheme &scheme, size_t size)
	Construct using the given color scheme and size.

bool	is_discrete () const override
	See color_scale::is_discrete().

bool	is_opaque () const override
	See color_scale::is_opaque().

float	normalize_value (float value) const override
	See color_scale::normalize_value().

cgv::rgb	get_mapped_color (float value) const override
	Map a value through the scale and return a RGB color.

cgv::rgba	get_indexed_color (size_t index) const override
	Return the RGBA color with the given index.

size_t	get_indexed_color_count () const override
	See color_scale::get_indexed_color_count().

std::vector< cgv::rgba >	quantize (size_t count) const override
	Return a sequence of all indexed colors, ignoring count.

std::vector< float >	get_ticks (size_t request_count) const override
	Not implemented for discrete color scales.

void	set_scheme (const discrete_color_scheme &scheme, size_t size)
	Set the color scheme and size used as this scale's indexed color source.

discrete_color_scheme	get_scheme () const
	Get the color scheme used as this scale's indexed color source.

Public Member Functions inherited from cgv::media::color_scale
virtual	~color_scale ()
	Destruct this color scale.

virtual void	set_domain (cgv::vec2 domain)
	Set the input domain of scalars that will be mapped.

cgv::vec2	get_domain () const
	Get the input domain of scalars that will be mapped.

virtual void	set_clamped (bool clamped)
	Set whether the input values are clamped to the domain before mapping.

bool	is_clamped () const
	Get whether the input values are clamped to the domain before mapping.

virtual void	set_reversed (bool reverse)
	Set whether the output color ramp is reversed.

bool	is_reversed () const
	Get whether the output color ramp is reversed.

virtual void	set_unknown_color (cgv::rgba color)
	Set the color returned for scalars outside the domain if clamping is disabled.

cgv::rgba	get_unknown_color () const
	Get the color returned for scalars outside the domain if clamping is disabled.

virtual cgv::rgba	map_value (float value) const
	Map a value through the scale and return a RGBA color.

virtual float	get_mapped_opacity (float value) const
	Map a value through the scale and return an opacity.

cgv::data::time_point	get_modified_time () const
	Get the time point of the last modification of this object.

Additional Inherited Members
Protected Member Functions inherited from cgv::media::color_scale
void	modified ()
	Update the object's modified time.

bool	is_unknown (float value) const
	Test whether the value is outside the domain according to the mapping options.

float	map_range_safe (float value, float in_left, float in_right, float out_left, float out_right) const
	Remap a scalar value from an input range to and output range while safely handling empty ranges.

Detailed Description

Implementation of a color_scale with a discrete input domain and output range using a discrete_color_scheme.

The scale is mainly used for mapping discrete indices to discrete colors for, e.g., categorical data. Additionally, discrete_color_scale supports mapping continuous input values to discrete colors.

Definition at line 373 of file color_scale.h.