Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members

TK_Cutting_Plane Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Cutting_Plane:

Inheritance graph
[legend]
Collaboration diagram for TK_Cutting_Plane:

Collaboration graph
[legend]
List of all members.

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

Definition at line 3973 of file BOpcodeHandler.h.

Public Member Functions

 TK_Cutting_Plane ()
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
void SetPlane (float a, float b, float c, float d) alter
void SetPlane (float const *p) alter
float const * GetPlane (void) const

Protected Attributes

float m_plane [4]
 internal use


Constructor & Destructor Documentation

TK_Cutting_Plane::TK_Cutting_Plane  )  [inline]
 

constructor

Definition at line 3983 of file BOpcodeHandler.h.


Member Function Documentation

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

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

Definition at line 3995 of file BOpcodeHandler.h.

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

Sets the cutting plane using an array of four floats

Definition at line 3993 of file BOpcodeHandler.h.

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

Sets the cutting plane using discrete float values

Definition at line 3990 of file BOpcodeHandler.h.

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:
Generated on Tue May 17 12:06:07 2005 for Autodesk DWF 3D Toolkit by  doxygen 1.4.1