TK_Area_Light Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Area_Light:

Inheritance graph
[legend]
Collaboration diagram for TK_Area_Light:

Collaboration graph
[legend]
List of all members.

Detailed Description

Handles the TKE_Area_Light opcode.

TK_Area_Light provides support for writing/reading the TKE_Area_Light opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph supports 'area-lights' which define a polygon that emits light

Definition at line 5922 of file BOpcodeHandler.h.

Public Member Functions

 TK_Area_Light ()
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
void Reset (void) alter
void SetPoints (int count, float const *points=0) alter
float const * GetPoints (void) const
float alter * GetPoints (void) alter
int GetCount (void) const
void SetOptions (int o) alter
int GetOptions (void) const

Protected Member Functions

void set_points (int count, float const *points=0) alter
 internal use

Protected Attributes

int m_count
 internal use
float * m_points
 internal use
char m_options
 internal use


Constructor & Destructor Documentation

TK_Area_Light::TK_Area_Light  )  [inline]
 

constructor

Definition at line 5937 of file BOpcodeHandler.h.


Member Function Documentation

TK_Status TK_Area_Light::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_Area_Light::GetCount void   )  const [inline]
 

Returns the number of points in the buffer

Definition at line 5960 of file BOpcodeHandler.h.

int TK_Area_Light::GetOptions void   )  const [inline]
 

Returns the options for the light

Definition at line 5965 of file BOpcodeHandler.h.

float alter* TK_Area_Light::GetPoints void   )  [inline]
 

Returns the address of the point buffer, which may be modified directly

Definition at line 5958 of file BOpcodeHandler.h.

float const* TK_Area_Light::GetPoints void   )  const [inline]
 

Returns the address of the point buffer

Definition at line 5956 of file BOpcodeHandler.h.

TK_Status TK_Area_Light::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_Area_Light::Reset void   )  [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.

void TK_Area_Light::SetOptions int  o  )  [inline]
 

Sets the options for the light

Definition at line 5963 of file BOpcodeHandler.h.

void TK_Area_Light::SetPoints int  count,
float const *  points = 0
[inline]
 

Sets the point array. Allocates a buffer which will hold 'count' float triplets, and if specified, copies the 'points' into the buffer

Definition at line 5954 of file BOpcodeHandler.h.

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