Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

Public Member Functions | Protected Member Functions | Protected Attributes
TK_Polypoint Class Reference

Handles the TKE_Polyline and TKE_Polygon opcodes. More...

#include <BOpcodeHandler.h>

List of all members.

Public Member Functions

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

Protected Member Functions

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

Protected Attributes

int m_allocated
int m_count
float * m_points

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.


Constructor & Destructor Documentation

TK_Polypoint::TK_Polypoint ( unsigned char  opcode) [inline]

constructor


Member Function Documentation

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

Copies the opcode handler

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

Reimplemented from BBaseOpcodeHandler.

int TK_Polypoint::GetCount ( ) const [inline]

Returns the number of points in the buffer

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

Returns the address of the point buffer

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

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

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:
tkA reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.

void TK_Polypoint::Reset ( ) [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

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:
tkA 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

int TK_Polypoint::m_count [protected]

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

float* TK_Polypoint::m_points [protected]

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


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