mc_rtc::gui Namespace Reference

Namespaces
	details
	plot

Classes
struct	ArrowConfig
struct	CallbackElement
struct	CallbackElement< ElementT, std::nullptr_t >
struct	Color
struct	CommonInputImpl
struct	CylinderParameters
struct	DataElement
struct	Element
struct	ForceConfig
struct	FormComboInput
struct	FormDataComboInput
struct	FormElement
struct	FormGenericArrayInput
struct	FormObjectInput
struct	FormOneOfInput
struct	LineConfig
struct	PointConfig
struct	PolyhedronConfig
struct	RobotMsgData
struct	StateBuilder
struct	VoidCallbackElement

Enumerations
enum	Elements {   Elements::Label = 0, Elements::ArrayLabel, Elements::Button, Elements::Checkbox,   Elements::StringInput, Elements::IntegerInput, Elements::NumberInput, Elements::NumberSlider,   Elements::ArrayInput, Elements::ComboInput, Elements::DataComboInput, Elements::Point3D,   Elements::Trajectory, Elements::Rotation, Elements::Transform, Elements::Schema,   Elements::Form, Elements::Polygon, Elements::Force, Elements::Arrow,   Elements::XYTheta, Elements::Table, Elements::Robot, Elements::Visual,   Elements::PolyhedronTrianglesList, Elements::PolyhedronVerticesTriangles, Elements::GenericArray, Elements::OneOf,   Elements::RobotMsg }
enum	ElementsStacking { ElementsStacking::Vertical = 0, ElementsStacking::Horizontal }
enum	LineStyle { LineStyle::Solid, LineStyle::Dotted }

