VR-Forces 4.0.4 Class Documentation
Public Member Functions | Public Attributes
DtDebugDrawerTriangleMemory Class Reference

A triangle definition to be stored in shared memory. More...

Inheritance diagram for DtDebugDrawerTriangleMemory:
Inheritance graph
[legend]

List of all members.

Public Member Functions

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

Public Attributes

DtVector myPoint1
 The first point of the triangle.
DtVector myPoint2
 The second point of the triangle.
DtVector myPoint3
 The third point of the triangle.

Detailed Description

A triangle definition to be stored in shared memory.


Constructor & Destructor Documentation

Constructor.

Destructor.


Member Function Documentation

virtual char* DtDebugDrawerTriangleMemory::encode ( char *  buffer) [virtual]

Encodes this triangle 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.

Implements DtDebugDrawerGeometryMemory.

virtual const char* DtDebugDrawerTriangleMemory::decode ( const char *  buffer) [virtual]

Decodes a triangle 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.

Implements DtDebugDrawerGeometryMemory.

virtual int DtDebugDrawerTriangleMemory::getSize ( ) [virtual]

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

Returns:
A size in bytes. See description.

Implements DtDebugDrawerGeometryMemory.

virtual int DtDebugDrawerTriangleMemory::type ( ) [virtual]

Gets the type of this object.

Used to identify the object of this class.

Returns:
Returns the integer value 3.

Implements DtDebugDrawerGeometryMemory.


Member Data Documentation

The first point of the triangle.

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

The second point of the triangle.

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

The third point of the triangle.

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


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)