VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkVoxel Class Reference

a cell that represents a 3D orthogonal parallelepiped More...

#include <vtkVoxel.h>

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

Public Types

typedef vtkCell3D Superclass
 
- Public Types inherited from vtkCell3D
typedef vtkCell Superclass
 
- Public Types inherited from vtkCell
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void GetEdgePoints (int edgeId, int *&pts)
 
virtual void GetFacePoints (int faceId, int *&pts)
 
virtual double * GetParametricCoords ()
 
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)
 
- Public Member Functions inherited from vtkCell3D
virtual void Clip (double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *connectivity, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut)
 
virtual void SetMergeTolerance (double)
 
virtual double GetMergeTolerance ()
 
- Public Member Functions inherited from vtkCell
void Initialize (int npts, vtkIdType *pts, vtkPoints *p)
 
virtual void ShallowCopy (vtkCell *c)
 
virtual void DeepCopy (vtkCell *c)
 
virtual int IsLinear ()
 
virtual int IsExplicitCell ()
 
vtkPointsGetPoints ()
 
vtkIdType GetNumberOfPoints ()
 
vtkIdListGetPointIds ()
 
vtkIdType GetPointId (int ptId)
 
void GetBounds (double bounds[6])
 
double * GetBounds ()
 
double GetLength2 ()
 
virtual int GetParametricCenter (double pcoords[3])
 
virtual double GetParametricDistance (double pcoords[3])
 
virtual int IsPrimaryCell ()
 
virtual int RequiresInitialization ()
 
virtual void Initialize ()
 
virtual int RequiresExplicitFaceRepresentation ()
 
virtual void SetFaces (vtkIdType *vtkNotUsed(faces))
 
virtual vtkIdTypeGetFaces ()
 
virtual void InterpolateFunctions (double pcoords[3], double weights[3])
 
virtual void InterpolateDerivs (double pcoords[3], double derivs[3])
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
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)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static vtkVoxelNew ()
 
static int IsTypeOf (const char *type)
 
static vtkVoxelSafeDownCast (vtkObject *o)
 
static void InterpolationFunctions (double pcoords[3], double weights[8])
 
static int * GetEdgeArray (int edgeId)
 
static int * GetFaceArray (int faceId)
 
- Static Public Member Functions inherited from vtkCell3D
static int IsTypeOf (const char *type)
 
static vtkCell3DSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkCell
static int IsTypeOf (const char *type)
 
static vtkCellSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkVoxel ()
 
 ~vtkVoxel ()
 
- Protected Member Functions inherited from vtkCell3D
 vtkCell3D ()
 
 ~vtkCell3D ()
 
- Protected Member Functions inherited from vtkCell
 vtkCell ()
 
 ~vtkCell ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &os)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 
static void InterpolationDerivs (double pcoords[3], double derivs[24])
 
virtual void InterpolateFunctions (double pcoords[3], double weights[8])
 
virtual void InterpolateDerivs (double pcoords[3], double derivs[24])
 

Additional Inherited Members

- Public Attributes inherited from vtkCell
vtkPointsPoints
 
vtkIdListPointIds
 
- Protected Attributes inherited from vtkCell3D
vtkOrderedTriangulatorTriangulator
 
double MergeTolerance
 
vtkTetraClipTetra
 
vtkDoubleArrayClipScalars
 
- Protected Attributes inherited from vtkCell
double Bounds [6]
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

a cell that represents a 3D orthogonal parallelepiped

vtkVoxel is a concrete implementation of vtkCell to represent a 3D orthogonal parallelepiped. Unlike vtkHexahedron, vtkVoxel has interior angles of 90 degrees, and sides are parallel to coordinate axes. This results in large increases in computational performance.

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

Definition at line 42 of file vtkVoxel.h.

Member Typedef Documentation

Definition at line 46 of file vtkVoxel.h.

Constructor & Destructor Documentation

vtkVoxel::vtkVoxel ( )
protected
vtkVoxel::~vtkVoxel ( )
protected

Member Function Documentation

static vtkVoxel* vtkVoxel::New ( )
static
virtual const char* vtkVoxel::GetClassName ( )
virtual

Reimplemented from vtkCell3D.

static int vtkVoxel::IsTypeOf ( const char *  type)
static
virtual int vtkVoxel::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 vtkVoxel* vtkVoxel::SafeDownCast ( vtkObject o)
static
void vtkVoxel::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 vtkVoxel::GetEdgePoints ( int  edgeId,
int *&  pts 
)
virtual

See vtkCell3D API for description of these methods.

Implements vtkCell3D.

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

See vtkCell3D API for description of these methods.

Implements vtkCell3D.

virtual double* vtkVoxel::GetParametricCoords ( )
virtual

See vtkCell3D API for description of these methods.

Reimplemented from vtkCell.

int vtkVoxel::GetCellType ( )
inlinevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 58 of file vtkVoxel.h.

int vtkVoxel::GetCellDimension ( )
inlinevirtual

See the vtkCell API for descriptions of these methods.

Reimplemented from vtkCell3D.

Definition at line 59 of file vtkVoxel.h.

int vtkVoxel::GetNumberOfEdges ( )
inlinevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 60 of file vtkVoxel.h.

int vtkVoxel::GetNumberOfFaces ( )
inlinevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 61 of file vtkVoxel.h.

vtkCell* vtkVoxel::GetEdge ( int  edgeId)
virtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

vtkCell* vtkVoxel::GetFace ( int  faceId)
virtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

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

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

void vtkVoxel::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 vtkVoxel::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 vtkVoxel::EvaluateLocation ( int &  subId,
double  pcoords[3],
double  x[3],
double *  weights 
)
virtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

int vtkVoxel::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 vtkVoxel::Triangulate ( int  index,
vtkIdList ptIds,
vtkPoints pts 
)
virtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

void vtkVoxel::Derivatives ( int  subId,
double  pcoords[3],
double *  values,
int  dim,
double *  derivs 
)
virtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

static void vtkVoxel::InterpolationDerivs ( double  pcoords[3],
double  derivs[24] 
)
static
Deprecated:
Replaced by vtkVoxel::InterpolateDerivs as of VTK 5.2
virtual void vtkVoxel::InterpolateFunctions ( double  pcoords[3],
double  weights[8] 
)
inlinevirtual
Deprecated:
Replaced by vtkVoxel::InterpolateDerivs as of VTK 5.2

Definition at line 88 of file vtkVoxel.h.

virtual void vtkVoxel::InterpolateDerivs ( double  pcoords[3],
double  derivs[24] 
)
inlinevirtual
Deprecated:
Replaced by vtkVoxel::InterpolateDerivs as of VTK 5.2

Definition at line 92 of file vtkVoxel.h.

static void vtkVoxel::InterpolationFunctions ( double  pcoords[3],
double  weights[8] 
)
static

Compute the interpolation functions. This static method is for convenience. Use the member function if you already have an instance of a voxel.

static int* vtkVoxel::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* vtkVoxel::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.


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