Functions
template<typename GetT , typename SetT >
auto	ArrayInput (const std::string &name, GetT get_fn, SetT set_fn)
template<typename GetT , typename SetT >
auto	ArrayInput (const std::string &name, const std::vector< std::string > &labels, GetT get_fn, SetT set_fn)
template<typename T >
auto	ArrayInput (const std::string &name, const std::vector< std::string > &labels, T &value)
template<typename T >
auto	ArrayInput (const std::string &name, T &value)
template<bool Degrees = true, typename T >
auto	RPYInput (const std::string &name, T &value)
template<typename GetT , std::enable_if_t< std::is_invocable_v< GetT >, int > = 0>
auto	ArrayLabel (const std::string &name, GetT get_fn)
template<typename GetT , std::enable_if_t< std::is_invocable_v< GetT >, int > = 0>
auto	ArrayLabel (const std::string &name, const std::vector< std::string > &labels, GetT get_fn)
template<typename T , std::enable_if_t<!std::is_invocable_v< T >, int > = 0>
auto	ArrayLabel (const std::string &name, const std::vector< std::string > &labels, T &&value)
template<typename T , std::enable_if_t<!std::is_invocable_v< T >, int > = 0>
auto	ArrayLabel (const std::string &name, T &&value)
template<bool Degrees = true, typename T >
auto	RPYLabel (const std::string &name, T &&value)
template<typename GetStart , typename GetEnd >
auto	Arrow (const std::string &name, GetStart get_start_fn, GetEnd get_end_fn)
template<typename GetStart , typename GetEnd >
auto	Arrow (const std::string &name, const ArrowConfig &config, GetStart get_start_fn, GetEnd get_end_fn)
template<typename GetStart , typename SetStart , typename GetEnd , typename SetEnd >
auto	Arrow (const std::string &name, GetStart get_start_fn, SetStart set_start_fn, GetEnd get_end_fn, SetEnd set_end_fn)
template<typename GetStart , typename SetStart , typename GetEnd , typename SetEnd >
auto	Arrow (const std::string &name, const ArrowConfig &config, GetStart get_start_fn, SetStart set_start_fn, GetEnd get_end_fn, SetEnd set_end_fn)
template<typename GetPos , typename GetSize = const Eigen::Vector3d &, typename GetColor = const mc_rtc::gui::Color &>
auto	Box (const std::string &name, GetSize size_fn, GetPos get_pos_fn, GetColor color_fn=mc_rtc::gui::Color::Red)
template<typename Callback >
auto	Button (const std::string &name, Callback cb)
template<typename GetT , typename Callback >
auto	Checkbox (const std::string &name, GetT get_fn, Callback cb)
auto	Checkbox (const std::string &name, bool &value)
template<typename GetT , typename SetT >
auto	ComboInput (const std::string &name, const std::vector< std::string > &values, GetT get_fn, SetT set_fn)
auto	ComboInput (const std::string &name, const std::vector< std::string > &values, std::string &value)
template<typename GetPos , typename GetParams = const CylinderParameters &, typename GetColor = const mc_rtc::gui::Color &>
auto	Cylinder (const std::string &name, GetParams params_fn, GetPos get_pos_fn, GetColor color_fn=mc_rtc::gui::Color::Red)
template<typename GetT , typename SetT >
auto	DataComboInput (const std::string &name, const std::vector< std::string > &values, GetT get_fn, SetT set_fn)
auto	DataComboInput (const std::string &name, const std::vector< std::string > &values, std::string &value)
template<typename GetPos , typename GetSize = const Eigen::Vector3d &, typename GetColor = const mc_rtc::gui::Color &>
auto	Ellipsoid (const std::string &name, GetSize size_fn, GetPos get_pos_fn, GetColor color_fn=mc_rtc::gui::Color::Red)
template<typename GetForce , typename GetSurface >
auto	Force (const std::string &name, GetForce get_force_fn, GetSurface get_surface_fn)
template<typename GetForce , typename GetSurface >
auto	Force (const std::string &name, const ForceConfig &config, GetForce get_force_fn, GetSurface get_surface_fn)
template<typename GetForce , typename GetSurface , typename SetForce >
auto	Force (const std::string &name, GetForce get_force_fn, SetForce set_force_fn, GetSurface get_surface_fn)
template<typename GetForce , typename GetSurface , typename SetForce >
auto	Force (const std::string &name, const ForceConfig &config, GetForce get_force_fn, SetForce set_force_fn, GetSurface get_surface_fn)
template<typename T >
details::FormArrayInput< T >	FormArrayInput (const std::string &name, bool required, bool fixed_size=false)
template<typename T >
auto	FormArrayInput (const std::string &name, bool required, T &&value, bool fixed_size=true)
template<typename Callback , typename... Args>
auto	Form (const std::string &name, Callback cb, Args &&... args)
template<typename T >
auto	Input (const std::string &name, T &value)
template<typename GetT , typename SetT >
auto	IntegerInput (const std::string &name, GetT get_fn, SetT set_fn)
template<typename T >
auto	IntegerInput (const std::string &name, T &value)
template<typename GetT , std::enable_if_t< std::is_invocable_v< GetT >, int > = 0>
auto	Label (const std::string &name, GetT get_fn)
template<typename T , std::enable_if_t<!std::is_invocable_v< T >, int > = 0>
auto	Label (const std::string &name, T &&value)
template<typename GetT , typename SetT >
auto	NumberInput (const std::string &name, GetT get_fn, SetT set_fn)
template<typename T >
auto	NumberInput (const std::string &name, T &value)
template<typename GetT , typename SetT >
auto	NumberSlider (const std::string &name, GetT get_fn, SetT set_fn, double min, double max)
template<typename T >
auto	NumberSlider (const std::string &name, T &value, double min, double max)
template<typename GetT , std::enable_if_t< std::is_invocable_v< GetT >, int > = 0>
auto	Point3D (const std::string &name, GetT get_fn)
template<typename GetT , typename SetT >
auto	Point3D (const std::string &name, GetT get_fn, SetT set_fn)
template<typename GetT , std::enable_if_t< std::is_invocable_v< GetT >, int > = 0>
auto	Point3D (const std::string &name, const PointConfig &config, GetT get_fn)
template<typename GetT , typename SetT >
auto	Point3D (const std::string &name, const PointConfig &config, GetT get_fn, SetT set_fn)
template<typename T >
auto	Point3DRO (const std::string &name, T &&value)
template<typename T >
auto	Point3DRO (const std::string &name, const PointConfig &config, T &&value)
template<typename T , std::enable_if_t<!std::is_invocable_v< T >, int > = 0>
auto	Point3D (const std::string &name, T &value)
template<typename T , std::enable_if_t<!std::is_invocable_v< T >, int > = 0>
auto	Point3D (const std::string &name, const PointConfig &config, T &value)
template<typename GetT >
auto	Polygon (const std::string &name, GetT get_fn)
template<typename GetT >
auto	Polygon (const std::string &name, const Color &color, GetT get_fn)
template<typename GetT >
auto	Polygon (const std::string &name, const LineConfig &config, GetT get_fn)
template<typename GetTrianglesT >
auto	Polyhedron (const std::string &name, GetTrianglesT get_triangles_fn)
template<typename GetTrianglesT >
auto	Polyhedron (const std::string &name, const PolyhedronConfig &config, GetTrianglesT get_triangles_fn)
template<typename GetVerticesOrTrianglesT , typename GetTrianglesOrColorsT >
auto	Polyhedron (const std::string &name, GetVerticesOrTrianglesT get_vertices_or_triangles_fn, GetTrianglesOrColorsT get_triangles_or_colors_fn)
template<typename GetVerticesOrTrianglesT , typename GetTrianglesOrColorsT >
auto	Polyhedron (const std::string &name, const PolyhedronConfig &config, GetVerticesOrTrianglesT get_vertices_or_triangles_fn, GetTrianglesOrColorsT get_triangles_or_colors_fn)
template<typename GetTrianglesT , typename GetColorT >
auto	ColoredPolyhedron (const std::string &name, const PolyhedronConfig &config, GetTrianglesT get_triangles_fn, GetColorT get_color_fn)
template<typename GetVerticesT , typename GetTrianglesT , typename GetColorT >
auto	Polyhedron (const std::string &name, GetVerticesT get_vertices_fn, GetTrianglesT get_triangles_fn, GetColorT get_color_fn)
template<typename GetVerticesT , typename GetTrianglesT , typename GetColorT >
auto	Polyhedron (const std::string &name, const PolyhedronConfig &config, GetVerticesT get_vertices_fn, GetTrianglesT get_triangles_fn, GetColorT get_color_fn)
template<typename GetT >
auto	Robot (const std::string &name, GetT get_fn)
template<typename GetT >
auto	RobotMsg (const std::string &name, GetT get_fn)
template<typename GetT >
auto	Rotation (const std::string &name, GetT get_fn)
template<typename GetT , typename SetT >
auto	Rotation (const std::string &name, GetT get_fn, SetT set_fn)
template<typename Callback >
auto	Schema (const std::string &name, const std::string &schema, Callback cb)
template<typename GetPos , typename GetRadius = double, typename GetColor = const mc_rtc::gui::Color &>
auto	Sphere (const std::string &name, GetRadius radius_fn, GetPos get_pos_fn, GetColor color_fn=mc_rtc::gui::Color::Red)
template<typename GetT , typename SetT >
auto	StringInput (const std::string &name, GetT get_fn, SetT set_fn)
auto	StringInput (const std::string &name, std::string &value)
template<typename GetData >
auto	Table (const std::string &name, std::vector< std::string > header, GetData get_data_fn)
template<typename GetData >
auto	Table (const std::string &name, std::vector< std::string > header, std::vector< std::string > format, GetData get_data_fn)
template<typename GetHeader , typename GetData >
auto	Table (const std::string &name, GetHeader get_header_fn, GetData get_data_fn)
template<typename GetHeader , typename GetFormat , typename GetData >
auto	Table (const std::string &name, GetHeader get_header_fn, GetFormat get_format_fn, GetData get_data_fn)
template<typename GetT >
auto	Trajectory (const std::string &name, GetT get_fn)
template<typename GetT >
auto	Trajectory (const std::string &name, const LineConfig &config, GetT get_fn)
template<typename GetT , std::enable_if_t< std::is_invocable_v< GetT >, int > = 0>
auto	Transform (const std::string &name, GetT get_fn)
template<typename GetT , typename SetT >
auto	Transform (const std::string &name, GetT get_fn, SetT set_fn)
template<typename T >
auto	TransformRO (const std::string &name, T &&value)
template<typename T , std::enable_if_t<!std::is_invocable_v< T >, int > = 0>
auto	Transform (const std::string &name, T &value)
template<typename GetVisual , typename GetPos >
auto	Visual (const std::string &name, GetVisual get_visual_fn, GetPos get_pos_fn)
template<typename GetT , std::enable_if_t< std::is_invocable_v< GetT >, int > = 0>
auto	XYTheta (const std::string &name, GetT get_fn)
template<typename GetT , typename SetT >
auto	XYTheta (const std::string &name, GetT get_fn, SetT set_fn)

