Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_Window Class Reference

Handles the TKE_Window opcode. More...

#include <BOpcodeHandler.h>

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
float const * GetWindow () const
TK_Status Read (BStreamFileToolkit &tk)
TK_Status ReadAscii (BStreamFileToolkit &tk)
 Deprecated.
void SetWindow (float l, float r, float b, float t)
void SetWindow (float const w[])
 TK_Window ()
TK_Status Write (BStreamFileToolkit &tk)
TK_Status WriteAscii (BStreamFileToolkit &tk)
 Deprecated.

Protected Attributes

float m_window [4]
 for internal use only

Detailed Description

Handles the TKE_Window opcode.

TK_Window provides support for writing/reading the TKE_Window opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph supports a window attributes, which defines a local viewport with it's own unique camera.


Constructor & Destructor Documentation

TK_Window::TK_Window ( ) [inline]

constructor


Member Function Documentation

TK_Status TK_Window::Clone ( BStreamFileToolkit tk,
BBaseOpcodeHandler **  handler 
) const [virtual]

Copies the opcode handler

Parameters:
tkA reference to the BStreamFileToolkit object.
handlerA pointer to the opcode handler object. Passed by reference.
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

Reimplemented in HTK_Window.

float const* TK_Window::GetWindow ( ) const [inline]

Returns the subwindow region as the address of an array of four floats

TK_Status TK_Window::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:
tkA reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.

void TK_Window::SetWindow ( float  l,
float  r,
float  b,
float  t 
) [inline]

Sets the subwindow region using discrete float values

void TK_Window::SetWindow ( float const  w[]) [inline]

Sets the subwindow region using an array of four floats

References SetWindow().

Referenced by SetWindow().

TK_Status TK_Window::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:
tkA 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: