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

vtkCell3D *	NewInstance () const

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

virtual void	GetEdgePoints (vtkIdType edgeId, const vtkIdType *&pts)=0
	Get the pair of vertices that define an edge. More...

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

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

virtual vtkIdType	GetFaceToAdjacentFaces (vtkIdType faceId, const vtkIdType *&faceIds)=0
	Get the ids of the adjacent faces to face of id faceId. More...

virtual vtkIdType	GetPointToIncidentEdges (vtkIdType pointId, const vtkIdType *&edgeIds)=0
	Get the ids of the incident edges to point of id pointId. More...

virtual vtkIdType	GetPointToIncidentFaces (vtkIdType pointId, const vtkIdType *&faceIds)=0
	Get the ids of the incident faces point of id pointId. More...

virtual vtkIdType	GetPointToOneRingPoints (vtkIdType pointId, const vtkIdType *&pts)=0
	Get the ids of a one-ring surrounding point of id pointId. More...

virtual bool	IsInsideOut ()
	Returns true if the normals of the vtkCell3D point inside the cell. More...

virtual bool	GetCentroid (double centroid[3]) const =0
	Computes the centroid of the cell. More...

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

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

int	GetCellDimension () override
	The topological dimension of the cell. More...

int	Inflate (double dist) override
	Inflates the cell. More...


virtual void	SetMergeTolerance (double)
	Set the tolerance for merging clip intersection points that are near the vertices of cells. More...

virtual double	GetMergeTolerance ()
	Set the tolerance for merging clip intersection points that are near the vertices of cells. More...

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. 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, 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 vtkIdType *	GetFaces ()

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

vtkIdType	GetNumberOfPoints () const
	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, 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 int	Inflate (double dist)
	Inflates the cell. 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	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))

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)
	Intersects with an other cell. More...

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	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

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

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

vtkTypeBool	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 vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. 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	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...

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 vtkTypeBool	IsTypeOf (const char *type)

static vtkCell3D *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkCell
static vtkTypeBool	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 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 vtkObjectBase *	New ()
	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...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCell3D ()

	~vtkCell3D () override

Protected Member Functions inherited from vtkCell
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=nullptr)
	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	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

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
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkCell
vtkPoints *	Points

vtkIdList *	PointIds

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

typedef vtkCell vtkCell3D::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

Reimplemented from vtkCell.

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

◆ 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

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

◆ 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

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

◆ 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:

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

◆ Superclass

Constructor & Destructor Documentation

◆ vtkCell3D()

◆ ~vtkCell3D()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetEdgePoints() [1/2]

◆ GetEdgePoints() [2/2]

◆ GetFacePoints() [1/2]

◆ GetFacePoints() [2/2]

◆ GetEdgeToAdjacentFaces()

◆ GetFaceToAdjacentFaces()

◆ GetPointToIncidentEdges()

◆ GetPointToIncidentFaces()

◆ GetPointToOneRingPoints()

◆ IsInsideOut()

◆ GetCentroid()

◆ Contour()

◆ Clip()

◆ GetCellDimension()

◆ Inflate()

◆ SetMergeTolerance()

◆ GetMergeTolerance()

Member Data Documentation

◆ Triangulator

◆ MergeTolerance

◆ ClipTetra

◆ ClipScalars