Allows datasets with arbitrary storage layouts to be used with VTK. More...

#include <vtkMappedUnstructuredGrid.h>

Inheritance diagram for vtkMappedUnstructuredGrid< Implementation, CellIterator >:

Collaboration diagram for vtkMappedUnstructuredGrid< Implementation, CellIterator >:

Public Types
typedef vtkTypeTemplate< vtkMappedUnstructuredGrid< Implementation, CellIterator >, vtkUnstructuredGridBase >	Superclass

typedef Implementation	ImplementationType

typedef CellIterator	CellIteratorType

Public Types inherited from vtkTypeTemplate< vtkMappedUnstructuredGrid< Implementation, CellIterator >, vtkUnstructuredGridBase >
typedef vtkUnstructuredGridBase	Superclass

Public Types inherited from vtkPointSet
typedef vtkDataSet	Superclass

Public Types inherited from vtkDataSet
enum	FieldDataType { DATA_OBJECT_FIELD =0, POINT_DATA_FIELD =1, CELL_DATA_FIELD =2 }

typedef vtkDataObject	Superclass

Public Types inherited from vtkDataObject
typedef vtkObject	Superclass

enum	FieldAssociations { FIELD_ASSOCIATION_POINTS, FIELD_ASSOCIATION_CELLS, FIELD_ASSOCIATION_NONE, FIELD_ASSOCIATION_POINTS_THEN_CELLS, FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, FIELD_ASSOCIATION_ROWS, NUMBER_OF_ASSOCIATIONS }

enum	AttributeTypes { POINT, CELL, FIELD, POINT_THEN_CELL, VERTEX, EDGE, ROW, NUMBER_OF_ATTRIBUTE_TYPES }

enum	FieldOperations { FIELD_OPERATION_PRESERVED, FIELD_OPERATION_REINTERPOLATED, FIELD_OPERATION_MODIFIED, FIELD_OPERATION_REMOVED }

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
void	PrintSelf (ostream &os, vtkIndent indent)

void	CopyStructure (vtkDataSet *pd)

void	ShallowCopy (vtkDataObject *src)

vtkIdType	GetNumberOfCells ()

vtkCell *	GetCell (vtkIdType cellId)

void	GetCell (vtkIdType cellId, vtkGenericCell *cell)

int	GetCellType (vtkIdType cellId)

void	GetCellPoints (vtkIdType cellId, vtkIdList *ptIds)

vtkCellIterator *	NewCellIterator ()

void	GetPointCells (vtkIdType ptId, vtkIdList *cellIds)

int	GetMaxCellSize ()

void	GetIdsOfCellsOfType (int type, vtkIdTypeArray *array)

int	IsHomogeneous ()

void	Allocate (vtkIdType numCells, int extSize=1000)

vtkIdType	InsertNextCell (int type, vtkIdList *ptIds)

vtkIdType	InsertNextCell (int type, vtkIdType npts, vtkIdType *ptIds)

vtkIdType	InsertNextCell (int type, vtkIdType npts, vtkIdType ptIds, vtkIdType nfaces, vtkIdType faces)

void	ReplaceCell (vtkIdType cellId, int npts, vtkIdType *pts)

unsigned long	GetMTime ()

void	SetImplementation (ImplementationType *impl)

ImplementationType *	GetImplementation ()

Public Member Functions inherited from vtkTypeTemplate< vtkMappedUnstructuredGrid< Implementation, CellIterator >, vtkUnstructuredGridBase >
vtkMappedUnstructuredGrid< Implementation, CellIterator > *	NewInstance () const

