VTK  9.1.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCell3D Class Referenceabstract

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

#include <vtkCell3D.h>

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

Public Types

typedef vtkCell Superclass
 
- Public Types inherited from vtkCell
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.
 
vtkCell3DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void GetEdgePoints (vtkIdType edgeId, const vtkIdType *&pts)=0
 Get the pair of vertices that define an edge.
 
virtual void GetEdgePoints (int edgeId, int *&pts)=0
 
virtual vtkIdType GetFacePoints (vtkIdType faceId, const vtkIdType *&pts)=0
 Get the list of vertices that define a face.
 
virtual void GetFacePoints (int faceId, int *&pts)=0
 
virtual void GetEdgeToAdjacentFaces (vtkIdType edgeId, const vtkIdType *&faceIds)=0
 Get the ids of the two adjacent faces to edge of id edgeId.
 
virtual vtkIdType GetFaceToAdjacentFaces (vtkIdType faceId, const vtkIdType *&faceIds)=0
 Get the ids of the adjacent faces to face of id faceId.
 
virtual vtkIdType GetPointToIncidentEdges (vtkIdType pointId, const vtkIdType *&edgeIds)=0
 Get the ids of the incident edges to point of id pointId.
 
virtual vtkIdType GetPointToIncidentFaces (vtkIdType pointId, const vtkIdType *&faceIds)=0
 Get the ids of the incident faces point of id pointId.
 
virtual vtkIdType GetPointToOneRingPoints (vtkIdType pointId, const vtkIdType *&pts)=0
 Get the ids of a one-ring surrounding point of id pointId.
 
virtual bool IsInsideOut ()
 Returns true if the normals of the vtkCell3D point inside the cell.
 
virtual bool GetCentroid (double centroid[3]) const =0
 Computes the centroid of the cell.
 
void Contour (double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *verts, vtkCellArray *lines, vtkCellArray *polys, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd) override
 Generate contouring primitives.
 
void Clip (double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *connectivity, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut) override
 Cut (or clip) the cell based on the input cellScalars and the specified value.
 
int GetCellDimension () override
 The topological dimension of the cell.
 
int Inflate (double dist) override
 Inflates the cell.
 
virtual void SetMergeTolerance (double)
 Set the tolerance for merging clip intersection points that are near the vertices of cells.
 
virtual double GetMergeTolerance ()
 Set the tolerance for merging clip intersection points that are near the vertices of cells.
 
- Public Member Functions inherited from vtkCell
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkCellNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void Initialize (int npts, const vtkIdType *pts, vtkPoints *p)
 Initialize cell from outside with point ids and point coordinates specified.
 
void Initialize (int npts, vtkPoints *p)
 Initialize the cell with point coordinates specified.
 
virtual void ShallowCopy (vtkCell *c)
 Copy this cell by reference counting the internal data structures.
 
virtual void DeepCopy (vtkCell *c)
 Copy this cell by completely copying internal data structures.
 
virtual int GetCellType ()=0
 Return the type of cell.
 
virtual int GetCellDimension ()=0
 Return the topological dimensional of the cell (0,1,2, or 3).
 
virtual int IsLinear ()
 Non-linear cells require special treatment beyond the usual cell type and connectivity list information.
 
virtual int RequiresInitialization ()
 Some cells require initialization prior to access.
 
virtual void Initialize ()
 
virtual int IsExplicitCell ()
 Explicit cells require additional representational information beyond the usual cell type and connectivity list information.
 
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).
 
virtual void SetFaces (vtkIdType *vtkNotUsed(faces))
 
virtual vtkIdTypeGetFaces ()
 
vtkPointsGetPoints ()
 Get the point coordinates for the cell.
 
vtkIdType GetNumberOfPoints () const
 Return the number of points in the cell.
 
virtual int GetNumberOfEdges ()=0
 Return the number of edges in the cell.
 
virtual int GetNumberOfFaces ()=0
 Return the number of faces in the cell.
 
vtkIdListGetPointIds ()
 Return the list of point ids defining the cell.
 
vtkIdType GetPointId (int ptId)
 For cell point i, return the actual point id.
 
virtual vtkCellGetEdge (int edgeId)=0
 Return the edge cell from the edgeId of the cell.
 
virtual vtkCellGetFace (int faceId)=0
 Return the face cell from the faceId of the cell.
 
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.
 
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.
 
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.
 
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.
 
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.
 
virtual int Inflate (double dist)
 Inflates the cell.
 
virtual double ComputeBoundingSphere (double center[3]) const
 Computes the bounding sphere of the cell.
 
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.
 
virtual int Triangulate (int index, vtkIdList *ptIds, vtkPoints *pts)=0
 Generate simplices of proper dimension.
 
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.
 
void GetBounds (double bounds[6])
 Compute cell bounding box (xmin,xmax,ymin,ymax,zmin,zmax).
 
