TK_Color_RGB Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Color_RGB:

Inheritance graph
[legend]
Collaboration diagram for TK_Color_RGB:

Collaboration graph
[legend]
List of all members.

Detailed Description

Handles the TKE_Color opcode.

TK_Color provides support for writing/reading the TKE_Color opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph segments can have a 'named' color (i.e. "faces = red, lines = blue")

Definition at line 2214 of file BOpcodeHandler.h.

Public Member Functions

 TK_Color_RGB ()
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
void SetGeometry (int m) alter
int GetGeometry (void) const
void SetRGB (float r, float g, float b) alter
void SetRGB (float const *rgb) alter
float const * GetRGB (void) const

Protected Attributes

int m_mask
 internal use
float m_rgb [3]
 internal use


Constructor & Destructor Documentation

TK_Color_RGB::TK_Color_RGB  )  [inline]
 

constructor

Definition at line 2225 of file BOpcodeHandler.h.


Member Function Documentation

TK_Status TK_Color_RGB::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_Color_RGB::GetGeometry void   )  const [inline]
 

Returns the mask value which indicates which types of geometry are affected by this color setting. Geometry types are specified by TKO_Geometry_Bits.

Definition at line 2253 of file BOpcodeHandler.h.

float const* TK_Color_RGB::GetRGB void   )  const [inline]
 

Returns the rgb color value as the address of a float triplet

Definition at line 2260 of file BOpcodeHandler.h.

TK_Status TK_Color_RGB::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_Color_RGB::SetGeometry int  m  )  [inline]
 

Sets the mask value which indicates which types of geometry are affected by this color setting. Geometry types are specified by TKO_Geometry_Bits.

Definition at line 2238 of file BOpcodeHandler.h.

void TK_Color_RGB::SetRGB float const *  rgb  )  [inline]
 

Sets the rgb color value as a float triplet

Definition at line 2258 of file BOpcodeHandler.h.

void TK_Color_RGB::SetRGB float  r,
float  g,
float  b
[inline]
 

Sets the rgb color value as discrete floats

Definition at line 2256 of file BOpcodeHandler.h.

TK_Status TK_Color_RGB::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 Jan 6 22:41:42 2009 for Autodesk DWF 3D Toolkit by  doxygen 1.4.5