Colormap.hpp File Reference

Colormap. More...

Go to the source code of this file.

Classes
class	NAV::Colormap
	Colormap class. More...

Enumerations
enum class	NAV::ColormapMaskType : int {   None ,   Global ,   Flow }
	Type of the Colormap mask. More...

Functions
bool	NAV::ColormapButton (const char *label, Colormap &cmap, const ImVec2 &size_arg)
	Display a colormap button.
std::optional< std::reference_wrapper< const Colormap > >	NAV::ColormapSearch (const ColormapMaskType &type, const int64_t &id)
	Searches for the colormap in the Global and Flow colormaps.
void	NAV::from_json (const json &j, Colormap &cmap)
	Converts the provided json object into a struct.
bool	NAV::ShowColormapSelector (ColormapMaskType &type, int64_t &id, const char *label="")
	Shows a combobox to select a colormap.
void	NAV::to_json (json &j, const Colormap &cmap)
	Converts the provided object into a json object.

Variables
std::vector< Colormap >	NAV::ColormapsFlow
	Flow colormaps.
std::vector< Colormap >	NAV::ColormapsGlobal
	Global colormaps.

Detailed Description

Colormap.

Author

T. Topp (topp@.nosp@m.ins..nosp@m.uni-s.nosp@m.tutt.nosp@m.gart..nosp@m.de)

Date

2023-09-22

Enumeration Type Documentation

ColormapMaskType

enum class NAV::ColormapMaskType : int

strong

Type of the Colormap mask.

Enumerator
None	Do not use a colormap mask.
Global	Use the global colormap.
Flow	Use the flow colormap.

Function Documentation

ColormapButton()

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

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

ColormapSearch()

std::optional< std::reference_wrapper< const Colormap > > NAV::ColormapSearch	(	const ColormapMaskType &	type,
		const int64_t &	id )

Searches for the colormap in the Global and Flow colormaps.

Parameters

type	Type of the colormap (global or flow)
id	Id of the colormap

Returns

The colormap if one could be found

from_json()

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

Converts the provided json object into a struct.

Parameters

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

ShowColormapSelector()

bool NAV::ShowColormapSelector	(	ColormapMaskType &	type,
		int64_t &	id,
		const char *	label = "" )

Shows a combobox to select a colormap.

Parameters

[in,out]	type	Type of the selected colormap
[in,out]	id	Id of the selected colormap
[in]	label	Unique ImGui Id

Returns

True if a change was made

to_json()

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

Converts the provided object into a json object.

Parameters

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