OgreDynamicLines Class Reference

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

#include <OgreDynamicLines.hh>

Public Member Functions
	OgreDynamicLines (MarkerType _opType=MT_LINE_STRIP)
	Constructor.
virtual	~OgreDynamicLines ()
	Destructor.
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.
void	AddPoint (const gz::math::Vector3d &_pt, const gz::math::Color &_color=gz::math::Color::White)
	Add a point to the point list.
void	Clear ()
	Remove all points from the point list.
gz::math::Vector3d	Point (unsigned int _index) const
	Return the location of an existing point in the point list.
unsigned int	PointCount () const
	Return the total number of points in the point list.
void	SetColor (unsigned int _index, const gz::math::Color &_color)
	Change the color of an existing point in the point list.
void	SetPoint (unsigned int _index, const gz::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.
Public Member Functions inherited from OgreDynamicRenderable
	OgreDynamicRenderable ()
	Constructor.
virtual	~OgreDynamicRenderable ()
	Virtual destructor.
virtual Ogre::Real	getBoundingRadius () const
	Implementation of Ogre::SimpleRenderable.
virtual Ogre::Real	getSquaredViewDepth (const Ogre::Camera *_cam) const
	Implementation of Ogre::SimpleRenderable.
void	Init (MarkerType _opType, bool _useIndices=false)
	Initializes the dynamic renderable.
MarkerType	OperationType () const
	Get the render operation type.
void	SetOperationType (MarkerType _opType)
	Set the render operation type.

Additional Inherited Members
Protected Member Functions inherited from OgreDynamicRenderable
void	PrepareHardwareBuffers (size_t _vertexCount, size_t _indexCount)
	Prepares the hardware buffers for the requested vertex and index counts.
Protected Attributes inherited from OgreDynamicRenderable
size_t	indexBufferCapacity = 0
	Maximum capacity of the currently allocated index buffer.
size_t	vertexBufferCapacity = 0
	Maximum capacity of the currently allocated vertex buffer.

Detailed Description

Class for drawing lines that can change.

Constructor & Destructor Documentation

OgreDynamicLines()

OgreDynamicLines ( MarkerType  _opType = MT_LINE_STRIP )

explicit

Constructor.

Parameters

[in]

_opType

The type of Line

~OgreDynamicLines()

virtual ~OgreDynamicLines ( )

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]	_x	X position
[in]	_y	Y position
[in]	_z	Z position
[in]	_color	gz::math::Color Point 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]	_pt	gz::math::Vector3d point
[in]	_color	gz::math::Color Point color

Clear()

void Clear

(

)

Remove all points from the point list.

Point()

gz::math::Vector3d Point

(

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

gz::math::Vector3d value of the 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]	_index	Index of the point to set
[in]	_color	gz::math::Color Pixelcolor color to set the point to

SetPoint()

void SetPoint	(	unsigned int	_index,
		const gz::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	gz::math::Vector3d value to set the point to

Update()

void Update

(

)

Call this to update the hardware buffer after making changes.

---

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

• OgreDynamicLines.hh