Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_Grid Class Reference

Handles the TKE_Grid opcode. More...

#include <BOpcodeHandler.h>

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
int const * GetCounts () const
int * GetCounts ()
double const * GetDOrigin () const
double * GetDOrigin ()
double const * GetDRef1 () const
double * GetDRef1 ()
double const * GetDRef2 () const
double * GetDRef2 ()
float const * GetOrigin () const
float * GetOrigin ()
float const * GetRef1 () const
float * GetRef1 ()
float const * GetRef2 () const
float * GetRef2 ()
int GetType () const
TK_Status Read (BStreamFileToolkit &tk)
TK_Status ReadAscii (BStreamFileToolkit &tk)
 Deprecated.
void SetCounts (int c1, int c2)
void SetDOrigin (double x, double y, double z)
void SetDOrigin (double const *o)
void SetDRef1 (double x, double y, double z)
void SetDRef1 (double const *r)
void SetDRef2 (double x, double y, double z)
void SetDRef2 (double const *r)
void SetOrigin (float x, float y, float z)
void SetOrigin (float const *o)
void SetRef1 (float x, float y, float z)
void SetRef1 (float const *r)
void SetRef2 (float x, float y, float z)
void SetRef2 (float const *r)
void SetType (int t)
 TK_Grid ()
TK_Status Write (BStreamFileToolkit &tk)
TK_Status WriteAscii (BStreamFileToolkit &tk)
 Deprecated.

Protected Attributes

int m_counts [2]
double m_dpoints [9]
float m_points [9]
char m_type

Detailed Description

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.


Constructor & Destructor Documentation

TK_Grid::TK_Grid ( ) [inline]

constructor


Member Function Documentation

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

Reimplemented in HTK_Grid.

int const* TK_Grid::GetCounts ( ) const [inline]

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

int* TK_Grid::GetCounts ( ) [inline]

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

double const* TK_Grid::GetDOrigin ( ) const [inline]

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

double* TK_Grid::GetDOrigin ( ) [inline]

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

double const* TK_Grid::GetDRef1 ( ) const [inline]

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

double* TK_Grid::GetDRef1 ( ) [inline]

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

double const* TK_Grid::GetDRef2 ( ) const [inline]

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

double* TK_Grid::GetDRef2 ( ) [inline]

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

float const* TK_Grid::GetOrigin ( ) const [inline]

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

float* TK_Grid::GetOrigin ( ) [inline]

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

float const* TK_Grid::GetRef1 ( ) const [inline]

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

float* TK_Grid::GetRef1 ( ) [inline]

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

float const* TK_Grid::GetRef2 ( ) const [inline]

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

float* TK_Grid::GetRef2 ( ) [inline]

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

int TK_Grid::GetType ( ) const [inline]

Returns the type of the grid

TK_Status TK_Grid::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_Grid::SetCounts ( int  c1,
int  c2 
) [inline]

Sets the extent counts of the grid using discrete integers

void TK_Grid::SetDOrigin ( double  x,
double  y,
double  z 
) [inline]

Sets the origin point of the grid using discrete double values

void TK_Grid::SetDOrigin ( double const *  o) [inline]

Sets the origin point of the grid using a double triplet

References SetDOrigin().

Referenced by SetDOrigin().

void TK_Grid::SetDRef1 ( double  x,
double  y,
double  z 
) [inline]

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

void TK_Grid::SetDRef1 ( double const *  r) [inline]

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

References SetDRef1().

Referenced by SetDRef1().

void TK_Grid::SetDRef2 ( double  x,
double  y,
double  z 
) [inline]

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

void TK_Grid::SetDRef2 ( double const *  r) [inline]

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

References SetDRef2().

Referenced by SetDRef2().

void TK_Grid::SetOrigin ( float  x,
float  y,
float  z 
) [inline]

Sets the origin point of the grid using discrete float values

void TK_Grid::SetOrigin ( float const *  o) [inline]

Sets the origin point of the grid using a float triplet

References SetOrigin().

Referenced by SetOrigin().

void TK_Grid::SetRef1 ( float  x,
float  y,
float  z 
) [inline]

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

void TK_Grid::SetRef1 ( float const *  r) [inline]

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

References SetRef1().

Referenced by SetRef1().

void TK_Grid::SetRef2 ( float  x,
float  y,
float  z 
) [inline]

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

void TK_Grid::SetRef2 ( float const *  r) [inline]

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

References SetRef2().

Referenced by SetRef2().

void TK_Grid::SetType ( int  t) [inline]

Sets the type of the grid

TK_Status TK_Grid::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

int TK_Grid::m_counts[2] [protected]

internal use; Number of units along the ref1 and ref2 dimensions

double TK_Grid::m_dpoints[9] [protected]

internal use; Grid origin

float TK_Grid::m_points[9] [protected]

internal use; Grid origin

char TK_Grid::m_type [protected]

internal use; Type of grid


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