VTK  9.1.0
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
vtkPyramid Class Reference

a 3D cell that represents a linear pyramid More...

#include <vtkPyramid.h>

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

Public Types

typedef vtkCell3D Superclass
 
- Public Types inherited from vtkCell3D
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.
 
vtkPyramidNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
int GetParametricCenter (double pcoords[3]) override
 Return the center of the pyramid in parametric coordinates.
 
int JacobianInverse (const double pcoords[3], double **inverse, double derivs[15])
 
void GetEdgePoints (vtkIdType edgeId, const vtkIdType *&pts) override
 See vtkCell3D API for description of these methods.
 
void GetEdgePoints (int edgeId, int *&pts) override
 See vtkCell3D API for description of these methods.
 
vtkIdType GetFacePoints (vtkIdType faceId, const vtkIdType *&pts) override
 See vtkCell3D API for description of these methods.
 
void GetFacePoints (int faceId, int *&pts) override
 See vtkCell3D API for description of these methods.
 
void GetEdgeToAdjacentFaces (vtkIdType edgeId, const vtkIdType *&pts) override
 See vtkCell3D API for description of these methods.
 
vtkIdType GetFaceToAdjacentFaces (vtkIdType faceId, const vtkIdType *&faceIds) override
 See vtkCell3D API for description of these methods.
 
vtkIdType GetPointToIncidentEdges (vtkIdType pointId, const vtkIdType *&edgeIds) override
 See vtkCell3D API for description of these methods.
 
vtkIdType GetPointToIncidentFaces (vtkIdType pointId, const vtkIdType *&faceIds) override
 See vtkCell3D API for description of these methods.
 
vtkIdType GetPointToOneRingPoints (vtkIdType pointId, const vtkIdType *&pts) override
 See vtkCell3D API for description of these methods.
 
bool GetCentroid (double centroid[3]) const override
 See vtkCell3D API for description of these methods.
 
bool IsInsideOut () override
 See vtkCell3D API for description of these methods.
 
int GetCellType () override
 See the vtkCell API for descriptions of these methods.
 
int GetCellDimension () override
 See the vtkCell API for descriptions of these methods.
 
int GetNumberOfEdges () override
 See the vtkCell API for descriptions of these methods.
 
int GetNumberOfFaces () override
 See the vtkCell API for descriptions of these methods.
 
vtkCellGetEdge (int edgeId) override
 See the vtkCell API for descriptions of these methods.
 
vtkCellGetFace (int faceId) override
 See the vtkCell API for descriptions of these methods.
 
int CellBoundary (int subId, const double pcoords[3], vtkIdList *pts) override
 See the vtkCell API for descriptions of these methods.
 
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
 See the vtkCell API for descriptions of these methods.
 
int EvaluatePosition (const double x[3], double closestPoint[3], int &subId, double pcoords[3], double &dist2, double weights[]) override
 See the vtkCell API for descriptions of these methods.
 
void EvaluateLocation (int &subId, const double pcoords[3], double x[3], double *weights) override
 See the vtkCell API for descriptions of these methods.
 
int IntersectWithLine (const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId) override
 See the vtkCell API for descriptions of these methods.
 
int Triangulate (int index, vtkIdList *ptIds, vtkPoints *pts) override
 See the vtkCell API for descriptions of these methods.
 
void Derivatives (int subId, const double pcoords[3], const double *values, int dim, double *derivs) override
 See the vtkCell API for descriptions of these methods.
 
double * GetParametricCoords () override
 See the vtkCell API for descriptions of these methods.
 
void InterpolateFunctions (const double pcoords[3], double weights[5]) override
 Compute the interpolation functions/derivatives (aka shape functions/derivatives)
 
void InterpolateDerivs (const double pcoords[3], double derivs[15]) override
 Compute the interpolation functions/derivatives (aka shape functions/derivatives)
 
- Public Member Functions inherited from vtkCell3D
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 vtkPyramidNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPyramidSafeDownCast (vtkObjectBase *o)
 
static int * GetTriangleCases (int caseId)
 Return the case table for table-based isocontouring (aka marching cubes style implementations).
 
static void InterpolationFunctions (const double pcoords[3], double weights[5])
 
static void InterpolationDerivs (const double pcoords[3], double derivs[15])
 
static const vtkIdTypeGetEdgeToAdjacentFacesArray (vtkIdType edgeId)
 Static method version of GetEdgeToAdjacentFaces.
 
static const vtkIdTypeGetFaceToAdjacentFacesArray (vtkIdType faceId)
 Static method version of GetFaceToAdjacentFaces.
 
