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

#include <vtkVoxel.h>

Inheritance diagram for vtkVoxel:

Collaboration diagram for vtkVoxel:

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 int	IsA (const char *type)

vtkVoxel *	NewInstance () const

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 ()

vtkCell *	GetEdge (int edgeId)

vtkCell *	GetFace (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 void	InterpolateFunctions (double pcoords[3], double weights[8])

virtual void	InterpolateDerivs (double pcoords[3], double derivs[24])

Public Member Functions inherited from vtkCell3D
vtkCell3D *	NewInstance () const

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
vtkCell *	NewInstance () const

void	Initialize (int npts, vtkIdType pts, vtkPoints p)

virtual void	ShallowCopy (vtkCell *c)

virtual void	DeepCopy (vtkCell *c)

virtual int	IsLinear ()

virtual int	RequiresInitialization ()

virtual void	Initialize ()

virtual int	IsExplicitCell ()

virtual int	RequiresExplicitFaceRepresentation ()

virtual void	SetFaces (vtkIdType *vtkNotUsed(faces))

virtual vtkIdType *	GetFaces ()

vtkPoints *	GetPoints ()

vtkIdType	GetNumberOfPoints ()

vtkIdList *	GetPointIds ()

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 void	InterpolateFunctions (double vtkNotUsed(pcoords)[3], double *vtkNotUsed(weight))

virtual void	InterpolateDerivs (double vtkNotUsed(pcoords)[3], double *vtkNotUsed(derivs))

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool 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)

vtkCommand *	GetCommand (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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(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	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

int	GetReferenceCount ()

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkVoxel *	New ()

static int	IsTypeOf (const char *type)

static vtkVoxel *	SafeDownCast (vtkObjectBase *o)

static void	InterpolationDerivs (double pcoords[3], double derivs[24])

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 vtkCell3D *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkCell
static int	IsTypeOf (const char *type)

static vtkCell *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

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 vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	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 &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Public Attributes inherited from vtkCell
vtkPoints *	Points

vtkIdList *	PointIds

Protected Attributes inherited from vtkCell3D
vtkOrderedTriangulator *	Triangulator

double	MergeTolerance

vtkTetra *	ClipTetra

vtkDoubleArray *	ClipScalars

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

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 43 of file vtkVoxel.h.

Member Typedef Documentation

◆ Superclass

typedef vtkCell3D vtkVoxel::Superclass

Definition at line 47 of file vtkVoxel.h.

Constructor & Destructor Documentation

◆ vtkVoxel()

vtkVoxel::vtkVoxel ( )

protected

◆ ~vtkVoxel()

vtkVoxel::~vtkVoxel ( )

protected

Member Function Documentation

◆ New()

static vtkVoxel* vtkVoxel::New ( )

static

◆ IsTypeOf()

static int vtkVoxel::IsTypeOf ( const char * type )

static

◆ IsA()

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.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkVoxel::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkCell3D.

◆ NewInstance()

vtkVoxel* vtkVoxel::NewInstance ( ) const

◆ PrintSelf()

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.

◆ GetEdgePoints()

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

virtual

See vtkCell3D API for description of these methods.

Implements vtkCell3D.

◆ GetFacePoints()

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

virtual

Get the list of vertices that define a face. The list is terminated with a negative number. Note that the vertices are 0-offset; that is, they refer to the ids of the cell, not the point ids of the mesh that the cell belongs to. The faceId must range between 0<=faceId<this->GetNumberOfFaces().

Implements vtkCell3D.

◆ GetParametricCoords()

virtual double* vtkVoxel::GetParametricCoords ( )

virtual

Return a contiguous array of parametric coordinates of the points defining this cell. In other words, (px,py,pz, px,py,pz, etc..) The coordinates are ordered consistent with the definition of the point ordering for the cell. This method returns a non-NULL pointer when the cell is a primary type (i.e., IsPrimaryCell() is true). Note that 3D parametric coordinates are returned no matter what the topological dimension of the cell.

Reimplemented from vtkCell.

◆ GetCellType()

int vtkVoxel::GetCellType ( )

inlinevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 59 of file vtkVoxel.h.

◆ GetCellDimension()

int vtkVoxel::GetCellDimension ( )

inlinevirtual

The topological dimension of the cell. (Satisfies vtkCell API.)

Reimplemented from vtkCell3D.

Definition at line 60 of file vtkVoxel.h.

◆ GetNumberOfEdges()

int vtkVoxel::GetNumberOfEdges ( )

inlinevirtual

Return the number of edges in the cell.

Implements vtkCell.

Definition at line 61 of file vtkVoxel.h.

◆ GetNumberOfFaces()

int vtkVoxel::GetNumberOfFaces ( )

inlinevirtual

Return the number of faces in the cell.

Implements vtkCell.

Definition at line 62 of file vtkVoxel.h.

◆ GetEdge()

vtkCell* vtkVoxel::GetEdge ( int edgeId )

virtual

Return the edge cell from the edgeId of the cell.

Implements vtkCell.

◆ GetFace()

vtkCell* vtkVoxel::GetFace ( int faceId )

virtual

Return the face cell from the faceId of the cell.

Implements vtkCell.

◆ CellBoundary()

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

virtual

Given parametric coordinates of a point, return the closest cell boundary, and whether the point is inside or outside of the cell. The cell boundary is defined by a list of points (pts) that specify a face (3D cell), edge (2D cell), or vertex (1D cell). If the return value of the method is != 0, then the point is inside the cell.

Implements vtkCell.

◆ Contour()

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

Generate contouring primitives. The scalar list cellScalars are scalar values at each cell point. The point locator is essentially a points list that merges points as they are inserted (i.e., prevents duplicates). Contouring primitives can be vertices, lines, or polygons. It is possible to interpolate point data along the edge by providing input and output point data - if outPd is NULL, then no interpolation is performed. Also, if the output cell data is non-NULL, the cell data from the contoured cell is passed to the generated contouring primitives. (Note: the CopyAllocate() method must be invoked on both the output cell and point data. The cellId refers to the cell from which the cell data is copied.)

Reimplemented from vtkCell3D.

◆ EvaluatePosition()

int vtkVoxel::EvaluatePosition	(	double	x[3],
		double *	closestPoint,
		int &	subId,
		double	pcoords[3],
		double &	dist2,
		double *	weights
	)

virtual

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. (The number of weights is equal to the number of points defining the cell). Note: on rare occasions a -1 is returned from the method. This means that numerical error has occurred and all data returned from this method should be ignored. Also, inside/outside is determine parametrically. That is, a point is inside if it satisfies parametric limits. This can cause problems for cells of topological dimension 2 or less, since a point in 3D can project onto the cell within parametric limits but be "far" from the cell. Thus the value dist2 may be checked to determine true in/out.

Implements vtkCell.

◆ EvaluateLocation()

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

virtual

Determine global coordinate (x[3]) from subId and parametric coordinates. Also returns interpolation weights. (The number of weights is equal to the number of points in the cell.)

Implements vtkCell.

◆ IntersectWithLine()

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

virtual

Intersect with a ray. Return parametric coordinates (both line and cell) and global intersection coordinates, given ray definition p1[3], p2[3] and tolerance tol. The method returns non-zero value if intersection occurs. A parametric distance t between 0 and 1 along the ray representing the intersection point, the point coordinates x[3] in data coordinates and also pcoords[3] in parametric coordinates. subId is the index within the cell if a composed cell like a triangle strip.

Implements vtkCell.

◆ Triangulate()

int vtkVoxel::Triangulate	(	int	index,
		vtkIdList *	ptIds,
		vtkPoints *	pts
	)

virtual

Generate simplices of proper dimension. If cell is 3D, tetrahedron are generated; if 2D triangles; if 1D lines; if 0D points. The form of the output is a sequence of points, each n+1 points (where n is topological cell dimension) defining a simplex. The index is a parameter that controls which triangulation to use (if more than one is possible). If numerical degeneracy encountered, 0 is returned, otherwise 1 is returned. This method does not insert new points: all the points that define the simplices are the points that define the cell.

Implements vtkCell.

◆ Derivatives()

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

virtual

Compute derivatives given cell subId and parametric coordinates. The values array is a series of data value(s) at the cell points. There is a one-to-one correspondence between cell point and data value(s). Dim is the number of data values per cell point. Derivs are derivatives in the x-y-z coordinate directions for each data value. Thus, if computing derivatives for a scalar function in a hexahedron, dim=1, 8 values are supplied, and 3 deriv values are returned (i.e., derivatives in x-y-z directions). On the other hand, if computing derivatives of velocity (vx,vy,vz) dim=3, 24 values are supplied ((vx,vy,vz)1, (vx,vy,vz)2, ....()8), and 9 deriv values are returned ((d(vx)/dx),(d(vx)/dy),(d(vx)/dz), (d(vy)/dx),(d(vy)/dy), (d(vy)/dz), (d(vz)/dx),(d(vz)/dy),(d(vz)/dz)).

Implements vtkCell.

◆ InterpolationDerivs()

static void vtkVoxel::InterpolationDerivs	(	double	pcoords[3],
		double	derivs[24]
	)

static

Deprecated:: Replaced by vtkVoxel::InterpolateDerivs as of VTK 5.2

◆ InterpolateFunctions()

virtual void vtkVoxel::InterpolateFunctions	(	double	pcoords[3],
		double	weights[8]
	)

inlinevirtual

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

Definition at line 88 of file vtkVoxel.h.

◆ InterpolateDerivs()

virtual void vtkVoxel::InterpolateDerivs	(	double	pcoords[3],
		double	derivs[24]
	)

inlinevirtual

Definition at line 92 of file vtkVoxel.h.

◆ InterpolationFunctions()

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.

◆ GetEdgeArray()

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.

◆ GetFaceArray()

static int* vtkVoxel::GetFaceArray ( int faceId )

static

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

dox/opt/build/vtk6-6.3.0+dfsg2/Common/DataModel/vtkVoxel.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkVoxel()

◆ ~vtkVoxel()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetEdgePoints()

◆ GetFacePoints()

◆ GetParametricCoords()

◆ GetCellType()

◆ GetCellDimension()

◆ GetNumberOfEdges()

◆ GetNumberOfFaces()

◆ GetEdge()

◆ GetFace()

◆ CellBoundary()

◆ Contour()

◆ EvaluatePosition()

◆ EvaluateLocation()

◆ IntersectWithLine()

◆ Triangulate()

◆ Derivatives()

◆ InterpolationDerivs()

◆ InterpolateFunctions()

◆ InterpolateDerivs()

◆ InterpolationFunctions()

◆ GetEdgeArray()

◆ GetFaceArray()