Enumeration Type Documentation

Elements

enum mc_rtc::gui::Elements

strong

An enumeration of available elements

Enumerator
Label
ArrayLabel
Button
Checkbox
StringInput
IntegerInput
NumberInput
NumberSlider
ArrayInput
ComboInput
DataComboInput
Point3D
Trajectory
Rotation
Transform
Schema
Form
Polygon
Force
Arrow
XYTheta
Table
Robot
Visual
PolyhedronTrianglesList
PolyhedronVerticesTriangles
GenericArray
OneOf
RobotMsg

ElementsStacking

enum mc_rtc::gui::ElementsStacking

strong

Describe elements stacking policy for the client

Enumerator
Vertical
Horizontal

LineStyle

enum mc_rtc::gui::LineStyle

strong

Enumerator
Solid
Dotted

Function Documentation

ArrayInput() [1/4]

template<typename GetT , typename SetT >

auto mc_rtc::gui::ArrayInput	(	const std::string &	name,
		const std::vector< std::string > &	labels,
		GetT	get_fn,
		SetT	set_fn
	)

Helper function to create an ArrayInput element (with labels)

ArrayInput() [2/4]

template<typename T >

auto mc_rtc::gui::ArrayInput	(	const std::string &	name,
		const std::vector< std::string > &	labels,
		T &	value
	)

