TK_Point Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Point:

Inheritance graph
[legend]
Collaboration diagram for TK_Point:

Collaboration graph
[legend]
List of all members.

Detailed Description

Handles the TKE_Marker, TKE_Text_Path TKE_Distant_Light, and TKE_Local_Light opcodes.

TK_Point provides support for writing/reading the TKE_Marker, TKE_Distant_Light, and TKE_Local_Light 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.

Definition at line 5483 of file BOpcodeHandler.h.

Public Member Functions

 TK_Point (unsigned char opcode)
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
void Reset (void)
void SetPoint (float x, float y, float z) alter
void SetPoint (float const *p) alter
float const * GetPoint (void) const
void SetOptions (int o) alter
int GetOptions (void) const

Protected Attributes

float m_point [3]
char m_options
 relevant to TKE_Distant_Light and TKE_Local_Light only. See TKO_Light_Options.


Constructor & Destructor Documentation

TK_Point::TK_Point unsigned char  opcode  )  [inline]
 

constructor

Definition at line 5494 of file BOpcodeHandler.h.


Member Function Documentation

TK_Status TK_Point::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_Point::GetOptions void   )  const [inline]
 

Returns the options (for lights only)

Definition at line 5525 of file BOpcodeHandler.h.

float const* TK_Point::GetPoint void   )  const [inline]
 

Returns the point as the address of a float triplet

Definition at line 5520 of file BOpcodeHandler.h.

TK_Status TK_Point::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_Point::Reset void   )  [inline, 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.

Definition at line 5507 of file BOpcodeHandler.h.

void TK_Point::SetOptions int  o  )  [inline]
 

Sets the options (for lights only)

Definition at line 5523 of file BOpcodeHandler.h.

void TK_Point::SetPoint float const *  p  )  [inline]
 

Sets the point using a float triplet

Definition at line 5518 of file BOpcodeHandler.h.

void TK_Point::SetPoint float  x,
float  y,
float  z
[inline]
 

Sets the point using discrete float values

Definition at line 5516 of file BOpcodeHandler.h.

TK_Status TK_Point::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_Point::m_point[3] [protected]
 

internal use; an array of three floats defining the x,y,z coordinates of the marker

Definition at line 5489 of file BOpcodeHandler.h.


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