# TK_Grid

## Functions

| `TK_Grid`
`TK_Status` | `Read`
`TK_Status` | `Write`
`TK_Status` | `Clone`
`TK_Status` | `ReadAscii`
`TK_Status` | `WriteAscii`
void | `SetOrigin`
void | `SetOrigin`
float const * | `GetOrigin`
float * | `GetOrigin`
void | `SetRef1`
void | `SetRef1`
float const * | `GetRef1`
float * | `GetRef1`
void | `SetRef2`
void | `SetRef2`
float const * | `GetRef2`
float * | `GetRef2`
void | `SetDOrigin`
void | `SetDOrigin`
double const * | `GetDOrigin`
double * | `GetDOrigin`
void | `SetDRef1`
void | `SetDRef1`
double const * | `GetDRef1`
double * | `GetDRef1`
void | `SetDRef2`
void | `SetDRef2`
double const * | `GetDRef2`
double * | `GetDRef2`
void | `SetCounts`
int const * | `GetCounts`
int * | `GetCounts`
void | `SetType`
int | `GetType`

## Detailed Description

class TK_Grid : public BBaseOpcodeHandler

  Handles the TKE_Grid opcode.

  TK_Grid provides support for writing/reading the TKE_Grid opcode object to/from an HSF file.

  The HOOPS/3dGS scene-graph supports ‘grid’ primitives which are defined by a grid type, origin, and points which define grid spacing.

  Public Functions

  inline TK_Grid()

    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.

  inline void SetOrigin(float x, float y, float z)

    Sets the origin point of the grid using discrete float values

  inline void SetOrigin(float const o[])

    Sets the origin point of the grid using a float triplet

  inline float const *GetOrigin() const

    Returns the origin point of the grid as the address of a float triplet

  inline float *GetOrigin()

    Returns the origin point of the grid as the address of a float triplet which may be written

  inline void SetRef1(float x, float y, float z)

    Sets the first reference point of the grid using discrete float values

  inline void SetRef1(float const r[])

    Sets the first reference point of the grid using a float triplet

  inline float const *GetRef1() const

    Returns the first reference point of the grid as the address of a float triplet

  inline float *GetRef1()

    Returns the first reference point of the grid as the address of a float triplet which may be written

  inline void SetRef2(float x, float y, float z)

    Sets the second reference point of the grid using discrete float values

  inline void SetRef2(float const r[])

    Sets the second reference point of the grid using a float triplet

  inline float const *GetRef2() const

    Returns the second reference point of the grid as the address of a float triplet

  inline float *GetRef2()

    Returns the second reference point of the grid as the address of a float triplet which may be written

  inline void SetDOrigin(double x, double y, double z)

    Sets the origin point of the grid using discrete double values

  inline void SetDOrigin(double const o[])

    Sets the origin point of the grid using a double triplet

  inline double const *GetDOrigin() const

    Returns the origin point of the grid as the address of a double triplet

  inline double *GetDOrigin()

    Returns the origin point of the grid as the address of a double triplet which may be written

  inline void SetDRef1(double x, double y, double z)

    Sets the first reference point of the grid using discrete double values

  inline void SetDRef1(double const r[])

    Sets the first reference point of the grid using a double triplet

  inline double const *GetDRef1() const

    Returns the first reference point of the grid as the address of a double triplet

  inline double *GetDRef1()

    Returns the first reference point of the grid as the address of a double triplet which may be written

  inline void SetDRef2(double x, double y, double z)

    Sets the second reference point of the grid using discrete double values

  inline void SetDRef2(double const r[])

    Sets the second reference point of the grid using a double triplet

  inline double const *GetDRef2() const

    Returns the second reference point of the grid as the address of a double triplet

  inline double *GetDRef2()

    Returns the second reference point of the grid as the address of a double triplet which may be written

  inline void SetCounts(int c1, int c2)

    Sets the extent counts of the grid using discrete integers

  inline int const *GetCounts() const

    Returns the extent counts of the grid as the address of a pair of integers

  inline int *GetCounts()

    Returns the extent counts of the grid as the address of a pair of integers which may be written

  inline void SetType(int t)

    Sets the type of the grid

  inline int GetType() const

    Returns the type of the grid