Gazebo Rendering

API Reference

3.7.2

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

#include <Ogre2Marker.hh>

Public Member Functions

virtual ~Ogre2Marker ()
 Destructor. More...
 
virtual void AddPoint (const gz::math::Vector3d &_pt, const gz::math::Color &_color) override
 Add a point with its respective color to the marker. More...
 
virtual void ClearPoints () override
 Clear the points of the marker, if applicable. More...
 
virtual void Destroy () override
 Destroy function. More...
 
virtual void Init () override
 
virtual MaterialPtr Material () const override
 Get the material of this geometry. More...
 
virtual Ogre::MovableObject * OgreObject () const override
 Get the ogre object representing this geometry. More...
 
virtual void PreRender () override
 PreRender function. More...
 
virtual void SetMaterial (MaterialPtr _material, bool _unique) override
 Set the materials of this Geometry. More...
 
virtual void SetPoint (unsigned int _index, const gz::math::Vector3d &_value) override
 Set an existing point's vector. More...
 
virtual void SetType (const MarkerType _markerType) override
 Set the render type of this Marker. More...
 
virtual MarkerType Type () const override
 Get the render type of this Marker. More...
 
- Public Member Functions inherited from BaseMarker< Ogre2Geometry >
virtual ~BaseMarker ()
 Destructor. More...
 
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. More...
 
virtual int32_t Layer () const override
 Get the layer of this Marker. More...
 
virtual std::chrono::steady_clock::duration Lifetime () const override
 Get the lifetime of this Marker. More...
 
virtual void SetLayer (int32_t _layer) override
 Set the layer of this Marker. More...
 
virtual void SetLifetime (const std::chrono::steady_clock::duration &_lifetime) override
 Set the lifetime of this Marker. More...
 
virtual MarkerType Type () const override
 Get the render type of this Marker. More...
 
- Public Member Functions inherited from Marker
virtual ~Marker ()
 Destructor. More...
 
virtual int32_t Layer () const =0
 Get the layer of this Marker. More...
 
virtual std::chrono::steady_clock::duration Lifetime () const =0
 Get the lifetime of this Marker. More...
 
- Public Member Functions inherited from Geometry
virtual ~Geometry ()
 Deconstructor. More...
 
- Public Member Functions inherited from Object
virtual ~Object ()
 Destructor. More...
 
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. More...
 
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. More...
 
virtual void PostRender ()=0
 Post process this object and any of its children after rendering. More...
 
virtual ScenePtr Scene () const =0
 Get the Scene that created this object. More...
 
- Public Member Functions inherited from Ogre2Geometry
virtual ~Ogre2Geometry ()
 Destructor. More...
 
virtual bool HasParent () const override
 Determine if this Geometry is attached to a Visual. More...
 
virtual VisualPtr Parent () const override
 Get the parent Visual. More...
 
- Public Member Functions inherited from BaseGeometry< Ogre2Object >
virtual ~BaseGeometry ()
 
virtual VisualPtr Parent () const override=0
 Get the parent Visual. More...
 
virtual void RemoveParent () override
 Detach this Geometry from its parent Visual. If this Geometry does not have a parent, no work will be done. More...
 
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. More...
 
- Public Member Functions inherited from Ogre2Object
virtual ~Ogre2Object ()
 Destructor. More...
 
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. More...
 
- Protected Member Functions inherited from BaseMarker< Ogre2Geometry >
 BaseMarker ()
 Constructor. More...
 
- Protected Member Functions inherited from Marker
 Marker ()
 
- Protected Member Functions inherited from Ogre2Geometry
 Ogre2Geometry ()
 Constructor. More...
 
virtual void SetParent (Ogre2VisualPtr _parent)
 Set the parent of this ogre geometry. More...
 
- Protected Member Functions inherited from BaseGeometry< Ogre2Object >
 BaseGeometry ()
 
- Protected Member Functions inherited from Ogre2Object
 Ogre2Object ()
 Constructor. More...
 
- 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. More...
 
std::chrono::steady_clock::duration lifetime
 Life time of a marker. More...
 
bool markerDirty
 Flag to indicate if marker needs to be updated. More...
 
MarkerType markerType
 Marker type. More...
 
- Protected Attributes inherited from Ogre2Geometry
Ogre2VisualPtr parent
 Parent visual. More...
 
- Protected Attributes inherited from Ogre2Object
Ogre2ScenePtr scene
 Pointer to the ogre scene. More...
 
- 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]_ptA vector containing the position of the point
[in]_colorThe 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]_materialNew Material to be assigned
[in]_uniqueTrue 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]_indexThe index of the point
[in]_valueThe 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]_markerTypeThe 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

Implements Marker.


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