Gazebo Rendering

API Reference

3.7.2
Ogre2DynamicRenderable Class Reference

Dynamic renderable class that manages hardware buffers for a dynamic geometry. More...

#include <Ogre2DynamicRenderable.hh>

Public Member Functions

 Ogre2DynamicRenderable (ScenePtr _scene)
 Constructor. More...
 
virtual ~Ogre2DynamicRenderable ()
 Virtual destructor. More...
 
void AddPoint (const double _x, const double _y, const double _z, const gz::math::Color &_color=gz::math::Color::White)
 Add a point to the point list. More...
 
void AddPoint (const gz::math::Vector3d &_pt, const gz::math::Color &_color=gz::math::Color::White)
 Add a point to the point list. More...
 
void Clear ()
 Remove all points from the point list. More...
 
void Destroy ()
 Destroy the dynamic renderable. More...
 
Ogre::MovableObject * OgreObject () const
 Get the ogre object associated with this dynamic renderable. More...
 
MarkerType OperationType () const
 Get the render operation type. More...
 
gz::math::Vector3d Point (unsigned int _index) const
 Return the position of an existing point in the point list. More...
 
unsigned int PointCount () const
 Return the total number of points in the point list. More...
 
void SetColor (unsigned int _index, const gz::math::Color &_color)
 Change the color of an existing point in the point list. More...
 
void SetMaterial (MaterialPtr _material, bool _unique=true)
 Set the material for this dynamic renderable. More...
 
void SetOperationType (MarkerType _opType)
 Set the render operation type. More...
 
void SetPoint (unsigned int _index, const gz::math::Vector3d &_value)
 Change the location of an existing point in the point list. More...
 
void Update ()
 Update the dynamic renderable. More...
 

Detailed Description

Dynamic renderable class that manages hardware buffers for a dynamic geometry.

Constructor & Destructor Documentation

◆ Ogre2DynamicRenderable()

Ogre2DynamicRenderable ( ScenePtr  _scene)
explicit

Constructor.

Parameters
[in]_scenePointer to scene

◆ ~Ogre2DynamicRenderable()

virtual ~Ogre2DynamicRenderable ( )
virtual

Virtual destructor.

Member Function Documentation

◆ AddPoint() [1/2]

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

Add a point to the point list.

Parameters
[in]_xX position
[in]_yY position
[in]_zZ position
[in]_colorPoint color

◆ AddPoint() [2/2]

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

Add a point to the point list.

Parameters
[in]_ptgz::math::Vector3d point
[in]_colorgz::math::Color Point color

◆ Clear()

void Clear ( )

Remove all points from the point list.

◆ Destroy()

void Destroy ( )

Destroy the dynamic renderable.

◆ OgreObject()

Ogre::MovableObject* OgreObject ( ) const

Get the ogre object associated with this dynamic renderable.

◆ OperationType()

MarkerType OperationType ( ) const

Get the render operation type.

Returns
The render operation type.

◆ Point()

gz::math::Vector3d Point ( unsigned int  _index) const

Return the position of an existing point in the point list.

Parameters
[in]_indexGet the point at this index
Returns
position of point. A vector of [gz::math::INF_D, gz::math::INF_D, gz::math::INF_D] is returned when then the _index is out of bounds. gz::math::INF_D==std::numeric_limits<double>::infinity()

◆ PointCount()

unsigned int PointCount ( ) const

Return the total number of points in the point list.

Returns
Number of points

◆ SetColor()

void SetColor ( unsigned int  _index,
const gz::math::Color &  _color 
)

Change the color of an existing point in the point list.

Parameters
[in]_indexIndex of the point to set
[in]_colorcolor to set the point to

◆ SetMaterial()

void SetMaterial ( MaterialPtr  _material,
bool  _unique = true 
)

Set the material for this dynamic renderable.

Parameters
[in]_materialNew Material to be assigned
[in]_uniqueTrue if the given material should be cloned

◆ SetOperationType()

void SetOperationType ( MarkerType  _opType)

Set the render operation type.

Parameters
[in]_opTypeThe type of render operation to perform.

◆ SetPoint()

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

Change the location of an existing point in the point list.

Parameters
[in]_indexIndex of the point to set
[in]_valuePosition of the point

◆ Update()

void Update ( )

Update the dynamic renderable.


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