abstract class to specify cell behavior More...

#include <vtkCell.h>

Inheritance diagram for vtkCell:

Collaboration diagram for vtkCell:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkCell *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	Initialize (int npts, vtkIdType pts, vtkPoints p)
	Initialize cell from outside with point ids and point coordinates specified. More...

virtual void	ShallowCopy (vtkCell *c)
	Copy this cell by reference counting the internal data structures. More...

virtual void	DeepCopy (vtkCell *c)
	Copy this cell by completely copying internal data structures. More...

virtual int	GetCellType ()=0
	Return the type of cell. More...

virtual int	GetCellDimension ()=0
	Return the topological dimensional of the cell (0,1,2, or 3). More...

virtual int	IsLinear ()
	Non-linear cells require special treatment beyond the usual cell type and connectivity list information. More...

virtual int	RequiresInitialization ()
	Some cells require initialization prior to access. More...

virtual void	Initialize ()

virtual int	IsExplicitCell ()
	Explicit cells require additional representational information beyond the usual cell type and connectivity list information. More...

virtual int	RequiresExplicitFaceRepresentation ()
	Determine whether the cell requires explicit face representation, and methods for setting and getting the faces (see vtkPolyhedron for example usage of these methods). More...

virtual void	SetFaces (vtkIdType *vtkNotUsed(faces))

virtual vtkIdType *	GetFaces ()

vtkPoints *	GetPoints ()
	Get the point coordinates for the cell. More...

vtkIdType	GetNumberOfPoints ()
	Return the number of points in the cell. More...

virtual int	GetNumberOfEdges ()=0
	Return the number of edges in the cell. More...

virtual int	GetNumberOfFaces ()=0
	Return the number of faces in the cell. More...

vtkIdList *	GetPointIds ()
	Return the list of point ids defining the cell. More...

vtkIdType	GetPointId (int ptId)
	For cell point i, return the actual point id. More...

virtual vtkCell *	GetEdge (int edgeId)=0
	Return the edge cell from the edgeId of the cell. More...

virtual vtkCell *	GetFace (int faceId)=0
	Return the face cell from the faceId of the cell. More...

virtual int	CellBoundary (int subId, double pcoords[3], vtkIdList *pts)=0
	Given parametric coordinates of a point, return the closest cell boundary, and whether the point is inside or outside of the cell. More...

virtual int	EvaluatePosition (double x[3], double closestPoint, int &subId, double pcoords[3], double &dist2, double weights)=0
	Given a point x[3] return inside(=1), outside(=0) cell, or (-1) computational problem encountered; evaluate parametric coordinates, sub-cell id (!=0 only if cell is composite), distance squared of point x[3] to cell (in particular, the sub-cell indicated), closest point on cell to x[3] (unless closestPoint is null, in which case, the closest point and dist2 are not found), and interpolation weights in cell. More...

virtual void	EvaluateLocation (int &subId, double pcoords[3], double x[3], double *weights)=0
	Determine global coordinate (x[3]) from subId and parametric coordinates. More...

virtual void	Contour (double value, vtkDataArray cellScalars, vtkIncrementalPointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd, vtkIdType cellId, vtkCellData *outCd)=0
	Generate contouring primitives. More...

virtual void	Clip (double value, vtkDataArray cellScalars, vtkIncrementalPointLocator locator, vtkCellArray connectivity, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut)=0
	Cut (or clip) the cell based on the input cellScalars and the specified value. More...

virtual int	IntersectWithLine (double p1[3], double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId)=0
	Intersect with a ray. More...

virtual int	Triangulate (int index, vtkIdList ptIds, vtkPoints pts)=0
	Generate simplices of proper dimension. More...

virtual void	Derivatives (int subId, double pcoords[3], double values, int dim, double derivs)=0
	Compute derivatives given cell subId and parametric coordinates. More...

void	GetBounds (double bounds[6])
	Compute cell bounding box (xmin,xmax,ymin,ymax,zmin,zmax). More...

