TK_Clip_Rectangle Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Clip_Rectangle:

Inheritance graph
[legend]
Collaboration diagram for TK_Clip_Rectangle:

Collaboration graph
[legend]
List of all members.

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)

Definition at line 7520 of file BOpcodeHandler.h.

Public Member Functions

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

Protected Attributes

char m_options
float m_rect [4]


Constructor & Destructor Documentation

TK_Clip_Rectangle::TK_Clip_Rectangle  )  [inline]
 

constructor

Definition at line 7531 of file BOpcodeHandler.h.


Member Function Documentation

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

int TK_Clip_Rectangle::GetOptions void   )  const [inline]
 

Returns the option flags

Definition at line 7555 of file BOpcodeHandler.h.

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

Returns the address of the rectangle

Definition at line 7550 of file BOpcodeHandler.h.

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.

Implements BBaseOpcodeHandler.

void TK_Clip_Rectangle::Reset void   )  [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

Definition at line 7553 of file BOpcodeHandler.h.

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

Sets the clip region using an array of float values

Definition at line 7547 of file BOpcodeHandler.h.

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

Sets the clip region using individual float values

Definition at line 7544 of file BOpcodeHandler.h.

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.

Implements BBaseOpcodeHandler.


Member Data Documentation

char TK_Clip_Rectangle::m_options [protected]
 

internal use; optional settings

Definition at line 7526 of file BOpcodeHandler.h.

float TK_Clip_Rectangle::m_rect[4] [protected]
 

internal use; description of a rectangular clip region

Definition at line 7527 of file BOpcodeHandler.h.


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:41:41 2009 for Autodesk DWF 3D Toolkit by  doxygen 1.4.5