double * GetBounds ()
 Compute cell bounding box (xmin,xmax,ymin,ymax,zmin,zmax).
 
double GetLength2 ()
 Compute Length squared of cell (i.e., bounding box diagonal squared).
 
virtual int GetParametricCenter (double pcoords[3])
 Return center of the cell in parametric coordinates.
 
virtual double GetParametricDistance (const double pcoords[3])
 Return the distance of the parametric coordinate provided to the cell.
 
virtual int IsPrimaryCell ()
 Return whether this cell type has a fixed topology or whether the topology varies depending on the data (e.g., vtkConvexPointSet).
 
virtual double * GetParametricCoords ()
 Return a contiguous array of parametric coordinates of the points defining this cell.
 
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.
 
virtual void InterpolateDerivs (const double vtkNotUsed(pcoords)[3], double *vtkNotUsed(derivs))
 
virtual int IntersectWithCell (vtkCell *other, double tol=0.0)
 Intersects with an other cell.
 
virtual int IntersectWithCell (vtkCell *other, const vtkBoundingBox &boudingBox, const vtkBoundingBox &otherBoundingBox, double tol=0.0)
 Intersects with an other cell.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
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)
 
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.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
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.
 
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.
 
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.
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
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).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCell3DSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkCell
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.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- 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.
 
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).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
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.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCell3D ()
 
 ~vtkCell3D () override
 
- Protected Member Functions inherited from vtkCell
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.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkOrderedTriangulatorTriangulator
 
double MergeTolerance
 
vtkTetraClipTetra
 
vtkDoubleArrayClipScalars
 
- Protected Attributes inherited from vtkCell
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

- Public Attributes inherited from vtkCell
vtkPointsPoints
 
vtkIdListPointIds
 
- 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 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 39 of file vtkCell3D.h.

Member Typedef Documentation

◆ Superclass

Definition at line 42 of file vtkCell3D.h.

Constructor & Destructor Documentation

◆ vtkCell3D()

vtkCell3D::vtkCell3D ( )
protected

◆ ~vtkCell3D()

vtkCell3D::~vtkCell3D ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCell3D::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkCell3D * vtkCell3D::NewInstance ( ) const

◆ PrintSelf()

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

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

◆ GetEdgePoints() [1/2]

