Gazebo

OgreDynamicLines Class Reference
[Rendering]

#include <OgreDynamicLines.hh>

Inheritance diagram for OgreDynamicLines:

OgreDynamicRenderable

List of all members.


Detailed Description

Class for drawing lines

Public Member Functions

 OgreDynamicLines (Ogre::RenderOperation::OperationType opType=Ogre::RenderOperation::OT_LINE_STRIP)
 Constructor.
virtual ~OgreDynamicLines ()
 Destructor.
void AddPoint (const Vector3 &pt)
 Add a point to the point list.
void SetPoint (unsigned int index, const Vector3 &value)
 Change the location of an existing point in the point list.
const Vector3GetPoint (unsigned int index) const
 Return the location of an existing point in the point list.
unsigned int GetNumPoints () const
 Return the total number of points in the point list.
void Clear ()
 Remove all points from the point list.
void Update ()
 Call this to update the hardware buffer after making changes.
void SetOperationType (Ogre::RenderOperation::OperationType opType)
 Set the type of operation to draw with.
Ogre::RenderOperation::OperationType GetOperationType () const
 Get the operation type.

Protected Member Functions

virtual void CreateVertexDeclaration ()
virtual void FillHardwareBuffers ()

Member Function Documentation

void AddPoint ( const Vector3 pt  ) 

Add a point to the point list.

Parameters:
pt Vector3 point

void SetPoint ( unsigned int  index,
const Vector3 value 
)

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

Parameters:
index Index of the point to set
value Vector3 value to set the point to

const Vector3& GetPoint ( unsigned int  index  )  const

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

Parameters:
index Number of the point to return
Returns:
Vector3 value of the point

unsigned int GetNumPoints (  )  const

Return the total number of points in the point list.

Returns:
Number of points

void SetOperationType ( Ogre::RenderOperation::OperationType  opType  ) 

Set the type of operation to draw with.

Parameters:
opType Can be one of
  • RenderOperation::OT_LINE_STRIP
  • RenderOperation::OT_LINE_LIST
  • RenderOperation::OT_POINT_LIST
  • RenderOperation::OT_TRIANGLE_LIST
  • RenderOperation::OT_TRIANGLE_STRIP
  • RenderOperation::OT_TRIANGLE_FAN The default is OT_LINE_STRIP.

Reimplemented from OgreDynamicRenderable.

Ogre::RenderOperation::OperationType GetOperationType (  )  const

Get the operation type.

Returns:
The operation type

Reimplemented from OgreDynamicRenderable.

virtual void CreateVertexDeclaration (  )  [protected, virtual]

Implementation DynamicRenderable, creates a simple vertex-only decl

Implements OgreDynamicRenderable.

virtual void FillHardwareBuffers (  )  [protected, virtual]

Implementation DynamicRenderable, pushes point list out to hardware memory

Implements OgreDynamicRenderable.


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

Last updated Aug 04 2007