static const vtkIdTypeGetPointToIncidentEdgesArray (vtkIdType pointId)
 Static method version of GetPointToIncidentEdgesArray.
 
static const vtkIdTypeGetPointToIncidentFacesArray (vtkIdType pointId)
 Static method version of GetPointToIncidentFacesArray.
 
static const vtkIdTypeGetPointToOneRingPointsArray (vtkIdType pointId)
 Static method version of GetPointToOneRingPoints.
 
static bool ComputeCentroid (vtkPoints *points, const vtkIdType *pointIds, double centroid[3])
 Static method version of GetCentroid.
 
static const vtkIdTypeGetEdgeArray (vtkIdType edgeId)
 Return the ids of the vertices defining edge/face (edgeId/‘faceId’).
 
static const vtkIdTypeGetFaceArray (vtkIdType faceId)
 Return the ids of the vertices defining edge/face (edgeId/‘faceId’).
 
- Static Public Member Functions inherited from vtkCell3D
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.
 

Static Public Attributes

static constexpr vtkIdType NumberOfPoints = 5
 static constexpr handle on the number of points.
 
static constexpr vtkIdType NumberOfEdges = 8
 static contexpr handle on the number of faces.
 
static constexpr vtkIdType NumberOfFaces = 5
 static contexpr handle on the number of edges.
 
static constexpr vtkIdType MaximumFaceSize = 4
 static contexpr handle on the maximum face size.
 
static constexpr vtkIdType MaximumValence = 4
 static constexpr handle on the maximum valence of this cell.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPyramid ()
 
 ~vtkPyramid () override
 
- Protected Member Functions inherited from vtkCell3D
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

vtkLineLine
 
vtkTriangleTriangle
 
vtkQuadQuad
 
- Protected Attributes inherited from vtkCell3D
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

a 3D cell that represents a linear pyramid

vtkPyramid is a concrete implementation of vtkCell to represent a 3D pyramid. A pyramid consists of a rectangular base with four triangular faces. vtkPyramid uses the standard isoparametric shape functions for a linear pyramid. The pyramid is defined by the five points (0-4) where (0,1,2,3) is the base of the pyramid which, using the right hand rule, forms a quadrilaterial whose normal points in the direction of the pyramid apex at vertex #4. The parametric location of vertex #4 is [0, 0, 1].

See also
vtkConvexPointSet vtkHexahedron vtkTetra vtkVoxel vtkWedge
Online Examples:

Definition at line 102 of file vtkPyramid.h.

Member Typedef Documentation

◆ Superclass

Definition at line 106 of file vtkPyramid.h.

Constructor & Destructor Documentation

◆ vtkPyramid()

vtkPyramid::vtkPyramid ( )
protected

◆ ~vtkPyramid()

vtkPyramid::~vtkPyramid ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkPyramid * vtkPyramid::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkPyramid::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 vtkCell3D.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkPyramid::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkCell3D.

◆ NewInstance()

vtkPyramid * vtkPyramid::NewInstance ( ) const

◆ PrintSelf()

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

◆ GetEdgePoints() [1/2]

void vtkPyramid::GetEdgePoints ( vtkIdType  edgeId,
const vtkIdType *&  pts 
)
overridevirtual

See vtkCell3D API for description of these methods.

Implements vtkCell3D.

◆ GetEdgePoints() [2/2]

void vtkPyramid::GetEdgePoints ( int  edgeId,
int *&  pts 
)
overridevirtual

See vtkCell3D API for description of these methods.

Implements vtkCell3D.

◆ GetFacePoints() [1/2]

vtkIdType vtkPyramid::GetFacePoints ( vtkIdType  faceId,
const vtkIdType *&  pts 
)
overridevirtual

See vtkCell3D API for description of these methods.

Implements vtkCell3D.

◆ GetFacePoints() [2/2]

void vtkPyramid::GetFacePoints ( int  faceId,
int *&  pts 
)
overridevirtual

See vtkCell3D API for description of these methods.

Implements vtkCell3D.

◆ GetEdgeToAdjacentFaces()

void vtkPyramid::GetEdgeToAdjacentFaces ( vtkIdType  edgeId,
const vtkIdType *&  pts 
)
overridevirtual

See vtkCell3D API for description of these methods.

Implements vtkCell3D.

◆ GetFaceToAdjacentFaces()

vtkIdType vtkPyramid::GetFaceToAdjacentFaces ( vtkIdType  faceId,
const vtkIdType *&  faceIds 
)
overridevirtual

See vtkCell3D API for description of these methods.

Implements vtkCell3D.

◆ GetPointToIncidentEdges()