Public Member Functions inherited from vtkUnstructuredGridBase
	vtkAbstractTypeMacro (vtkUnstructuredGridBase, vtkPointSet) void PrintSelf(ostream &os

int	GetDataObjectType ()

void	DeepCopy (vtkDataObject *src)

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

void	PrintSelf (ostream &os, vtkIndent indent)

void	Initialize ()

void	CopyStructure (vtkDataSet *pd)

vtkCellIterator *	NewCellIterator ()

unsigned long	GetMTime ()

void	ComputeBounds ()

void	Squeeze ()

unsigned long	GetActualMemorySize ()

vtkIdType	GetNumberOfPoints ()

double *	GetPoint (vtkIdType ptId)

void	GetPoint (vtkIdType ptId, double x[3])

virtual vtkIdType	FindPoint (double x[3])

vtkIdType	FindPoint (double x, double y, double z)

virtual vtkIdType	FindCell (double x[3], vtkCell cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double weights)

virtual vtkIdType	FindCell (double x[3], vtkCell cell, vtkGenericCell gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)

virtual void	SetPoints (vtkPoints *)

virtual vtkPoints *	GetPoints ()

void	ShallowCopy (vtkDataObject *src)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

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

virtual void	CopyAttributes (vtkDataSet *ds)

virtual void	GetCellBounds (vtkIdType cellId, double bounds[6])

virtual void	GetCellTypes (vtkCellTypes *types)

vtkCellData *	GetCellData ()

vtkPointData *	GetPointData ()

double *	GetBounds ()

void	GetBounds (double bounds[6])

double *	GetCenter ()

void	GetCenter (double center[3])

double	GetLength ()

virtual void	GetScalarRange (double range[2])

double *	GetScalarRange ()

int	CheckAttributes ()

virtual vtkFieldData *	GetAttributesAsFieldData (int type)

virtual vtkIdType	GetNumberOfElements (int type)

bool	HasAnyGhostCells ()

bool	HasAnyGhostPoints ()

vtkUnsignedCharArray *	GetPointGhostArray ()

void	UpdatePointGhostArrayCache ()

vtkUnsignedCharArray *	AllocatePointGhostArray ()

vtkUnsignedCharArray *	GetCellGhostArray ()

void	UpdateCellGhostArrayCache ()

vtkUnsignedCharArray *	AllocateCellGhostArray ()

virtual void	GetCellNeighbors (vtkIdType cellId, vtkIdList ptIds, vtkIdList cellIds)

vtkIdType	FindPoint (double x, double y, double z)

virtual vtkCell *	FindAndGetCell (double x[3], vtkCell cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double weights)

virtual void	GenerateGhostArray (int zeroExt[6])

virtual void	GenerateGhostArray (int zeroExt[6], bool cellOnly)

virtual bool	HasAnyBlankCells ()

virtual bool	HasAnyBlankPoints ()

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

void	ReleaseData ()

unsigned long	GetUpdateTime ()

virtual void	CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))

void	DataHasBeenGenerated ()

virtual void	PrepareForNewData ()

virtual int	GetExtentType ()

virtual void	Crop (const int *updateExtent)

virtual vtkDataSetAttributes *	GetAttributes (int type)

virtual int	GetAttributeTypeForArray (vtkAbstractArray *arr)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

virtual int	GetDataReleased ()

virtual void	SetFieldData (vtkFieldData *)

virtual vtkFieldData *	GetFieldData ()

virtual void	CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))

void	GlobalReleaseDataFlagOn ()

void	GlobalReleaseDataFlagOff ()

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

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

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)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Protected Types
typedef vtkMappedUnstructuredGrid< Implementation, CellIterator >	ThisType

Protected Member Functions
	vtkMappedUnstructuredGrid ()

	~vtkMappedUnstructuredGrid ()

Protected Member Functions inherited from vtkTypeTemplate< vtkMappedUnstructuredGrid< Implementation, CellIterator >, vtkUnstructuredGridBase >
virtual vtkObjectBase *	NewInstanceInternal () const

virtual int	IsA (const char *type)

	vtkTypeTemplate ()

Protected Member Functions inherited from vtkUnstructuredGridBase
	vtkUnstructuredGridBase ()

	~vtkUnstructuredGridBase ()

Protected Member Functions inherited from vtkPointSet
	vtkPointSet ()

	~vtkPointSet ()

virtual void	ReportReferences (vtkGarbageCollector *)

Protected Member Functions inherited from vtkDataSet
	vtkDataSet ()

	~vtkDataSet ()

virtual void	ComputeScalarRange ()

bool	IsAnyBitSet (vtkUnsignedCharArray *a, int bitFlag)

Protected Member Functions inherited from vtkDataObject
	vtkDataObject ()

	~vtkDataObject ()

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

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkSmartPointer< ImplementationType >	Impl

Protected Attributes inherited from vtkPointSet
vtkPoints *	Points

vtkPointLocator *	Locator

Protected Attributes inherited from vtkDataSet
vtkCellData *	CellData

vtkPointData *	PointData

vtkCallbackCommand *	DataObserver

vtkTimeStamp	ComputeTime

double	Bounds [6]

double	Center [3]

double	ScalarRange [2]

vtkTimeStamp	ScalarRangeComputeTime

vtkUnsignedCharArray *	PointGhostArray

vtkUnsignedCharArray *	CellGhostArray

bool	PointGhostArrayCached

bool	CellGhostArrayCached

Protected Attributes inherited from vtkDataObject
vtkFieldData *	FieldData

int	DataReleased

vtkTimeStamp	UpdateTime

vtkInformation *	Information

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Public Member Functions inherited from vtkTypeTemplate< vtkMappedUnstructuredGrid< Implementation, CellIterator >, vtkUnstructuredGridBase >
static vtkMappedUnstructuredGrid< Implementation, CellIterator > *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkUnstructuredGridBase
static vtkUnstructuredGridBase *	GetData (vtkInformation *info)

