TK_Window

class TK_Window

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.

Inherits from: BBaseOpcodeHandler

Methods

TK_Window::TK_Window()

constructor

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.
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.
TK_Status TK_Window::Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const

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.
TK_Status TK_Window::ReadAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status TK_Window::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

void TK_Window::SetWindow(float l, float r, float b, float t, float lo = 0, float ro = 0, float bo = 0, float to = 0)

Sets the subwindow region using discrete float values

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

Sets the subwindow region using an array of four floats

void TK_Window::SetWindow(float const w[], float const o[])

Sets the subwindow region using two arrays of four floats each

void TK_Window::SetWindow(int n, float const w[])

Sets the subwindow region using a float array (specified length, should be 4 or 8)

float const *TK_Window::GetWindow() const

const

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

void TK_Window::SetOptions(int opt)

Sets the mask indicating which window options are specified.

int TK_Window::GetOptions() const

const

Returns the mask indicating which window options are specified.

Variables

float TK_Window::m_window[8]

protected

float

for internal use only

unsigned char TK_Window::m_options

protected

unsigned char