vtkIdType vtkPyramid::GetPointToIncidentEdges ( vtkIdType  pointId,
const vtkIdType *&  edgeIds 
)
overridevirtual

See vtkCell3D API for description of these methods.

Implements vtkCell3D.

◆ GetPointToIncidentFaces()

vtkIdType vtkPyramid::GetPointToIncidentFaces ( vtkIdType  pointId,
const vtkIdType *&  faceIds 
)
overridevirtual

See vtkCell3D API for description of these methods.

Implements vtkCell3D.

◆ GetPointToOneRingPoints()

vtkIdType vtkPyramid::GetPointToOneRingPoints ( vtkIdType  pointId,
const vtkIdType *&  pts 
)
overridevirtual

See vtkCell3D API for description of these methods.

Implements vtkCell3D.

◆ GetCentroid()

bool vtkPyramid::GetCentroid ( double  centroid[3]) const
overridevirtual

See vtkCell3D API for description of these methods.

Implements vtkCell3D.

◆ IsInsideOut()

bool vtkPyramid::IsInsideOut ( )
overridevirtual

See vtkCell3D API for description of these methods.

Reimplemented from vtkCell3D.

◆ GetCellType()

int vtkPyramid::GetCellType ( )
inlineoverridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 161 of file vtkPyramid.h.

◆ GetCellDimension()

int vtkPyramid::GetCellDimension ( )
inlineoverridevirtual

See the vtkCell API for descriptions of these methods.

Reimplemented from vtkCell3D.

Definition at line 162 of file vtkPyramid.h.

◆ GetNumberOfEdges()

int vtkPyramid::GetNumberOfEdges ( )
inlineoverridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 163 of file vtkPyramid.h.

◆ GetNumberOfFaces()

int vtkPyramid::GetNumberOfFaces ( )
inlineoverridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 164 of file vtkPyramid.h.

◆ GetEdge()

vtkCell * vtkPyramid::GetEdge ( int  edgeId)
overridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

◆ GetFace()

vtkCell * vtkPyramid::GetFace ( int  faceId)
overridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

◆ CellBoundary()

int vtkPyramid::CellBoundary ( int  subId,
const double  pcoords[3],
vtkIdList pts 
)
overridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

◆ Contour()

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

See the vtkCell API for descriptions of these methods.

Reimplemented from vtkCell3D.

◆ EvaluatePosition()

int vtkPyramid::EvaluatePosition ( const double  x[3],
double  closestPoint[3],
int &  subId,
double  pcoords[3],
double &  dist2,
double  weights[] 
)
overridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

◆ EvaluateLocation()

void vtkPyramid::EvaluateLocation ( int &  subId,
const double  pcoords[3],
double  x[3],
double *  weights 
)
overridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

◆ IntersectWithLine()

int vtkPyramid::IntersectWithLine ( const double  p1[3],
const double  p2[3],
double  tol,
double &  t,
double  x[3],
double  pcoords[3],
int &  subId 
)
overridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

◆ Triangulate()

int vtkPyramid::Triangulate ( int  index,
vtkIdList ptIds,
vtkPoints pts 
)
overridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

◆ Derivatives()

void vtkPyramid::Derivatives ( int  subId,
const double  pcoords[3],
const double *  values,
int  dim,
double *  derivs 
)
overridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

◆ GetParametricCoords()

double * vtkPyramid::GetParametricCoords ( )
overridevirtual

See the vtkCell API for descriptions of these methods.

Reimplemented from vtkCell.

◆ GetTriangleCases()

static int * vtkPyramid::GetTriangleCases ( int  caseId)
static

Return the case table for table-based isocontouring (aka marching cubes style implementations).

A linear 3D cell with N vertices will have 2**N cases. The returned case array lists three edges in order to produce one output triangle which may be repeated to generate multiple triangles. The list of cases terminates with a -1 entry.

◆ GetParametricCenter()

int vtkPyramid::GetParametricCenter ( double  pcoords[3])
inlineoverridevirtual

Return the center of the pyramid in parametric coordinates.

Reimplemented from vtkCell.

Definition at line 272 of file vtkPyramid.h.

◆ InterpolationFunctions()

static void vtkPyramid::InterpolationFunctions ( const double  pcoords[3],
double  weights[5] 
)
static

◆ InterpolationDerivs()

static void vtkPyramid::InterpolationDerivs ( const double  pcoords[3],
double  derivs[15] 
)
static

◆ InterpolateFunctions()

void vtkPyramid::InterpolateFunctions ( const double  pcoords[3],
double  weights[5] 
)
inlineoverride

