Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_Point Class Reference

Handles the TKE_Marker, TKE_Text_Path TKE_Distant_Light, and TKE_Local_Light opcodes. More...

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Point:

BBaseOpcodeHandler BControlledMemoryObject

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
double const * GetDPoint () const
int GetOptions () const
float const * GetPoint () const
TK_Status Read (BStreamFileToolkit &tk)
TK_Status ReadAscii (BStreamFileToolkit &tk)
 Deprecated.
void Reset (void)
void SetDPoint (double const *p)
void SetDPoint (double x, double y, double z)
void SetOptions (int o)
void SetPoint (float const *p)
void SetPoint (float x, float y, float z)
 TK_Point (unsigned char opcode)
TK_Status Write (BStreamFileToolkit &tk)
TK_Status WriteAscii (BStreamFileToolkit &tk)
 Deprecated.

Protected Attributes

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


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.


Constructor & Destructor Documentation

TK_Point::TK_Point ( unsigned char  opcode  )  [inline]

constructor


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.

double const* TK_Point::GetDPoint (  )  const [inline]

Returns the point as the address of a float triplet

int TK_Point::GetOptions (  )  const [inline]

Returns the options (for lights only)

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

Returns the point as the address of a float triplet

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.

References BBaseOpcodeHandler::Reset().

void TK_Point::SetDPoint ( double const *  p  )  [inline]

Sets the point using a float triplet

void TK_Point::SetDPoint ( double  x,
double  y,
double  z 
) [inline]

Sets the point using discrete double values

void TK_Point::SetOptions ( int  o  )  [inline]

Sets the options (for lights only)

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

Sets the point using a float triplet

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

Sets the point using discrete float values

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

double TK_Point::m_dpoint[3] [protected]

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

float TK_Point::m_point[3] [protected]

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


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