VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkPyramid Class Reference

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

#include <vtkPyramid.h>

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

List of all members.

Public Types

typedef vtkCell3D Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkPyramidNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
int GetParametricCenter (double pcoords[3])
int JacobianInverse (double pcoords[3], double **inverse, double derivs[15])
virtual void GetEdgePoints (int edgeId, int *&pts)
virtual void GetFacePoints (int faceId, int *&pts)
int GetCellType ()
int GetCellDimension ()
int GetNumberOfEdges ()
int GetNumberOfFaces ()
vtkCellGetEdge (int edgeId)
vtkCellGetFace (int faceId)
int CellBoundary (int subId, double pcoords[3], vtkIdList *pts)
void Contour (double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *verts, vtkCellArray *lines, vtkCellArray *polys, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd)
int EvaluatePosition (double x[3], double *closestPoint, int &subId, double pcoords[3], double &dist2, double *weights)
void EvaluateLocation (int &subId, double pcoords[3], double x[3], double *weights)
int IntersectWithLine (double p1[3], double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId)
int Triangulate (int index, vtkIdList *ptIds, vtkPoints *pts)
void Derivatives (int subId, double pcoords[3], double *values, int dim, double *derivs)
virtual doubleGetParametricCoords ()
virtual void InterpolateFunctions (double pcoords[3], double weights[5])
virtual void InterpolateDerivs (double pcoords[3], double derivs[15])

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)
static intGetFaceArray (int faceId)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkPyramid ()
 ~vtkPyramid ()

Protected Attributes

vtkLineLine
vtkTriangleTriangle
vtkQuadQuad

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 48 of file vtkPyramid.h.


Member Typedef Documentation

Reimplemented from vtkCell3D.

Definition at line 52 of file vtkPyramid.h.


Constructor & Destructor Documentation

vtkPyramid::vtkPyramid ( ) [protected]
vtkPyramid::~vtkPyramid ( ) [protected]

Member Function Documentation

static vtkPyramid* vtkPyramid::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

static int vtkPyramid::IsTypeOf ( const char *  name) [static]

Return 1 if this class type 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.

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.

Reimplemented from vtkCell3D.

virtual vtkObjectBase* vtkPyramid::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkCell3D.

Reimplemented from vtkCell3D.

void vtkPyramid::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

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.

virtual void vtkPyramid::GetEdgePoints ( int  edgeId,
int *&  pts 
) [virtual]

See vtkCell3D API for description of these methods.

Implements vtkCell3D.

virtual void vtkPyramid::GetFacePoints ( int  faceId,
int *&  pts 
) [virtual]

See vtkCell3D API for description of these methods.

Implements vtkCell3D.

int vtkPyramid::GetCellType ( ) [inline, virtual]

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 63 of file vtkPyramid.h.

int vtkPyramid::GetCellDimension ( ) [inline, virtual]

See the vtkCell API for descriptions of these methods.

Reimplemented from vtkCell3D.

Definition at line 64 of file vtkPyramid.h.

int vtkPyramid::GetNumberOfEdges ( ) [inline, virtual]

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 65 of file vtkPyramid.h.

int vtkPyramid::GetNumberOfFaces ( ) [inline, virtual]

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 66 of file vtkPyramid.h.

vtkCell* vtkPyramid::GetEdge ( int  edgeId) [virtual]

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

vtkCell* vtkPyramid::GetFace ( int  faceId) [virtual]

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

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

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 
) [virtual]

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 
) [virtual]

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

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

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 
) [virtual]

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

int vtkPyramid::Triangulate ( int  index,
vtkIdList ptIds,
vtkPoints pts 
) [virtual]

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 
) [virtual]

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

virtual double* vtkPyramid::GetParametricCoords ( ) [virtual]

See the vtkCell API for descriptions of these methods.

Reimplemented from vtkCell.

int vtkPyramid::GetParametricCenter ( double  pcoords[3]) [inline, virtual]

Return the center of the pyramid in parametric coordinates.

Reimplemented from vtkCell.

Definition at line 132 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
virtual void vtkPyramid::InterpolateFunctions ( double  pcoords[3],
double  weights[5] 
) [inline, virtual]

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

Definition at line 99 of file vtkPyramid.h.

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

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

Definition at line 103 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 122 of file vtkPyramid.h.

Definition at line 123 of file vtkPyramid.h.

vtkQuad* vtkPyramid::Quad [protected]

Definition at line 124 of file vtkPyramid.h.


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