Compute the interpolation functions/derivatives (aka shape functions/derivatives)

Definition at line 203 of file vtkPyramid.h.

◆ InterpolateDerivs()

void vtkPyramid::InterpolateDerivs ( const double  pcoords[3],
double  derivs[15] 
)
inlineoverride

Compute the interpolation functions/derivatives (aka shape functions/derivatives)

Definition at line 207 of file vtkPyramid.h.

◆ JacobianInverse()

int vtkPyramid::JacobianInverse ( const double  pcoords[3],
double **  inverse,
double  derivs[15] 
)

◆ GetEdgeArray()

static const vtkIdType * vtkPyramid::GetEdgeArray ( vtkIdType  edgeId)
static

Return the ids of the vertices defining edge/face (edgeId/‘faceId’).

Ids are related to the cell, not to the dataset.

Note
The return type changed. It used to be int*, it is now const vtkIdType*. This is so ids are unified between vtkCell and vtkPoints, and so vtkCell ids can be used as inputs in algorithms such as vtkPolygon::ComputeNormal.

◆ GetFaceArray()

static const vtkIdType * vtkPyramid::GetFaceArray ( vtkIdType  faceId)
static

Return the ids of the vertices defining edge/face (edgeId/‘faceId’).

Ids are related to the cell, not to the dataset.

Note
The return type changed. It used to be int*, it is now const vtkIdType*. This is so ids are unified between vtkCell and vtkPoints, and so vtkCell ids can be used as inputs in algorithms such as vtkPolygon::ComputeNormal.

◆ GetEdgeToAdjacentFacesArray()

static const vtkIdType * vtkPyramid::GetEdgeToAdjacentFacesArray ( vtkIdType  edgeId)
static

Static method version of GetEdgeToAdjacentFaces.

◆ GetFaceToAdjacentFacesArray()

static const vtkIdType * vtkPyramid::GetFaceToAdjacentFacesArray ( vtkIdType  faceId)
static

Static method version of GetFaceToAdjacentFaces.

◆ GetPointToIncidentEdgesArray()

static const vtkIdType * vtkPyramid::GetPointToIncidentEdgesArray ( vtkIdType  pointId)
static

Static method version of GetPointToIncidentEdgesArray.

◆ GetPointToIncidentFacesArray()

static const vtkIdType * vtkPyramid::GetPointToIncidentFacesArray ( vtkIdType  pointId)
static

Static method version of GetPointToIncidentFacesArray.

◆ GetPointToOneRingPointsArray()

static const vtkIdType * vtkPyramid::GetPointToOneRingPointsArray ( vtkIdType  pointId)
static

Static method version of GetPointToOneRingPoints.

◆ ComputeCentroid()

static bool vtkPyramid::ComputeCentroid ( vtkPoints points,
const vtkIdType pointIds,
double  centroid[3] 
)
static

Static method version of GetCentroid.

Member Data Documentation

◆ NumberOfPoints

constexpr vtkIdType vtkPyramid::NumberOfPoints = 5
staticconstexpr

static constexpr handle on the number of points.

Definition at line 133 of file vtkPyramid.h.

◆ NumberOfEdges

constexpr vtkIdType vtkPyramid::NumberOfEdges = 8
staticconstexpr

static contexpr handle on the number of faces.

Definition at line 138 of file vtkPyramid.h.

◆ NumberOfFaces

constexpr vtkIdType vtkPyramid::NumberOfFaces = 5
staticconstexpr

static contexpr handle on the number of edges.

Definition at line 143 of file vtkPyramid.h.

◆ MaximumFaceSize

constexpr vtkIdType vtkPyramid::MaximumFaceSize = 4
staticconstexpr

static contexpr handle on the maximum face size.

It can also be used to know the number of faces adjacent to one face.

Definition at line 149 of file vtkPyramid.h.

◆ MaximumValence

constexpr vtkIdType vtkPyramid::MaximumValence = 4
staticconstexpr

static constexpr handle on the maximum valence of this cell.

The valence of a vertex is the number of incident edges (or equivalently faces) to this vertex. It is also equal to the size of a one ring neighborhood of a vertex.

Definition at line 156 of file vtkPyramid.h.

◆ Line

vtkLine* vtkPyramid::Line
protected

Definition at line 262 of file vtkPyramid.h.

◆ Triangle

vtkTriangle* vtkPyramid::Triangle
protected

Definition at line 263 of file vtkPyramid.h.

◆ Quad

vtkQuad* vtkPyramid::Quad
protected

Definition at line 264 of file vtkPyramid.h.


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