vtkPyramid Class Reference

#include <vtkPyramid.h>

Inheritance diagram for vtkPyramid:

[legend]Collaboration diagram for vtkPyramid:

[legend]List of all members.

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

Created by:

Bertel, Francois

CVS contributions (if > 5%):

Bertel, Francois (100%)

CVS logs (CVSweb):

.cxx (/Filtering/vtkPyramid.cxx)
.h (/Filtering/vtkPyramid.h)

Examples:: vtkPyramid (Examples)

Tests:: vtkPyramid (Tests)

Definition at line 56 of file vtkPyramid.h.

[NOHEADER]

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

void InterpolationFunctions (double pcoords[3], double weights[5])

void InterpolationDerivs (double pcoords[3], double derivs[15])

int * GetEdgeArray (int edgeId)

int * GetFaceArray (int faceId)

Public Types

typedef vtkCell3D Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

void PrintSelf (ostream &os, vtkIndent indent)

int GetParametricCenter (double pcoords[3])

virtual void GetEdgePoints (int edgeId, int *&pts)

virtual void GetFacePoints (int faceId, int *&pts)

int GetCellType ()

int GetCellDimension ()

int GetNumberOfEdges ()

int GetNumberOfFaces ()

vtkCell * GetEdge (int edgeId)

vtkCell * GetFace (int faceId)

int CellBoundary (int subId, double pcoords[3], vtkIdList *pts)

void Contour (double value, vtkDataArray *cellScalars, vtkPointLocator *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 double * GetParametricCoords ()

Static Public Member Functions

int IsTypeOf (const char *type)

vtkPyramid * SafeDownCast (vtkObject *o)

vtkPyramid * New ()

Protected Member Functions

vtkPyramid ()

~vtkPyramid ()

Protected Attributes

vtkLine * Line

vtkTriangle * Triangle

vtkQuad * Quad

Member Typedef Documentation

typedef vtkCell3D vtkPyramid::Superclass

Reimplemented from vtkCell3D.
Definition at line 59 of file vtkPyramid.h.

Constructor & Destructor Documentation

vtkPyramid::vtkPyramid ( ) [protected]

vtkPyramid::~vtkPyramid ( ) [protected]

Member Function Documentation

virtual const char* vtkPyramid::GetClassName ( ) [virtual]

Reimplemented from vtkCell3D.

int vtkPyramid::IsTypeOf ( const char * type ) [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkCell3D.

virtual int vtkPyramid::IsA ( const char * type ) [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkCell3D.

vtkPyramid* vtkPyramid::SafeDownCast ( vtkObject * o ) [static]

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.

vtkPyramid* vtkPyramid::New ( ) [static]

Create an instance of this class.
Reimplemented from vtkObject.

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

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

See the vtkCell API for descriptions of these methods.
Reimplemented from vtkCell3D.
Definition at line 74 of file vtkPyramid.h.

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

See the vtkCell API for descriptions of these methods.
Implements vtkCell.
Definition at line 75 of file vtkPyramid.h.

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

See the vtkCell API for descriptions of these methods.
Implements vtkCell.
Definition at line 76 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,

vtkPointLocator * 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 125 of file vtkPyramid.h.

void vtkPyramid::InterpolationFunctions ( double pcoords[3],

double weights[5]

) [static]

Pyramid specific methods for computing interpolation functions and derivatives.

void vtkPyramid::InterpolationDerivs ( double pcoords[3],

double derivs[15]

) [static]

int vtkPyramid::JacobianInverse ( double pcoords[3],

double ** inverse,

double derivs[15]

)

int* vtkPyramid::GetEdgeArray ( int edgeId ) [static]

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

Member Data Documentation

vtkLine* vtkPyramid::Line [protected]

Definition at line 115 of file vtkPyramid.h.

vtkTriangle* vtkPyramid::Triangle [protected]

Definition at line 116 of file vtkPyramid.h.

vtkQuad* vtkPyramid::Quad [protected]

Definition at line 117 of file vtkPyramid.h.

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

dox/Filtering/vtkPyramid.h


[NOHEADER]
int	JacobianInverse (double pcoords[3], double **inverse, double derivs[15])
void	InterpolationFunctions (double pcoords[3], double weights[5])
void	InterpolationDerivs (double pcoords[3], double derivs[15])
int *	GetEdgeArray (int edgeId)
int *	GetFaceArray (int faceId)
Public Types
typedef vtkCell3D	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
int	GetParametricCenter (double pcoords[3])

virtual void	GetEdgePoints (int edgeId, int *&pts)
virtual void	GetFacePoints (int faceId, int *&pts)

int	GetCellType ()
int	GetCellDimension ()
int	GetNumberOfEdges ()
int	GetNumberOfFaces ()
vtkCell *	GetEdge (int edgeId)
vtkCell *	GetFace (int faceId)
int	CellBoundary (int subId, double pcoords[3], vtkIdList *pts)
void	Contour (double value, vtkDataArray cellScalars, vtkPointLocator 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 double *	GetParametricCoords ()
Static Public Member Functions
int	IsTypeOf (const char *type)
vtkPyramid *	SafeDownCast (vtkObject *o)
vtkPyramid *	New ()
Protected Member Functions
	vtkPyramid ()
	~vtkPyramid ()
Protected Attributes
vtkLine *	Line
vtkTriangle *	Triangle
vtkQuad *	Quad