vtkCell3D Class Reference

#include <vtkCell3D.h>

Inheritance diagram for vtkCell3D:

[legend]Collaboration diagram for vtkCell3D:

[legend]List of all members.

Detailed Description

abstract class to specify 3D cell interface

vtkCell3D is an abstract class that extends the interfaces for 3D data cells, and implements methods needed to satisfy the vtkCell API. The 3D cells include hexehedra, tetrahedra, wedge, pyramid, and voxel.

See also:: vtkTetra vtkHexahedron vtkVoxel vtkWedge vtkPyramid

Created by:

Bertel, Francois

CVS contributions (if > 5%):

Bertel, Francois (100%)

CVS logs (CVSweb):

.cxx (/Filtering/vtkCell3D.cxx)
.h (/Filtering/vtkCell3D.h)

Definition at line 46 of file vtkCell3D.h.

Public Types

typedef vtkCell Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

void PrintSelf (ostream &os, vtkIndent indent)

virtual void GetEdgePoints (int edgeId, int *&pts)=0

virtual void GetFacePoints (int faceId, int *&pts)=0

void Contour (double value, vtkDataArray *cellScalars, vtkPointLocator *locator, vtkCellArray *verts, vtkCellArray *lines, vtkCellArray *polys, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd)

virtual int GetCellDimension ()

virtual void Clip (double value, vtkDataArray *cellScalars, vtkPointLocator *locator, vtkCellArray *connectivity, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut)

virtual void SetMergeTolerance (double)

virtual double GetMergeTolerance ()

Static Public Member Functions

int IsTypeOf (const char *type)

vtkCell3D * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkCell3D ()

~vtkCell3D ()

Protected Attributes

vtkOrderedTriangulator * Triangulator

double MergeTolerance

vtkTetra * ClipTetra

vtkDoubleArray * ClipScalars

Member Typedef Documentation

typedef vtkCell vtkCell3D::Superclass

Reimplemented from vtkCell.
Reimplemented in vtkConvexPointSet, vtkHexagonalPrism, vtkHexahedron, vtkPentagonalPrism, vtkPyramid, vtkTetra, vtkVoxel, and vtkWedge.
Definition at line 49 of file vtkCell3D.h.

Constructor & Destructor Documentation

vtkCell3D::vtkCell3D ( ) [protected]

vtkCell3D::~vtkCell3D ( ) [protected]

Member Function Documentation

virtual const char* vtkCell3D::GetClassName ( ) [virtual]

Reimplemented from vtkCell.
Reimplemented in vtkConvexPointSet, vtkHexagonalPrism, vtkHexahedron, vtkPentagonalPrism, vtkPyramid, vtkTetra, vtkVoxel, and vtkWedge.

