DtDebugDrawerSphereMemory Class Reference

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

Inheritance diagram for DtDebugDrawerSphereMemory:

Public Member Functions
	DtDebugDrawerSphereMemory ()
	Constructor.
	~DtDebugDrawerSphereMemory ()
	Destructor.
virtual char *	encode (char *buffer)
	Encodes this sphere into a buffer.
virtual const char *	decode (const char *buffer)
	Decodes a sphere 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 Member Functions inherited from DtDebugDrawerGeometryMemory
	DtDebugDrawerGeometryMemory ()
	Constructor.
virtual	~DtDebugDrawerGeometryMemory ()
	Destructor.

Public Attributes
DtVector	myCenter
	The center of the sphere.
double	myRadius
	The radius of the sphere.
Public Attributes inherited from DtDebugDrawerGeometryMemory
DtDebugDrawerGeometryMemoryColor	myColor
	The color of this geometry.

Detailed Description

A sphere definition to be stored in shared memory.

Constructor & Destructor Documentation

DtDebugDrawerSphereMemory::DtDebugDrawerSphereMemory

(

)

Constructor.

DtDebugDrawerSphereMemory::~DtDebugDrawerSphereMemory

(

)

Destructor.

Member Function Documentation

virtual char* DtDebugDrawerSphereMemory::encode ( char *  buffer )

virtual

Encodes this sphere into a buffer.

Parameters

buffer

pointer 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* DtDebugDrawerSphereMemory::decode ( const char *  buffer )

virtual

Decodes a sphere 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

buffer

Pointer 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 DtDebugDrawerSphereMemory::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 DtDebugDrawerSphereMemory::type ( )

virtual

Gets the type of this object.

Used to identify the object of this class.

Returns

Returns the integer value 1.

Implements DtDebugDrawerGeometryMemory.

Member Data Documentation

DtVector DtDebugDrawerSphereMemory::myCenter

The center of the sphere.

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

double DtDebugDrawerSphereMemory::myRadius

The radius of the sphere.

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

---

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

• include/simTerrainDrawer/debugDrawerSphereMemory.h