Handles the TKE_Visibility opcode. More...
#include <BOpcodeHandler.h>
Public Member Functions | |
TK_Status | Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const |
int | GetGeometry () const |
int | GetValue () const |
TK_Status | Read (BStreamFileToolkit &tk) alter |
TK_Status | ReadAscii (BStreamFileToolkit &tk) alter |
Deprecated. | |
void | SetGeometry (int m) alter |
void | SetValue (int m) alter |
TK_Visibility (void) | |
TK_Status | Write (BStreamFileToolkit &tk) alter |
TK_Status | WriteAscii (BStreamFileToolkit &tk) alter |
Deprecated. | |
Protected Attributes | |
int | m_mask |
internal use; specifies which visibility settings are active (and hence, which are valid). For internal use only. | |
int | m_value |
internal use; specifies what values to set for boolean options. For internal use only. |
Handles the TKE_Visibility opcode.
TK_Visibility provides support for writing/reading the TKE_Visibility opcode object to/from an HSF file.
The HOOPS/3dGS scene-graph supports an attribute called Visibility which affects the display of objects.
TK_Visibility::TK_Visibility | ( | void | ) | [inline] |
constructor
TK_Status TK_Visibility::Clone | ( | BStreamFileToolkit & | tk, |
BBaseOpcodeHandler ** | handler | ||
) | const [virtual] |
Copies the opcode handler
tk | A reference to the BStreamFileToolkit object. |
handler | A pointer to the opcode handler object. Passed by reference. |
Reimplemented from BBaseOpcodeHandler.
Reimplemented in HTK_Visibility.
int TK_Visibility::GetGeometry | ( | ) | const [inline] |
Returns the mask indicating which geometries have a visibility setting. Geometry types are specified by TKO_Geometry_Bits.
int TK_Visibility::GetValue | ( | ) | const [inline] |
Returns the mask indicating which geometries have visibility set on. Geometry types are specified by TKO_Geometry_Bits.
TK_Status TK_Visibility::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.
tk | A reference to the BStreamFileToolkit object. |
Implements BBaseOpcodeHandler.
void TK_Visibility::SetGeometry | ( | int | m | ) | [inline] |
Sets the mask indicating which geometries have a visibility setting. Geometry types are specified by TKO_Geometry_Bits.
References TKO_Geo_All_Visibles, TKO_Geo_Extended, TKO_Geo_Extended2, TKO_Geo_Extended2_Mask, and TKO_Geo_Extended_Mask.
void TK_Visibility::SetValue | ( | int | m | ) | [inline] |
Sets the mask indicating which geometries have visibility set on. Geometry types are specified by TKO_Geometry_Bits.
TK_Status TK_Visibility::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.
tk | A reference to the BStreamFileToolkit object. |
Implements BBaseOpcodeHandler.