Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

Public Member Functions | Protected Attributes
TK_Clip_Rectangle Class Reference

Handles the TKE_Clip_Rectangle opcode. More...

#include <BOpcodeHandler.h>

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
int GetOptions () const
float const * GetRectangle () const
TK_Status Read (BStreamFileToolkit &tk)
TK_Status ReadAscii (BStreamFileToolkit &tk)
 Deprecated.
void Reset ()
void SetOptions (int o)
void SetRectangle (float left, float right, float bottom, float top)
void SetRectangle (float const *rect)
 TK_Clip_Rectangle ()
TK_Status Write (BStreamFileToolkit &tk)
TK_Status WriteAscii (BStreamFileToolkit &tk)
 Deprecated.

Protected Attributes

char m_options
float m_rect [4]

Detailed Description

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)


Constructor & Destructor Documentation

TK_Clip_Rectangle::TK_Clip_Rectangle ( ) [inline]

constructor


Member Function Documentation

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

int TK_Clip_Rectangle::GetOptions ( ) const [inline]

Returns the option flags

float const* TK_Clip_Rectangle::GetRectangle ( ) const [inline]

Returns the address of the rectangle

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

Implements BBaseOpcodeHandler.

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.

Reimplemented from BBaseOpcodeHandler.

void TK_Clip_Rectangle::SetOptions ( int  o) [inline]

Sets the option flags

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

Sets the clip region using individual float values

void TK_Clip_Rectangle::SetRectangle ( float const *  rect) [inline]

Sets the clip region using an array of float values

References SetRectangle().

Referenced by SetRectangle().

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

Implements BBaseOpcodeHandler.


Member Data Documentation

char TK_Clip_Rectangle::m_options [protected]

internal use; optional settings

float TK_Clip_Rectangle::m_rect[4] [protected]

internal use; description of a rectangular clip region


The documentation for this class was generated from the following file: