Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_Clip_Region Class Reference

Handles the TKE_Clip_Region opcodes. More...

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Clip_Region:

BBaseOpcodeHandler BControlledMemoryObject HTK_Clip_Region

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
int GetCount () const
double * GetDPoints ()
double const * GetDPoints () const
int GetOptions () const
float * GetPoints ()
float const * GetPoints () const
TK_Status Read (BStreamFileToolkit &tk)
TK_Status ReadAscii (BStreamFileToolkit &tk)
 Deprecated.
void Reset ()
void SetDPoints (int count, double const *points=0)
void SetOptions (int o)
void SetPoints (int count, float const *points=0)
 TK_Clip_Region ()
TK_Status Write (BStreamFileToolkit &tk)
TK_Status WriteAscii (BStreamFileToolkit &tk)
 Deprecated.

Protected Attributes

int m_count
double * m_dpoints
char m_options
float * m_points


Detailed Description

Handles the TKE_Clip_Region opcodes.

TK_Clip_Region provides support for writing/reading the TKE_Clip_Region opcode to/from an HSF file. A clip region defines a convex clip region which should be applied to the contents of the current segment and all subsegments (just like any HOOPS/3dGS attribute)


Constructor & Destructor Documentation

TK_Clip_Region::TK_Clip_Region (  )  [inline]

constructor


Member Function Documentation

TK_Status TK_Clip_Region::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.

Reimplemented in HTK_Clip_Region.

int TK_Clip_Region::GetCount (  )  const [inline]

Returns the number of points in the buffer

double* TK_Clip_Region::GetDPoints (  )  [inline]

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

double const* TK_Clip_Region::GetDPoints (  )  const [inline]

Returns the address of the point buffer

int TK_Clip_Region::GetOptions (  )  const [inline]

Returns the option flags

float* TK_Clip_Region::GetPoints (  )  [inline]

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

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

Returns the address of the point buffer

TK_Status TK_Clip_Region::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_Clip_Region::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_Clip_Region::SetDPoints ( int  count,
double const *  points = 0 
)

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

void TK_Clip_Region::SetOptions ( int  o  )  [inline]

Sets the option flags

void TK_Clip_Region::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_Clip_Region::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_Clip_Region::m_count [protected]

internal use; Number of 3D points that define this clip region object

double* TK_Clip_Region::m_dpoints [protected]

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

char TK_Clip_Region::m_options [protected]

internal use; type of region and optional settings

float* TK_Clip_Region::m_points [protected]

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


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