DtDebugDrawerLineMemory Class Reference

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

Inheritance diagram for DtDebugDrawerLineMemory:

List of all members.

Public Member Functions
	DtDebugDrawerLineMemory ()
	Constructor.
	~DtDebugDrawerLineMemory ()
	Destructor.
virtual char *	encode (char *buffer)
	Encodes this line into a buffer.
virtual const char *	decode (const char *buffer)
	Decodes a line 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 line.
DtVector	myPoint2
	The second point of the line.

---

Detailed Description

A line definition to be stored in shared memory.

---

Constructor & Destructor Documentation

DtDebugDrawerLineMemory::DtDebugDrawerLineMemory

(

)

Constructor.

DtDebugDrawerLineMemory::~DtDebugDrawerLineMemory

(

)

Destructor.

---

Member Function Documentation

virtual char* DtDebugDrawerLineMemory::encode

(

char *

buffer

)

[virtual]

Encodes this line 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* DtDebugDrawerLineMemory::decode

(

const char *

buffer

)

[virtual]

Decodes a line 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 DtDebugDrawerLineMemory::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 DtDebugDrawerLineMemory::type

(

)

[virtual]

Gets the type of this object.

Used to identify the object of this class.

Returns:

Returns the integer value 2.

Implements DtDebugDrawerGeometryMemory.

---

Member Data Documentation

DtVector DtDebugDrawerLineMemory::myPoint1

The first point of the line.

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

DtVector DtDebugDrawerLineMemory::myPoint2

The second point of the line.

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/debugDrawerLineMemory.h