static vtkUnstructuredGridBase *	GetData (vtkInformationVector *v, int i=0)

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

static vtkPointSet *	SafeDownCast (vtkObjectBase *o)

static vtkPointSet *	GetData (vtkInformation *info)

static vtkPointSet *	GetData (vtkInformationVector *v, int i=0)

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

static vtkDataSet *	SafeDownCast (vtkObjectBase *o)

static vtkDataSet *	GetData (vtkInformation *info)

static vtkDataSet *	GetData (vtkInformationVector *v, int i=0)

Static Public Member Functions inherited from vtkDataObject
static vtkDataObject *	New ()

static int	IsTypeOf (const char *type)

static vtkDataObject *	SafeDownCast (vtkObjectBase *o)

static const char *	GetAssociationTypeAsString (int associationType)

static int	GetAssociationTypeFromString (const char *associationType)

static vtkInformationStringKey *	DATA_TYPE_NAME ()

static vtkInformationDataObjectKey *	DATA_OBJECT ()

static vtkInformationIntegerKey *	DATA_EXTENT_TYPE ()

static vtkInformationIntegerPointerKey *	DATA_EXTENT ()

static vtkInformationIntegerVectorKey *	ALL_PIECES_EXTENT ()

static vtkInformationIntegerKey *	DATA_PIECE_NUMBER ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_PIECES ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_GHOST_LEVELS ()

static vtkInformationDoubleKey *	DATA_TIME_STEP ()

static vtkInformationInformationVectorKey *	POINT_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	CELL_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	VERTEX_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	EDGE_DATA_VECTOR ()

static vtkInformationIntegerKey *	FIELD_ARRAY_TYPE ()

static vtkInformationIntegerKey *	FIELD_ASSOCIATION ()

static vtkInformationIntegerKey *	FIELD_ATTRIBUTE_TYPE ()

static vtkInformationIntegerKey *	FIELD_ACTIVE_ATTRIBUTE ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_COMPONENTS ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_TUPLES ()

static vtkInformationIntegerKey *	FIELD_OPERATION ()

static vtkInformationDoubleVectorKey *	FIELD_RANGE ()

static vtkInformationIntegerVectorKey *	PIECE_EXTENT ()

static vtkInformationStringKey *	FIELD_NAME ()

static vtkInformationDoubleVectorKey *	ORIGIN ()

static vtkInformationDoubleVectorKey *	SPACING ()

static vtkInformationDoubleVectorKey *	BOUNDING_BOX ()

static vtkInformationDataObjectKey *	SIL ()

static vtkInformation *	GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)

static vtkInformation *	GetNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)

static void	RemoveNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)

static vtkInformation *	SetActiveAttribute (vtkInformation info, int fieldAssociation, const char attributeName, int attributeType)

static void	SetActiveAttributeInfo (vtkInformation info, int fieldAssociation, int attributeType, const char name, int arrayType, int numComponents, int numTuples)

static void	SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)

static vtkDataObject *	GetData (vtkInformation *info)

static vtkDataObject *	GetData (vtkInformationVector *v, int i=0)

static void	SetGlobalReleaseDataFlag (int val)

static int	GetGlobalReleaseDataFlag ()

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

Public Attributes inherited from vtkUnstructuredGridBase
vtkIndent	indent

Static Protected Member Functions inherited from vtkTypeTemplate< vtkMappedUnstructuredGrid< Implementation, CellIterator >, vtkUnstructuredGridBase >
static int	IsTypeOf (const char *type)

Detailed Description

template<class Implementation, class CellIterator = vtkMappedUnstructuredGridCellIterator<Implementation>>
class vtkMappedUnstructuredGrid< Implementation, CellIterator >

Allows datasets with arbitrary storage layouts to be used with VTK.

This class fulfills the vtkUnstructuredGridBase API while delegating to a arbitrary implementation of the dataset topology. The purpose of vtkMappedUnstructuredGrid is to allow external data structures to be used directly in a VTK pipeline, e.g. for in-situ analysis of a running simulation.

When introducing an external data structure into VTK, there are 3 principle components of the dataset to consider:

Points
Cells (topology)
Point/Cell attributes

Points and attributes can be handled by subclassing vtkMappedDataArray and implementing that interface to adapt the external data structures into VTK. The vtkMappedDataArray subclasses can then be used as the vtkPoints's Data member (for points/nodes) or added directly to vtkPointData, vtkCellData, or vtkFieldData for attribute information. Filters used in the pipeline will need to be modified to remove calls to vtkDataArray::GetVoidPointer and use vtkTypedDataArrayIterators instead. See vtkDataArrayIteratorMacro.h for a (relatively) simple way to write processing algorithms that will use efficient raw memory accesses for standard VTK data arrays and safe iterators for non-standard data arrays in a single templated implementation.