Helper function to build an ArrayInput from a variable

ArrayInput() [3/4]

template<typename GetT , typename SetT >

auto mc_rtc::gui::ArrayInput	(	const std::string &	name,
		GetT	get_fn,
		SetT	set_fn
	)

Helper function to create an ArrayInput element (no labels)

ArrayInput() [4/4]

template<typename T >

auto mc_rtc::gui::ArrayInput	(	const std::string &	name,
		T &	value
	)

Helper function to build an ArrayInput from a variable

Labels are automatically added for certain types, see details::Labels<T>

ArrayLabel() [1/4]

template<typename GetT , std::enable_if_t< std::is_invocable_v< GetT >, int > = 0>

auto mc_rtc::gui::ArrayLabel	(	const std::string &	name,
		const std::vector< std::string > &	labels,
		GetT	get_fn
	)

Helper function to build an ArrayLabelImpl (with labels)

ArrayLabel() [2/4]

template<typename T , std::enable_if_t<!std::is_invocable_v< T >, int > = 0>

auto mc_rtc::gui::ArrayLabel	(	const std::string &	name,
		const std::vector< std::string > &	labels,
		T &&	value
	)

Helper function to build an ArrayLabelImpl from a variable.

Labels are automatically added for certain types, see details::Labels<T>

ArrayLabel() [3/4]

template<typename GetT , std::enable_if_t< std::is_invocable_v< GetT >, int > = 0>

auto mc_rtc::gui::ArrayLabel	(	const std::string &	name,
		GetT	get_fn
	)

Helper function to build an ArrayLabelImpl (no labels)

ArrayLabel() [4/4]

template<typename T , std::enable_if_t<!std::is_invocable_v< T >, int > = 0>

auto mc_rtc::gui::ArrayLabel	(	const std::string &	name,
		T &&	value
	)

Helper function to build an ArrayLabelImpl from a variable.

Labels are automatically added for certain types, see details::Labels<T>

Arrow() [1/4]

template<typename GetStart , typename GetEnd >

auto mc_rtc::gui::Arrow	(	const std::string &	name,
		const ArrowConfig &	config,
		GetStart	get_start_fn,
		GetEnd	get_end_fn
	)

Helper function to create an ArrowImpl

Arrow() [2/4]

template<typename GetStart , typename SetStart , typename GetEnd , typename SetEnd >

auto mc_rtc::gui::Arrow	(	const std::string &	name,
		const ArrowConfig &	config,
		GetStart	get_start_fn,
		SetStart	set_start_fn,
		GetEnd	get_end_fn,
		SetEnd	set_end_fn
	)

Arrow() [3/4]

template<typename GetStart , typename GetEnd >

auto mc_rtc::gui::Arrow	(	const std::string &	name,
		GetStart	get_start_fn,
		GetEnd	get_end_fn
	)

Helper function to create an ArrowImpl

Arrow() [4/4]

template<typename GetStart , typename SetStart , typename GetEnd , typename SetEnd >

auto mc_rtc::gui::Arrow	(	const std::string &	name,
		GetStart	get_start_fn,
		SetStart	set_start_fn,
		GetEnd	get_end_fn,
		SetEnd	set_end_fn
	)

Box()

template<typename GetPos , typename GetSize = const Eigen::Vector3d &, typename GetColor = const mc_rtc::gui::Color &>

auto mc_rtc::gui::Box	(	const std::string &	name,
		GetSize	size_fn,
		GetPos	get_pos_fn,
		GetColor	color_fn = mc_rtc::gui::Color::Red
	)

Creates a Box

Template Parameters

GetPos	Callback to get the box position
GetSize	An Eigen::Vector3d (fixed size) or callback to get the size
GetColor	A color (fixed color) or callback to get the color

