# TK_Clip_Rectangle

## Functions

| `TK_Clip_Rectangle`
`TK_Status` | `Read`
`TK_Status` | `Write`
`TK_Status` | `Clone`
`TK_Status` | `ReadAscii`
`TK_Status` | `WriteAscii`
void | `Reset`
void | `SetRectangle`
void | `SetRectangle`
float const * | `GetRectangle`
void | `SetOptions`
int | `GetOptions`

## Detailed Description

class `TK_Clip_Rectangle` : public BBaseOpcodeHandler

  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)

  Public Functions

  inline `TK_Clip_Rectangle`()

    constructor

  virtual TK_Status `Read`(BStreamFileToolkit &tk)

    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.

  virtual TK_Status `Write`(BStreamFileToolkit &tk)

    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.

  virtual TK_Status `Clone`(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const

    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 `ReadAscii`(BStreamFileToolkit &tk)

    Deprecated.

  TK_Status `WriteAscii`(BStreamFileToolkit &tk)

    Deprecated.

  virtual void `Reset`()

    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.

  inline void `SetRectangle`(float left, float right, float bottom, float top)

    Sets the clip region using individual float values

  inline void `SetRectangle`(float const *rect)

    Sets the clip region using an array of float values

  inline float const *`GetRectangle`() const

    Returns the address of the rectangle

  inline void `SetOptions`(int o)

    Sets the option flags

  inline int `GetOptions`() const

    Returns the option flags

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your multilingual generative AI assistant for documentation. Ask me anything about HOOPS Visualize 3DF in your own language, or choose a sample question below to start a conversation:

What is HOOPS Visualize 3DF?
What are the latest release notes for HOOPS Visualize 3DF?
How do I start evaluating HOOPS Visualize 3DF?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...