Introducing an arbitrary topology implementation into VTK requires the use of the vtkMappedUnstructuredGrid class. Unlike the data array counterpart, the mapped unstructured grid is not subclassed, but rather takes an adaptor class as a template argument. This is to allow cheap shallow copies of the data by passing the reference-counted implementation object to new instances of vtkMappedUnstructuredGrid.

The implementation class should derive from vtkObject (for reference counting) and implement the usual vtkObject API requirements, such as a static New() method and PrintSelf function. The following methods must also be implemented:

vtkIdType GetNumberOfCells()
int GetCellType(vtkIdType cellId)
void GetCellPoints(vtkIdType cellId, vtkIdList *ptIds)
void GetPointCells(vtkIdType ptId, vtkIdList *cellIds)
int GetMaxCellSize()
void GetIdsOfCellsOfType(int type, vtkIdTypeArray *array)
int IsHomogeneous()
void Allocate(vtkIdType numCells, int extSize = 1000)
vtkIdType InsertNextCell(int type, vtkIdList *ptIds)
vtkIdType InsertNextCell(int type, vtkIdType npts, vtkIdType *ptIds)
vtkIdType InsertNextCell(int type, vtkIdType npts, vtkIdType *ptIds, vtkIdType nfaces, vtkIdType *faces)
void ReplaceCell(vtkIdType cellId, int npts, vtkIdType *pts)

These methods should provide the same functionality as defined in vtkUnstructuredGrid. See that class's documentation for more information.

Note that since the implementation class is used as a compile-time template parameter in vtkMappedUnstructuredGrid, the above methods do not need be virtuals. The compiler will statically bind the calls, making dynamic vtable lookups unneccessary and giving a slight performance boost.

Adapting a filter or algorithm to safely traverse the vtkMappedUnstructuredGrid's topology requires removing calls the following implementation-dependent vtkUnstructuredGrid methods:

vtkUnstructuredGrid::GetCellTypesArray()
vtkUnstructuredGrid::GetCellLocationsArray()
vtkUnstructuredGrid::GetCellLinks()
vtkUnstructuredGrid::GetCells() Access to the values returned by these methods should be replaced by the equivalent random-access lookup methods in the vtkUnstructuredGridBase API, or use vtkCellIterator (see vtkDataSet::NewCellIterator) for sequential access.

A custom vtkCellIterator implementation may be specified for a particular vtkMappedUnstructuredGrid as the second template parameter. By default, vtkMappedUnstructuredGridCellIterator will be used, which increments an internal cell id counter and performs random-access lookup as-needed. More efficient implementations may be used with data structures better suited for sequential access, see vtkUnstructuredGridCellIterator for an example.

A set of four macros are provided to generate a concrete subclass of vtkMappedUnstructuredGrid with a specified implementation, cell iterator, and export declaration. They are:

vtkMakeMappedUnstructuredGrid(_className, _impl)
- Create a subclass of vtkMappedUnstructuredGrid using _impl implemenation that is named _className.
vtkMakeMappedUnstructuredGridWithIter(_className, _impl, _cIter)
- Create a subclass of vtkMappedUnstructuredGrid using _impl implemenation and _cIter vtkCellIterator that is named _className.
vtkMakeExportedMappedUnstructuredGrid(_className, _impl, _exportDecl)
- Create a subclass of vtkMappedUnstructuredGrid using _impl implemenation that is named _className. _exportDecl is used to decorate the class declaration.
vtkMakeExportedMappedUnstructuredGridWithIter(_className, _impl, _cIter, _exportDecl)
- Create a subclass of vtkMappedUnstructuredGrid using _impl implemenation and _cIter vtkCellIterator that is named _className. _exportDecl is used to decorate the class declaration.

To instantiate a vtkMappedUnstructuredGrid subclass created by the above macro, the follow pattern is encouraged:

MyGrid.h:
----------------------------------------------------------------------
class MyGridImplementation : public vtkObject
{
public:
  ... (vtkObject required API) ...
  ... (vtkMappedUnstructuredGrid Implementation required API) ...
  void SetImplementationDetails(...raw data from external source...);
};
vtkMakeMappedUnstructuredGrid(MyGrid, MyGridImplementation)
SomeSource.cxx
----------------------------------------------------------------------
vtkNew<MyGrid> grid;
grid->GetImplementation()->SetImplementationDetails(...);
/* grid is now ready to use. */

The vtkCPExodusIIElementBlock class provides an example of vtkMappedUnstructuredGrid usage, adapting the Exodus II data structures for the VTK pipeline.

Definition at line 154 of file vtkMappedUnstructuredGrid.h.