Go::RectGrid Class Reference
['geometry' - a spline library]

This class represent the simplest of all quadrangulations: a rectangular grid. More...

#include <RectGrid.h>

Inheritance diagram for Go::RectGrid:

Go::GeomObject Go::Streamable List of all members.

Public Member Functions

 RectGrid ()
 Constructor that defines an empty grid, which can only be assigned or read() into.
 RectGrid (int numu, int numv, int dim, double *pts)
 Constructor explicitly specifying a RectGrid.
virtual ~RectGrid ()
 virtual destructor assures safe inheritacne
virtual BoundingBox boundingBox () const
 Return the object's bounding box.
virtual int dimension () const
 Return the dimension of the space in which the object lies (usually 2 or 3).
virtual ClassType instanceType () const
 Return the class type identifier of a given, derived instance of GeomObject.
virtual GeomObjectclone () const
 Clone the GeomObject and return a pointer to the clone.
void read (std::istream &is)
 read object from stream
void write (std::ostream &os) const
 write object to stream
void setGrid (int numu, int numv, int dim, const double *pts)
 Set grid according to the user-supplied data.
int numCoefs_u () const
 Get number of points along the first grid direction.
int numCoefs_v () const
 Get number of points along the second grid direction.
double * rawData ()
 Get a pointer to the start of the array where grid point coordinates are stored.
const double * rawData () const
 Get a const pointer to the start of the array where grid point coordinates are stored.

Static Public Member Functions

static ClassType classType ()
 Return the class type identifier of a given class derived from GeomObject.

Detailed Description

This class represent the simplest of all quadrangulations: a rectangular grid.

Definition at line 46 of file RectGrid.h.


Constructor & Destructor Documentation

Go::RectGrid::RectGrid ( int  numu,
int  numv,
int  dim,
double *  pts 
) [inline]

Constructor explicitly specifying a RectGrid.

Parameters:
numu number of points along the first grid direction
numv number of points along the second grid direction
dim dimension of the points (usually 2 or 3)
pts pointer to the array where the points are stored. The points should be stored so that the first grid has lowest stride (ie., coefficients are stored (u1v1, u2v1,... unv1, u1v2, u2v2, ...unv2,.... unvm)

Definition at line 65 of file RectGrid.h.


Member Function Documentation

void Go::RectGrid::read ( std::istream &  is  )  [virtual]

read object from stream

Parameters:
is stream from which object is read

Implements Go::Streamable.

void Go::RectGrid::write ( std::ostream &  os  )  const [virtual]

write object to stream

Parameters:
os stream to which object is written

Implements Go::Streamable.

void Go::RectGrid::setGrid ( int  numu,
int  numv,
int  dim,
const double *  pts 
) [inline]

Set grid according to the user-supplied data.

Parameters:
numu number of points along the first grid direction
numv number of points along the second grid direction
dim dimension of the points (usually 2 or 3)
pts pointer to the array where the points are stored. The points should be stored so that the first grid has lowest stride (ie., coefficients are stored (u1v1, u2v1,... unv1, u1v2, u2v2, ...unv2,.... unvm)

Definition at line 108 of file RectGrid.h.

int Go::RectGrid::numCoefs_u (  )  const [inline]

Get number of points along the first grid direction.

Returns:
the number of points along the first grid direction

Definition at line 119 of file RectGrid.h.

int Go::RectGrid::numCoefs_v (  )  const [inline]

Get number of points along the second grid direction.

Returns:
the number of points along the second grid direction

Definition at line 126 of file RectGrid.h.

double* Go::RectGrid::rawData (  )  [inline]

Get a pointer to the start of the array where grid point coordinates are stored.

Returns:
a pointer to the storage array for grid points.

Definition at line 134 of file RectGrid.h.

const double* Go::RectGrid::rawData (  )  const [inline]

Get a const pointer to the start of the array where grid point coordinates are stored.

Returns:
a const pointer to the storage array for grid points.

Definition at line 142 of file RectGrid.h.


The documentation for this class was generated from the following file:
Generated on Mon Jun 11 14:48:19 2007 for GoTools Core Library by  doxygen 1.5.1