double *	GetBounds ()
	Compute cell bounding box (xmin,xmax,ymin,ymax,zmin,zmax). More...

double	GetLength2 ()
	Compute Length squared of cell (i.e., bounding box diagonal squared). More...

virtual int	GetParametricCenter (double pcoords[3])
	Return center of the cell in parametric coordinates. More...

virtual double	GetParametricDistance (double pcoords[3])
	Return the distance of the parametric coordinate provided to the cell. More...

virtual int	IsPrimaryCell ()
	Return whether this cell type has a fixed topology or whether the topology varies depending on the data (e.g., vtkConvexPointSet). More...

virtual double *	GetParametricCoords ()
	Return a contiguous array of parametric coordinates of the points defining this cell. More...

virtual void	InterpolateFunctions (double vtkNotUsed(pcoords)[3], double *vtkNotUsed(weight))
	Compute the interpolation functions/derivatives (aka shape functions/derivatives) No-ops at this level. More...

virtual void	InterpolateDerivs (double vtkNotUsed(pcoords)[3], double *vtkNotUsed(derivs))

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkCell *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Public Attributes
vtkPoints *	Points

vtkIdList *	PointIds

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCell ()

	~vtkCell () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
double	Bounds [6]

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

abstract class to specify cell behavior

vtkCell is an abstract class that specifies the interfaces for data cells. Data cells are simple topological elements like points, lines, polygons, and tetrahedra of which visualization datasets are composed. In some cases visualization datasets may explicitly represent cells (e.g., vtkPolyData, vtkUnstructuredGrid), and in some cases, the datasets are implicitly composed of cells (e.g., vtkStructuredPoints).

Warning: The #define VTK_CELL_SIZE is a parameter used to construct cells and provide a general guideline for controlling object execution. This parameter is not a hard boundary: you can create cells with more points.

See also: vtkHexahedron vtkLine vtkPixel vtkPolyLine vtkPolyVertex vtkPolygon vtkQuad vtkTetra vtkTriangle vtkTriangleStrip vtkVertex vtkVoxel vtkWedge vtkPyramid

Tests:: vtkCell (Tests)

Definition at line 59 of file vtkCell.h.

Member Typedef Documentation

typedef vtkObject vtkCell::Superclass

Definition at line 62 of file vtkCell.h.

Constructor & Destructor Documentation

vtkCell::vtkCell ( )

protected

vtkCell::~vtkCell ( )

overrideprotected

Member Function Documentation

static int vtkCell::IsTypeOf ( const char * type )

static

virtual int vtkCell::IsA ( const char * name )

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

Reimplemented in vtkTriQuadraticHexahedron, vtkBiQuadraticQuadraticHexahedron, vtkPolyhedron, vtkBiQuadraticQuadraticWedge, vtkPentagonalPrism, vtkQuadraticLinearWedge, vtkQuadraticPyramid, vtkBiQuadraticQuad, vtkBiQuadraticTriangle, vtkQuadraticTetra, vtkQuadraticWedge, vtkQuadraticLinearQuad, vtkPyramid, vtkWedge, vtkHexagonalPrism, vtkQuadraticHexahedron, vtkHexahedron, vtkTetra, vtkQuadraticPolygon, vtkQuadraticQuad, vtkQuadraticTriangle, vtkConvexPointSet, vtkCubicLine, vtkPolygon, vtkVoxel, vtkGenericCell, vtkQuadraticEdge, vtkTriangleStrip, vtkPolyLine, vtkQuad, vtkTriangle, vtkPixel, vtkPolyVertex, vtkCell3D, vtkVertex, vtkLine, vtkNonLinearCell, and vtkEmptyCell.

static vtkCell* vtkCell::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkCell::NewInstanceInternal ( ) const

protectedvirtual

vtkCell* vtkCell::NewInstance ( ) const

void vtkCell::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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 vtkObject.