If

Template Parameters

GetSize	and/or
GetColor	are callbacks they are invoked immediately

Button()

template<typename Callback >

auto mc_rtc::gui::Button	(	const std::string &	name,
		Callback	cb
	)

Helper function to create a ButtonImpl

Checkbox() [1/2]

auto mc_rtc::gui::Checkbox ( const std::string &  name, bool &  value  )

inline

Helper function to create a Checkbox from a variable, the callback flips the variable state

Checkbox() [2/2]

template<typename GetT , typename Callback >

auto mc_rtc::gui::Checkbox	(	const std::string &	name,
		GetT	get_fn,
		Callback	cb
	)

Helper function to create a Checkbox

ColoredPolyhedron()

template<typename GetTrianglesT , typename GetColorT >

auto mc_rtc::gui::ColoredPolyhedron	(	const std::string &	name,
		const PolyhedronConfig &	config,
		GetTrianglesT	get_triangles_fn,
		GetColorT	get_color_fn
	)

Helper function to build a ColoredPolyhedronImpl

ComboInput() [1/2]

template<typename GetT , typename SetT >

auto mc_rtc::gui::ComboInput	(	const std::string &	name,
		const std::vector< std::string > &	values,
		GetT	get_fn,
		SetT	set_fn
	)

Helper function to create a ComboInputImpl

ComboInput() [2/2]

auto mc_rtc::gui::ComboInput ( const std::string &  name, const std::vector< std::string > &  values, std::string &  value  )

inline

Helper function to create a ComboInputImpl from a variable

Cylinder()

template<typename GetPos , typename GetParams = const CylinderParameters &, typename GetColor = const mc_rtc::gui::Color &>

auto mc_rtc::gui::Cylinder	(	const std::string &	name,
		GetParams	params_fn,
		GetPos	get_pos_fn,
		GetColor	color_fn = mc_rtc::gui::Color::Red
	)

Creates a Cylinder

Template Parameters

GetPos	Callback to get the cylinder position
GetParams	A CylinderParameters (fixed size) or callback to get the parameters
GetColor	A color (fixed color) or callback to get the color

If

Template Parameters

GetParams	and/or
GetColor	are callbacks they are invoked immediately

DataComboInput() [1/2]

template<typename GetT , typename SetT >

auto mc_rtc::gui::DataComboInput	(	const std::string &	name,
		const std::vector< std::string > &	values,
		GetT	get_fn,
		SetT	set_fn
	)

Helper function to build a DataComboInputImpl

DataComboInput() [2/2]

auto mc_rtc::gui::DataComboInput ( const std::string &  name, const std::vector< std::string > &  values, std::string &  value  )

inline

Helper function to build a DataComboInputImpl from a variable

Ellipsoid()

template<typename GetPos , typename GetSize = const Eigen::Vector3d &, typename GetColor = const mc_rtc::gui::Color &>

auto mc_rtc::gui::Ellipsoid	(	const std::string &	name,
		GetSize	size_fn,
		GetPos	get_pos_fn,
		GetColor	color_fn = mc_rtc::gui::Color::Red
	)

Creates an Ellipsoid

Template Parameters

GetPos	Callback to get the ellipsoid position
GetSize	An Eigen::Vector3d (fixed size) or callback to get the ellipsoid size
GetColor	A color (fixed color) or callback to get the color

If

Template Parameters

GetSize	and/or
GetColor	are callbacks they are invoked immediately

Force() [1/4]

template<typename GetForce , typename GetSurface >

auto mc_rtc::gui::Force	(	const std::string &	name,
		const ForceConfig &	config,
		GetForce	get_force_fn,
		GetSurface	get_surface_fn
	)

Helper function to get a ForceImpl

Force() [2/4]

template<typename GetForce , typename GetSurface , typename SetForce >

auto mc_rtc::gui::Force	(	const std::string &	name,
		const ForceConfig &	config,
		GetForce	get_force_fn,
		SetForce	set_force_fn,
		GetSurface	get_surface_fn
	)

Helper function to get a ForceImpl

Force() [3/4]

template<typename GetForce , typename GetSurface >

auto mc_rtc::gui::Force	(	const std::string &	name,
		GetForce	get_force_fn,
		GetSurface	get_surface_fn
	)

Helper function to get a ForceImpl

Force() [4/4]

template<typename GetForce , typename GetSurface , typename SetForce >

