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 Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkVoxel *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

double	ComputeBoundingSphere (double center[3]) const override
	Computes exact bounding sphere of this voxel. More...

int	Inflate (double dist) override
	Inflates voxel by moving every faces by dist. More...


void	GetEdgePoints (vtkIdType edgeId, const vtkIdType *&pts) override
	See vtkCell3D API for description of these methods. More...

vtkIdType	GetFacePoints (vtkIdType faceId, const vtkIdType *&pts) override
	See vtkCell3D API for description of these methods. More...

void	GetEdgeToAdjacentFaces (vtkIdType edgeId, const vtkIdType *&pts) override
	See vtkCell3D API for description of these methods. More...

vtkIdType	GetFaceToAdjacentFaces (vtkIdType faceId, const vtkIdType *&faces) override
	See vtkCell3D API for description of these methods. More...

vtkIdType	GetPointToIncidentEdges (vtkIdType pointId, const vtkIdType *&edges) override
	See vtkCell3D API for description of these methods. More...

vtkIdType	GetPointToIncidentFaces (vtkIdType pointId, const vtkIdType *&faces) override
	See vtkCell3D API for description of these methods. More...

vtkIdType	GetPointToOneRingPoints (vtkIdType pointId, const vtkIdType *&pts) override
	See vtkCell3D API for description of these methods. More...

double *	GetParametricCoords () override
	See vtkCell3D API for description of these methods. More...

bool	GetCentroid (double centroid[3]) const override
	See vtkCell3D API for description of these methods. More...

bool	IsInsideOut () 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...

vtkCell *	GetEdge (int edgeId) override
	See the vtkCell API for descriptions of these methods. More...

vtkCell *	GetFace (int faceId) override
	See the vtkCell API for descriptions of these methods. More...

int	CellBoundary (int subId, const 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 (const double x[3], double closestPoint[3], int &subId, double pcoords[3], double &dist2, double weights[]) override
	See the vtkCell API for descriptions of these methods. More...

void	EvaluateLocation (int &subId, const double pcoords[3], double x[3], double *weights) override
	See the vtkCell API for descriptions of these methods. More...

int	IntersectWithLine (const double p1[3], const 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, const double pcoords[3], const double values, int dim, double derivs) override
	See the vtkCell API for descriptions of these methods. More...


void	InterpolateFunctions (const double pcoords[3], double weights[8]) override
	Compute the interpolation functions/derivatives (aka shape functions/derivatives) More...

void	InterpolateDerivs (const double pcoords[3], double derivs[24]) override
	Compute the interpolation functions/derivatives (aka shape functions/derivatives) More...

Public Member Functions inherited from vtkCell3D
vtkCell3D *	NewInstance () 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
vtkCell *	NewInstance () const

void	Initialize (int npts, const 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 vtkIdType *	GetFaces ()

vtkPoints *	GetPoints ()
	Get the point coordinates for the cell. More...

vtkIdType	GetNumberOfPoints () const
	Return the number of points in the cell. More...

vtkIdList *	GetPointIds ()
	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...

double *	GetBounds ()
	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 int	GetParametricCenter (double pcoords[3])
	Return center of the cell in parametric coordinates. More...

virtual double	GetParametricDistance (const 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 (const 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 (const double vtkNotUsed(pcoords)[3], double *vtkNotUsed(derivs))

virtual int	IntersectWithCell (vtkCell *other, double tol=0.0)
	Intersects with an other cell. More...

virtual int	IntersectWithCell (vtkCell *other, const vtkBoundingBox &boudingBox, const vtkBoundingBox &otherBoundingBox, double tol=0.0)
	Intersects with an other cell. More...

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

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output. More...

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...

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

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	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...

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes. More...

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. 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...

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not. More...

Static Public Member Functions
static vtkVoxel *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkVoxel *	SafeDownCast (vtkObjectBase *o)

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

static void	InterpolationFunctions (const double pcoords[3], double weights[8])
	Compute the interpolation functions. More...

static int *	GetTriangleCases (int caseId)
	Return the case table for table-based isocontouring (aka marching cubes style implementations). More...

static const vtkIdType *	GetEdgeToAdjacentFacesArray (vtkIdType edgeId)
	Static method version of GetEdgeToAdjacentFaces. More...

static const vtkIdType *	GetFaceToAdjacentFacesArray (vtkIdType faceId)
	Static method version of GetFaceToAdjacentFaces. More...

static const vtkIdType *	GetPointToIncidentEdgesArray (vtkIdType pointId)
	Static method version of GetPointToIncidentEdgesArray. More...

static const vtkIdType *	GetPointToIncidentFacesArray (vtkIdType pointId)
	Static method version of GetPointToIncidentFacesArray. More...

static const vtkIdType *	GetPointToOneRingPointsArray (vtkIdType pointId)
	Static method version of GetPointToOneRingPoints. More...

static bool	ComputeCentroid (vtkPoints points, const vtkIdType pointIds, double centroid[3])
	Static method version of GetCentroid. More...


static const vtkIdType *	GetEdgeArray (vtkIdType edgeId)
	Return the ids of the vertices defining edge/face (`edgeId`/‘faceId’). More...

static const vtkIdType *	GetFaceArray (vtkIdType faceId)
	Return the ids of the vertices defining edge/face (`edgeId`/‘faceId’). More...

Static Public Member Functions inherited from vtkCell3D
static vtkTypeBool	IsTypeOf (const char *type)

static vtkCell3D *	SafeDownCast (vtkObjectBase *o)

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

static vtkCell *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Static Public Attributes
static constexpr vtkIdType	NumberOfPoints = 8
	static constexpr handle on the number of points. More...

static constexpr vtkIdType	NumberOfEdges = 12
	static contexpr handle on the number of faces. More...

static constexpr vtkIdType	NumberOfFaces = 6
	static contexpr handle on the number of edges. More...

static constexpr vtkIdType	MaximumFaceSize = 4
	static contexpr handle on the maximum face size. More...

static constexpr vtkIdType	MaximumValence = 3
	static constexpr handle on the maximum valence of this cell. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkVoxel ()

	~vtkVoxel () 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	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Public Attributes inherited from vtkCell
vtkPoints *	Points

vtkIdList *	PointIds

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	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

Online Examples:

Cell3DDemonstration

LinearCellDemo

WriteLegacyLinearCells

WriteXMLLinearCells

Tests:: vtkVoxel (Tests)

Definition at line 90 of file vtkVoxel.h.

Member Typedef Documentation

◆ Superclass

typedef vtkCell3D vtkVoxel::Superclass

Definition at line 94 of file vtkVoxel.h.

Constructor & Destructor Documentation

◆ vtkVoxel()

vtkVoxel::vtkVoxel ( )

protected

◆ ~vtkVoxel()

vtkVoxel::~vtkVoxel ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkVoxel* vtkVoxel::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool 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
	)

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.

◆ GetEdgePoints()

void vtkVoxel::GetEdgePoints	(	vtkIdType	edgeId,
		const vtkIdType *&	pts
	)

overridevirtual

See vtkCell3D API for description of these methods.

Warning: Face points of vtkVoxel are not sorted properly. {pts[0], pts[1], pts[3], pts[2]} forms consecutive points of one face.

Implements vtkCell3D.

◆ GetFacePoints()

vtkIdType vtkVoxel::GetFacePoints	(	vtkIdType	faceId,
		const vtkIdType *&	pts
	)

overridevirtual

See vtkCell3D API for description of these methods.

Warning: Face points of vtkVoxel are not sorted properly. {pts[0], pts[1], pts[3], pts[2]} forms consecutive points of one face.

Implements vtkCell3D.

◆ GetEdgeToAdjacentFaces()

void vtkVoxel::GetEdgeToAdjacentFaces	(	vtkIdType	edgeId,
		const vtkIdType *&	pts
	)

overridevirtual

See vtkCell3D API for description of these methods.

Warning: Face points of vtkVoxel are not sorted properly. {pts[0], pts[1], pts[3], pts[2]} forms consecutive points of one face.

Implements vtkCell3D.

◆ GetFaceToAdjacentFaces()

vtkIdType vtkVoxel::GetFaceToAdjacentFaces	(	vtkIdType	faceId,
		const vtkIdType *&	faces
	)

overridevirtual

See vtkCell3D API for description of these methods.

Warning: Face points of vtkVoxel are not sorted properly. {pts[0], pts[1], pts[3], pts[2]} forms consecutive points of one face.

Implements vtkCell3D.

◆ GetPointToIncidentEdges()

vtkIdType vtkVoxel::GetPointToIncidentEdges	(	vtkIdType	pointId,
		const vtkIdType *&	edges
	)

overridevirtual

See vtkCell3D API for description of these methods.

Warning: Face points of vtkVoxel are not sorted properly. {pts[0], pts[1], pts[3], pts[2]} forms consecutive points of one face.

Implements vtkCell3D.

◆ GetPointToIncidentFaces()

vtkIdType vtkVoxel::GetPointToIncidentFaces	(	vtkIdType	pointId,
		const vtkIdType *&	faces
	)

overridevirtual

See vtkCell3D API for description of these methods.

Warning: Face points of vtkVoxel are not sorted properly. {pts[0], pts[1], pts[3], pts[2]} forms consecutive points of one face.

Implements vtkCell3D.

◆ GetPointToOneRingPoints()

vtkIdType vtkVoxel::GetPointToOneRingPoints	(	vtkIdType	pointId,
		const vtkIdType *&	pts
	)

overridevirtual

See vtkCell3D API for description of these methods.

Warning: Face points of vtkVoxel are not sorted properly. {pts[0], pts[1], pts[3], pts[2]} forms consecutive points of one face.

Implements vtkCell3D.

◆ GetParametricCoords()

double* vtkVoxel::GetParametricCoords ( )

overridevirtual

See vtkCell3D API for description of these methods.

Warning: Face points of vtkVoxel are not sorted properly. {pts[0], pts[1], pts[3], pts[2]} forms consecutive points of one face.

Reimplemented from vtkCell.

◆ GetCentroid()

bool vtkVoxel::GetCentroid ( double centroid[3] ) const

overridevirtual

See vtkCell3D API for description of these methods.

Warning: Face points of vtkVoxel are not sorted properly. {pts[0], pts[1], pts[3], pts[2]} forms consecutive points of one face.

Implements vtkCell3D.

◆ IsInsideOut()

bool vtkVoxel::IsInsideOut ( )

overridevirtual

See vtkCell3D API for description of these methods.

Warning: Face points of vtkVoxel are not sorted properly. {pts[0], pts[1], pts[3], pts[2]} forms consecutive points of one face.

Reimplemented from vtkCell3D.

◆ ComputeBoundingSphere()

double vtkVoxel::ComputeBoundingSphere ( double center[3] ) const

overridevirtual

Computes exact bounding sphere of this voxel.

Reimplemented from vtkCell.