TK_Window Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Window:

Inheritance graph
[legend]
Collaboration diagram for TK_Window:

Collaboration graph
[legend]
List of all members.

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.

Definition at line 5085 of file BOpcodeHandler.h.

Public Member Functions

 TK_Window ()
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
void SetWindow (float l, float r, float b, float t) alter
void SetWindow (float const *w) alter
float const * GetWindow (void) const

Protected Attributes

float m_window [4]
 for internal use only


Constructor & Destructor Documentation

TK_Window::TK_Window  )  [inline]
 

constructor

Definition at line 5095 of file BOpcodeHandler.h.


Member Function Documentation

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

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

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

Definition at line 5111 of file BOpcodeHandler.h.

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

Implements BBaseOpcodeHandler.

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

Sets the subwindow region using an array of four floats

Definition at line 5109 of file BOpcodeHandler.h.

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

Sets the subwindow region using discrete float values

Definition at line 5106 of file BOpcodeHandler.h.

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:
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