DebugDrawerTopic::VisuID Struct Reference

A visualisation ID. More...

#include <RobotAPI/libraries/core/visualization/DebugDrawerTopic.h>

Public Member Functions
	VisuID ()
	Empty constructor.
template<typename Source>
	VisuID (const Source &name)
	Construct a VisuID from a non-std::string source (e.g. char[]).
	VisuID (const std::string &layer, const std::string &name)
	Construct a VisuID with given name and layer.
	VisuID (const std::string &name)
	Construct a VisuID with given name (for drawing to the preset layer).
VisuID	withName (const std::string &name) const
	Get a VisuID with the given name and same layer as `*this.

Public Attributes
std::string	layer = ""
	The layer name (empty by default).
std::string	name = ""
	The visu name (empty by default).

Friends
std::ostream &	operator<< (std::ostream &os, const VisuID &rhs)
	Streams a short human-readable description of rhs to os.

Detailed Description

A visualisation ID.

This constructor can be called in the following ways (with draw(const VisuID& id, ...) being any drawing method):

std::string name = "pose";
std::string layer = "layer";
draw(name, ...);           // just the name, implicit call
draw({name}, ...);         // just the name, call with initializer list
draw({layer, name}, ...);  // layer and name, with initializer list

(And of course by an explicit call if you want to be really verbose.) Not passing a layer will cause DebugDrawerTopic to use the preset layer.

Constructor & Destructor Documentation

VisuID() [1/4]

VisuID

(

)

Empty constructor.

VisuID() [2/4]

VisuID

(

const std::string &

name

)

Construct a VisuID with given name (for drawing to the preset layer).

VisuID() [3/4]

VisuID	(	const std::string &	layer,
		const std::string &	name )

Construct a VisuID with given name and layer.

VisuID() [4/4]

template<typename Source>

VisuID ( const Source & name )

inline

Construct a VisuID from a non-std::string source (e.g. char[]).

Member Function Documentation

withName()

DebugDrawerTopic::VisuID withName

(

const std::string &

name

)

const

Get a VisuID with the given name and same layer as `*this.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & os, const VisuID & rhs )

friend

Streams a short human-readable description of rhs to os.

Member Data Documentation

layer

std::string layer = ""

The layer name (empty by default).

name

std::string name = ""

The visu name (empty by default).

---

The documentation for this struct was generated from the following files:

• RobotAPI/libraries/core/visualization/DebugDrawerTopic.h
• RobotAPI/libraries/core/visualization/DebugDrawerTopic.cpp