Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_Line Class Reference

Handles the TKE_Line opcode. More...

#include <BOpcodeHandler.h>

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
double const * GetDPoints () const
float const * GetPoints () const
TK_Status Read (BStreamFileToolkit &tk)
TK_Status ReadAscii (BStreamFileToolkit &tk)
 Deprecated.
void SetDPoints (double x1, double y1, double z1, double x2, double y2, double z2)
void SetDPoints (double const *s, double const *e)
void SetDPoints (double const *p)
void SetPoints (float x1, float y1, float z1, float x2, float y2, float z2)
void SetPoints (float const *s, float const *e)
void SetPoints (float const *p)
 TK_Line (unsigned char opcode=TKE_Line)
TK_Status Write (BStreamFileToolkit &tk)
TK_Status WriteAscii (BStreamFileToolkit &tk)
 Deprecated.

Protected Attributes

double m_dpoints [6]
float m_points [6]

Detailed Description

Handles the TKE_Line opcode.

TK_Line provides support for writing/reading the TKE_Line, TKE_Infinite_Line, and TKE_Infinite_Ray opcode objects to/from an HSF file.

The HOOPS/3dGS scene-graph supports 'line', 'infinite line', and infinite ray' primitives which are defined by two 3D points.


Constructor & Destructor Documentation

TK_Line::TK_Line ( unsigned char  opcode = TKE_Line) [inline]

default constructor


Member Function Documentation

TK_Status TK_Line::Clone ( BStreamFileToolkit tk,
BBaseOpcodeHandler **  handler 
) const [virtual]

Copies the opcode handler

Parameters:
tkA reference to the BStreamFileToolkit object.
handlerA pointer to the opcode handler object. Passed by reference.
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

Reimplemented in HTK_Line.

double const* TK_Line::GetDPoints ( ) const [inline]

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

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

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

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:
tkA reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.

void TK_Line::SetDPoints ( double  x1,
double  y1,
double  z1,
double  x2,
double  y2,
double  z2 
) [inline]

Sets the line using discrete double values

void TK_Line::SetDPoints ( double const *  s,
double const *  e 
) [inline]

Sets the line using discrete float triplets

void TK_Line::SetDPoints ( double const *  p) [inline]

Sets the line using an array of 6 floats

References SetDPoints().

Referenced by SetDPoints().

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

Sets the line using discrete float values

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

Sets the line using discrete float triplets

void TK_Line::SetPoints ( float const *  p) [inline]

Sets the line using an array of 6 floats

References SetPoints().

Referenced by SetPoints().

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:
tkA reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.


Member Data Documentation

double TK_Line::m_dpoints[6] [protected]

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

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


The documentation for this class was generated from the following file: