VTK
9.1.0
|
Allows datasets with arbitrary storage layouts to be used with VTK. More...
#include <vtkMappedUnstructuredGrid.h>
Public Member Functions | |
vtkTemplateTypeMacro (SelfType, vtkUnstructuredGridBase) | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
void | CopyStructure (vtkDataSet *pd) override |
Copy the geometric and topological structure of an object. | |
void | ShallowCopy (vtkDataObject *src) override |
Shallow and Deep copy. | |
vtkIdType | GetNumberOfCells () override |
Determine the number of cells composing the dataset. | |
vtkCell * | GetCell (vtkIdType cellId) override |
Get cell with cellId such that: 0 <= cellId < NumberOfCells. | |
void | GetCell (vtkIdType cellId, vtkGenericCell *cell) override |
Get cell with cellId such that: 0 <= cellId < NumberOfCells. | |
int | GetCellType (vtkIdType cellId) override |
Get type of cell with cellId such that: 0 <= cellId < NumberOfCells. | |
void | GetCellPoints (vtkIdType cellId, vtkIdList *ptIds) override |
Topological inquiry to get points defining cell. | |
vtkCellIterator * | NewCellIterator () override |
Return an iterator that traverses the cells in this data set. | |
void | GetPointCells (vtkIdType ptId, vtkIdList *cellIds) override |
Topological inquiry to get cells using point. | |
int | GetMaxCellSize () override |
Convenience method returns largest cell size in dataset. | |
void | GetIdsOfCellsOfType (int type, vtkIdTypeArray *array) override |
Fill vtkIdTypeArray container with list of cell Ids. | |
int | IsHomogeneous () override |
Traverse cells and determine if cells are all of the same type. | |
void | Allocate (vtkIdType numCells, int extSize=1000) override |
Allocate memory for the number of cells indicated. | |
vtkMTimeType | GetMTime () override |
Datasets are composite objects and need to check each part for MTime THIS METHOD IS THREAD SAFE. | |
void | SetImplementation (ImplementationType *impl) |
ImplementationType * | GetImplementation () |
virtual vtkCell * | GetCell (vtkIdType cellId)=0 |
Get cell with cellId such that: 0 <= cellId < NumberOfCells. | |
virtual vtkCell * | GetCell (int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k)) |
virtual void | GetCell (vtkIdType cellId, vtkGenericCell *cell)=0 |
Get cell with cellId such that: 0 <= cellId < NumberOfCells. | |
Public Member Functions inherited from vtkUnstructuredGridBase | |
vtkAbstractTypeMacro (vtkUnstructuredGridBase, vtkPointSet) | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Standard methdos for type information and printing. | |
int | GetDataObjectType () override |
Return the type of data object. | |
virtual void | Allocate (vtkIdType numCells=1000, int extSize=1000)=0 |
Allocate memory for the number of cells indicated. | |
void | DeepCopy (vtkDataObject *src) override |
Shallow and Deep copy. | |
vtkIdType | InsertNextCell (int type, vtkIdType npts, const vtkIdType ptIds[]) |
Insert/create cell in object by type and list of point ids defining cell topology. | |
vtkIdType | InsertNextCell (int type, vtkIdList *ptIds) |
Insert/create cell in object by a list of point ids defining cell topology. | |
vtkIdType | InsertNextCell (int type, vtkIdType npts, const vtkIdType ptIds[], vtkIdType nfaces, const vtkIdType faces[]) |
void | ReplaceCell (vtkIdType cellId, int npts, const vtkIdType pts[]) |
Replace the points defining cell "cellId" with a new set of points. | |
virtual void | GetIdsOfCellsOfType (int type, vtkIdTypeArray *array)=0 |
Fill vtkIdTypeArray container with list of cell Ids. | |
virtual int | IsHomogeneous ()=0 |
Traverse cells and determine if cells are all of the same type. | |
Public Member Functions inherited from vtkPointSet | |
void | Initialize () override |
Reset to an empty state and free any memory. | |
void | CopyStructure (vtkDataSet *pd) override |
Copy the geometric structure of an input point set object. | |
vtkCell * | GetCell (vtkIdType) override |
This method always return a vtkEmptyCell , as there is no cell in a vtkPointSet . | |
void | GetCell (vtkIdType, vtkGenericCell *cell) override |
This method sets cell to be an empty cell. | |
int | GetCellType (vtkIdType) override |
This method always returns VTK_EMPTY_CELL , as there is no cell in a vtkPointSet . | |
double * | GetPoint (vtkIdType ptId) override |
See vtkDataSet for additional information. | |
vtkCellIterator * | NewCellIterator () override |
Return an iterator that traverses the cells in this data set. | |
void | BuildCellLocator () |
Build the cell locator. | |
vtkMTimeType | GetMTime () override |
Get MTime which also considers its vtkPoints MTime. | |
void | ComputeBounds () override |
Compute the (X, Y, Z) bounds of the data. | |
void | Squeeze () override |
Reclaim any unused memory. | |
unsigned long | GetActualMemorySize () override |
Return the actual size of the data in kibibytes (1024 bytes). | |
virtual vtkCell * | GetCell (vtkIdType cellId)=0 |
Get cell with cellId such that: 0 <= cellId < NumberOfCells. | |
virtual vtkCell * | GetCell (int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k)) |
virtual void | GetCell (vtkIdType cellId, vtkGenericCell *cell)=0 |
Get cell with cellId such that: 0 <= cellId < NumberOfCells. | |
virtual void | SetEditable (bool) |
Specify whether this dataset is editable after creation. | |
virtual bool | GetEditable () |
Specify whether this dataset is editable after creation. | |
virtual void | EditableOn () |
Specify whether this dataset is editable after creation. | |
virtual void | EditableOff () |
Specify whether this dataset is editable after creation. | |
vtkIdType | GetNumberOfPoints () override |
See vtkDataSet for additional information. | |
void | GetPoint (vtkIdType ptId, double x[3]) override |
See vtkDataSet for additional information. | |
vtkIdType | FindPoint (double x[3]) override |
See vtkDataSet for additional information. | |
vtkIdType | FindPoint (double x, double y, double z) |
See vtkDataSet for additional information. | |
vtkIdType | FindCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override |
See vtkDataSet for additional information. | |
vtkIdType | FindCell (double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override |
See vtkDataSet for additional information. | |
vtkIdType | GetNumberOfCells () override |
This method always returns 0, as there are no cells in a vtkPointSet . | |
int | GetMaxCellSize () override |
This method always returns 0, as there are no cells in a vtkPointSet . | |
void | GetCellPoints (vtkIdType, vtkIdList *idList) override |
This method resets parameter idList, as there is no cell in a vtkPointSet . | |
void | GetPointCells (vtkIdType, vtkIdList *idList) override |
This method resets parameter idList, as there is no cell in a vtkPointSet . | |
void | BuildPointLocator () |
Build the internal point locator . | |
void | BuildLocator () |
Build the internal point locator . | |
virtual void | SetPointLocator (vtkAbstractPointLocator *) |
Set / get an instance of vtkAbstractPointLocator which is used to support the FindPoint() and FindCell() methods. | |
virtual vtkAbstractPointLocator * | GetPointLocator () |
Set / get an instance of vtkAbstractPointLocator which is used to support the FindPoint() and FindCell() methods. | |
virtual void | SetCellLocator (vtkAbstractCellLocator *) |
Set / get an instance of vtkAbstractCellLocator which may be used when a vtkCellLocatorStrategy is used during a FindCelloperation. | |
virtual vtkAbstractCellLocator * | GetCellLocator () |
Set / get an instance of vtkAbstractCellLocator which may be used when a vtkCellLocatorStrategy is used during a FindCelloperation. | |
virtual void | SetPoints (vtkPoints *) |
Specify point array to define point coordinates. | |
virtual vtkPoints * | GetPoints () |
Specify point array to define point coordinates. | |
void | ShallowCopy (vtkDataObject *src) override |
Shallow and Deep copy. | |
void | Register (vtkObjectBase *o) override |
Overwritten to handle the data/locator loop. | |
void | UnRegister (vtkObjectBase *o) override |
Overwritten to handle the data/locator loop. | |
virtual vtkTypeBool | IsA (const char *type) |
Standard methdos for type information and printing. | |
vtkPointSet * | NewInstance () const |
Standard methdos for type information and printing. | |
Public Member Functions inherited from vtkDataSet | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
vtkDataSet * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | CopyStructure (vtkDataSet *ds)=0 |
Copy the geometric and topological structure of an object. | |
virtual void | CopyAttributes (vtkDataSet *ds) |
Copy the attributes associated with the specified dataset to this instance of vtkDataSet. | |
virtual vtkIdType | GetNumberOfPoints ()=0 |
Determine the number of points composing the dataset. | |
virtual vtkIdType | GetNumberOfCells ()=0 |
Determine the number of cells composing the dataset. | |
virtual double * | GetPoint (vtkIdType ptId)=0 |
Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints. | |
virtual void | GetPoint (vtkIdType id, double x[3]) |
Copy point coordinates into user provided array x[3] for specified point id. | |
virtual vtkCellIterator * | NewCellIterator () |
Return an iterator that traverses the cells in this data set. | |
virtual vtkCell * | GetCell (vtkIdType cellId)=0 |
Get cell with cellId such that: 0 <= cellId < NumberOfCells. | |
virtual vtkCell * | GetCell (int vtkNotUsed(i), int vtkNotUsed(j), int vtkNotUsed(k)) |
void | SetCellOrderAndRationalWeights (vtkIdType cellId, vtkGenericCell *cell) |
virtual void | GetCell (vtkIdType cellId, vtkGenericCell *cell)=0 |
Get cell with cellId such that: 0 <= cellId < NumberOfCells. | |
virtual void | GetCellBounds (vtkIdType cellId, double bounds[6]) |
Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells. | |
virtual int | GetCellType (vtkIdType cellId)=0 |
Get type of cell with cellId such that: 0 <= cellId < NumberOfCells. | |
virtual void | GetCellTypes (vtkCellTypes *types) |
Get a list of types of cells in a dataset. | |
virtual void | GetCellPoints (vtkIdType cellId, vtkIdList *ptIds)=0 |
Topological inquiry to get points defining cell. | |
virtual void | GetPointCells (vtkIdType ptId, vtkIdList *cellIds)=0 |
Topological inquiry to get cells using point. | |
virtual void | GetCellNeighbors (vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds) |
Topological inquiry to get all cells using list of points exclusive of cell specified (e.g., cellId). | |
virtual vtkIdType | FindCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)=0 |
Locate cell based on global coordinate x and tolerance squared. | |
virtual vtkIdType | FindCell (double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)=0 |
This is a version of the above method that can be used with multithreaded applications. | |
virtual vtkCell * | FindAndGetCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) |
Locate the cell that contains a point and return the cell. | |
vtkMTimeType | GetMTime () override |
Datasets are composite objects and need to check each part for MTime THIS METHOD IS THREAD SAFE. | |
vtkCellData * | GetCellData () |
Return a pointer to this dataset's cell data. | |
vtkPointData * | GetPointData () |
Return a pointer to this dataset's point data. | |
virtual void | Squeeze () |
Reclaim any extra memory used to store data. | |
virtual void | ComputeBounds () |
Compute the data bounding box from data points. | |
double * | GetBounds () |
Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). | |
void | GetBounds (double bounds[6]) |
Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). | |
double * | GetCenter () |
Get the center of the bounding box. | |
void | GetCenter (double center[3]) |
Get the center of the bounding box. | |
double | GetLength () |
Return the length of the diagonal of the bounding box. | |
void | Initialize () override |
Restore data object to initial state. | |
virtual void | GetScalarRange (double range[2]) |
Convenience method to get the range of the first component (and only the first component) of any scalars in the data set. | |
double * | GetScalarRange () |
Convenience method to get the range of the first component (and only the first component) of any scalars in the data set. | |
virtual int | GetMaxCellSize ()=0 |
Convenience method returns largest cell size in dataset. | |
unsigned long | GetActualMemorySize () override |
Return the actual size of the data in kibibytes (1024 bytes). | |
int | GetDataObjectType () override |
Return the type of data object. | |
int | CheckAttributes () |
This method checks to see if the cell and point attributes match the geometry. | |
vtkFieldData * | GetAttributesAsFieldData (int type) override |
Returns the attributes of the data object as a vtkFieldData. | |
vtkIdType | GetNumberOfElements (int type) override |
Get the number of elements for a specific attribute type (POINT, CELL, etc.). | |
bool | HasAnyGhostCells () |
Returns 1 if there are any ghost cells 0 otherwise. | |
bool | HasAnyGhostPoints () |
Returns 1 if there are any ghost points 0 otherwise. | |
virtual bool | HasAnyBlankCells () |
Returns 1 if there are any blanking cells 0 otherwise. | |
virtual bool | HasAnyBlankPoints () |
Returns 1 if there are any blanking points 0 otherwise. | |
vtkUnsignedCharArray * | GetPointGhostArray () |
Gets the array that defines the ghost type of each point. | |
void | UpdatePointGhostArrayCache () |
Updates the pointer to the point ghost array. | |
vtkUnsignedCharArray * | AllocatePointGhostArray () |
Allocate ghost array for points. | |
vtkUnsignedCharArray * | GetCellGhostArray () |
Get the array that defines the ghost type of each cell. | |
void | UpdateCellGhostArrayCache () |
Updates the pointer to the cell ghost array. | |
vtkUnsignedCharArray * | AllocateCellGhostArray () |
Allocate ghost array for cells. | |
vtkIdType | FindPoint (double x, double y, double z) |
Locate the closest point to the global coordinate x. | |
virtual void | GenerateGhostArray (int zeroExt[6]) |
Normally called by pipeline executives or algorithms only. | |
virtual void | GenerateGhostArray (int zeroExt[6], bool cellOnly) |
Normally called by pipeline executives or algorithms only. | |
Public Member Functions inherited from vtkDataObject | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
vtkDataObject * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
vtkMTimeType | GetMTime () override |
Data objects are composite objects and need to check each part for MTime. | |
virtual void | Initialize () |
Restore data object to initial state,. | |
void | ReleaseData () |
Release data back to system to conserve memory resource. | |
virtual int | GetDataObjectType () |
Return class name of data type. | |
vtkMTimeType | GetUpdateTime () |
Used by Threaded ports to determine if they should initiate an asynchronous update (still in development). | |
virtual unsigned long | GetActualMemorySize () |
Return the actual size of the data in kibibytes (1024 bytes). | |
virtual void | CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info)) |
Copy from the pipeline information to the data object's own information. | |
virtual void | CopyInformationToPipeline (vtkInformation *vtkNotUsed(info)) |
Copy information from this data object to the pipeline information. | |
void | DataHasBeenGenerated () |
This method is called by the source when it executes to generate data. | |
virtual void | PrepareForNewData () |
make the output data ready for new data to be inserted. | |
virtual int | GetExtentType () |
The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstructuredGrid. | |
virtual void | Crop (const int *updateExtent) |
This method crops the data object (if necessary) so that the extent matches the update extent. | |
virtual vtkDataSetAttributes * | GetAttributes (int type) |
Returns the attributes of the data object of the specified attribute type. | |
virtual vtkDataArray * | GetGhostArray (int type) |
Returns the ghost arrays of the data object of the specified atribute type. | |
virtual vtkFieldData * | GetAttributesAsFieldData (int type) |
Returns the attributes of the data object as a vtkFieldData. | |
virtual int | GetAttributeTypeForArray (vtkAbstractArray *arr) |
Retrieves the attribute type that an array came from. | |
virtual vtkIdType | GetNumberOfElements (int type) |
Get the number of elements for a specific attribute type (POINT, CELL, etc.). | |
virtual vtkInformation * | GetInformation () |
Set/Get the information object associated with this data object. | |
virtual void | SetInformation (vtkInformation *) |
Set/Get the information object associated with this data object. | |
virtual int | GetDataReleased () |
Get the flag indicating the data has been released. | |
virtual void | SetFieldData (vtkFieldData *) |
Assign or retrieve a general field data to this data object. | |
virtual vtkFieldData * | GetFieldData () |
Assign or retrieve a general field data to this data object. | |
void | GlobalReleaseDataFlagOn () |
Turn on/off flag to control whether every object releases its data after being used by a filter. | |
void | GlobalReleaseDataFlagOff () |
Turn on/off flag to control whether every object releases its data after being used by a filter. | |
Public Member Functions inherited from vtkObject | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. | |
virtual void | DebugOff () |
Turn debugging output off. | |
bool | GetDebug () |
Get the value of the debug flag. | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. | |
virtual void | Modified () |
Update the modification time for this object. | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
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) |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
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. | |
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. | |
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. | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
int | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
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). | |
virtual void | Delete () |
Delete a VTK object. | |
virtual void | FastDelete () |
Delete a reference to this object. | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. | |
virtual void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). | |
int | GetReferenceCount () |
Return the current reference count of this object. | |
void | SetReferenceCount (int) |
Sets the reference count. | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
Protected Types | |
typedef vtkMappedUnstructuredGrid< Implementation, CellIterator > | ThisType |
Protected Member Functions | |
vtkMappedUnstructuredGrid () | |
~vtkMappedUnstructuredGrid () override | |
vtkIdType | InternalInsertNextCell (int type, vtkIdType npts, const vtkIdType ptIds[]) override |
vtkIdType | InternalInsertNextCell (int type, vtkIdList *ptIds) override |
vtkIdType | InternalInsertNextCell (int type, vtkIdType npts, const vtkIdType ptIds[], vtkIdType nfaces, const vtkIdType faces[]) override |
void | InternalReplaceCell (vtkIdType cellId, int npts, const vtkIdType pts[]) override |
Protected Member Functions inherited from vtkUnstructuredGridBase | |
vtkUnstructuredGridBase () | |
~vtkUnstructuredGridBase () override | |
virtual vtkIdType | InternalInsertNextCell (int type, vtkIdList *ptIds)=0 |
virtual vtkIdType | InternalInsertNextCell (int type, vtkIdType npts, const vtkIdType ptIds[])=0 |
virtual vtkIdType | InternalInsertNextCell (int type, vtkIdType npts, const vtkIdType ptIds[], vtkIdType nfaces, const vtkIdType faces[])=0 |
virtual void | InternalReplaceCell (vtkIdType cellId, int npts, const vtkIdType pts[])=0 |
Protected Member Functions inherited from vtkPointSet | |
vtkPointSet () | |
~vtkPointSet () override | |
void | ReportReferences (vtkGarbageCollector *) override |
virtual vtkObjectBase * | NewInstanceInternal () const |
Standard methdos for type information and printing. | |
Protected Member Functions inherited from vtkDataSet | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkDataSet () | |
~vtkDataSet () override | |
virtual void | ComputeScalarRange () |
Compute the range of the scalars and cache it into ScalarRange only if the cache became invalid (ScalarRangeComputeTime). | |
bool | IsAnyBitSet (vtkUnsignedCharArray *a, int bitFlag) |
Helper function that tests if any of the values in 'a' have bitFlag set. | |
Protected Member Functions inherited from vtkDataObject | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkDataObject () | |
~vtkDataObject () 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. | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. | |
Protected Member Functions inherited from vtkObjectBase | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
vtkSmartPointer< ImplementationType > | Impl |
Protected Attributes inherited from vtkPointSet | |
bool | Editable |
vtkPoints * | Points |
vtkAbstractPointLocator * | PointLocator |
vtkAbstractCellLocator * | CellLocator |
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 |
These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name)) | |
vtkUnsignedCharArray * | CellGhostArray |
These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name)) | |
bool | PointGhostArrayCached |
These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name)) | |
bool | CellGhostArrayCached |
These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name)) | |
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 | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Additional Inherited Members | |
Static Public Member Functions inherited from vtkUnstructuredGridBase | |
static vtkUnstructuredGridBase * | GetData (vtkInformation *info) |
Retrieve an instance of this class from an information object. | |
static vtkUnstructuredGridBase * | GetData (vtkInformationVector *v, int i=0) |
Retrieve an instance of this class from an information object. | |
Static Public Member Functions inherited from vtkPointSet | |
static vtkPointSet * | New () |
Standard instantiation method. | |
static vtkPointSet * | ExtendedNew () |
static vtkPointSet * | GetData (vtkInformation *info) |
Retrieve an instance of this class from an information object. | |
static vtkPointSet * | GetData (vtkInformationVector *v, int i=0) |
Retrieve an instance of this class from an information object. | |
static vtkTypeBool | IsTypeOf (const char *type) |
Standard methdos for type information and printing. | |
static vtkPointSet * | SafeDownCast (vtkObjectBase *o) |
Standard methdos for type information and printing. | |
Static Public Member Functions inherited from vtkDataSet | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkDataSet * | SafeDownCast (vtkObjectBase *o) |
static vtkDataSet * | GetData (vtkInformation *info) |
Retrieve an instance of this class from an information object. | |
static vtkDataSet * | GetData (vtkInformationVector *v, int i=0) |
Retrieve an instance of this class from an information object. | |
Static Public Member Functions inherited from vtkDataObject | |
static vtkDataObject * | New () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkDataObject * | SafeDownCast (vtkObjectBase *o) |
static vtkInformation * | GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType) |
Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and attribute (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) | |
static vtkInformation * | GetNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name) |
Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and name. | |
static void | RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name) |
Remove the info associated with an array. | |
static vtkInformation * | SetActiveAttribute (vtkInformation *info, int fieldAssociation, const char *attributeName, int attributeType) |
Set the named array to be the active field for the specified type (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) and association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS). | |
static void | SetActiveAttributeInfo (vtkInformation *info, int fieldAssociation, int attributeType, const char *name, int arrayType, int numComponents, int numTuples) |
Set the name, array type, number of components, and number of tuples within the passed information object for the active attribute of type attributeType (in specified association, FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS). | |
static void | SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents) |
Convenience version of previous method for use (primarily) by the Imaging filters. | |
static const char * | GetAssociationTypeAsString (int associationType) |
Given an integer association type, this static method returns a string type for the attribute (i.e. | |
static int | GetAssociationTypeFromString (const char *associationName) |
Given a string association name, this static method returns an integer association type for the attribute (i.e. | |
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 * | DIRECTION () |
static vtkInformationDoubleVectorKey * | BOUNDING_BOX () |
static vtkInformationDataObjectKey * | SIL () |
static vtkDataObject * | GetData (vtkInformation *info) |
Retrieve an instance of this class from an information object. | |
static vtkDataObject * | GetData (vtkInformationVector *v, int i=0) |
Retrieve an instance of this class from an information object. | |
static void | SetGlobalReleaseDataFlag (int val) |
Turn on/off flag to control whether every object releases its data after being used by a filter. | |
static int | GetGlobalReleaseDataFlag () |
Turn on/off flag to control whether every object releases its data after being used by a filter. | |
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. | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. | |
static void | SetGlobalWarningDisplay (int val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOn () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static int | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
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. | |
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). | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. | |
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. | |
Static Protected Member Functions inherited from vtkObjectBase | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
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 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 a suitable vtkArrayDispatch instead.
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:
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 unnecessary 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:
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:
To instantiate a vtkMappedUnstructuredGrid subclass created by the above macro, the follow pattern is encouraged:
The vtkCPExodusIIElementBlock class provides an example of vtkMappedUnstructuredGrid usage, adapting the Exodus II data structures for the VTK pipeline.
Definition at line 150 of file vtkMappedUnstructuredGrid.h.
typedef Implementation vtkMappedUnstructuredGrid< Implementation, CellIterator >::ImplementationType |
Definition at line 156 of file vtkMappedUnstructuredGrid.h.
typedef CellIterator vtkMappedUnstructuredGrid< Implementation, CellIterator >::CellIteratorType |
Definition at line 157 of file vtkMappedUnstructuredGrid.h.
|
protected |
Definition at line 185 of file vtkMappedUnstructuredGrid.h.
|
protected |
|
overrideprotected |
vtkMappedUnstructuredGrid< Implementation, CellIterator >::vtkTemplateTypeMacro | ( | SelfType | , |
vtkUnstructuredGridBase | |||
) |
|
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 vtkDataSet.
|
overridevirtual |
Copy the geometric and topological structure of an object.
Note that the invoking object and the object pointed to by the parameter ds must be of the same type. THIS METHOD IS NOT THREAD SAFE.
Implements vtkDataSet.
|
overridevirtual |
Shallow and Deep copy.
Reimplemented from vtkDataSet.
|
overridevirtual |
Determine the number of cells composing the dataset.
THIS METHOD IS THREAD SAFE
Implements vtkDataSet.
|
overridevirtual |
Get cell with cellId such that: 0 <= cellId < NumberOfCells.
The returned vtkCell is an object owned by this instance, hence the return value must not be deleted by the caller.
Implements vtkDataSet.
|
overridevirtual |
Get cell with cellId such that: 0 <= cellId < NumberOfCells.
This is a thread-safe alternative to the previous GetCell() method. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED
Implements vtkDataSet.
|
overridevirtual |
Get type of cell with cellId such that: 0 <= cellId < NumberOfCells.
THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED
Implements vtkDataSet.
|
overridevirtual |
Topological inquiry to get points defining cell.
THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED
Implements vtkDataSet.
|
overridevirtual |
Return an iterator that traverses the cells in this data set.
Reimplemented from vtkDataSet.
|
overridevirtual |
Topological inquiry to get cells using point.
THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED
Implements vtkDataSet.
|
overridevirtual |
Convenience method returns largest cell size in dataset.
This is generally used to allocate memory for supporting data structures. THIS METHOD IS THREAD SAFE
Implements vtkDataSet.
|
overridevirtual |
Fill vtkIdTypeArray container with list of cell Ids.
This method traverses all cells and, for a particular cell type, inserts the cell Id into the container.
Implements vtkUnstructuredGridBase.
|
overridevirtual |
Traverse cells and determine if cells are all of the same type.
Implements vtkUnstructuredGridBase.
|
overridevirtual |
Allocate memory for the number of cells indicated.
extSize is not used.
Implements vtkUnstructuredGridBase.
|
overridevirtual |
Datasets are composite objects and need to check each part for MTime THIS METHOD IS THREAD SAFE.
Reimplemented from vtkDataSet.
void vtkMappedUnstructuredGrid< Implementation, CellIterator >::SetImplementation | ( | ImplementationType * | impl | ) |
ImplementationType * vtkMappedUnstructuredGrid< Implementation, CellIterator >::GetImplementation | ( | ) |
|
overrideprotectedvirtual |
Implements vtkUnstructuredGridBase.
|
overrideprotectedvirtual |
Implements vtkUnstructuredGridBase.
|
overrideprotectedvirtual |
Implements vtkUnstructuredGridBase.
|
overrideprotectedvirtual |
Implements vtkUnstructuredGridBase.
|
virtual |
Get cell with cellId such that: 0 <= cellId < NumberOfCells.
The returned vtkCell is an object owned by this instance, hence the return value must not be deleted by the caller.
Reimplemented from vtkPointSet.
|
inlinevirtual |
Reimplemented from vtkDataSet.
Definition at line 231 of file vtkDataSet.h.
|
virtual |
Get cell with cellId such that: 0 <= cellId < NumberOfCells.
This is a thread-safe alternative to the previous GetCell() method. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED
Reimplemented from vtkPointSet.
|
protected |
Definition at line 187 of file vtkMappedUnstructuredGrid.h.