auto mc_rtc::gui::Force	(	const std::string &	name,
		GetForce	get_force_fn,
		SetForce	set_force_fn,
		GetSurface	get_surface_fn
	)

Helper function to get a ForceImpl

Form()

template<typename Callback , typename... Args>

auto mc_rtc::gui::Form	(	const std::string &	name,
		Callback	cb,
		Args &&...	args
	)

Helper to create a Form element

FormArrayInput() [1/2]

template<typename T >

details::FormArrayInput<T> mc_rtc::gui::FormArrayInput	(	const std::string &	name,
		bool	required,
		bool	fixed_size = false
	)

FormArrayInput() [2/2]

template<typename T >

auto mc_rtc::gui::FormArrayInput	(	const std::string &	name,
		bool	required,
		T &&	value,
		bool	fixed_size = true
	)

Input()

template<typename T >

auto mc_rtc::gui::Input	(	const std::string &	name,
		T &	value
	)

Generic helper to build an input from a variable, the most appopriate type is automatically selected

IntegerInput() [1/2]

template<typename GetT , typename SetT >

auto mc_rtc::gui::IntegerInput	(	const std::string &	name,
		GetT	get_fn,
		SetT	set_fn
	)

Helper function to create a IntegerInputImpl

IntegerInput() [2/2]

template<typename T >

auto mc_rtc::gui::IntegerInput	(	const std::string &	name,
		T &	value
	)

Helper function to create an IntegerInputImpl from a reference

Label() [1/2]

template<typename GetT , std::enable_if_t< std::is_invocable_v< GetT >, int > = 0>

auto mc_rtc::gui::Label	(	const std::string &	name,
		GetT	get_fn
	)

Helper function to create a Label element

Label() [2/2]

template<typename T , std::enable_if_t<!std::is_invocable_v< T >, int > = 0>

auto mc_rtc::gui::Label	(	const std::string &	name,
		T &&	value
	)

Helper function to create a Label element from a variable

NumberInput() [1/2]

template<typename GetT , typename SetT >

auto mc_rtc::gui::NumberInput	(	const std::string &	name,
		GetT	get_fn,
		SetT	set_fn
	)

Helper function to create a NumberInputImpl

NumberInput() [2/2]

template<typename T >

auto mc_rtc::gui::NumberInput	(	const std::string &	name,
		T &	value
	)

Helper function to create a NumberInputImpl from a variable

NumberSlider() [1/2]

template<typename GetT , typename SetT >

auto mc_rtc::gui::NumberSlider	(	const std::string &	name,
		GetT	get_fn,
		SetT	set_fn,
		double	min,
		double	max
	)

Helper function to create a NumberSliderImpl

NumberSlider() [2/2]

template<typename T >

auto mc_rtc::gui::NumberSlider	(	const std::string &	name,
		T &	value,
		double	min,
		double	max
	)

Helper function to create a NumberSlider from a variable

Point3D() [1/6]

template<typename GetT , std::enable_if_t< std::is_invocable_v< GetT >, int > = 0>

auto mc_rtc::gui::Point3D	(	const std::string &	name,
		const PointConfig &	config,
		GetT	get_fn
	)

Helper function to create a read-only Point3DImpl with configuration

Point3D() [2/6]

template<typename GetT , typename SetT >

auto mc_rtc::gui::Point3D	(	const std::string &	name,
		const PointConfig &	config,
		GetT	get_fn,
		SetT	set_fn
	)

Helper function to create a Point3DImpl with configuration

Point3D() [3/6]

template<typename T , std::enable_if_t<!std::is_invocable_v< T >, int > = 0>

auto mc_rtc::gui::Point3D	(	const std::string &	name,
		const PointConfig &	config,
		T &	value
	)

Helper function to build a Point3D from a variable

Point3D() [4/6]

template<typename GetT , std::enable_if_t< std::is_invocable_v< GetT >, int > = 0>

auto mc_rtc::gui::Point3D	(	const std::string &	name,
		GetT	get_fn
	)

Helper function to create a read-only Point3DImpl

Point3D() [5/6]

template<typename GetT , typename SetT >

auto mc_rtc::gui::Point3D	(	const std::string &	name,
		GetT	get_fn,
		SetT	set_fn
	)

Helper function to create a Point3DImpl

Point3D() [6/6]

template<typename T , std::enable_if_t<!std::is_invocable_v< T >, int > = 0>

auto mc_rtc::gui::Point3D	(	const std::string &	name,
		T &	value
	)

Helper function to build a Point3D from a variable

Point3DRO() [1/2]

template<typename T >

