Gazebo Rendering

API Reference

7.4.2

A marker geometry class. The marker's visual appearance is based on the marker type specified. More...

#include <gz/rendering/Marker>

Public Member Functions

virtual ~Marker ()
 Destructor. More...
 
virtual void AddPoint (const gz::math::Vector3d &_pt, const gz::math::Color &_color)=0
 Add a point with its respective color to the marker. More...
 
virtual void AddPoint (double _x, double _y, double _z, const gz::math::Color &_color)=0
 Add a point with its respective color to the marker. More...
 
virtual void ClearPoints ()=0
 Clear the points of the marker, if applicable. 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...
 
virtual void SetLayer (int32_t _layer)=0
 Set the layer of this Marker. More...
 
virtual void SetLifetime (const std::chrono::steady_clock::duration &_lifetime)=0
 Set the lifetime of this Marker. More...
 
virtual void SetPoint (unsigned int _index, const gz::math::Vector3d &_value)=0
 Set an existing point's vector. More...
 
virtual void SetSize (double _size)=0
 Set size of the marker. Only affects MT_POINTS. e.g. size of rasterized points in pixels. More...
 
virtual void SetType (const MarkerType _markerType)=0
 Set the render type of this Marker. More...
 
virtual double Size () const =0
 Get the size of the marker. More...
 
virtual MarkerType Type () const =0
 Get the render type of this Marker. More...
 
- Public Member Functions inherited from Geometry
virtual ~Geometry ()
 Destructor. More...
 
virtual GeometryPtr Clone () const =0
 Clone the geometry. More...
 
virtual bool HasParent () const =0
 Determine if this Geometry is attached to a Visual. More...
 
virtual MaterialPtr Material () const =0
 Get the material of this geometry. More...
 
virtual VisualPtr Parent () const =0
 Get the parent Visual. More...
 
virtual void RemoveParent ()=0
 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 &_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. More...
 
virtual void SetMaterial (MaterialPtr _material, bool _unique=true)=0
 Set the materials of this Geometry. More...
 
- Public Member Functions inherited from Object
virtual ~Object ()
 Destructor. More...
 
virtual void Destroy ()=0
 Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. 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 void PreRender ()=0
 Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender. More...
 
virtual ScenePtr Scene () const =0
 Get the Scene that created this object. More...
 

Protected Member Functions

 Marker ()
 

Detailed Description

A marker geometry class. The marker's visual appearance is based on the marker type specified.

Constructor & Destructor Documentation

◆ Marker()

Marker ( )
protected

◆ ~Marker()

virtual ~Marker ( )
virtual

Destructor.

Member Function Documentation

◆ AddPoint() [1/2]

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

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

Implemented in BaseMarker< T >, BaseMarker< Ogre2Geometry >, BaseMarker< OgreGeometry >, OgreMarker, and Ogre2Marker.

◆ AddPoint() [2/2]

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

Add a point with its respective color to the marker.

Parameters
[in]_xX coordinate
[in]_yY coordinate
[in]_zZ coordinate
[in]_colorThe color the point is set to

Implemented in BaseMarker< T >, BaseMarker< Ogre2Geometry >, and BaseMarker< OgreGeometry >.

◆ ClearPoints()

virtual void ClearPoints ( )
pure virtual

Clear the points of the marker, if applicable.

Implemented in BaseMarker< T >, BaseMarker< Ogre2Geometry >, BaseMarker< OgreGeometry >, OgreMarker, and Ogre2Marker.

◆ Layer()

virtual int32_t Layer ( ) const
pure virtual

Get the layer of this Marker.

Returns
The layer of the marker

Implemented in BaseMarker< T >.

◆ Lifetime()

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

Get the lifetime of this Marker.

Returns
The time at which the marker will be removed

Implemented in BaseMarker< T >.

◆ SetLayer()

virtual void SetLayer ( int32_t  _layer)
pure virtual

Set the layer of this Marker.

Parameters
[in]_layerLayer at which the marker will reside

Implemented in BaseMarker< T >, BaseMarker< Ogre2Geometry >, and BaseMarker< OgreGeometry >.

◆ SetLifetime()

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

Set the lifetime of this Marker.

Parameters
[in]_lifetimeThe time at which the marker will be removed

Implemented in BaseMarker< T >, BaseMarker< Ogre2Geometry >, and BaseMarker< OgreGeometry >.

◆ SetPoint()

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

Set an existing point's vector.

Parameters
[in]_indexThe index of the point
[in]_valueThe new positional vector of the point

Implemented in BaseMarker< T >, BaseMarker< Ogre2Geometry >, BaseMarker< OgreGeometry >, OgreMarker, and Ogre2Marker.

◆ SetSize()

virtual void SetSize ( double  _size)
pure virtual

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

Parameters
[in]_sizeSize of the marker

Implemented in BaseMarker< T >, BaseMarker< Ogre2Geometry >, and BaseMarker< OgreGeometry >.

◆ SetType()

virtual void SetType ( const MarkerType  _markerType)
pure virtual

Set the render type of this Marker.

Parameters
[in]_markerTypeThe desired render type

Implemented in OgreMarker, Ogre2Marker, BaseMarker< T >, BaseMarker< Ogre2Geometry >, and BaseMarker< OgreGeometry >.

◆ Size()

virtual double Size ( ) const
pure virtual

Get the size of the marker.

Returns
The size of the marker
See also
SetSize

Implemented in BaseMarker< T >.

◆ Type()

virtual MarkerType Type ( ) const
pure virtual

Get the render type of this Marker.

Returns
The render type of the marker

Implemented in OgreMarker, Ogre2Marker, and BaseMarker< T >.


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