NAV::Colormap Class Reference

Colormap class. More...

Public Member Functions
void	addColor (double value, ImColor color)
	Add a color with value.
	Colormap ()
	Constructor.
ImColor	getColor (double value, const ImColor &defaultColor) const
	Gets the color for the given value.
const std::vector< std::pair< double, ImColor > > &	getColormap () const
	Return the map.
int64_t	getId () const
	Return the id of the colormap.
void	removeColor (size_t idx)
	Remove the entry at the index (if past the last index or empty, NoOp)

Public Attributes
bool	discrete
	Whether to have discrete changes of the colors or continuous.
std::string	name
	Name of the Colormap.
size_t	version
	Version, to tell nodes that the colormap was updated.

Private Member Functions
void	render () const
	Renders the colormap.
void	render (const ImRect &bounds) const
	Renders the colormap.

Private Attributes
std::vector< std::pair< double, ImColor > >	colormap
	Sorted list of value/color combinations (value is active if lookup is greater or equal)
int64_t	id
	Unique id of the colormap.

Friends
void	from_json (const json &j, Colormap &cmap)
	Converts the provided json object into a struct.
bool	NAV::ColormapButton (const char *label, Colormap &cmap, const ImVec2 &size_arg)
	Display a colormap button.
void	to_json (json &j, const Colormap &cmap)
	Converts the provided object into a json object.

Detailed Description

Colormap class.

Member Function Documentation

addColor()

void NAV::Colormap::addColor	(	double	value,
		ImColor	color )

Add a color with value.

Parameters

value	Value
color	Color

getColor()

ImColor NAV::Colormap::getColor ( double value, const ImColor & defaultColor ) const

nodiscard

Gets the color for the given value.

Parameters

[in]	value	Value to look for
[in]	defaultColor	Default color to display if no enty in the colormap matches

Returns

The color for the value or the given defaultColor if nothing matches

removeColor()

void NAV::Colormap::removeColor

(

size_t

idx

)

Remove the entry at the index (if past the last index or empty, NoOp)

Parameters

idx	Index to remove

render() [1/2]

void NAV::Colormap::render ( ) const

private

Renders the colormap.

Note

Code from Implot library

render() [2/2]

void NAV::Colormap::render ( const ImRect & bounds ) const

private

Renders the colormap.

Parameters

[in]

bounds

Bounds where to draw the rect

Note

Code from Implot library

Friends And Related Symbol Documentation

from_json

void from_json ( const json & j, Colormap & cmap )

friend

Converts the provided json object into a struct.

Parameters

[in]	j	Json object with the vector values
[out]	cmap	Struct to return

NAV::ColormapButton

bool NAV::ColormapButton ( const char * label, Colormap & cmap, const ImVec2 & size_arg )

friend

Display a colormap button.

Parameters

[in]	label	Label to display on the button (unique id for ImGui)
[in,out]	cmap	Colormap to show on the button and edit in the popup
[in]	size_arg	Size of the button

Returns

True if clicked

Note

Code from Implot library

to_json

void to_json ( json & j, const Colormap & cmap )

friend

Converts the provided object into a json object.

Parameters

[out]	j	Return Json object
[in]	cmap	Colormap to convert

---

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

• /home/runner/work/INSTINCT/INSTINCT/src/util/Plot/Colormap.hpp