TK_Geometry_Options

Fields

unsigned char mask
unsigned char mode
float color
float alpha
float scale

Detailed Description

class TK_Geometry_Options : public BBaseOpcodeHandler

Handles the TKE_Geometry_Options opcode.

TK_Geometry_Options provides support for writing/reading the TKE_Geometry_Options opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph supports an attribute called Geometry_Options which provide instructions about scene-graph optimizations or required calculations

Public Functions

inline TK_Geometry_Options()

constructor

~TK_Geometry_Options()
virtual void Reset()

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.

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 SetMask(int m)

Sets the mask indicating which options have a setting. Options are specified by TKO_Geometry_Options.

inline int GetMask() const

Returns the mask indicating which options have a setting. Options are specified by TKO_Geometry_Options.

inline void SetOrientation(int count, float const o[])

Sets the one or two orientation vectors (as 3 or 6 float values)

inline int GetOrientationCount() const

returns the number of float values associated with the orientation vectors

inline float const *GetOrientation() const

returns the array of floats representing the orientation vectors

inline void SetCoordinateSystems(int count, char const cs[])

Sets the array of coordinate system identifiers

inline int GetCoordinateSystemCount() const

returns the number of coordinate system identifiers

inline char const *GetCoordinateSystems() const

returns the array of bytes representing the coordinate system identifiers

inline void SetCutVisualizationMask(int m)

Sets the mask indicating which cut visualization options have a setting. Options are specified by TKO_Geometry_Options.

inline int GetCutVisualizationMask() const

Returns the mask indicating which cut visualization options have a setting. Options are specified by TKO_Geometry_Options.

inline void SetCutVisualizationMode(int m)

Sets the cut visualization mode (shape). Options are specified by TKO_Geometry_Options.

inline int GetCutVisualizationMode() const

Returns the cut visualization mode (shape). Options are specified by TKO_Geometry_Options.

inline void SetCutVisualizationColor(float const *c)

Sets the cut visualization color given a float triplet. Options are specified by TKO_Geometry_Options.

inline float const *GetCutVisualizationColor() const

Returns the cut visualization mode color as the address of a float triplet. Options are specified by TKO_Geometry_Options.

inline void SetCutVisualizationAlpha(float a)

Sets the cut visualization alpha (opacity). Options are specified by TKO_Geometry_Options.

inline float GetCutVisualizationAlpha() const

Returns the cut visualization alpha (opacity)). Options are specified by TKO_Geometry_Options.

inline void SetCutVisualizationSCale(float s)

Sets the cut visualization scale factor. Options are specified by TKO_Geometry_Options.

inline float GetCutVisualizationScale() const

Returns the cut visualization scale factor. Options are specified by TKO_Geometry_Options.

Public Members

unsigned char mask

internal use

unsigned char mode
float color[3]
float alpha
float scale