abstract class to specify 3D cell interface More...

#include <vtkCell3D.h>

Inheritance diagram for vtkCell3D:

Collaboration diagram for vtkCell3D:

Public Types
typedef vtkCell	Superclass

Public Types inherited from vtkCell
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkCell3D *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

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

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

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)

virtual int	GetCellDimension ()


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


virtual void	SetMergeTolerance (double)

virtual double	GetMergeTolerance ()

Public Member Functions inherited from vtkCell
vtkCell *	NewInstance () const

void	Initialize (int npts, vtkIdType pts, vtkPoints p)

virtual void	ShallowCopy (vtkCell *c)

virtual void	DeepCopy (vtkCell *c)

virtual int	GetCellType ()=0

virtual int	IsLinear ()

virtual int	IsExplicitCell ()

vtkPoints *	GetPoints ()

vtkIdType	GetNumberOfPoints ()

virtual int	GetNumberOfEdges ()=0

virtual int	GetNumberOfFaces ()=0

vtkIdList *	GetPointIds ()

vtkIdType	GetPointId (int ptId)

virtual vtkCell *	GetEdge (int edgeId)=0

virtual vtkCell *	GetFace (int faceId)=0

virtual int	CellBoundary (int subId, double pcoords[3], vtkIdList *pts)=0

virtual int	Triangulate (int index, vtkIdList ptIds, vtkPoints pts)=0

void	GetBounds (double bounds[6])

double *	GetBounds ()

double	GetLength2 ()

virtual int	GetParametricCenter (double pcoords[3])

virtual double	GetParametricDistance (double pcoords[3])

virtual int	IsPrimaryCell ()

virtual double *	GetParametricCoords ()

virtual int	RequiresInitialization ()

virtual void	Initialize ()

virtual int	RequiresExplicitFaceRepresentation ()

virtual void	SetFaces (vtkIdType *vtkNotUsed(faces))

virtual vtkIdType *	GetFaces ()

virtual int	EvaluatePosition (double x[3], double closestPoint, int &subId, double pcoords[3], double &dist2, double weights)=0

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

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

virtual void	Derivatives (int subId, double pcoords[3], double values, int dim, double derivs)=0

virtual void	InterpolateFunctions (double vtkNotUsed(pcoords)[3], double *vtkNotUsed(weight))

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

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

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

static vtkCell3D *	SafeDownCast (vtkObjectBase *o)

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

static vtkCell *	SafeDownCast (vtkObjectBase *o)

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

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCell3D ()

	~vtkCell3D ()

Protected Member Functions inherited from vtkCell
	vtkCell ()

	~vtkCell ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

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
vtkOrderedTriangulator *	Triangulator

double	MergeTolerance

vtkTetra *	ClipTetra

vtkDoubleArray *	ClipScalars

Protected Attributes inherited from vtkCell
double	Bounds [6]

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkCell
vtkPoints *	Points

vtkIdList *	PointIds

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

Definition at line 37 of file vtkCell3D.h.

Member Typedef Documentation

typedef vtkCell vtkCell3D::Superclass

Definition at line 40 of file vtkCell3D.h.

Constructor & Destructor Documentation

vtkCell3D::vtkCell3D ( )

protected

vtkCell3D::~vtkCell3D ( )

protected

Member Function Documentation

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

static

virtual int vtkCell3D::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 vtkCell.

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

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

static

virtual vtkObjectBase* vtkCell3D::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkCell.

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

vtkCell3D* vtkCell3D::NewInstance ( ) const

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 vtkPolyhedron, vtkPentagonalPrism, vtkPyramid, vtkWedge, vtkHexagonalPrism, vtkHexahedron, vtkTetra, vtkConvexPointSet, and vtkVoxel.

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 vtkPentagonalPrism, vtkPyramid, vtkWedge, vtkHexagonalPrism, vtkHexahedron, vtkTetra, and vtkVoxel.

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 vtkPentagonalPrism, vtkPyramid, vtkWedge, vtkHexagonalPrism, vtkHexahedron, vtkTetra, and vtkVoxel.

virtual void vtkCell3D::Contour	(	double	value,
		vtkDataArray *	cellScalars,
		vtkIncrementalPointLocator *	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 vtkPolyhedron, vtkConvexPointSet, vtkPyramid, vtkWedge, vtkHexahedron, vtkTetra, and vtkVoxel.

virtual void vtkCell3D::Clip	(	double	value,
		vtkDataArray *	cellScalars,
		vtkIncrementalPointLocator *	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 vtkPolyhedron, vtkConvexPointSet, and vtkTetra.

virtual int vtkCell3D::GetCellDimension ( )

inlinevirtual

The topological dimension of the cell. (Satisfies vtkCell API.)

Implements vtkCell.

Reimplemented in vtkPentagonalPrism, vtkPyramid, vtkWedge, vtkHexagonalPrism, and vtkVoxel.

Definition at line 83 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 97 of file vtkCell3D.h.

double vtkCell3D::MergeTolerance

protected

Definition at line 98 of file vtkCell3D.h.

vtkTetra* vtkCell3D::ClipTetra

protected

Definition at line 101 of file vtkCell3D.h.

vtkDoubleArray* vtkCell3D::ClipScalars

protected

Definition at line 102 of file vtkCell3D.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/DataModel/vtkCell3D.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation