Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_Cutting_Plane Class Reference

Handles the TKE_Cutting_Plane opcode. More...

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Cutting_Plane:

BBaseOpcodeHandler BControlledMemoryObject

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
int GetCount () const
float const * GetPlane () const
float const * GetPlanes () const
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status ReadAscii (BStreamFileToolkit &tk) alter
 Deprecated.
void Reset () alter
void SetPlane (float const *p) alter
void SetPlane (float a, float b, float c, float d) alter
void SetPlanes (int count, float const *p=0) alter
 TK_Cutting_Plane ()
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status WriteAscii (BStreamFileToolkit &tk) alter
 Deprecated.

Protected Attributes

int m_count
 internal use
float * m_planes
 internal use


Detailed Description

Handles the TKE_Cutting_Plane opcode.

TK_Cutting_Plane provides support for writing/reading the TKE_Cutting_Plane opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph supports 'cutting planes' which define a plane that will cut away part of the scene


Constructor & Destructor Documentation

TK_Cutting_Plane::TK_Cutting_Plane (  )  [inline]

constructor


Member Function Documentation

TK_Status TK_Cutting_Plane::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_Cutting_Plane::GetCount (  )  const [inline]

Returns the cutting planes buffer which may be modified directly

float const* TK_Cutting_Plane::GetPlane (  )  const [inline]

Returns the cutting plane as the address of an array of four floats

float const* TK_Cutting_Plane::GetPlanes (  )  const [inline]

Returns the cutting planes as the address of an array of four floats per plane

TK_Status TK_Cutting_Plane::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_Cutting_Plane::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_Cutting_Plane::SetPlane ( float const *  p  )  [inline]

Sets the cutting plane using an array of four floats

void TK_Cutting_Plane::SetPlane ( float  a,
float  b,
float  c,
float  d 
) [inline]

Sets the cutting plane using discrete float values

void TK_Cutting_Plane::SetPlanes ( int  count,
float const *  p = 0 
)

Sets the cutting planes and/or allocates space

TK_Status TK_Cutting_Plane::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: