mc_rtc::gui::plot Namespace Reference

Namespaces
	impl

Classes
struct	AxisConfiguration
struct	PolygonDescription
struct	Range

Enumerations
enum	Plot { Plot::Standard = 0, Plot::XY }
enum	Type {   Type::Abscissa, Type::Ordinate, Type::Polygon, Type::Polygons,   Type::AbscissaOrdinate }

Functions
template<typename GetT >
impl::Abscissa< GetT >	X (AxisConfiguration config, GetT get_fn)
template<typename GetT >
impl::Abscissa< GetT >	X (std::string_view legend, GetT get_fn)
template<typename UpdateCacheT , typename MaybeGetColor >
auto	XYChunk (std::string_view name, UpdateCacheT update_fn, MaybeGetColor color, Style style=Style::Solid, Side side=Side::Left)
template<typename GetXT , typename GetYT , typename MaybeGetColor >
auto	XY (std::string_view name, GetXT get_x_fn, GetYT get_y_fn, MaybeGetColor color, Style style=Style::Solid, Side side=Side::Left)
template<typename GetT >
impl::Ordinate< GetT >	Y (std::string_view name, GetT get_fn, Color color, Style style=Style::Solid, Side side=Side::Left)
template<typename GetT , typename GetColor >
impl::OrdinateWithColor< GetT, GetColor >	Y (std::string_view name, GetT get_fn, GetColor get_color, Style style=Style::Solid, Side side=Side::Left)
template<typename GetT >
impl::Polygon< GetT >	Polygon (const std::string &name, GetT get_fn, Side side=Side::Left)
template<typename GetT >
impl::Polygons< GetT >	Polygons (const std::string &name, GetT get_fn, Side side=Side::Left)
template<typename T >
constexpr bool	is_Abscissa ()
template<bool = true>
constexpr bool	is_not_Abscissa ()
template<typename T , typename... Args>
constexpr bool	is_not_Abscissa ()
template<bool = true>
constexpr bool	is_2d ()
template<typename T , typename... Args>
constexpr bool	is_2d ()

Enumeration Type Documentation

Plot

enum mc_rtc::gui::plot::Plot

strong

Describe plot types for the client

Enumerator
Standard	Identify a plot that provides an abscissa
XY	Identify a plot that provides XY legends

Type

enum mc_rtc::gui::plot::Type

strong

Distinguish plot types

Enumerator
Abscissa	This plot type is expected to return X values only
Ordinate	This plot type is expected to return Y values only
Polygon	This plot type is expected to return a list of points to plot
Polygons	This plot type is expected to return a list of polygons
AbscissaOrdinate	This plot type return (X, Y) couples

Function Documentation

is_2d() [1/2]

template<bool = true>

constexpr bool mc_rtc::gui::plot::is_2d ( )

constexpr

is_2d() [2/2]

template<typename T , typename... Args>

constexpr bool mc_rtc::gui::plot::is_2d ( )

constexpr

is_Abscissa()

template<typename T >

constexpr bool mc_rtc::gui::plot::is_Abscissa ( )

constexpr

is_not_Abscissa() [1/2]

template<bool = true>

constexpr bool mc_rtc::gui::plot::is_not_Abscissa ( )

constexpr

is_not_Abscissa() [2/2]

template<typename T , typename... Args>

constexpr bool mc_rtc::gui::plot::is_not_Abscissa ( )

constexpr

Polygon()

template<typename GetT >

impl::Polygon<GetT> mc_rtc::gui::plot::Polygon	(	const std::string &	name,
		GetT	get_fn,
		Side	side = Side::Left
	)

Helper function to create an impl::Polygon

Polygons()

template<typename GetT >

impl::Polygons<GetT> mc_rtc::gui::plot::Polygons	(	const std::string &	name,
		GetT	get_fn,
		Side	side = Side::Left
	)

Helper function to create an impl::Polygon

X() [1/2]

template<typename GetT >

impl::Abscissa<GetT> mc_rtc::gui::plot::X	(	AxisConfiguration	config,
		GetT	get_fn
	)

Helper to create an impl::Abscissa

X() [2/2]

template<typename GetT >

impl::Abscissa<GetT> mc_rtc::gui::plot::X	(	std::string_view	legend,
		GetT	get_fn
	)

Helper to create an impl::Abscissa without limits

XY()

template<typename GetXT , typename GetYT , typename MaybeGetColor >

auto mc_rtc::gui::plot::XY	(	std::string_view	name,
		GetXT	get_x_fn,
		GetYT	get_y_fn,
		MaybeGetColor	color,
		Style	style = Style::Solid,
		Side	side = Side::Left
	)

Helper to create an impl::AbscissaOrdinate|impl::AbscissaOrdinateWithColor

XYChunk()

template<typename UpdateCacheT , typename MaybeGetColor >

auto mc_rtc::gui::plot::XYChunk	(	std::string_view	name,
		UpdateCacheT	update_fn,
		MaybeGetColor	color,
		Style	style = Style::Solid,
		Side	side = Side::Left
	)

Helper to create an impl::AbscissaOrdinate|impl::AbscissaOrdinateWithColor with chunky updates

This is meant to be used to create/update graphs with a bunch of data at once

Y() [1/2]

template<typename GetT >

impl::Ordinate<GetT> mc_rtc::gui::plot::Y	(	std::string_view	name,
		GetT	get_fn,
		Color	color,
		Style	style = Style::Solid,
		Side	side = Side::Left
	)

Helper to create an impl::Ordinate

Y() [2/2]

template<typename GetT , typename GetColor >

impl::OrdinateWithColor<GetT, GetColor> mc_rtc::gui::plot::Y	(	std::string_view	name,
		GetT	get_fn,
		GetColor	get_color,
		Style	style = Style::Solid,
		Side	side = Side::Left
	)

Helper to create an impl::OrdinateWithColor