auto mc_rtc::gui::Point3DRO	(	const std::string &	name,
		const PointConfig &	config,
		T &&	value
	)

Helper function to build a Point3D from a variable

Point3DRO() [2/2]

template<typename T >

auto mc_rtc::gui::Point3DRO	(	const std::string &	name,
		T &&	value
	)

Helper function to build a Point3D from a variable

Polygon() [1/3]

template<typename GetT >

auto mc_rtc::gui::Polygon	(	const std::string &	name,
		const Color &	color,
		GetT	get_fn
	)

Helper function to build a PolygonImpl

Polygon() [2/3]

template<typename GetT >

auto mc_rtc::gui::Polygon	(	const std::string &	name,
		const LineConfig &	config,
		GetT	get_fn
	)

Helper function to build a PolygonImpl

Polygon() [3/3]

template<typename GetT >

auto mc_rtc::gui::Polygon	(	const std::string &	name,
		GetT	get_fn
	)

Helper function to build a PolygonImpl

Polyhedron() [1/6]

template<typename GetTrianglesT >

auto mc_rtc::gui::Polyhedron	(	const std::string &	name,
		const PolyhedronConfig &	config,
		GetTrianglesT	get_triangles_fn
	)

Helper function to build a PolyhedronTriangleListImpl

Polyhedron() [2/6]

template<typename GetVerticesOrTrianglesT , typename GetTrianglesOrColorsT >

auto mc_rtc::gui::Polyhedron	(	const std::string &	name,
		const PolyhedronConfig &	config,
		GetVerticesOrTrianglesT	get_vertices_or_triangles_fn,
		GetTrianglesOrColorsT	get_triangles_or_colors_fn
	)

Helper function to build a PolyhedronVerticesTrianglesImpl

Polyhedron() [3/6]

template<typename GetVerticesT , typename GetTrianglesT , typename GetColorT >

auto mc_rtc::gui::Polyhedron	(	const std::string &	name,
		const PolyhedronConfig &	config,
		GetVerticesT	get_vertices_fn,
		GetTrianglesT	get_triangles_fn,
		GetColorT	get_color_fn
	)

Helper function to build a ColoredPolyhedronImpl

Polyhedron() [4/6]

template<typename GetTrianglesT >

auto mc_rtc::gui::Polyhedron	(	const std::string &	name,
		GetTrianglesT	get_triangles_fn
	)

Helper function to build a PolyhedronTriangleListImpl

Polyhedron() [5/6]

template<typename GetVerticesOrTrianglesT , typename GetTrianglesOrColorsT >

auto mc_rtc::gui::Polyhedron	(	const std::string &	name,
		GetVerticesOrTrianglesT	get_vertices_or_triangles_fn,
		GetTrianglesOrColorsT	get_triangles_or_colors_fn
	)

Helper function to build a PolyhedronVerticesTrianglesImpl

Polyhedron() [6/6]

template<typename GetVerticesT , typename GetTrianglesT , typename GetColorT >

auto mc_rtc::gui::Polyhedron	(	const std::string &	name,
		GetVerticesT	get_vertices_fn,
		GetTrianglesT	get_triangles_fn,
		GetColorT	get_color_fn
	)

Helper function to build a ColoredPolyhedronImpl

Robot()

template<typename GetT >

auto mc_rtc::gui::Robot	(	const std::string &	name,
		GetT	get_fn
	)

Helper function to create a RobotImpl

RobotMsg()

template<typename GetT >

auto mc_rtc::gui::RobotMsg	(	const std::string &	name,
		GetT	get_fn
	)

Helper function to create a RobotImpl

Rotation() [1/2]

template<typename GetT >

auto mc_rtc::gui::Rotation	(	const std::string &	name,
		GetT	get_fn
	)

Helper function to create a Rotation element (read-only)

Rotation() [2/2]

template<typename GetT , typename SetT >

auto mc_rtc::gui::Rotation	(	const std::string &	name,
		GetT	get_fn,
		SetT	set_fn
	)

Helper function to create a Rotation element (writable)

RPYInput()

template<bool Degrees = true, typename T >

auto mc_rtc::gui::RPYInput	(	const std::string &	name,
		T &	value
	)

Creates an input for a rotation using RPY angles

Defaults to degrees inputs, can be changed via the

Template Parameters

Degrees

template parameter

RPYLabel()

template<bool Degrees = true, typename T >

auto mc_rtc::gui::RPYLabel	(	const std::string &	name,
		T &&	value
	)

Creates a label for RPY angles