Reimplemented in vtkTriQuadraticHexahedron, vtkPolyhedron, vtkPentagonalPrism, vtkQuadraticLinearWedge, vtkQuadraticPyramid, vtkQuadraticTetra, vtkQuadraticWedge, vtkQuadraticLinearQuad, vtkPyramid, vtkWedge, vtkHexagonalPrism, vtkQuadraticHexahedron, vtkHexahedron, vtkTetra, vtkQuadraticPolygon, vtkQuadraticQuad, vtkQuadraticTriangle, vtkConvexPointSet, vtkCubicLine, vtkPolygon, vtkVoxel, vtkGenericCell, vtkQuadraticEdge, vtkTriangleStrip, vtkPolyLine, vtkQuad, vtkTriangle, vtkPixel, vtkPolyVertex, vtkCell3D, vtkVertex, vtkLine, vtkNonLinearCell, and vtkEmptyCell.

void vtkCell::Initialize	(	int	npts,
		vtkIdType *	pts,
		vtkPoints *	p
	)

Initialize cell from outside with point ids and point coordinates specified.

virtual void vtkCell::ShallowCopy ( vtkCell * c )

virtual

Copy this cell by reference counting the internal data structures.

This is safe if you want a "read-only" copy. If you modify the cell you might wish to use DeepCopy().

Reimplemented in vtkGenericCell.

virtual void vtkCell::DeepCopy ( vtkCell * c )

virtual

Copy this cell by completely copying internal data structures.

This is slower but safer than ShallowCopy().

Reimplemented in vtkGenericCell.

virtual int vtkCell::GetCellType ( )

pure virtual

virtual int vtkCell::GetCellDimension ( )

pure virtual

Return the topological dimensional of the cell (0,1,2, or 3).

Implemented in vtkTriQuadraticHexahedron, vtkBiQuadraticQuadraticHexahedron, vtkCell3D, vtkPentagonalPrism, vtkBiQuadraticQuadraticWedge, vtkGenericCell, vtkPyramid, vtkWedge, vtkHexagonalPrism, vtkQuadraticLinearWedge, vtkQuadraticPyramid, vtkPolyLine, vtkBiQuadraticQuad, vtkVoxel, vtkBiQuadraticTriangle, vtkQuadraticTetra, vtkQuadraticWedge, vtkQuadraticLinearQuad, vtkQuadraticHexahedron, vtkQuadraticQuad, vtkQuadraticTriangle, vtkTriangle, vtkQuadraticPolygon, vtkCubicLine, vtkPolygon, vtkQuadraticEdge, vtkTriangleStrip, vtkQuad, vtkPixel, vtkVertex, vtkPolyVertex, vtkLine, and vtkEmptyCell.

virtual int vtkCell::IsLinear ( )

inlinevirtual

Non-linear cells require special treatment beyond the usual cell type and connectivity list information.

Most cells in VTK are implicit cells.

Reimplemented in vtkGenericCell, and vtkNonLinearCell.

Definition at line 99 of file vtkCell.h.

virtual int vtkCell::RequiresInitialization ( )

inlinevirtual

Some cells require initialization prior to access.

For example, they may have to triangulate themselves or set up internal data structures.

Reimplemented in vtkPolyhedron, vtkConvexPointSet, and vtkGenericCell.

Definition at line 105 of file vtkCell.h.

virtual void vtkCell::Initialize ( )

inlinevirtual

Reimplemented in vtkPolyhedron, vtkConvexPointSet, and vtkGenericCell.

Definition at line 106 of file vtkCell.h.

virtual int vtkCell::IsExplicitCell ( )

inlinevirtual

Explicit cells require additional representational information beyond the usual cell type and connectivity list information.

Most cells in VTK are implicit cells.

Definition at line 113 of file vtkCell.h.

virtual int vtkCell::RequiresExplicitFaceRepresentation ( )

inlinevirtual

Determine whether the cell requires explicit face representation, and methods for setting and getting the faces (see vtkPolyhedron for example usage of these methods).

Reimplemented in vtkPolyhedron, and vtkGenericCell.

Definition at line 120 of file vtkCell.h.

virtual void vtkCell::SetFaces ( vtkIdType * vtkNotUsedfaces )

inlinevirtual

