Ogre 2.x implementation of a marker geometry. More...

#include <Ogre2Marker.hh>

Public Member Functions
virtual	~Ogre2Marker ()
	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	ClearPoints () override
	Clear the points of the marker, if applicable.

virtual void	Destroy () override
	Destroy function.

virtual void	Init () override

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

virtual Ogre::MovableObject *	OgreObject () const override
	Get the ogre object representing this geometry.

virtual void	PreRender () override
	PreRender function.

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

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

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

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

Public Member Functions inherited from BaseMarker< Ogre2Geometry >
virtual	~BaseMarker ()
	Destructor.

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 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	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	SetSize (double _size) override
	Set size of the marker. Only affects MT_POINTS. e.g. size of rasterized points in pixels.

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

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

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

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.

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

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

virtual VisualPtr	Parent () const override
	Get the parent Visual.

Public Member Functions inherited from BaseGeometry< Ogre2Object >
virtual	~BaseGeometry ()

virtual GeometryPtr	Clone () const override
	Clone the geometry.

virtual void	RemoveParent () override
	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 &_material, bool _unique=true) override
	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.

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

virtual ScenePtr	Scene () const override

Public Member Functions inherited from BaseObject
virtual	~BaseObject ()

virtual unsigned int	Id () const override

virtual std::string	Name () const override

virtual void	PostRender () override

Protected Member Functions
	Ogre2Marker ()
	Constructor.

Protected Member Functions inherited from BaseMarker< Ogre2Geometry >
	BaseMarker ()
	Constructor.

Protected Member Functions inherited from Marker
	Marker ()

Protected Member Functions inherited from Ogre2Geometry
	Ogre2Geometry ()
	Constructor.

virtual void	SetParent (Ogre2VisualPtr _parent)
	Set the parent of this ogre geometry.

Protected Member Functions inherited from BaseGeometry< Ogre2Object >
	BaseGeometry ()

Protected Member Functions inherited from Ogre2Object
	Ogre2Object ()
	Constructor.

Protected Member Functions inherited from BaseObject
	BaseObject ()

virtual void	Load ()

Additional Inherited Members
Protected Attributes inherited from BaseMarker< Ogre2Geometry >
int32_t	layer
	Layer at which the marker will reside.

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

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

MarkerType	markerType
	Marker type.

double	size
	Marker size.

Protected Attributes inherited from Ogre2Geometry
Ogre2VisualPtr	parent
	Parent visual.

Protected Attributes inherited from Ogre2Object
Ogre2ScenePtr	scene
	Pointer to the ogre scene.

Protected Attributes inherited from BaseObject
unsigned int	id

std::string	name

Detailed Description

Ogre 2.x implementation of a marker geometry.

Constructor & Destructor Documentation

◆ Ogre2Marker()

Ogre2Marker ( )

protected

Constructor.

◆ ~Ogre2Marker()

virtual ~Ogre2Marker ( )

virtual

Destructor.

Member Function Documentation

◆ AddPoint()

virtual 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

Reimplemented from BaseMarker< Ogre2Geometry >.

◆ ClearPoints()

virtual void ClearPoints ( )

overridevirtual

Clear the points of the marker, if applicable.

Reimplemented from BaseMarker< Ogre2Geometry >.

◆ Destroy()

virtual void Destroy ( )

overridevirtual

Destroy function.

Reimplemented from BaseMarker< Ogre2Geometry >.

◆ Init()

virtual void Init ( )

overridevirtual

Reimplemented from BaseObject.

◆ Material()

virtual MaterialPtr Material ( ) const

overridevirtual

Get the material of this geometry.

Returns: Material used by this geometry

Implements Geometry.

◆ OgreObject()

virtual Ogre::MovableObject * OgreObject ( ) const

overridevirtual

Get the ogre object representing this geometry.

Returns: Pointer to an ogre movable object

Implements Ogre2Geometry.

◆ PreRender()

virtual void PreRender ( )

overridevirtual

PreRender function.

Reimplemented from BaseMarker< Ogre2Geometry >.

◆ SetMaterial()

virtual void SetMaterial	(	MaterialPtr	_material,
		bool	_unique
	)

overridevirtual

Set the materials of this Geometry.

Parameters

[in]	_material	New Material to be assigned
[in]	_unique	True if the given material should be cloned

Implements Geometry.

◆ SetPoint()

virtual 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

Reimplemented from BaseMarker< Ogre2Geometry >.

◆ SetType()

virtual void SetType ( const MarkerType _markerType )

overridevirtual

Set the render type of this Marker.

Parameters

[in] _markerType The desired render type

Reimplemented from BaseMarker< Ogre2Geometry >.

◆ Type()

virtual MarkerType Type ( ) const

overridevirtual

Get the render type of this Marker.

Returns: The render type of the marker

Reimplemented from BaseMarker< Ogre2Geometry >.

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

Ogre2Marker.hh

Gazebo Rendering

API Reference

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Ogre2Marker()

◆ ~Ogre2Marker()

Member Function Documentation

◆ AddPoint()

◆ ClearPoints()

◆ Destroy()

◆ Init()

◆ Material()

◆ OgreObject()

◆ PreRender()

◆ SetMaterial()

◆ SetPoint()

◆ SetType()

◆ Type()