TK_Clip_Region Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Clip_Region:

Inheritance graph
[legend]
Collaboration diagram for TK_Clip_Region:

Collaboration graph
[legend]
List of all members.

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)

Definition at line 7573 of file BOpcodeHandler.h.

Public Member Functions

 TK_Clip_Region ()
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
void SetOptions (int o) alter
int GetOptions (void) const

Protected Attributes

char m_options
int m_count
float * m_points


Constructor & Destructor Documentation

TK_Clip_Region::TK_Clip_Region  )  [inline]
 

constructor

Definition at line 7585 of file BOpcodeHandler.h.


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.

int TK_Clip_Region::GetCount void   )  const [inline]
 

Returns the number of points in the buffer

Definition at line 7608 of file BOpcodeHandler.h.

int TK_Clip_Region::GetOptions void   )  const [inline]
 

Returns the option flags

Definition at line 7613 of file BOpcodeHandler.h.

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

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

Definition at line 7606 of file BOpcodeHandler.h.

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

Returns the address of the point buffer

Definition at line 7604 of file BOpcodeHandler.h.

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 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_Clip_Region::SetOptions int  o  )  [inline]
 

Sets the option flags

Definition at line 7611 of file BOpcodeHandler.h.

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

Definition at line 7580 of file BOpcodeHandler.h.

char TK_Clip_Region::m_options [protected]
 

internal use; type of region and optional settings

Definition at line 7579 of file BOpcodeHandler.h.

float* TK_Clip_Region::m_points [protected]
 

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

Definition at line 7581 of file BOpcodeHandler.h.


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