Definition at line 121 of file vtkCell.h.

virtual vtkIdType* vtkCell::GetFaces ( )

inlinevirtual

Reimplemented in vtkPolyhedron, and vtkGenericCell.

Definition at line 122 of file vtkCell.h.

vtkPoints* vtkCell::GetPoints ( )

inline

Get the point coordinates for the cell.

Definition at line 127 of file vtkCell.h.

vtkIdType vtkCell::GetNumberOfPoints ( )

inline

Return the number of points in the cell.

Definition at line 132 of file vtkCell.h.

virtual int vtkCell::GetNumberOfEdges ( )

pure virtual

virtual int vtkCell::GetNumberOfFaces ( )

pure virtual

vtkIdList* vtkCell::GetPointIds ( )

inline

Return the list of point ids defining the cell.

Definition at line 147 of file vtkCell.h.

vtkIdType vtkCell::GetPointId ( int ptId )

inline

For cell point i, return the actual point id.

Definition at line 152 of file vtkCell.h.

virtual vtkCell* vtkCell::GetEdge ( int edgeId )

pure virtual

Return the edge cell from the edgeId of the cell.

Implemented in vtkTriQuadraticHexahedron, vtkBiQuadraticQuadraticHexahedron, vtkPolyhedron, vtkConvexPointSet, vtkPentagonalPrism, vtkGenericCell, vtkBiQuadraticQuadraticWedge, vtkPyramid, vtkWedge, vtkHexagonalPrism, vtkQuadraticLinearWedge, vtkQuadraticPyramid, vtkBiQuadraticQuad, vtkHexahedron, vtkTetra, vtkVoxel, vtkBiQuadraticTriangle, vtkQuadraticTetra, vtkQuadraticWedge, vtkQuadraticLinearQuad, vtkQuadraticHexahedron, vtkQuadraticQuad, vtkQuadraticTriangle, vtkQuadraticPolygon, vtkCubicLine, vtkPolygon, vtkQuadraticEdge, vtkTriangleStrip, vtkQuad, vtkPixel, vtkVertex, vtkTriangle, vtkLine, and vtkEmptyCell.

virtual vtkCell* vtkCell::GetFace ( int faceId )

pure virtual

Return the face cell from the faceId of the cell.

Implemented in vtkTriQuadraticHexahedron, vtkBiQuadraticQuadraticHexahedron, vtkPolyhedron, vtkConvexPointSet, vtkPentagonalPrism, vtkGenericCell, vtkBiQuadraticQuadraticWedge, vtkPyramid, vtkWedge, vtkHexagonalPrism, vtkQuadraticLinearWedge, vtkQuadraticPyramid, vtkBiQuadraticQuad, vtkHexahedron, vtkTetra, vtkVoxel, vtkBiQuadraticTriangle, vtkQuadraticTetra, vtkQuadraticWedge, vtkQuadraticLinearQuad, vtkQuadraticHexahedron, vtkQuadraticQuad, vtkQuadraticTriangle, vtkQuadraticPolygon, vtkTriangle, vtkCubicLine, vtkPolygon, vtkQuadraticEdge, vtkQuad, vtkPixel, vtkVertex, vtkLine, and vtkEmptyCell.

virtual int vtkCell::CellBoundary	(	int	subId,
		double	pcoords[3],
		vtkIdList *	pts
	)

pure virtual

Given parametric coordinates of a point, return the closest cell boundary, and whether the point is inside or outside of the cell.

The cell boundary is defined by a list of points (pts) that specify a face (3D cell), edge (2D cell), or vertex (1D cell). If the return value of the method is != 0, then the point is inside the cell.

