# TK_Clip_Region

## Functions

| `TK_Clip_Region`
| `~TK_Clip_Region`
`TK_Status` | `Read`
`TK_Status` | `Write`
`TK_Status` | `Clone`
`TK_Status` | `ReadAscii`
`TK_Status` | `WriteAscii`
void | `Reset`
void | `SetPoints`
float const * | `GetPoints`
float * | `GetPoints`
void | `SetDPoints`
double const * | `GetDPoints`
double * | `GetDPoints`
int | `GetCount`
void | `SetOptions`
int | `GetOptions`

## Detailed Description

class TK_Clip_Region : public BBaseOpcodeHandler

  Handles the TKE_Clip_Region opcodes.

  TK_Clip_Region provides support for writing/reading the TKE_Clip_Region opcode to/from an HSF file. A clip region defines a clip region 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_Region()

    constructor

  ~TK_Clip_Region()
  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.

  void SetPoints(int count, float const points[] = 0)

    Sets the point array. Allocates a buffer which will hold ‘count’ float triplets, and if specified, copies the ‘points’ into the buffer

  inline float const *GetPoints() const

    Returns the address of the point buffer

  inline float *GetPoints()

    Returns the address of the point buffer, which may be modified directly

  void SetDPoints(int count, double const points[] = 0)

    Sets the point array. Allocates a buffer which will hold ‘count’ double triplets, and if specified, copies the ‘points’ into the buffer

  inline double const *GetDPoints() const

    Returns the address of the point buffer

  inline double *GetDPoints()

    Returns the address of the point buffer, which may be modified directly

  inline int GetCount() const

    Returns the number of points in the buffer

  inline void SetOptions(int o)

    Sets the option flags

  inline int GetOptions() const

    Returns the option flags