TK_Area_Light
-
class
TK_Area_Light Handles the TKE_Area_Light opcode.
TK_Area_Lightprovides 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
Inherits from:
BBaseOpcodeHandler
Methods
-
void
TK_Area_Light::set_points(int count, float const points[] = 0) protected
internal use
-
TK_Area_Light::TK_Area_Light() constructor
-
TK_Area_Light::~TK_Area_Light()
-
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 theBStreamFileToolkitobject.Returns
The result of the function call.
-
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 theBStreamFileToolkitobject.Returns
The result of the function call.
-
TK_Status
TK_Area_Light::Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const const virtual
Copies the opcode handler
Parameters
tk: A reference to the
BStreamFileToolkitobject.handler: A pointer to the opcode handler object. Passed by reference.
Returns
The result of the function call.
-
TK_Status
TK_Area_Light::ReadAscii(BStreamFileToolkit &tk) Deprecated.
-
TK_Status
TK_Area_Light::WriteAscii(BStreamFileToolkit &tk) Deprecated.
-
void
TK_Area_Light::Reset() 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.
-
void
TK_Area_Light::SetPoints(int count, float const points[] = 0) Sets the point array. Allocates a buffer which will hold ‘count’ float triplets, and if specified, copies the ‘points’ into the buffer
-
float const *
TK_Area_Light::GetPoints() const const
Returns the address of the point buffer
-
float *
TK_Area_Light::GetPoints() Returns the address of the point buffer, which may be modified directly
-
void
TK_Area_Light::SetDPoints(int count, double const points[] = 0) Sets the point array. Allocates a buffer which will hold ‘count’ double triplets, and if specified, copies the ‘points’ into the buffer
-
double const *
TK_Area_Light::GetDPoints() const const
Returns the address of the point buffer
-
double *
TK_Area_Light::GetDPoints() Returns the address of the point buffer, which may be modified directly
-
int
TK_Area_Light::GetCount() const const
Returns the number of points in the buffer
-
void
TK_Area_Light::SetOptions(int o) Sets the options for the light
-
int
TK_Area_Light::GetOptions() const const
Returns the options for the light
Variables
-
int
TK_Area_Light::m_count protected
intinternal use
-
float *
TK_Area_Light::m_points protected
floatinternal use
-
double *
TK_Area_Light::m_dpoints protected
doubleinternal use
-
char
TK_Area_Light::m_options protected
charinternal use