TK_Bounding Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Bounding:

Inheritance graph
[legend]
Collaboration diagram for TK_Bounding:

Collaboration graph
[legend]
List of all members.

Detailed Description

Handles the TKE_Bounding, and TKE_Bounding_Info opcodes.

TK_Bounding provides support for writing/reading the TKE_Bounding TKE_Bounding_Info opcode objects to/from an HSF file.

The HOOPS/3dGS scene-graph supports 'marker' primitives which consist of a 3D point, as well as distant and local lights which are also denoted by a single 3D point.

Two different opcodes are used as follows: The TKE_Bounding opcode will exporta bounding volume that was explicitly set on a HOOPS segment (if any). The TKE_Bounding_Info will cause an explicit computation of the HOOPS/3dGS bounding information and export it.

Definition at line 5430 of file BOpcodeHandler.h.

Public Member Functions

 TK_Bounding (unsigned char opcode)
 TK_Bounding (unsigned char opcode, float *min, float *max)
 TK_Bounding (unsigned char opcode, float *center, float radius)
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const

Protected Attributes

float m_values [6]
 internal use
char m_type
 internal use


Constructor & Destructor Documentation

TK_Bounding::TK_Bounding unsigned char  opcode  )  [inline]
 

default constructor

Definition at line 5441 of file BOpcodeHandler.h.

TK_Bounding::TK_Bounding unsigned char  opcode,
float *  min,
float *  max
[inline]
 

constructor variant that accepts min and max values

Definition at line 5444 of file BOpcodeHandler.h.

TK_Bounding::TK_Bounding unsigned char  opcode,
float *  center,
float  radius
[inline]
 

constructor variant that accepts center and radius values

Definition at line 5450 of file BOpcodeHandler.h.


Member Function Documentation

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

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

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


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