Implemented in vtkPolyhedron, vtkConvexPointSet, vtkTriQuadraticHexahedron, vtkBiQuadraticQuadraticHexahedron, vtkTetra, vtkPentagonalPrism, vtkGenericCell, vtkVertex, vtkBiQuadraticQuadraticWedge, vtkQuadraticLinearWedge, vtkQuadraticPyramid, vtkPyramid, vtkWedge, vtkHexagonalPrism, vtkBiQuadraticQuad, vtkPolyLine, vtkQuadraticPolygon, vtkBiQuadraticTriangle, vtkHexahedron, vtkQuadraticTetra, vtkQuadraticWedge, vtkQuadraticLinearQuad, vtkVoxel, vtkQuadraticHexahedron, vtkQuadraticQuad, vtkQuadraticTriangle, vtkTriangle, vtkCubicLine, vtkPolygon, vtkQuadraticEdge, vtkTriangleStrip, vtkQuad, vtkPixel, vtkPolyVertex, vtkLine, and vtkEmptyCell.

virtual int vtkCell::EvaluatePosition	(	double	x[3],
		double *	closestPoint,
		int &	subId,
		double	pcoords[3],
		double &	dist2,
		double *	weights
	)

pure virtual

Given a point x[3] return inside(=1), outside(=0) cell, or (-1) computational problem encountered; evaluate parametric coordinates, sub-cell id (!=0 only if cell is composite), distance squared of point x[3] to cell (in particular, the sub-cell indicated), closest point on cell to x[3] (unless closestPoint is null, in which case, the closest point and dist2 are not found), and interpolation weights in cell.

(The number of weights is equal to the number of points defining the cell). Note: on rare occasions a -1 is returned from the method. This means that numerical error has occurred and all data returned from this method should be ignored. Also, inside/outside is determine parametrically. That is, a point is inside if it satisfies parametric limits. This can cause problems for cells of topological dimension 2 or less, since a point in 3D can project onto the cell within parametric limits but be "far" from the cell. Thus the value dist2 may be checked to determine true in/out.

Implemented in vtkPolyhedron, vtkConvexPointSet, vtkTriQuadraticHexahedron, vtkBiQuadraticQuadraticHexahedron, vtkQuadraticLinearWedge, vtkPentagonalPrism, vtkPolyLine, vtkQuadraticPolygon, vtkBiQuadraticQuadraticWedge, vtkGenericCell, vtkQuadraticPyramid, vtkTetra, vtkPyramid, vtkWedge, vtkHexahedron, vtkBiQuadraticTriangle, vtkQuadraticTetra, vtkQuadraticWedge, vtkHexagonalPrism, vtkQuadraticLinearQuad, vtkVoxel, vtkQuadraticHexahedron, vtkBiQuadraticQuad, vtkPolygon, vtkTriangleStrip, vtkQuadraticQuad, vtkQuadraticTriangle, vtkTriangle, vtkCubicLine, vtkPixel, vtkQuadraticEdge, vtkPolyVertex, vtkQuad, vtkEmptyCell, vtkVertex, and vtkLine.

virtual void vtkCell::EvaluateLocation	(	int &	subId,
		double	pcoords[3],
		double	x[3],
		double *	weights
	)

pure virtual

Determine global coordinate (x[3]) from subId and parametric coordinates.

Also returns interpolation weights. (The number of weights is equal to the number of points in the cell.)

Implemented in vtkPolyhedron, vtkConvexPointSet, vtkTriQuadraticHexahedron, vtkBiQuadraticQuadraticHexahedron, vtkQuadraticLinearWedge, vtkPentagonalPrism, vtkPolyLine, vtkQuadraticPolygon, vtkBiQuadraticQuadraticWedge, vtkGenericCell, vtkQuadraticPyramid, vtkTetra, vtkPyramid, vtkWedge, vtkHexahedron, vtkBiQuadraticTriangle, vtkQuadraticTetra, vtkQuadraticWedge, vtkHexagonalPrism, vtkVoxel, vtkQuadraticLinearQuad, vtkQuadraticHexahedron, vtkBiQuadraticQuad, vtkPolygon, vtkTriangleStrip, vtkQuadraticQuad, vtkQuadraticTriangle, vtkTriangle, vtkCubicLine, vtkPixel, vtkQuadraticEdge, vtkPolyVertex, vtkQuad, vtkEmptyCell, vtkVertex, and vtkLine.

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

pure 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.)

