TK_Clip_Rectangle

class TK_Clip_Rectangle

Handles the TKE_Clip_Rectangle opcode.

TK_Clip_Rectangle provides support for writing/reading the TKE_Clip_Rectangle opcode to/from an HSF file. A clip rectangle defines a 2d (dc) clip rectangle which should be applied to the contents of the current segment and all subsegments (just like any HOOPS/3dGS attribute)

Inherits from: BBaseOpcodeHandler

Methods

TK_Clip_Rectangle::TK_Clip_Rectangle()

constructor

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

Deprecated.

TK_Status TK_Clip_Rectangle::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

void TK_Clip_Rectangle::Reset()

virtual

Resets the current opcode handler. This is called by the toolkit when it is done processing an opcode. This method reinitializes any opcode handler variables and frees up temporary data.

void TK_Clip_Rectangle::SetRectangle(float left, float right, float bottom, float top)

Sets the clip region using individual float values

void TK_Clip_Rectangle::SetRectangle(float const *rect)

Sets the clip region using an array of float values

float const *TK_Clip_Rectangle::GetRectangle() const

const

Returns the address of the rectangle

void TK_Clip_Rectangle::SetOptions(int o)

Sets the option flags

int TK_Clip_Rectangle::GetOptions() const

const

Returns the option flags

Variables

char TK_Clip_Rectangle::m_options

protected

char

internal use; optional settings

float TK_Clip_Rectangle::m_rect[4]

protected

float

internal use; description of a rectangular clip region