TK_Spot_Light

Detailed Description

class TK_Spot_Light : public BBaseOpcodeHandler

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

Subclassed by HTK_Spot_Light

Public Functions

inline TK_Spot_Light()

constructor

virtual TK_Status Read(BStreamFileToolkit &tk)

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.
virtual TK_Status Write(BStreamFileToolkit &tk)

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.
virtual TK_Status Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const

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.

TK_Status ReadAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status WriteAscii(BStreamFileToolkit &tk)

Deprecated.

inline void SetPosition(float x, float y, float z)

Sets the position of the light using discrete float values

inline void SetPosition(float const p[])

Sets the position of the light using a float triplet

inline float const *GetPosition() const

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

inline void SetDPosition(double x, double y, double z)

Sets the position of the light using discrete double values

inline void SetDPosition(double const p[])

Sets the position of the light using a float triplet

inline double const *GetDPosition() const

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

inline void SetTarget(float x, float y, float z)

Sets the target of the light using discrete float values

inline void SetTarget(float const t[])

Sets the target of the light using a float triplet

inline float const *GetTarget() const

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

inline void SetDTarget(double x, double y, double z)

Sets the target of the light using discrete double values

inline void SetDTarget(double const t[])

Sets the target of the light using a float triplet

inline double const *GetDTarget() const

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

inline void SetOuter(float o)

Sets the outer cone angle of the light

inline float GetOuter() const

Returns the outer cone angle of the light

inline void SetInner(float i)

Sets the inner cone angle of the light

inline float GetInner() const

Returns the inner cone angle of the light

inline void SetConcentration(float c)

Sets the concentration of the light

inline float GetConcentration() const

Returns the concentration of the light

inline void SetOptions(int o)

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

inline int GetOptions() const

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