Base implementation of a Marker geometry. More...

#include <BaseMarker.hh>

Public Member Functions
virtual	~BaseMarker ()
	Destructor.

virtual void	AddPoint (const gz::math::Vector3d &_pt, const gz::math::Color &_color) override
	Add a point with its respective color to the marker.

virtual void	AddPoint (double _x, double _y, double _z, const gz::math::Color &_color) override
	Add a point with its respective color to the marker.

virtual void	ClearPoints () override
	Clear the points of the marker, if applicable.

virtual void	Destroy () override
	Destroy function.

virtual int32_t	Layer () const override
	Get the layer of this Marker.

virtual std::chrono::steady_clock::duration	Lifetime () const override
	Get the lifetime of this Marker.

virtual void	PreRender () override
	PreRender function.

virtual void	SetLayer (int32_t _layer) override
	Set the layer of this Marker.

virtual void	SetLifetime (const std::chrono::steady_clock::duration &_lifetime) override
	Set the lifetime of this Marker.

virtual void	SetPoint (unsigned int _index, const gz::math::Vector3d &_value) override
	Set an existing point's vector.

virtual void	SetSize (double _size) override
	Set size of the marker. Only affects MT_POINTS. e.g. size of rasterized points in pixels.

virtual void	SetType (const MarkerType _markerType) override
	Set the render type of this Marker.

virtual double	Size () const override
	Get the size of the marker.

virtual MarkerType	Type () const override
	Get the render type of this Marker.

Public Member Functions inherited from Marker
virtual	~Marker ()
	Destructor.

Public Member Functions inherited from Geometry
virtual	~Geometry ()
	Destructor.

virtual GeometryPtr	Clone () const =0
	Clone the geometry.

virtual bool	HasParent () const =0
	Determine if this Geometry is attached to a Visual.

virtual MaterialPtr	Material () const =0
	Get the material of this geometry.

virtual VisualPtr	Parent () const =0
	Get the parent Visual.

virtual void	RemoveParent ()=0
	Detach this Geometry from its parent Visual. If this Geometry does not have a parent, no work will be done.

virtual void	SetMaterial (const std::string &_name, bool _unique=true)=0
	Set the materials of this Geometry. The specified material will be retrieved from the parent Scene. If no material is registered by the given name, no work will be done.

virtual void	SetMaterial (MaterialPtr _material, bool _unique=true)=0
	Set the materials of this Geometry.

Public Member Functions inherited from Object
virtual	~Object ()
	Destructor.

virtual unsigned int	Id () const =0
	Get the object ID. This ID will be unique across all objects inside a given scene, but necessarily true for objects across different scenes.

virtual std::string	Name () const =0
	Get the object name. This name will be unique across all objects inside a given scene, but necessarily true for objects across different scenes.

virtual void	PostRender ()=0
	Post process this object and any of its children after rendering.

virtual ScenePtr	Scene () const =0
	Get the Scene that created this object.

Protected Member Functions
	BaseMarker ()
	Constructor.

Protected Member Functions inherited from Marker
	Marker ()

Protected Attributes
int32_t	layer = 0
	Layer at which the marker will reside.

std::chrono::steady_clock::duration	lifetime
	Life time of a marker.

bool	markerDirty = false
	Flag to indicate if marker needs to be updated.

MarkerType	markerType
	Marker type.

double	size = 1.0
	Marker size.

Detailed Description

template<class T>
class gz::rendering::BaseMarker< T >

Base implementation of a Marker geometry.

Constructor & Destructor Documentation

◆ BaseMarker()

template<class T >

BaseMarker ( )

protected

Constructor.

◆ ~BaseMarker()

template<class T >

~BaseMarker ( )

virtual

Destructor.

Member Function Documentation

◆ AddPoint() [1/2]

template<class T >

void AddPoint	(	const gz::math::Vector3d &	_pt,
		const gz::math::Color &	_color
	)

overridevirtual

Add a point with its respective color to the marker.

Parameters

[in]	_pt	A vector containing the position of the point
[in]	_color	The color the point is set to

Implements Marker.

Reimplemented in OgreMarker, and Ogre2Marker.

◆ AddPoint() [2/2]

template<class T >