int vtkCell3D::IsTypeOf ( const char * type ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkCell.
Reimplemented in vtkConvexPointSet, vtkHexagonalPrism, vtkHexahedron, vtkPentagonalPrism, vtkPyramid, vtkTetra, vtkVoxel, and vtkWedge.

virtual int vtkCell3D::IsA ( const char * type ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkCell.
Reimplemented in vtkConvexPointSet, vtkHexagonalPrism, vtkHexahedron, vtkPentagonalPrism, vtkPyramid, vtkTetra, vtkVoxel, and vtkWedge.

vtkCell3D* vtkCell3D::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkCell.
Reimplemented in vtkConvexPointSet, vtkHexagonalPrism, vtkHexahedron, vtkPentagonalPrism, vtkPyramid, vtkTetra, vtkVoxel, and vtkWedge.

void vtkCell3D::PrintSelf ( ostream & os,

vtkIndent indent

) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkCell.
Reimplemented in vtkConvexPointSet, vtkHexagonalPrism, vtkHexahedron, vtkPentagonalPrism, vtkPyramid, vtkTetra, vtkVoxel, and vtkWedge.

virtual void vtkCell3D::GetEdgePoints ( int edgeId,

int *& pts

) [pure virtual]

Get the pair of vertices that define an edge. The method returns the number of vertices, along with an array of vertices. Note that the vertices are 0-offset; that is, they refer to the ids of the cell, not the point ids of the mesh that the cell belongs to. The edgeId must range between 0<=edgeId<this->GetNumberOfEdges().
Implemented in vtkHexagonalPrism, vtkHexahedron, vtkPentagonalPrism, vtkPyramid, vtkTetra, vtkVoxel, and vtkWedge.

virtual void vtkCell3D::GetFacePoints ( int faceId,

int *& pts

) [pure virtual]

Get the list of vertices that define a face. The list is terminated with a negative number. Note that the vertices are 0-offset; that is, they refer to the ids of the cell, not the point ids of the mesh that the cell belongs to. The faceId must range between 0<=faceId<this->GetNumberOfFaces().
Implemented in vtkHexagonalPrism, vtkHexahedron, vtkPentagonalPrism, vtkPyramid, vtkTetra, vtkVoxel, and vtkWedge.

void vtkCell3D::Contour ( double value,

vtkDataArray * cellScalars,

vtkPointLocator * locator,

vtkCellArray * verts,

vtkCellArray * lines,

vtkCellArray * polys,

vtkPointData * inPd,

vtkPointData * outPd,

vtkCellData * inCd,

vtkIdType cellId,

vtkCellData * outCd

) [virtual]

Generate contouring primitives. The scalar list cellScalars are scalar values at each cell point. The point locator is essentially a points list that merges points as they are inserted (i.e., prevents duplicates). Contouring primitives can be vertices, lines, or polygons. It is possible to interpolate point data along the edge by providing input and output point data - if outPd is NULL, then no interpolation is performed. Also, if the output cell data is non-NULL, the cell data from the contoured cell is passed to the generated contouring primitives. (Note: the CopyAllocate() method must be invoked on both the output cell and point data. The cellId refers to the cell from which the cell data is copied.)
Implements vtkCell.
Reimplemented in vtkConvexPointSet, vtkHexahedron, vtkPyramid, vtkTetra, vtkVoxel, and vtkWedge.

virtual void vtkCell3D::Clip ( double value,

vtkDataArray * cellScalars,

vtkPointLocator * locator,

vtkCellArray * connectivity,

vtkPointData * inPd,

vtkPointData * outPd,

vtkCellData * inCd,

vtkIdType cellId,

vtkCellData * outCd,

int insideOut

) [virtual]

Cut (or clip) the cell based on the input cellScalars and the specified value. The output of the clip operation will be one or more cells of the same topological dimension as the original cell. The flag insideOut controls what part of the cell is considered inside - normally cell points whose scalar value is greater than "value" are considered inside. If insideOut is on, this is reversed. Also, if the output cell data is non-NULL, the cell data from the clipped cell is passed to the generated contouring primitives. (Note: the CopyAllocate() method must be invoked on both the output cell and point data. The cellId refers to the cell from which the cell data is copied.) (Satisfies vtkCell API.)
Implements vtkCell.
Reimplemented in vtkConvexPointSet, and vtkTetra.

virtual int vtkCell3D::GetCellDimension ( ) [inline, virtual]

The topological dimension of the cell. (Satisfies vtkCell API.)
Implements vtkCell.
Reimplemented in vtkHexagonalPrism, vtkPentagonalPrism, vtkPyramid, vtkVoxel, and vtkWedge.
Definition at line 92 of file vtkCell3D.h.

virtual void vtkCell3D::SetMergeTolerance ( double ) [virtual]

Set the tolerance for merging clip intersection points that are near the vertices of cells. This tolerance is used to prevent the generation of degenerate tetrahedra during clipping.

virtual double vtkCell3D::GetMergeTolerance ( ) [virtual]

Set the tolerance for merging clip intersection points that are near the vertices of cells. This tolerance is used to prevent the generation of degenerate tetrahedra during clipping.

Member Data Documentation

vtkOrderedTriangulator* vtkCell3D::Triangulator [protected]

Definition at line 106 of file vtkCell3D.h.

double vtkCell3D::MergeTolerance [protected]

Definition at line 107 of file vtkCell3D.h.

vtkTetra* vtkCell3D::ClipTetra [protected]

Definition at line 110 of file vtkCell3D.h.

vtkDoubleArray* vtkCell3D::ClipScalars [protected]

Definition at line 111 of file vtkCell3D.h.

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

dox/Filtering/vtkCell3D.h


Public Types
typedef vtkCell	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	GetEdgePoints (int edgeId, int *&pts)=0
virtual void	GetFacePoints (int faceId, int *&pts)=0
void	Contour (double value, vtkDataArray cellScalars, vtkPointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd, vtkIdType cellId, vtkCellData *outCd)
virtual int	GetCellDimension ()

virtual void	Clip (double value, vtkDataArray cellScalars, vtkPointLocator locator, vtkCellArray connectivity, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut)

virtual void	SetMergeTolerance (double)
virtual double	GetMergeTolerance ()
Static Public Member Functions
int	IsTypeOf (const char *type)
vtkCell3D *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkCell3D ()
	~vtkCell3D ()
Protected Attributes
vtkOrderedTriangulator *	Triangulator
double	MergeTolerance
vtkTetra *	ClipTetra
vtkDoubleArray *	ClipScalars