TK_Polypoint Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Polypoint:

Inheritance graph
[legend]
Collaboration diagram for TK_Polypoint:

Collaboration graph
[legend]
List of all members.

Detailed Description

Handles the TKE_Polyline and TKE_Polygon opcodes.

TK_Polypoint provides support for writing/reading the TKE_Polyline and TKE_Polygon opcode objects to/from an HSF file.

The HOOPS/3dGS scene-graph supports 'polyline' and 'polygon' primitives which are both defined by a point count and points array.

See also TK_PolyPolypoint.

Definition at line 5625 of file BOpcodeHandler.h.

Public Member Functions

 TK_Polypoint (unsigned char opcode)
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
void Reset (void) alter
void SetPoints (int count, float const *points=0) alter
float const * GetPoints (void) const
float alter * GetPoints (void) alter
int GetCount (void) const

Protected Member Functions

void set_points (int count, float const *points=0) alter

Protected Attributes

int m_count
int m_allocated
float * m_points


Constructor & Destructor Documentation

TK_Polypoint::TK_Polypoint unsigned char  opcode  )  [inline]
 

constructor

Definition at line 5641 of file BOpcodeHandler.h.


Member Function Documentation

TK_Status TK_Polypoint::Clone BStreamFileToolkit tk,
BBaseOpcodeHandler **  handler
const [virtual]
 

Copies the opcode handler

Parameters:
tk A reference to the BStreamFileToolkit object.
handler A pointer to the opcode handler object. Passed by reference.
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

int TK_Polypoint::GetCount void   )  const [inline]
 

Returns the number of points in the buffer

Definition at line 5662 of file BOpcodeHandler.h.

float alter* TK_Polypoint::GetPoints void   )  [inline]
 

Returns the address of the point buffer, which may be modified directly

Definition at line 5660 of file BOpcodeHandler.h.

float const* TK_Polypoint::GetPoints void   )  const [inline]
 

Returns the address of the point buffer

Definition at line 5658 of file BOpcodeHandler.h.

TK_Status TK_Polypoint::Read BStreamFileToolkit tk  )  [virtual]
 

Reads data from the toolkit buffer, decodes/decompresses it, and maps it to the opcode handlers data members. User-defined classes which need to write out custom data should utilize one of the available GetData() methods.

Parameters:
tk A reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.

void TK_Polypoint::Reset void   )  [virtual]
 

Resets the current opcode handler. This is called by the toolkit when it is done processing an opcode. This method reinitializes any opcode handler variables and frees up temporary data.

Reimplemented from BBaseOpcodeHandler.

void TK_Polypoint::set_points int  count,
float const *  points = 0
[inline, protected]
 

for source compatibility in older versions

Definition at line 5636 of file BOpcodeHandler.h.

void TK_Polypoint::SetPoints int  count,
float const *  points = 0
 

Sets the point array. Allocates a buffer which will hold 'count' float triplets, and if specified, copies the 'points' into the buffer

TK_Status TK_Polypoint::Write BStreamFileToolkit tk  )  [virtual]
 

Encodes/compresses data and writes data to the toolkit buffer. User-defined classes which need to write out custom data should utilize one of the available PutData() methods, and first write out the opcode associated with the group of binary data followed by the data itself.

Parameters:
tk A reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.


Member Data Documentation

int TK_Polypoint::m_allocated [protected]
 

internal use; Number of points the allocated array can contain

Definition at line 5632 of file BOpcodeHandler.h.

int TK_Polypoint::m_count [protected]
 

internal use; number of 3D points that define this polypoint object

Definition at line 5631 of file BOpcodeHandler.h.

float* TK_Polypoint::m_points [protected]
 

internal use; Array of floats which denote the point coordinates.

Definition at line 5633 of file BOpcodeHandler.h.


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:41:45 2009 for Autodesk DWF 3D Toolkit by  doxygen 1.4.5