VTK
Public Types | Public Member Functions | Static Public Member Functions | 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 int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkPyramidNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int GetParametricCenter (double pcoords[3]) override
 Return the center of the pyramid in parametric coordinates. More...
 
int JacobianInverse (double pcoords[3], double **inverse, double derivs[15])
 
void GetEdgePoints (int edgeId, int *&pts) override
 See vtkCell3D API for description of these methods. More...
 
void GetFacePoints (int faceId, int *&pts) override
 See vtkCell3D API for description of these methods. More...
 
int GetCellType () override
 See the vtkCell API for descriptions of these methods. More...
 
int GetCellDimension () override
 See the vtkCell API for descriptions of these methods. More...
 
int GetNumberOfEdges () override
 See the vtkCell API for descriptions of these methods. More...
 
int GetNumberOfFaces () override
 See the vtkCell API for descriptions of these methods. More...
 
vtkCellGetEdge (int edgeId) override
 See the vtkCell API for descriptions of these methods. More...
 
vtkCellGetFace (int faceId) override
 See the vtkCell API for descriptions of these methods. More...
 
int CellBoundary (int subId, double pcoords[3], vtkIdList *pts) override
 See the vtkCell API for descriptions of these methods. 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
 See the vtkCell API for descriptions of these methods. More...
 
int EvaluatePosition (double x[3], double *closestPoint, int &subId, double pcoords[3], double &dist2, double *weights) override
 See the vtkCell API for descriptions of these methods. More...
 
void EvaluateLocation (int &subId, double pcoords[3], double x[3], double *weights) override
 See the vtkCell API for descriptions of these methods. More...
 