void AddPoint	(	double	_x,
		double	_y,
		double	_z,
		const gz::math::Color &	_color
	)

overridevirtual

Add a point with its respective color to the marker.

Parameters

[in]	_x	X coordinate
[in]	_y	Y coordinate
[in]	_z	Z coordinate
[in]	_color	The color the point is set to

Implements Marker.

◆ ClearPoints()

template<class T >

void ClearPoints ( )

overridevirtual

Clear the points of the marker, if applicable.

Implements Marker.

Reimplemented in OgreMarker, and Ogre2Marker.

◆ Destroy()

template<class T >

void Destroy ( )

overridevirtual

Destroy function.

Implements Object.

Reimplemented in OgreMarker, and Ogre2Marker.

◆ Layer()

template<class T >

int32_t Layer ( ) const

overridevirtual

Get the layer of this Marker.

Returns: The layer of the marker

Implements Marker.

◆ Lifetime()

template<class T >

std::chrono::steady_clock::duration Lifetime ( ) const

overridevirtual

Get the lifetime of this Marker.

Returns: The time at which the marker will be removed

Implements Marker.

◆ PreRender()

template<class T >

void PreRender ( )

overridevirtual

PreRender function.

Implements Object.

Reimplemented in OgreMarker, and Ogre2Marker.

◆ SetLayer()

template<class T >

void SetLayer ( int32_t _layer )

overridevirtual

Set the layer of this Marker.

Parameters

[in] _layer Layer at which the marker will reside

Implements Marker.

◆ SetLifetime()

template<class T >

void SetLifetime ( const std::chrono::steady_clock::duration & _lifetime )

overridevirtual

Set the lifetime of this Marker.

Parameters

[in] _lifetime The time at which the marker will be removed

Implements Marker.

◆ SetPoint()

template<class T >

void SetPoint	(	unsigned int	_index,
		const gz::math::Vector3d &	_value
	)

overridevirtual

Set an existing point's vector.

Parameters

[in]	_index	The index of the point
[in]	_value	The new positional vector of the point

Implements Marker.

Reimplemented in OgreMarker, and Ogre2Marker.

◆ SetSize()

template<class T >

void SetSize ( double _size )

overridevirtual

Set size of the marker. Only affects MT_POINTS. e.g. size of rasterized points in pixels.

Parameters

[in] _size Size of the marker

Implements Marker.

◆ SetType()

template<class T >

void SetType ( const MarkerType _markerType )

overridevirtual

Set the render type of this Marker.

Parameters

[in] _markerType The desired render type

Implements Marker.

Reimplemented in OgreMarker, and Ogre2Marker.

◆ Size()

template<class T >

double Size ( ) const

overridevirtual

Get the size of the marker.

Returns: The size of the marker

See also: SetSize

Implements Marker.

◆ Type()

template<class T >

MarkerType Type ( ) const

overridevirtual

Get the render type of this Marker.

Returns: The render type of the marker

Implements Marker.

Reimplemented in OgreMarker, and Ogre2Marker.

Member Data Documentation

◆ layer

template<class T >

int32_t layer = 0

protected

Layer at which the marker will reside.

◆ lifetime

template<class T >

std::chrono::steady_clock::duration lifetime

protected

Initial value:

=

std::chrono::steady_clock::duration::zero()

Life time of a marker.

◆ markerDirty

template<class T >

bool markerDirty = false

protected

Flag to indicate if marker needs to be updated.

◆ markerType

template<class T >

MarkerType markerType

protected

Initial value:

=

MarkerType::MT_NONE

Marker type.

◆ size

template<class T >

double size = 1.0

protected

Marker size.

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

BaseMarker.hh

Gazebo Rendering

API Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BaseMarker()

◆ ~BaseMarker()

Member Function Documentation

◆ AddPoint() [1/2]

◆ AddPoint() [2/2]

◆ ClearPoints()

◆ Destroy()

◆ Layer()

◆ Lifetime()

◆ PreRender()

◆ SetLayer()

◆ SetLifetime()

◆ SetPoint()

◆ SetSize()

◆ SetType()

◆ Size()

◆ Type()

Member Data Documentation

◆ layer

◆ lifetime

◆ markerDirty

◆ markerType

◆ size