Defaults to degrees inputs, can be changed via the

Template Parameters

DegreesInput

template parameter

Schema()

template<typename Callback >

auto mc_rtc::gui::Schema	(	const std::string &	name,
		const std::string &	schema,
		Callback	cb
	)

Helper function to create a Schema element

Sphere()

template<typename GetPos , typename GetRadius = double, typename GetColor = const mc_rtc::gui::Color &>

auto mc_rtc::gui::Sphere	(	const std::string &	name,
		GetRadius	radius_fn,
		GetPos	get_pos_fn,
		GetColor	color_fn = mc_rtc::gui::Color::Red
	)

Creates a Sphere

Template Parameters

GetPos	Callback to get the sphere position
GetRadius	A double (fixed radius) or callback to get the radius
GetColor	A color (fixed color) or callback to get the color

If

Template Parameters

GetRadius	and/or
GetColor	are callbacks they are invoked immediately

StringInput() [1/2]

template<typename GetT , typename SetT >

auto mc_rtc::gui::StringInput	(	const std::string &	name,
		GetT	get_fn,
		SetT	set_fn
	)

Helper function to create a StringInputImpl

StringInput() [2/2]

auto mc_rtc::gui::StringInput ( const std::string &  name, std::string &  value  )

inline

Helper function to create a StringInputImpl from a variable

Table() [1/4]

template<typename GetHeader , typename GetData >

auto mc_rtc::gui::Table	(	const std::string &	name,
		GetHeader	get_header_fn,
		GetData	get_data_fn
	)

Helper function to get a TableImpl

Table() [2/4]

template<typename GetHeader , typename GetFormat , typename GetData >

auto mc_rtc::gui::Table	(	const std::string &	name,
		GetHeader	get_header_fn,
		GetFormat	get_format_fn,
		GetData	get_data_fn
	)

Helper function to get a FormattedTableImpl

Table() [3/4]

template<typename GetData >

auto mc_rtc::gui::Table	(	const std::string &	name,
		std::vector< std::string >	header,
		GetData	get_data_fn
	)

Helper function to a get a StaticTableImpl

Table() [4/4]

template<typename GetData >

auto mc_rtc::gui::Table	(	const std::string &	name,
		std::vector< std::string >	header,
		std::vector< std::string >	format,
		GetData	get_data_fn
	)

Helper function to a get a StaticTableImpl with format

Trajectory() [1/2]

template<typename GetT >

auto mc_rtc::gui::Trajectory	(	const std::string &	name,
		const LineConfig &	config,
		GetT	get_fn
	)

Function helper to get a TrajectoryImpl

Trajectory() [2/2]

template<typename GetT >

auto mc_rtc::gui::Trajectory	(	const std::string &	name,
		GetT	get_fn
	)

Function helper to get a TrajectoryImpl

Transform() [1/3]

template<typename GetT , std::enable_if_t< std::is_invocable_v< GetT >, int > = 0>

auto mc_rtc::gui::Transform	(	const std::string &	name,
		GetT	get_fn
	)

Helper function to create a Transform element (read-only)

Transform() [2/3]

template<typename GetT , typename SetT >

auto mc_rtc::gui::Transform	(	const std::string &	name,
		GetT	get_fn,
		SetT	set_fn
	)

Helper function to create a Transform element (editable)

Transform() [3/3]

template<typename T , std::enable_if_t<!std::is_invocable_v< T >, int > = 0>

auto mc_rtc::gui::Transform	(	const std::string &	name,
		T &	value
	)

Helper function to create a writable transform element from a variable

TransformRO()

template<typename T >

auto mc_rtc::gui::TransformRO	(	const std::string &	name,
		T &&	value
	)

Helper function to create a read-only transform display from a variable

Visual()

template<typename GetVisual , typename GetPos >

auto mc_rtc::gui::Visual	(	const std::string &	name,
		GetVisual	get_visual_fn,
		GetPos	get_pos_fn
	)

Helper function to create a details::VisualImpl

XYTheta() [1/2]

template<typename GetT , std::enable_if_t< std::is_invocable_v< GetT >, int > = 0>

auto mc_rtc::gui::XYTheta	(	const std::string &	name,
		GetT	get_fn
	)

Helper function to create an XYTheta element (read-only)

XYTheta() [2/2]

template<typename GetT , typename SetT >

auto mc_rtc::gui::XYTheta	(	const std::string &	name,
		GetT	get_fn,
		SetT	set_fn
	)

Helper function to create an XYTheta element