virtual void vtkCell3D::GetEdgePoints ( vtkIdType  edgeId,
const vtkIdType *&  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.

◆ GetEdgePoints() [2/2]

virtual void vtkCell3D::GetEdgePoints ( int  edgeId,
int *&  pts 
)
pure virtual

◆ GetFacePoints() [1/2]

virtual vtkIdType vtkCell3D::GetFacePoints ( vtkIdType  faceId,
const vtkIdType *&  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().

Returns
The number of points in face faceId

Implemented in vtkHexagonalPrism, vtkHexahedron, vtkPentagonalPrism, vtkPyramid, vtkTetra, vtkVoxel, and vtkWedge.

◆ GetFacePoints() [2/2]

virtual void vtkCell3D::GetFacePoints ( int  faceId,
int *&  pts 
)
pure virtual

◆ GetEdgeToAdjacentFaces()

virtual void vtkCell3D::GetEdgeToAdjacentFaces ( vtkIdType  edgeId,
const vtkIdType *&  faceIds 
)
pure virtual

Get the ids of the two adjacent faces to edge of id edgeId.

The output face ids are sorted from id of lowest rank to highest. Note that the faces are 0-offset; that is, they refer to the ids of the cells, not the face 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.

◆ GetFaceToAdjacentFaces()

virtual vtkIdType vtkCell3D::GetFaceToAdjacentFaces ( vtkIdType  faceId,
const vtkIdType *&  faceIds 
)
pure virtual

Get the ids of the adjacent faces to face of id faceId.

The order of faces is consistent. They are always ordered in counter clockwise w.r.t. normal orientation. The first id faces[0] corresponds to the face sharing point of id pts[0] where pts is obtained from this->GetFacePoints(faceId, pts), being the "most counter clockwise" oriented w.r.t. face faceId. Note that the faces are 0-offset; that is, they refer to the ids of the cell, not the face ids of the mesh that the cell belongs to. The faceId must be between 0<=faceId<this->GetNumberOfFaces();

Warning
If the vtkCell3D is "inside out", i.e. normals point inside the cell, the order is inverted.
Returns
The number of adjacent faces to faceId.

Implemented in vtkHexagonalPrism, vtkHexahedron, vtkPentagonalPrism, vtkPyramid, vtkTetra, vtkWedge, and vtkVoxel.

◆ GetPointToIncidentEdges()

virtual vtkIdType vtkCell3D::GetPointToIncidentEdges ( vtkIdType  pointId,
const vtkIdType *&  edgeIds 
)
pure virtual

Get the ids of the incident edges to point of id pointId.

Edges are sorted in counter clockwise order w.r.t. bisectrix pointing outside the cell at point of id pointId. The first edge corresponds to the edge containing point of id pts[0], where pts is obtained from this->GetPointToOnRingVertices(pointId, pts). Note that the edges are 0-offset; that is, they refer to the ids of the cell, not the edge ids of the mesh that the cell belongs to. The edgeId must be between 0<=edgeId<this->GetNumberOfEdges();

Warning
If the vtkCell3D is "inside out", i.e. normals point inside the cell, the order is inverted.
Returns
The valence of point pointId.

Implemented in vtkHexagonalPrism, vtkHexahedron, vtkPentagonalPrism, vtkPyramid, vtkTetra, vtkWedge, and vtkVoxel.

◆ GetPointToIncidentFaces()

virtual vtkIdType vtkCell3D::GetPointToIncidentFaces ( vtkIdType  pointId,
const vtkIdType *&  faceIds 
)
pure virtual

Get the ids of the incident faces point of id pointId.

Faces are sorted in counter clockwise order w.r.t. bisectrix pointing outside the cell at point of id pointId. The first face corresponds to the face containing edge of id edges[0], where edges is obtained from this->GetPointToIncidentEdges(pointId, edges), such that face faces[0] is the "most counterclockwise" face incident to point pointId containing edges[0]. Note that the faces are 0-offset; that is, they refer to the ids of the cell, not the face ids of the mesh that the cell belongs to. The pointId must be between 0<=pointId<this->GetNumberOfPoints().

Warning
If the vtkCell3D is "inside out", i.e. normals point inside the cell, the order is inverted.
Returns
The valence of point pointId.

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

◆ GetPointToOneRingPoints()

virtual vtkIdType vtkCell3D::GetPointToOneRingPoints ( vtkIdType  pointId,
const vtkIdType *&  pts 
)
pure virtual

Get the ids of a one-ring surrounding point of id pointId.

Points are sorted in counter clockwise order w.r.t. bisectrix pointing outside the cell at point of id pointId. The first point corresponds to the point contained in edges[0], where edges is obtained from this->GetPointToIncidentEdges(pointId, edges). Note that the points 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 pointId must be between 0<pointId<this->GetNumberOfPoints().

Returns
The valence of point pointId.

Implemented in vtkHexagonalPrism, vtkHexahedron, vtkPentagonalPrism, vtkPyramid, vtkTetra, vtkVoxel, and vtkWedge.

◆ IsInsideOut()

virtual bool vtkCell3D::IsInsideOut ( )
virtual

Returns true if the normals of the vtkCell3D point inside the cell.

Warning
This flag is not precomputed. It is advised for the return result of this method to be stored in a local boolean by the user if needed multiple times.

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

◆ GetCentroid()

virtual bool vtkCell3D::GetCentroid ( double  centroid[3]) const
pure virtual

Computes the centroid of the cell.

Implemented in vtkHexagonalPrism, vtkHexahedron, vtkPentagonalPrism, vtkPyramid, vtkTetra, vtkVoxel, and vtkWedge.

◆ Contour()

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 
)
overridevirtual

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

Implements vtkCell.

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

◆ Clip()

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

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.) (Satisfies vtkCell API.)

Implements vtkCell.

Reimplemented in vtkConvexPointSet, vtkTetra, and vtkPolyhedron.

◆ GetCellDimension()

int vtkCell3D::GetCellDimension ( )
inlineoverridevirtual

The topological dimension of the cell.

(Satisfies vtkCell API.)

Implements vtkCell.

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

Definition at line 180 of file vtkCell3D.h.

◆ Inflate()

int vtkCell3D::Inflate ( double  dist)
overridevirtual

Inflates the cell.

Each face is displaced following its normal by a distance of value dist. If dist is negative, then the cell shrinks. The resulting cell edges / faces are colinear / coplanar to their previous self.

Degenerate parts of the 3D cell are unchanged. This happens a points to which incident faces are homogeneous to a plane, to a line, or to a point.

Returns
1 if inflation was successful, 0 if no inflation was performed

Reimplemented from vtkCell.

Reimplemented in vtkVoxel.

◆ SetMergeTolerance()

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.

◆ GetMergeTolerance()

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

◆ Triangulator

vtkOrderedTriangulator* vtkCell3D::Triangulator
protected

Definition at line 209 of file vtkCell3D.h.

◆ MergeTolerance

double vtkCell3D::MergeTolerance
protected

Definition at line 210 of file vtkCell3D.h.

◆ ClipTetra

vtkTetra* vtkCell3D::ClipTetra
protected

Definition at line 213 of file vtkCell3D.h.

◆ ClipScalars

vtkDoubleArray* vtkCell3D::ClipScalars
protected

Definition at line 214 of file vtkCell3D.h.


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