TK_Line Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Line:

Inheritance graph
[legend]
Collaboration diagram for TK_Line:

Collaboration graph
[legend]
List of all members.

Detailed Description

Handles the TKE_Line opcode.

TK_Line provides support for writing/reading the TKE_Line opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph supports 'line' primitives which consist of two 3D points.

Definition at line 5536 of file BOpcodeHandler.h.

Public Member Functions

 TK_Line ()
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
void SetPoints (float x1, float y1, float z1, float x2, float y2, float z2) alter
void SetPoints (float const *s, float const *e) alter
void SetPoints (float const *p) alter
float const * GetPoints (void) const

Protected Attributes

float m_points [6]


Constructor & Destructor Documentation

TK_Line::TK_Line  )  [inline]
 

default constructor

Definition at line 5547 of file BOpcodeHandler.h.


Member Function Documentation

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

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

Returns the point as the address of an array of six floats

Definition at line 5569 of file BOpcodeHandler.h.

TK_Status TK_Line::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_Line::SetPoints float const *  p  )  [inline]
 

Sets the line using an array of 6 floats

Definition at line 5567 of file BOpcodeHandler.h.

void TK_Line::SetPoints float const *  s,
float const *  e
[inline]
 

Sets the line using discrete float triplets

Definition at line 5563 of file BOpcodeHandler.h.

void TK_Line::SetPoints float  x1,
float  y1,
float  z1,
float  x2,
float  y2,
float  z2
[inline]
 

Sets the line using discrete float values

Definition at line 5558 of file BOpcodeHandler.h.

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

float TK_Line::m_points[6] [protected]
 

internal use; array of floats which denote the two sets of x,y,z values that define the line

Definition at line 5543 of file BOpcodeHandler.h.


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