TK_Color_By_Value Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Color_By_Value:

Inheritance graph
[legend]
Collaboration diagram for TK_Color_By_Value:

Collaboration graph
[legend]
List of all members.

Detailed Description

Handles the TKE_Color_By_Value opcode.

TK_Color_By_Value provides support for writing/reading the TKE_Color_By_Value opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph segments can have colors set by value (RGB, HSV, HIC, etc...)

Definition at line 2270 of file BOpcodeHandler.h.

Public Member Functions

 TK_Color_By_Value ()
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 SetSpace (int s) alter
int GetSpace (void) const
void SetValue (float a, float b, float c) alter
void SetValue (float const *triple) alter
float const * GetValue (void) const

Protected Attributes

int m_mask
 internal use
float m_value [3]
 internal use
char m_space
 internal use


Constructor & Destructor Documentation

TK_Color_By_Value::TK_Color_By_Value  )  [inline]
 

constructor

Definition at line 2282 of file BOpcodeHandler.h.


Member Function Documentation

TK_Status TK_Color_By_Value::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_By_Value::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 2310 of file BOpcodeHandler.h.

int TK_Color_By_Value::GetSpace void   )  const [inline]
 

Returns the type of color space used to interpret the values

Definition at line 2315 of file BOpcodeHandler.h.

float const* TK_Color_By_Value::GetValue void   )  const [inline]
 

Returns the color value as the address of a float triplet

Definition at line 2324 of file BOpcodeHandler.h.

TK_Status TK_Color_By_Value::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_By_Value::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 2295 of file BOpcodeHandler.h.

void TK_Color_By_Value::SetSpace int  s  )  [inline]
 

Sets the type of color space used to interpret the values

Definition at line 2313 of file BOpcodeHandler.h.

void TK_Color_By_Value::SetValue float const *  triple  )  [inline]
 

Sets the color value as a float triplet

Definition at line 2322 of file BOpcodeHandler.h.

void TK_Color_By_Value::SetValue float  a,
float  b,
float  c
[inline]
 

Sets the color value as discrete floats

Definition at line 2318 of file BOpcodeHandler.h.

TK_Status TK_Color_By_Value::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:41 2009 for Autodesk DWF 3D Toolkit by  doxygen 1.4.5