##

DynamicLines Class Reference
Rendering

Class for drawing lines that can change. More...

`#include <rendering/rendering.hh>`

Inherits DynamicRenderable.

## Public Member Functions

| DynamicLines (RenderOpType _opType=RENDERING_LINE_STRIP)
| Constructor. More...
virtual | ~DynamicLines ()
| Destructor. More...
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. More...
void | AddPoint (const ignition::math::Vector3d &_pt, const common::Color &_color) GAZEBO_DEPRECATED(9.0)
| Add a point to the point list. More...
void | AddPoint (const ignition::math::Vector3d &_pt, const ignition::math::Color &_color=ignition::math::Color::White)
| Add a point to the point list. More...
void | AddPoint (double _x, double _y, double _z, const common::Color &_color) GAZEBO_DEPRECATED(9.0)
| Add a point to the point list. More...
void | Clear ()
| Remove all points from the point list. More...
virtual Ogre::Real | getBoundingRadius () const
| Implementation of Ogre::SimpleRenderable. More...
virtual const Ogre::String & | getMovableType () const
| Overridden function from Ogre's base class. More...
std::string | GetMovableType () const
| Get type of movable. More...
RenderOpType | GetOperationType () const
| Get the render operation type. More...
unsigned int | GetPointCount () const
| Return the total number of points in the point list. More...
virtual Ogre::Real | getSquaredViewDepth (const Ogre::Camera *_cam) const
| Implementation of Ogre::SimpleRenderable. More...
void | Init (RenderOpType _opType, bool _useIndices=false)
| Initializes the dynamic renderable. More...
ignition::math::Vector3d | Point (const unsigned int _index) const
| Return the location of an existing point in the point list. More...
void | SetColor (const unsigned int _index, const ignition::math::Color &_color)
| Change the color of an existing point in the point list. More...
void | SetColor (unsigned int _index, const common::Color &_color) GAZEBO_DEPRECATED(9.0)
| Change the color of an existing point in the point list. More...
void | SetOperationType (RenderOpType _opType)
| Set the render operation type. More...
void | SetPoint (const unsigned int _index, const ignition::math::Vector3d &_value)
| Change the location of an existing point in the point list. More...
void | Update ()
| Call this to update the hardware buffer after making changes. More...

## Static Public Member Functions

static std::string | GetMovableType ()
| Get type of movable. More...

## Protected Member Functions

void | PrepareHardwareBuffers (size_t _vertexCount, size_t _indexCount)
| Prepares the hardware buffers for the requested vertex and index counts. More...

## Protected Attributes

size_t | indexBufferCapacity
| Maximum capacity of the currently allocated index buffer. More...
size_t | vertexBufferCapacity
| Maximum capacity of the currently allocated vertex buffer. More...

## Detailed Description

Class for drawing lines that can change.

## Constructor & Destructor Documentation

## DynamicLines()

DynamicLines | ( | RenderOpType | _opType = `RENDERING_LINE_STRIP` | ) |

explicit

Constructor.

Parameters

  [in] | _opType | The type of Line

## ~DynamicLines()

virtual ~DynamicLines | ( |  | ) |

virtual

Destructor.

## Member Function Documentation

## AddPoint() [1/4]

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/4]

void AddPoint | ( | const ignition::math::Vector3d & | _pt,
|  | const common::Color & | _color
| ) |  |

Add a point to the point list.

Parameters

  [in] | _pt | ignition::math::Vector3d point
  [in] | _color | common::Color Point color

Deprecated:
  See function that accepts ignition::math::Color

## AddPoint() [3/4]

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

## AddPoint() [4/4]

void AddPoint | ( | double | _x,
|  | double | _y,
|  | double | _z,
|  | const common::Color & | _color
| ) |  |

Add a point to the point list.

Parameters

  [in] | _x | X position
  [in] | _y | Y position
  [in] | _z | Z position
  [in] | _color | common::Color Point color

Deprecated:
  See function that accepts ignition::math::Color

## Clear()

void Clear | ( |  | ) |

Remove all points from the point list.

## getBoundingRadius()

virtual Ogre::Real getBoundingRadius | ( |  | ) | const

virtual inherited

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()

RenderOpType GetOperationType | ( |  | ) | const

inherited

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

virtual inherited

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.

Remarks
  This function should only be called once. It initializes the render operation, and calls the abstract function CreateVertexDeclaration().

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
| ) |  |

protected inherited

Prepares the hardware buffers for the requested vertex and index counts.

Remarks
  This function must be called before locking the buffers in fillHardwareBuffers(). It guarantees that the hardware buffers are large enough to hold at least the requested number of vertices and indices (if using indices). The buffers are possibly reallocated to achieve this.

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() [1/2]

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

## SetColor() [2/2]

void SetColor | ( | unsigned int | _index,
|  | const common::Color & | _color
| ) |  |

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

Parameters

  [in] | _index | Index of the point to set
  [in] | _color | common::Color Pixelcolor color to set the point to

Deprecated:
  See function that accepts ignition::math::Color

## SetOperationType()

void SetOperationType | ( | RenderOpType | _opType | ) |

inherited

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()

void Update | ( |  | ) |

Call this to update the hardware buffer after making changes.

## Member Data Documentation

## indexBufferCapacity

size_t indexBufferCapacity

protected inherited

Maximum capacity of the currently allocated index buffer.

## vertexBufferCapacity

size_t vertexBufferCapacity

protected inherited

Maximum capacity of the currently allocated vertex buffer.

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

- DynamicLines.hh