Implemented in vtkPolyhedron, vtkTriQuadraticHexahedron, vtkBiQuadraticQuadraticHexahedron, vtkConvexPointSet, vtkGenericCell, vtkVertex, vtkBiQuadraticQuad, vtkQuadraticLinearWedge, vtkBiQuadraticQuadraticWedge, vtkQuadraticPyramid, vtkPyramid, vtkWedge, vtkPolyLine, vtkQuadraticPolygon, vtkBiQuadraticTriangle, vtkHexahedron, vtkQuadraticTetra, vtkQuadraticWedge, vtkQuadraticLinearQuad, vtkTetra, vtkVoxel, vtkQuadraticHexahedron, vtkQuadraticQuad, vtkQuadraticTriangle, vtkTriangle, vtkCubicLine, vtkPolygon, vtkCell3D, vtkQuadraticEdge, vtkTriangleStrip, vtkQuad, vtkPixel, vtkPolyVertex, vtkLine, and vtkEmptyCell.

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

pure 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.)

Implemented in vtkTriQuadraticHexahedron, vtkBiQuadraticQuadraticHexahedron, vtkPolyhedron, vtkConvexPointSet, vtkQuadraticLinearWedge, vtkBiQuadraticQuadraticWedge, vtkQuadraticPyramid, vtkBiQuadraticQuad, vtkBiQuadraticTriangle, vtkGenericCell, vtkQuadraticWedge, vtkQuadraticTetra, vtkCubicLine, vtkQuadraticHexahedron, vtkQuadraticLinearQuad, vtkTriangle, vtkQuadraticTriangle, vtkQuad, vtkQuadraticQuad, vtkCell3D, vtkQuadraticEdge, vtkPolyLine, vtkQuadraticPolygon, vtkTetra, vtkLine, vtkPolygon, vtkTriangleStrip, vtkPixel, vtkPolyVertex, vtkVertex, and vtkEmptyCell.

virtual int vtkCell::IntersectWithLine	(	double	p1[3],
		double	p2[3],
		double	tol,
		double &	t,
		double	x[3],
		double	pcoords[3],
		int &	subId
	)

pure virtual

Intersect with a ray.

Return parametric coordinates (both line and cell) and global intersection coordinates, given ray definition p1[3], p2[3] and tolerance tol. The method returns non-zero value if intersection occurs. A parametric distance t between 0 and 1 along the ray representing the intersection point, the point coordinates x[3] in data coordinates and also pcoords[3] in parametric coordinates. subId is the index within the cell if a composed cell like a triangle strip.

Implemented in vtkPolyhedron, vtkTriQuadraticHexahedron, vtkBiQuadraticQuadraticHexahedron, vtkConvexPointSet, vtkTriangle, vtkQuadraticLinearWedge, vtkBiQuadraticQuadraticWedge, vtkQuadraticPyramid, vtkCubicLine, vtkBiQuadraticQuad, vtkBiQuadraticTriangle, vtkQuadraticWedge, vtkQuadraticTetra, vtkVertex, vtkQuadraticHexahedron, vtkQuadraticLinearQuad, vtkGenericCell, vtkQuadraticTriangle, vtkQuadraticQuad, vtkQuadraticEdge, vtkPentagonalPrism, vtkLine, vtkPolyLine, vtkQuadraticPolygon, vtkTetra, vtkPyramid, vtkWedge, vtkHexahedron, vtkHexagonalPrism, vtkVoxel, vtkPixel, vtkPolygon, vtkTriangleStrip, vtkPolyVertex, vtkQuad, and vtkEmptyCell.

virtual int vtkCell::Triangulate	(	int	index,
		vtkIdList *	ptIds,
		vtkPoints *	pts
	)

pure virtual

Generate simplices of proper dimension.

If cell is 3D, tetrahedron are generated; if 2D triangles; if 1D lines; if 0D points. The form of the output is a sequence of points, each n+1 points (where n is topological cell dimension) defining a simplex. The index is a parameter that controls which triangulation to use (if more than one is possible). If numerical degeneracy encountered, 0 is returned, otherwise 1 is returned. This method does not insert new points: all the points that define the simplices are the points that define the cell.

