Class for drawing lines that can change.
More...
#include <rendering/rendering.hh>
Inherits DynamicRenderable.
|
| DynamicLines (RenderOpType _opType=RENDERING_LINE_STRIP) |
| Constructor.
|
|
virtual | ~DynamicLines () |
| Destructor.
|
|
void | AddPoint (const double _x, const double _y, const double _z, const ignition::math::Color &_color=ignition::math::Color::White) |
| Add a point to the point list.
|
|
void | AddPoint (const ignition::math::Vector3d &_pt, const ignition::math::Color &_color=ignition::math::Color::White) |
| Add a point to the point list.
|
|
void | Clear () |
| Remove all points from the point list.
|
|
virtual Ogre::Real | getBoundingRadius () const |
| Implementation of Ogre::SimpleRenderable.
|
|
virtual const Ogre::String & | getMovableType () const |
| Overridden function from Ogre's base class.
|
|
std::string | GetMovableType () const |
| Get type of movable.
|
|
RenderOpType | GetOperationType () const |
| Get the render operation type.
|
|
unsigned int | GetPointCount () const |
| Return the total number of points in the point list.
|
|
virtual Ogre::Real | getSquaredViewDepth (const Ogre::Camera *_cam) const |
| Implementation of Ogre::SimpleRenderable.
|
|
void | Init (RenderOpType _opType, bool _useIndices=false) |
| Initializes the dynamic renderable.
|
|
ignition::math::Vector3d | Point (const unsigned int _index) const |
| Return the location of an existing point in the point list.
|
|
void | SetColor (const unsigned int _index, const ignition::math::Color &_color) |
| Change the color of an existing point in the point list.
|
|
void | SetOperationType (RenderOpType _opType) |
| Set the render operation type.
|
|
void | SetPoint (const unsigned int _index, const ignition::math::Vector3d &_value) |
| Change the location of an existing point in the point list.
|
|
void | Update () |
| Call this to update the hardware buffer after making changes.
|
|
|
void | PrepareHardwareBuffers (size_t _vertexCount, size_t _indexCount) |
| Prepares the hardware buffers for the requested vertex and index counts.
|
|
Class for drawing lines that can change.
◆ DynamicLines()
Constructor.
- Parameters
-
[in] | _opType | The type of Line |
◆ ~DynamicLines()
◆ AddPoint() [1/2]
void AddPoint |
( |
const double | _x, |
|
|
const double | _y, |
|
|
const double | _z, |
|
|
const ignition::math::Color & | _color = ignition::math::Color::White ) |
Add a point to the point list.
- Parameters
-
[in] | _x | X position |
[in] | _y | Y position |
[in] | _z | Z position |
[in] | _color | ignition::math::Color Point color |
◆ AddPoint() [2/2]
void AddPoint |
( |
const ignition::math::Vector3d & | _pt, |
|
|
const ignition::math::Color & | _color = ignition::math::Color::White ) |
Add a point to the point list.
- Parameters
-
[in] | _pt | ignition::math::Vector3d point |
[in] | _color | ignition::math::Color Point color |
◆ Clear()
Remove all points from the point list.
◆ getBoundingRadius()
virtual Ogre::Real getBoundingRadius |
( |
| ) |
const |
|
virtualinherited |
Implementation of Ogre::SimpleRenderable.
- Returns
- The bounding radius
◆ GetMovableType() [1/2]
static std::string GetMovableType |
( |
| ) |
|
|
static |
Get type of movable.
- Returns
- This returns "gazebo::dynamiclines"
◆ getMovableType()
virtual const Ogre::String & getMovableType |
( |
| ) |
const |
|
virtual |
Overridden function from Ogre's base class.
- Returns
- Returns "gazebo::ogredynamicslines"
◆ GetMovableType() [2/2]
std::string GetMovableType |
( |
| ) |
const |
|
inherited |
Get type of movable.
- Returns
- This returns "gazebo::DynamicRenderable"
◆ GetOperationType()
Get the render operation type.
- Returns
- The render operation type.
◆ GetPointCount()
unsigned int GetPointCount |
( |
| ) |
const |
Return the total number of points in the point list.
- Returns
- Number of points
◆ getSquaredViewDepth()
virtual Ogre::Real getSquaredViewDepth |
( |
const Ogre::Camera * | _cam | ) |
const |
|
virtualinherited |
Implementation of Ogre::SimpleRenderable.
- Parameters
-
[in] | _cam | Pointer to the Ogre camera that views the renderable. |
- Returns
- The squared depth in the Camera's view
◆ Init()
void Init |
( |
RenderOpType | _opType, |
|
|
bool | _useIndices = false ) |
|
inherited |
Initializes the dynamic renderable.
- Parameters
-
[in] | _opType | The type of render operation to perform. |
[in] | _useIndices | Specifies whether to use indices to determine the vertices to use as input. |
◆ Point()
ignition::math::Vector3d Point |
( |
const unsigned int | _index | ) |
const |
Return the location of an existing point in the point list.
- Parameters
-
[in] | _index | Number of the point to return |
- Returns
- ignition::math::Vector3d value of the point. A vector of [ignition::math::INF_D, ignition::math::INF_D, ignition::math::INF_D] is returned when then the _index is out of bounds. ignition::math::INF_D==std::numeric_limits<double>::infinity()
◆ PrepareHardwareBuffers()
void PrepareHardwareBuffers |
( |
size_t | _vertexCount, |
|
|
size_t | _indexCount ) |
|
protectedinherited |
Prepares the hardware buffers for the requested vertex and index counts.
- The vertex and index count in the render operation are set to
- the values of vertexCount and indexCount respectively.
- Parameters
-
[in] | _vertexCount | The number of vertices the buffer must hold. |
[in] | _indexCount | The number of indices the buffer must hold. This parameter is ignored if not using indices. |
◆ SetColor()
void SetColor |
( |
const unsigned int | _index, |
|
|
const ignition::math::Color & | _color ) |
Change the color of an existing point in the point list.
- Parameters
-
[in] | _index | Index of the point to set |
[in] | _color | ignition::math::Color Pixelcolor color to set the point to |
◆ SetOperationType()
Set the render operation type.
- Parameters
-
[in] | _opType | The type of render operation to perform. |
◆ SetPoint()
void SetPoint |
( |
const unsigned int | _index, |
|
|
const ignition::math::Vector3d & | _value ) |
Change the location of an existing point in the point list.
- Parameters
-
[in] | _index | Index of the point to set |
[in] | _value | ignition::math::Vector3d value to set the point to |
◆ Update()
Call this to update the hardware buffer after making changes.
◆ indexBufferCapacity
size_t indexBufferCapacity |
|
protectedinherited |
Maximum capacity of the currently allocated index buffer.
◆ vertexBufferCapacity
size_t vertexBufferCapacity |
|
protectedinherited |
Maximum capacity of the currently allocated vertex buffer.
The documentation for this class was generated from the following file: