iso::visual::PointData Class Reference

#include <iso_visual_point_data.h>

Inherited by iso::visual::GridData, and iso::visual::UnstructuredGrid.

Inheritance diagram for iso::visual::PointData:

[legend]Collaboration diagram for iso::visual::PointData:

[legend]List of all members.

Public Member Functions
	PointData (int pGridDim, const CellType &pCellType)
	create point data
	PointData (int pGridDim, int pPointCount, int pCellCount, const CellType &pCellType)
	create point data
	PointData (const PointData &pPointData)
	create point data
virtual	~PointData ()
	destructor
virtual PointData *	copy () const=0
	create a copy of point data
virtual const PointData &	operator= (const PointData &pPointData) throw (VisualException)
int	gridDim () const
	return grid dimension
int	pointCount () const
	return point count
const CellType *	cellType () const
	return cell type
int	cellCount () const
	return cell count
int	cellVertexCount () const
	return number of vertices per cell
const real *	minPos () const
	return minimum point position
const real *	maxPos () const
	return maximum point position
virtual int	cellIndex (real pPointCoord[]) const =0
	retrieve cell index from point coordinates
virtual void	vertexIndices (int pCellIndex, int *pVertexIndices) const =0
	retrieve vertex indices from cell index
void	vertexCoord (const int *pVertexIndices, real *pVertexCoord) const
	retrieve vertex cordinates from vertex indices
virtual void	vertex (int pVertexIndex, real pVertexCoord[]) const =0
	retrieve vertex cordinate from vertex index
void	world2cell (const real pCellVertices[], const real pWorldPoint[], real pCellPoint[]) const
	retrieve point in cell coordinates
template<typename DataType>
void	attribute (real pCellPoint[], int pAttributeDim, DataType pVertexAttributes[], DataType pPointAttribute[])
	return attribute value at point
template<typename DataType>
void	attribute (const real pCellPoint[], int pAttributeDim, const DataType *pVertexAttributes[], DataType pPointAttribute[])
	return attribute value at point
virtual base::String	info () const
	return textual point data information
Protected Attributes
int	mGridDim
int	mPointCount
int	mCellCount
real *	mMinPos
real *	mMaxPos
CellType *	mCellType

---

Constructor & Destructor Documentation

PointData::PointData	(	int	pGridDim,
		const CellType &	pCellType
	)

create point data

Parameters:

	pGridDim	grid dimension (1 or 2 or 3)
	pCellType	cell type

PointData::PointData	(	int	pGridDim,
		int	pPointCount,
		int	pCellCount,
		const CellType &	pCellType
	)

create point data

Parameters:

	pGridDim	grid dimension (1 or 2 or 3)
	pPointCount	number of points
	pCellCount	number of cells
	pCellType	cell type

PointData::PointData

(

const PointData &

pPointData

)

create point data

Parameters:

pPointData

point data to copy

PointData::~PointData

(

)

[virtual]

destructor

---

Member Function Documentation

virtual PointData* iso::visual::PointData::copy

(

)

const [pure virtual]

create a copy of point data

Returns:

copy of point data

Implemented in iso::visual::UniformGrid, iso::visual::RectilinearGrid, iso::visual::StructuredGrid, and iso::visual::UnstructuredGrid.

const PointData & PointData::operator=

(

const PointData &

pPointData

)

throw (VisualException) [virtual]

Reimplemented in iso::visual::GridData, iso::visual::UniformGrid, iso::visual::RectilinearGrid, iso::visual::StructuredGrid, and iso::visual::UnstructuredGrid.

int PointData::gridDim

(

)

const

return grid dimension

Returns:

grid dimension

int PointData::pointCount

(

)

const

return point count

Returns:

point count

const CellType * PointData::cellType

(

)

const

return cell type

Returns:

cell type

int PointData::cellCount

(

)

const

return cell count

Returns:

cell count

int PointData::cellVertexCount

(

)

const

return number of vertices per cell

Returns:

number of vertices per cell

const real * PointData::minPos

(

)

const

return minimum point position

Returns:

minimum point position

const real * PointData::maxPos

(

)

const

return maximum point position

Returns:

maximmum point position

virtual int iso::visual::PointData::cellIndex

(

real

pPointCoord[]

)

const [pure virtual]

retrieve cell index from point coordinates

Parameters:

pPointCoord

point coordinates (world coordinates)

Implemented in iso::visual::UniformGrid, iso::visual::RectilinearGrid, iso::visual::StructuredGrid, and iso::visual::UnstructuredGrid.

virtual void iso::visual::PointData::vertexIndices	(	int	pCellIndex,
		int *	pVertexIndices
	)			const [pure virtual]

retrieve vertex indices from cell index

Parameters:

	pCellIndex	cell index
	pVertexIndices	vertex indices (return value)

Implemented in iso::visual::GridData, and iso::visual::UnstructuredGrid.

void PointData::vertexCoord	(	const int *	pVertexIndices,
		real *	pVertexCoord
	)			const

retrieve vertex cordinates from vertex indices

Parameters:

	pVertexIndices	vertex indices
	pVertexCoord	vertex coordinates (return value)

virtual void iso::visual::PointData::vertex	(	int	pVertexIndex,
		real	pVertexCoord[]
	)			const [pure virtual]

retrieve vertex cordinate from vertex index

Parameters:

	pVertexIndex	vertex index
	pVertexCoord	vertex coordinates (return value)

Implemented in iso::visual::UniformGrid, iso::visual::RectilinearGrid, iso::visual::StructuredGrid, and iso::visual::UnstructuredGrid.

void PointData::world2cell	(	const real	pCellVertices[],
		const real	pWorldPoint[],
		real	pCellPoint[]
	)			const

retrieve point in cell coordinates

Parameters:

	pCellVertices	cell vertex coordinates
	pWorldPoint	point in world coordinates
	pCellPoint	point in cell coordinates (return value)

template<typename DataType>

void iso::visual::PointData::attribute	(	real	pCellPoint[],
		int	pAttributeDim,
		DataType	pVertexAttributes[],
		DataType	pPointAttribute[]
	)

return attribute value at point

Parameters:

	pCellPoint	point within cell in cell coordinates
	pAttributeDim	dimension of attribute values
	pVertexAttributes	attribute values at vertices
	pPointAttribute	attribute values at point (return value)

template<typename DataType>

void iso::visual::PointData::attribute	(	const real	pCellPoint[],
		int	pAttributeDim,
		const DataType *	pVertexAttributes[],
		DataType	pPointAttribute[]
	)

return attribute value at point

Parameters:

	pCellPoint	point within cell in cell coordinates
	pAttributeDim	dimension of attribute values
	pVertexAttributes	pointers to attribute values at vertices
	pPointAttribute	attribute values at point (return value)

base::String PointData::info

(

)

const [virtual]

return textual point data information

Returns:

textual point data information

Reimplemented in iso::visual::GridData, iso::visual::UniformGrid, iso::visual::RectilinearGrid, iso::visual::StructuredGrid, and iso::visual::UnstructuredGrid.

---

Member Data Documentation

int iso::visual::PointData::mGridDim [protected]

int iso::visual::PointData::mPointCount [protected]

int iso::visual::PointData::mCellCount [protected]

real* iso::visual::PointData::mMinPos [protected]

real* iso::visual::PointData::mMaxPos [protected]

CellType* iso::visual::PointData::mCellType [protected]

---

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

• /Users/dbisig/programming/swarms/trunk/visual/trunk/code/data/iso_visual_point_data.h
• /Users/dbisig/programming/swarms/trunk/visual/trunk/code/data/iso_visual_point_data.cpp

---