Implemented in vtkPolyhedron, vtkConvexPointSet, vtkTriQuadraticHexahedron, vtkBiQuadraticQuadraticHexahedron, vtkVertex, vtkGenericCell, vtkQuadraticPolygon, vtkPentagonalPrism, vtkQuadraticLinearWedge, vtkPolyLine, vtkTetra, vtkBiQuadraticQuadraticWedge, vtkPyramid, vtkWedge, vtkHexahedron, vtkQuadraticPyramid, vtkHexagonalPrism, vtkVoxel, vtkBiQuadraticTriangle, vtkPixel, vtkQuadraticTetra, vtkQuadraticWedge, vtkPolygon, vtkQuadraticLinearQuad, vtkTriangleStrip, vtkQuadraticHexahedron, vtkBiQuadraticQuad, vtkQuadraticQuad, vtkQuadraticTriangle, vtkTriangle, vtkCubicLine, vtkPolyVertex, vtkQuadraticEdge, vtkQuad, vtkEmptyCell, and vtkLine.

virtual void vtkCell::Derivatives	(	int	subId,
		double	pcoords[3],
		double *	values,
		int	dim,
		double *	derivs
	)

pure virtual

Compute derivatives given cell subId and parametric coordinates.

The values array is a series of data value(s) at the cell points. There is a one-to-one correspondence between cell point and data value(s). Dim is the number of data values per cell point. Derivs are derivatives in the x-y-z coordinate directions for each data value. Thus, if computing derivatives for a scalar function in a hexahedron, dim=1, 8 values are supplied, and 3 deriv values are returned (i.e., derivatives in x-y-z directions). On the other hand, if computing derivatives of velocity (vx,vy,vz) dim=3, 24 values are supplied ((vx,vy,vz)1, (vx,vy,vz)2, ....()8), and 9 deriv values are returned ((d(vx)/dx),(d(vx)/dy),(d(vx)/dz), (d(vy)/dx),(d(vy)/dy), (d(vy)/dz), (d(vz)/dx),(d(vz)/dy),(d(vz)/dz)).

Implemented in vtkPolyhedron, vtkConvexPointSet, vtkTriQuadraticHexahedron, vtkBiQuadraticQuadraticHexahedron, vtkVertex, vtkQuadraticPolygon, vtkGenericCell, vtkPentagonalPrism, vtkQuadraticLinearWedge, vtkPolyLine, vtkTetra, vtkBiQuadraticQuadraticWedge, vtkPyramid, vtkWedge, vtkHexahedron, vtkQuadraticPyramid, vtkHexagonalPrism, vtkVoxel, vtkBiQuadraticTriangle, vtkPixel, vtkQuadraticTetra, vtkQuadraticWedge, vtkPolygon, vtkQuadraticLinearQuad, vtkTriangleStrip, vtkQuadraticHexahedron, vtkBiQuadraticQuad, vtkQuadraticQuad, vtkQuadraticTriangle, vtkTriangle, vtkCubicLine, vtkPolyVertex, vtkQuadraticEdge, vtkQuad, vtkEmptyCell, and vtkLine.

void vtkCell::GetBounds ( double bounds[6] )

Compute cell bounding box (xmin,xmax,ymin,ymax,zmin,zmax).

Copy result into user provided array.

double* vtkCell::GetBounds ( )

Compute cell bounding box (xmin,xmax,ymin,ymax,zmin,zmax).

Return pointer to array of six double values.

double vtkCell::GetLength2 ( )

Compute Length squared of cell (i.e., bounding box diagonal squared).

virtual int vtkCell::GetParametricCenter ( double pcoords[3] )

virtual

Return center of the cell in parametric coordinates.

Note that the parametric center is not always located at (0.5,0.5,0.5). The return value is the subId that the center is in (if a composite cell). If you want the center in x-y-z space, invoke the EvaluateLocation() method.