int IntersectWithLine (double p1[3], 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. More...
 
int Triangulate (int index, vtkIdList *ptIds, vtkPoints *pts) override
 See the vtkCell API for descriptions of these methods. More...
 
void Derivatives (int subId, double pcoords[3], double *values, int dim, double *derivs) override
 See the vtkCell API for descriptions of these methods. More...
 
doubleGetParametricCoords () override
 See the vtkCell API for descriptions of these methods. More...
 
void InterpolateFunctions (double pcoords[3], double weights[5]) override
 Compute the interpolation functions/derivatives (aka shape functions/derivatives) More...
 
void InterpolateDerivs (double pcoords[3], double derivs[15]) override
 Compute the interpolation functions/derivatives (aka shape functions/derivatives) More...
 
- Public Member Functions inherited from vtkCell3D
vtkCell3DNewInstance () const
 
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...
 
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
vtkCellNewInstance () const
 
void Initialize (int npts, 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 IsLinear ()
 Non-linear cells require special treatment beyond the usual cell type and connectivity list information. More...
 
virtual int RequiresInitialization ()
 Some cells require initialization prior to access. More...
 
virtual void Initialize ()
 
virtual int IsExplicitCell ()
 Explicit cells require additional representational information beyond the usual cell type and connectivity list information. More...
 
virtual int RequiresExplicitFaceRepresentation ()
 Determine whether the cell requires explicit face representation, and methods for setting and getting the faces (see vtkPolyhedron for example usage of these methods). More...
 
virtual void SetFaces (vtkIdType *vtkNotUsed(faces))
 
virtual vtkIdTypeGetFaces ()
 
vtkPointsGetPoints ()
 Get the point coordinates for the cell. More...
 
vtkIdType GetNumberOfPoints ()
 Return the number of points in the cell. More...
 
vtkIdListGetPointIds ()
 Return the list of point ids defining the cell. More...
 
vtkIdType GetPointId (int ptId)
 For cell point i, return the actual point id. More...
 
void GetBounds (double bounds[6])
 Compute cell bounding box (xmin,xmax,ymin,ymax,zmin,zmax). More...
 
doubleGetBounds ()
 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 double GetParametricDistance (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 void InterpolateFunctions (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 (double vtkNotUsed(pcoords)[3], double *vtkNotUsed(derivs))
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
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...
 
vtkCommandGetCommand (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...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int 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 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...
 
void PrintRevisions (ostream &)
 Legacy. 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 vtkPyramidNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPyramidSafeDownCast (vtkObjectBase *o)
 
static void InterpolationFunctions (double pcoords[3], double weights[5])
 
static void InterpolationDerivs (double pcoords[3], double derivs[15])
 
static intGetEdgeArray (int edgeId)
 Return the ids of the vertices defining edge/face (edgeId/`faceId'). More...
 
static intGetFaceArray (int faceId)
 Return the ids of the vertices defining edge/face (edgeId/`faceId'). More...
 
- Static Public Member Functions inherited from vtkCell3D
static int IsTypeOf (const char *type)
 
static vtkCell3DSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkCell
static int IsTypeOf (const char *type)
 
static vtkCellSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPyramid ()
 
 ~vtkPyramid () override
 
- Protected Member Functions inherited from vtkCell3D
 vtkCell3D ()
 
 ~vtkCell3D () override
 
- Protected Member Functions inherited from vtkCell
 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 CollectRevisions (ostream &)
 
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
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkCell
vtkPointsPoints
 
vtkIdListPointIds
 

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.

See also
vtkConvexPointSet vtkHexahedron vtkTetra vtkVoxel vtkWedge
Examples:
vtkPyramid (Examples)
Tests:
vtkPyramid (Tests)

Definition at line 49 of file vtkPyramid.h.

Member Typedef Documentation

Definition at line 53 of file vtkPyramid.h.

Constructor & Destructor Documentation

vtkPyramid::vtkPyramid ( )
protected
vtkPyramid::~vtkPyramid ( )
overrideprotected

Member Function Documentation

static vtkPyramid* vtkPyramid::New ( )
static
static int vtkPyramid::IsTypeOf ( const char *  type)
static
virtual int 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.

static vtkPyramid* vtkPyramid::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkPyramid::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkCell3D.

vtkPyramid* vtkPyramid::NewInstance ( ) const
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.

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

See vtkCell3D API for description of these methods.

Implements vtkCell3D.

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

See vtkCell3D API for description of these methods.

Implements vtkCell3D.

int vtkPyramid::GetCellType ( )
inlineoverridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 68 of file vtkPyramid.h.

int vtkPyramid::GetCellDimension ( )
inlineoverridevirtual

See the vtkCell API for descriptions of these methods.

Reimplemented from vtkCell3D.

Definition at line 69 of file vtkPyramid.h.

int vtkPyramid::GetNumberOfEdges ( )
inlineoverridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 70 of file vtkPyramid.h.

int vtkPyramid::GetNumberOfFaces ( )
inlineoverridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 71 of file vtkPyramid.h.

vtkCell* vtkPyramid::GetEdge ( int  edgeId)
overridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

vtkCell* vtkPyramid::GetFace ( int  faceId)
overridevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

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

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

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.

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

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

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

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

int vtkPyramid::IntersectWithLine ( double  p1[3],
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.

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

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

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

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

double* vtkPyramid::GetParametricCoords ( )
overridevirtual

See the vtkCell API for descriptions of these methods.

Reimplemented from vtkCell.

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

Return the center of the pyramid in parametric coordinates.

Reimplemented from vtkCell.

Definition at line 146 of file vtkPyramid.h.

static void vtkPyramid::InterpolationFunctions ( double  pcoords[3],
double  weights[5] 
)
static
static void vtkPyramid::InterpolationDerivs ( double  pcoords[3],
double  derivs[15] 
)
static
Deprecated:
Replaced by vtkPyramid::InterpolateDerivs as of VTK 5.2
void vtkPyramid::InterpolateFunctions ( double  pcoords[3],
double  weights[5] 
)
inlineoverride

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

Definition at line 111 of file vtkPyramid.h.

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

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

Definition at line 115 of file vtkPyramid.h.

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

Return the ids of the vertices defining edge/face (edgeId/`faceId').

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

static int* vtkPyramid::GetFaceArray ( int  faceId)
static

Return the ids of the vertices defining edge/face (edgeId/`faceId').

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

Member Data Documentation

vtkLine* vtkPyramid::Line
protected

Definition at line 136 of file vtkPyramid.h.

vtkTriangle* vtkPyramid::Triangle
protected

Definition at line 137 of file vtkPyramid.h.

vtkQuad* vtkPyramid::Quad
protected

Definition at line 138 of file vtkPyramid.h.


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