VR-Forces 4.0.4 Class Documentation
Public Member Functions | Public Attributes
DtDebugDrawerGeometryMemory Class Reference
Inheritance diagram for DtDebugDrawerGeometryMemory:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtDebugDrawerGeometryMemory ()
 Constructor.
virtual ~DtDebugDrawerGeometryMemory ()
 Destructor.
virtual char * encode (char *buffer)=0
 Encodes this shape geometry into a buffer.
virtual const char * decode (const char *buffer)=0
 Decodes this shape geometry from a buffer into this object.
virtual int getSize ()=0
 Gets the size this object would take in bytes were it encoded with encode().
virtual int type ()=0
 Gets the type of this object.

Public Attributes

DtDebugDrawerGeometryMemoryColor myColor
 The color of this geometry.

Constructor & Destructor Documentation

Constructor.

Destructor.


Member Function Documentation

virtual char* DtDebugDrawerGeometryMemory::encode ( char *  buffer) [pure virtual]

Encodes this shape geometry into a buffer.

Parameters:
bufferpointer to a character buffer
Returns:
Returns a pointer to the buffer after where this function wrote data from the buffer param.

Implemented in DtDebugDrawerTriangleMemory, DtDebugDrawerLineMemory, and DtDebugDrawerSphereMemory.

virtual const char* DtDebugDrawerGeometryMemory::decode ( const char *  buffer) [pure virtual]

Decodes this shape geometry from a buffer into this object.

This should only be called when it is certain that the the first set of data in the buffer is of this particular shape.

Parameters:
bufferPointer to a character buffer that previously had encode() called on it.
Returns:
Returns a pointer to the buffer after where this function read data from the buffer param. It is important to note that this reads the buffer like a queue rather than a stack.

Implemented in DtDebugDrawerTriangleMemory, DtDebugDrawerLineMemory, and DtDebugDrawerSphereMemory.

virtual int DtDebugDrawerGeometryMemory::getSize ( ) [pure virtual]

Gets the size this object would take in bytes were it encoded with encode().

Returns:
A size in bytes. See description.

Implemented in DtDebugDrawerTriangleMemory, DtDebugDrawerLineMemory, and DtDebugDrawerSphereMemory.

virtual int DtDebugDrawerGeometryMemory::type ( ) [pure virtual]

Gets the type of this object.

The types are integer values based on the number of points it requires to draw the shape. A sphere is a single point, a line is two points, and a triangle is three points.

Implemented in DtDebugDrawerTriangleMemory, DtDebugDrawerLineMemory, and DtDebugDrawerSphereMemory.


Member Data Documentation

The color of this geometry.

This member was intentionally left public for easier access to the values.


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)