Reimplemented in vtkPolyhedron, vtkConvexPointSet, vtkTriangle, vtkQuadraticLinearWedge, vtkBiQuadraticQuadraticWedge, vtkQuadraticPyramid, vtkBiQuadraticQuad, vtkBiQuadraticTriangle, vtkQuadraticWedge, vtkQuadraticTetra, vtkQuadraticLinearQuad, vtkQuadraticTriangle, vtkTetra, vtkGenericCell, vtkQuadraticQuad, vtkPentagonalPrism, vtkPolyLine, vtkCubicLine, vtkQuadraticEdge, vtkPyramid, vtkWedge, vtkVertex, vtkHexagonalPrism, vtkTriangleStrip, vtkLine, vtkPolyVertex, vtkQuad, and vtkPixel.

virtual double vtkCell::GetParametricDistance ( double pcoords[3] )

virtual

Return the distance of the parametric coordinate provided to the cell.

If inside the cell, a distance of zero is returned. This is used during picking to get the correct cell picked. (The tolerance will occasionally allow cells to be picked who are not really intersected "inside" the cell.)

Reimplemented in vtkTriangle, vtkBiQuadraticTriangle, vtkQuadraticTetra, vtkQuadraticTriangle, vtkTetra, and vtkCubicLine.

virtual int vtkCell::IsPrimaryCell ( )

inlinevirtual

Return whether this cell type has a fixed topology or whether the topology varies depending on the data (e.g., vtkConvexPointSet).

This compares to composite cells that are typically composed of primary cells (e.g., a triangle strip composite cell is made up of triangle primary cells).

Reimplemented in vtkPolyhedron, vtkConvexPointSet, vtkGenericCell, vtkPolyLine, vtkPolygon, vtkTriangleStrip, vtkPolyVertex, and vtkQuadraticPolygon.

Definition at line 328 of file vtkCell.h.

virtual double* vtkCell::GetParametricCoords ( )

virtual

Return a contiguous array of parametric coordinates of the points defining this cell.

In other words, (px,py,pz, px,py,pz, etc..) The coordinates are ordered consistent with the definition of the point ordering for the cell. This method returns a non-NULL pointer when the cell is a primary type (i.e., IsPrimaryCell() is true). Note that 3D parametric coordinates are returned no matter what the topological dimension of the cell.

Reimplemented in vtkTriQuadraticHexahedron, vtkBiQuadraticQuadraticHexahedron, vtkGenericCell, vtkPentagonalPrism, vtkQuadraticLinearWedge, vtkTetra, vtkBiQuadraticQuadraticWedge, vtkPyramid, vtkWedge, vtkHexahedron, vtkQuadraticPyramid, vtkHexagonalPrism, vtkBiQuadraticTriangle, vtkPixel, vtkQuadraticTetra, vtkQuadraticWedge, vtkQuadraticLinearQuad, vtkQuadraticHexahedron, vtkBiQuadraticQuad, vtkQuadraticQuad, vtkQuadraticTriangle, vtkPolyhedron, vtkTriangle, vtkCubicLine, vtkQuadraticEdge, vtkQuad, vtkVertex, vtkLine, vtkConvexPointSet, and vtkVoxel.

virtual void vtkCell::InterpolateFunctions	(	double	vtkNotUsed(pcoords)[3],
		double *	vtkNotUsedweight
	)

inlinevirtual

Compute the interpolation functions/derivatives (aka shape functions/derivatives) No-ops at this level.

Typically overridden in subclasses.

Definition at line 347 of file vtkCell.h.

virtual void vtkCell::InterpolateDerivs	(	double	vtkNotUsed(pcoords)[3],
		double *	vtkNotUsedderivs
	)

inlinevirtual

Definition at line 350 of file vtkCell.h.

Member Data Documentation

vtkPoints* vtkCell::Points

Definition at line 355 of file vtkCell.h.

vtkIdList* vtkCell::PointIds

Definition at line 356 of file vtkCell.h.

double vtkCell::Bounds[6]

protected

Definition at line 362 of file vtkCell.h.

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Common/DataModel/vtkCell.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation