TK_Visibility Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Visibility:

Inheritance graph
[legend]
Collaboration diagram for TK_Visibility:

Collaboration graph
[legend]
List of all members.

Detailed Description

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.

Definition at line 4219 of file BOpcodeHandler.h.

Public Member Functions

 TK_Visibility (void)
 TK_Visibility (const TK_Visibility &rVis)
TK_Visibilityoperator= (const TK_Visibility &rVis)
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
void SetGeometry (int m) alter
int GetGeometry (void) const
void SetValue (int m) alter
int GetValue (void) const

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.


Constructor & Destructor Documentation

TK_Visibility::TK_Visibility void   )  [inline]
 

constructor

Definition at line 4226 of file BOpcodeHandler.h.


Member Function Documentation

TK_Status TK_Visibility::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.

int TK_Visibility::GetGeometry void   )  const [inline]
 

Returns the mask indicating which geometries have a visibility setting. Geometry types are specified by TKO_Geometry_Bits.

Definition at line 4267 of file BOpcodeHandler.h.

int TK_Visibility::GetValue void   )  const [inline]
 

Returns the mask indicating which geometries have visibility set on. Geometry types are specified by TKO_Geometry_Bits.

Definition at line 4278 of file BOpcodeHandler.h.

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.

Parameters:
tk A reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

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.

Definition at line 4255 of file BOpcodeHandler.h.

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.

Definition at line 4273 of file BOpcodeHandler.h.

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.

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