TK_Spot_Light Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Spot_Light:

Inheritance graph
[legend]
Collaboration diagram for TK_Spot_Light:

Collaboration graph
[legend]
List of all members.

Detailed Description

Handles the TKE_Spot_Light opcode.

TK_Spot_Light provides support for writing/reading the TKE_Spot_Light opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph supports 'spot-lights' which define a light cone

Definition at line 5995 of file BOpcodeHandler.h.

Public Member Functions

 TK_Spot_Light ()
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
void SetPosition (float x, float y, float z) alter
void SetPosition (float const *p) alter
float const * GetPosition (void) const
void SetTarget (float x, float y, float z) alter
void SetTarget (float const *t) alter
float const * GetTarget (void) const
void SetOuter (float o) alter
float GetOuter (void) const
void SetInner (float i) alter
float GetInner (void) const
void SetConcentration (float c) alter
float GetConcentration (void) const
void SetOptions (int o) alter
int GetOptions (void) const

Protected Attributes

float m_position [3]
 for internal use only
float m_target [3]
 for internal use only
float m_outer
 for internal use only
float m_inner
 for internal use only
float m_concentration
 for internal use only
char m_options
 for internal use only


Constructor & Destructor Documentation

TK_Spot_Light::TK_Spot_Light  )  [inline]
 

constructor

Definition at line 6010 of file BOpcodeHandler.h.


Member Function Documentation

TK_Status TK_Spot_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.

float TK_Spot_Light::GetConcentration void   )  const [inline]
 

Returns the concentration of the light

Definition at line 6049 of file BOpcodeHandler.h.

float TK_Spot_Light::GetInner void   )  const [inline]
 

Returns the inner cone angle of the light

Definition at line 6044 of file BOpcodeHandler.h.

int TK_Spot_Light::GetOptions void   )  const [inline]
 

Returns the options for the light. Options are specified by TKO_Spot_Light_Options.

Definition at line 6054 of file BOpcodeHandler.h.

float TK_Spot_Light::GetOuter void   )  const [inline]
 

Returns the outer cone angle of the light

Definition at line 6039 of file BOpcodeHandler.h.

float const* TK_Spot_Light::GetPosition void   )  const [inline]
 

Returns the position of the lihgt as the address of a float triplet

Definition at line 6026 of file BOpcodeHandler.h.

float const* TK_Spot_Light::GetTarget void   )  const [inline]
 

Returns the target of the lihgt as the address of a float triplet

Definition at line 6034 of file BOpcodeHandler.h.

TK_Status TK_Spot_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_Spot_Light::SetConcentration float  c  )  [inline]
 

Sets the concentration of the light

Definition at line 6047 of file BOpcodeHandler.h.

void TK_Spot_Light::SetInner float  i  )  [inline]
 

Sets the inner cone angle of the light

Definition at line 6042 of file BOpcodeHandler.h.

void TK_Spot_Light::SetOptions int  o  )  [inline]
 

Sets the options for the light. Options are specified by TKO_Spot_Light_Options.

Definition at line 6052 of file BOpcodeHandler.h.

void TK_Spot_Light::SetOuter float  o  )  [inline]
 

Sets the outer cone angle of the light

Definition at line 6037 of file BOpcodeHandler.h.

void TK_Spot_Light::SetPosition float const *  p  )  [inline]
 

Sets the position of the light using a float triplet

Definition at line 6024 of file BOpcodeHandler.h.

void TK_Spot_Light::SetPosition float  x,
float  y,
float  z
[inline]
 

Sets the position of the light using discrete float values

Definition at line 6021 of file BOpcodeHandler.h.

void TK_Spot_Light::SetTarget float const *  t  )  [inline]
 

Sets the target of the light using a float triplet

Definition at line 6032 of file BOpcodeHandler.h.

void TK_Spot_Light::SetTarget float  x,
float  y,
float  z
[inline]
 

Sets the target of the light using discrete float values

Definition at line 6029 of file BOpcodeHandler.h.

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