VTK  9.0.20200606
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
vtkCell Class Referenceabstract

abstract class to specify cell behavior More...

#include <vtkCell.h>

Inheritance diagram for vtkCell:
[legend]
Collaboration diagram for vtkCell:
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkCellNewInstance () 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, const vtkIdType *pts, vtkPoints *p)
 Initialize cell from outside with point ids and point coordinates specified. More...
 
void Initialize (int npts, vtkPoints *p)
 Initialize the cell with 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 vtkIdTypeGetFaces ()
 
vtkPointsGetPoints ()
 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...
 
vtkIdListGetPointIds ()
 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 vtkCellGetEdge (int edgeId)=0
 Return the edge cell from the edgeId of the cell. More...
 
virtual vtkCellGetFace (int faceId)=0
 Return the face cell from the faceId of the cell. More...
 
virtual int CellBoundary (int subId, const 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 (const double x[3], double closestPoint[3], 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, const 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 void Inflate (double dist)
 Inflates the cell by dist. More...
 
virtual double ComputeBoundingSphere (double center[3]) const
 Computes the bounding sphere of the cell. More...
 
virtual int IntersectWithLine (const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId)=0
 Intersect with a ray. More...
 
virtual int IntersectWithCell (vtkCell *other, double tol=0.0)
 Intersects with an other cell. More...
 
virtual int IntersectWithCell (vtkCell *other, const vtkBoundingBox &boudingBox, const vtkBoundingBox &otherBoundingBox, double tol=0.0)
 
virtual int Triangulate (int index, vtkIdList *ptIds, vtkPoints *pts)=0
 Generate simplices of proper dimension. More...
 
virtual void Derivatives (int subId, const double pcoords[3], const 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 (const 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 (const 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 (const 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCellSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Public Attributes

vtkPointsPoints
 
vtkIdListPointIds
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
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
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

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

Definition at line 57 of file vtkCell.h.

Member Typedef Documentation

◆ Superclass

Definition at line 60 of file vtkCell.h.

Constructor & Destructor Documentation

◆ vtkCell()

vtkCell::vtkCell ( )
protected

◆ ~vtkCell()

vtkCell::~vtkCell ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkCell::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkCell* vtkCell::NewInstance ( ) const

◆ PrintSelf()

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

◆ Initialize() [1/3]

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

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

◆ Initialize() [2/3]

void vtkCell::Initialize ( int  npts,
vtkPoints p 
)

Initialize the cell with point coordinates specified.

Note that this simplified version of Initialize() assumes that the point ids are simply the indices into the supplied points array. Make sure that the ordering of the points is consistent with the definition of the cell.

◆ ShallowCopy()

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.

◆ DeepCopy()

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.

◆ GetCellType()

virtual int vtkCell::GetCellType ( )
pure virtual

◆ GetCellDimension()

virtual int vtkCell::GetCellDimension ( )
pure virtual

◆ IsLinear()

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 105 of file vtkCell.h.

◆ RequiresInitialization()

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, vtkGenericCell, vtkHigherOrderWedge, vtkHigherOrderHexahedron, vtkHigherOrderTetra, vtkHigherOrderTriangle, vtkHigherOrderQuadrilateral, and vtkHigherOrderCurve.

Definition at line 111 of file vtkCell.h.

◆ Initialize() [3/3]

virtual void vtkCell::Initialize ( )
inlinevirtual

◆ IsExplicitCell()

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 119 of file vtkCell.h.

◆ RequiresExplicitFaceRepresentation()

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 126 of file vtkCell.h.

◆ SetFaces()

virtual void vtkCell::SetFaces ( vtkIdType vtkNotUsedfaces)
inlinevirtual

Definition at line 127 of file vtkCell.h.

◆ GetFaces()

virtual vtkIdType* vtkCell::GetFaces ( )
inlinevirtual

Reimplemented in vtkPolyhedron, and vtkGenericCell.

Definition at line 128 of file vtkCell.h.

◆ GetPoints()

vtkPoints* vtkCell::GetPoints ( )
inline

Get the point coordinates for the cell.

Definition at line 133 of file vtkCell.h.

◆ GetNumberOfPoints()

vtkIdType vtkCell::GetNumberOfPoints ( )
inline

Return the number of points in the cell.

Definition at line 138 of file vtkCell.h.

◆ GetNumberOfEdges()

virtual int vtkCell::GetNumberOfEdges ( )
pure virtual

◆ GetNumberOfFaces()

virtual int vtkCell::GetNumberOfFaces ( )
pure virtual

◆ GetPointIds()

vtkIdList* vtkCell::GetPointIds ( )
inline

Return the list of point ids defining the cell.

Definition at line 153 of file vtkCell.h.

◆ GetPointId()

vtkIdType vtkCell::GetPointId ( int  ptId)
inline

For cell point i, return the actual point id.

Definition at line 158 of file vtkCell.h.

◆ GetEdge()

virtual vtkCell* vtkCell::GetEdge ( int  edgeId)
pure virtual

◆ GetFace()

virtual vtkCell* vtkCell::GetFace ( int  faceId)
pure virtual

◆ CellBoundary()

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

◆ EvaluatePosition()

virtual int vtkCell::EvaluatePosition ( const double  x[3],
double  closestPoint[3],
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, vtkPentagonalPrism, vtkHexagonalPrism, vtkVoxel, vtkWedge, vtkHexahedron, vtkPyramid, vtkTetra, vtkBiQuadraticQuadraticHexahedron, vtkGenericCell, vtkQuadraticPolygon, vtkQuadraticPyramid, vtkHigherOrderWedge, vtkBiQuadraticTriangle, vtkPolyLine, vtkQuadraticTetra, vtkQuadraticWedge, vtkQuadraticHexahedron, vtkQuadraticQuad, vtkQuadraticTriangle, vtkHigherOrderHexahedron, vtkHigherOrderTetra, vtkCubicLine, vtkHigherOrderTriangle, vtkPolygon, vtkTriangleStrip, vtkQuadraticEdge, vtkTriangle, vtkPixel, vtkHigherOrderQuadrilateral, vtkPolyVertex, vtkQuad, vtkEmptyCell, vtkHigherOrderCurve, vtkVertex, and vtkLine.

◆ EvaluateLocation()

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

◆ Contour()

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 nullptr, then no interpolation is performed. Also, if the output cell data is non-nullptr, 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, vtkVertex, vtkEmptyCell, vtkConvexPointSet, vtkCell3D, vtkVoxel, vtkWedge, vtkPyramid, vtkHexahedron, vtkTetra, vtkTriQuadraticHexahedron, vtkBiQuadraticQuadraticHexahedron, vtkGenericCell, vtkQuadraticLinearWedge, vtkBiQuadraticQuad, vtkHigherOrderWedge, vtkBiQuadraticQuadraticWedge, vtkQuadraticPyramid, vtkQuadraticPolygon, vtkBiQuadraticTriangle, vtkHigherOrderHexahedron, vtkQuadraticTetra, vtkQuadraticWedge, vtkHigherOrderTetra, vtkQuadraticLinearQuad, vtkHigherOrderTriangle, vtkPolyLine, vtkQuadraticHexahedron, vtkQuadraticQuad, vtkQuadraticTriangle, vtkCubicLine, vtkHigherOrderQuadrilateral, vtkQuadraticEdge, vtkTriangle, vtkHigherOrderCurve, vtkPolygon, vtkTriangleStrip, vtkQuad, vtkPixel, vtkPolyVertex, and vtkLine.

◆ Clip()

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-nullptr, 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 vtkPolyhedron, vtkPolyVertex, vtkPolygon, vtkQuadraticPyramid, vtkTriQuadraticHexahedron, vtkBiQuadraticQuadraticHexahedron, vtkQuadraticLinearWedge, vtkBiQuadraticQuadraticWedge, vtkQuadraticWedge, vtkQuadraticTetra, vtkQuadraticHexahedron, vtkVertex, vtkEmptyCell, vtkBiQuadraticQuad, vtkBiQuadraticTriangle, vtkQuadraticLinearQuad, vtkHigherOrderWedge, vtkQuadraticTriangle, vtkQuadraticQuad, vtkTriangle, vtkQuad, vtkQuadraticPolygon, vtkHigherOrderHexahedron, vtkHigherOrderTetra, vtkHigherOrderTriangle, vtkHigherOrderQuadrilateral, vtkHigherOrderCurve, vtkTriangleStrip, vtkPixel, vtkCubicLine, vtkQuadraticEdge, vtkPolyLine, vtkLine, vtkCell3D, vtkConvexPointSet, vtkTetra, and vtkGenericCell.

◆ Inflate()

virtual void vtkCell::Inflate ( double  dist)
virtual

Inflates the cell by dist.

Each point is displaced by dist in the direction of every halfedge. Input can be negative. If so, the cell will shrink. Artifacts will appear if one shrinks with -dist larger than any edge length, probably causing the cell to self-intersect.

Reimplemented in vtkCell3D, vtkVoxel, and vtkPixel.

◆ ComputeBoundingSphere()

virtual double vtkCell::ComputeBoundingSphere ( double  center[3]) const
virtual

Computes the bounding sphere of the cell.

If the number of points in the cell is lower or equal to 4, an exact bounding sphere is computed. If not, Ritter's algorithm is followed. If the input sphere has zero points, then each coordinate of center is set to NaN, as well as the returned distance.

This method computes the center of the sphere, and returns its squared radius.

Reimplemented in vtkVoxel, and vtkPixel.

◆ IntersectWithLine()

virtual int vtkCell::IntersectWithLine ( const double  p1[3],
const 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, vtkConvexPointSet, vtkPentagonalPrism, vtkTriQuadraticHexahedron, vtkBiQuadraticQuadraticHexahedron, vtkHexagonalPrism, vtkVoxel, vtkWedge, vtkHexahedron, vtkPyramid, vtkTetra, vtkTriangle, vtkQuadraticLinearWedge, vtkBiQuadraticQuadraticWedge, vtkQuadraticPyramid, vtkCubicLine, vtkBiQuadraticQuad, vtkBiQuadraticTriangle, vtkQuadraticWedge, vtkQuadraticTetra, vtkQuadraticLinearQuad, vtkQuadraticHexahedron, vtkVertex, vtkQuadraticTriangle, vtkGenericCell, vtkQuadraticQuad, vtkHigherOrderWedge, vtkQuadraticEdge, vtkQuadraticPolygon, vtkLine, vtkHigherOrderHexahedron, vtkPolyLine, vtkHigherOrderTetra, vtkPixel, vtkHigherOrderTriangle, vtkPolygon, vtkTriangleStrip, vtkHigherOrderQuadrilateral, vtkHigherOrderCurve, vtkPolyVertex, vtkQuad, and vtkEmptyCell.

◆ IntersectWithCell() [1/2]

virtual int vtkCell::IntersectWithCell ( vtkCell other,
double  tol = 0.0 
)
virtual

Intersects with an other cell.

Returns 1 if cells intersect, 0 otherwise. If an exact intersection detection with regards to floating point precision is wanted, tol should be disregarded. vtkBoundingBox are optional parameters which slightly improve the speed of the computation if bounding boxes are already available to user.

◆ IntersectWithCell() [2/2]

virtual int vtkCell::IntersectWithCell ( vtkCell other,
const vtkBoundingBox boudingBox,
const vtkBoundingBox otherBoundingBox,
double  tol = 0.0 
)
virtual

◆ Triangulate()

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, vtkPentagonalPrism, vtkHexagonalPrism, vtkVoxel, vtkWedge, vtkHexahedron, vtkPyramid, vtkTetra, vtkTriQuadraticHexahedron, vtkBiQuadraticQuadraticHexahedron, vtkVertex, vtkGenericCell, vtkQuadraticPolygon, vtkHigherOrderWedge, vtkQuadraticLinearWedge, vtkBiQuadraticQuadraticWedge, vtkQuadraticPyramid, vtkHigherOrderHexahedron, vtkPolyLine, vtkHigherOrderTetra, vtkPixel, vtkBiQuadraticTriangle, vtkQuadraticTetra, vtkQuadraticWedge, vtkHigherOrderTriangle, vtkQuadraticLinearQuad, vtkBiQuadraticQuad, vtkQuadraticHexahedron, vtkQuadraticQuad, vtkQuadraticTriangle, vtkPolygon, vtkTriangleStrip, vtkHigherOrderQuadrilateral, vtkCubicLine, vtkHigherOrderCurve, vtkQuadraticEdge, vtkTriangle, vtkPolyVertex, vtkQuad, vtkEmptyCell, and vtkLine.

◆ Derivatives()

virtual void vtkCell::Derivatives ( int  subId,
const double  pcoords[3],
const 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, vtkPentagonalPrism, vtkHexagonalPrism, vtkVoxel, vtkWedge, vtkHexahedron, vtkPyramid, vtkTetra, vtkTriQuadraticHexahedron, vtkBiQuadraticQuadraticHexahedron, vtkVertex, vtkQuadraticPolygon, vtkGenericCell, vtkHigherOrderWedge, vtkQuadraticLinearWedge, vtkBiQuadraticQuadraticWedge, vtkQuadraticPyramid, vtkHigherOrderHexahedron, vtkHigherOrderTetra, vtkPolyLine, vtkPixel, vtkBiQuadraticTriangle, vtkHigherOrderTriangle, vtkQuadraticTetra, vtkQuadraticWedge, vtkQuadraticLinearQuad, vtkBiQuadraticQuad, vtkQuadraticHexahedron, vtkQuadraticQuad, vtkQuadraticTriangle, vtkPolygon, vtkTriangleStrip, vtkHigherOrderQuadrilateral, vtkCubicLine, vtkHigherOrderCurve, vtkQuadraticEdge, vtkTriangle, vtkPolyVertex, vtkQuad, vtkEmptyCell, and vtkLine.

◆ GetBounds() [1/2]

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

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

Copy result into user provided array.

◆ GetBounds() [2/2]

double* vtkCell::GetBounds ( )

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

Return pointer to array of six double values.

◆ GetLength2()

double vtkCell::GetLength2 ( )

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

◆ GetParametricCenter()

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

◆ GetParametricDistance()

virtual double vtkCell::GetParametricDistance ( const 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 vtkTetra, vtkTriangle, vtkBiQuadraticTriangle, vtkQuadraticTetra, vtkQuadraticTriangle, vtkHigherOrderWedge, vtkHigherOrderHexahedron, vtkHigherOrderTetra, vtkHigherOrderTriangle, vtkCubicLine, vtkHigherOrderQuadrilateral, and vtkHigherOrderCurve.

◆ IsPrimaryCell()

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 354 of file vtkCell.h.

◆ GetParametricCoords()

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-nullptr 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 vtkPolyhedron, vtkPentagonalPrism, vtkConvexPointSet, vtkHexagonalPrism, vtkWedge, vtkHexahedron, vtkPyramid, vtkTetra, vtkTriQuadraticHexahedron, vtkBiQuadraticQuadraticHexahedron, vtkGenericCell, vtkHigherOrderWedge, vtkQuadraticLinearWedge, vtkBiQuadraticQuadraticWedge, vtkQuadraticPyramid, vtkHigherOrderHexahedron, vtkHigherOrderTetra, vtkHigherOrderTriangle, vtkPixel, vtkBiQuadraticTriangle, vtkQuadraticTetra, vtkQuadraticWedge, vtkQuadraticLinearQuad, vtkBiQuadraticQuad, vtkQuadraticHexahedron, vtkQuadraticQuad, vtkQuadraticTriangle, vtkHigherOrderQuadrilateral, vtkCubicLine, vtkHigherOrderCurve, vtkQuadraticEdge, vtkTriangle, vtkQuad, vtkVoxel, vtkVertex, and vtkLine.

◆ InterpolateFunctions()

virtual void vtkCell::InterpolateFunctions ( const 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 372 of file vtkCell.h.

◆ InterpolateDerivs()

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

Definition at line 375 of file vtkCell.h.

Member Data Documentation

◆ Points

vtkPoints* vtkCell::Points

Definition at line 378 of file vtkCell.h.

◆ PointIds

vtkIdList* vtkCell::PointIds

Definition at line 379 of file vtkCell.h.

◆ Bounds

double vtkCell::Bounds[6]
protected

Definition at line 385 of file vtkCell.h.


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