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

#include <vtkmDataSet.h>

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

Public Types

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
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
}
 Possible values for the FIELD_ASSOCIATION information entry. More...
 
enum  AttributeTypes {
  POINT , CELL , FIELD , POINT_THEN_CELL ,
  VERTEX , EDGE , ROW , NUMBER_OF_ATTRIBUTE_TYPES
}
 Possible attribute types. More...
 
enum  FieldOperations { FIELD_OPERATION_PRESERVED , FIELD_OPERATION_REINTERPOLATED , FIELD_OPERATION_MODIFIED , FIELD_OPERATION_REMOVED }
 Possible values for the FIELD_OPERATION information entry. More...
 
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.
 
vtkmDataSetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void SetVtkmDataSet (const vtkm::cont::DataSet &ds)
 
vtkm::cont::DataSet GetVtkmDataSet () const
 
void CopyStructure (vtkDataSet *ds) override
 Copy the geometric and topological structure of an object.
 
vtkIdType GetNumberOfPoints () override
 Determine the number of points composing the dataset.
 
vtkIdType GetNumberOfCells () override
 Determine the number of cells composing the dataset.
 
double * GetPoint (vtkIdType ptId) override
 Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints.
 
void GetPoint (vtkIdType id, double x[3]) override
 Copy point coordinates into user provided array x[3] for specified point id.
 
vtkCellGetCell (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.
 
void GetCellBounds (vtkIdType cellId, double bounds[6]) override
 Get the bounds of the 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.
 
void GetPointCells (vtkIdType ptId, vtkIdList *cellIds) override
 Topological inquiry to get cells using point.
 
vtkIdType FindCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
 Locate cell based on global coordinate x and tolerance squared.
 
vtkIdType FindCell (double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights) override
 This is a version of the above method that can be used with multithreaded applications.
 
void Squeeze () override
 Reclaim any extra memory used to store data.
 
void ComputeBounds () override
 Compute the data bounding box from data points.
 
void Initialize () override
 Restore data object to initial state.
 
int GetMaxCellSize () override
 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.
 
virtual vtkCellGetCell (vtkIdType cellId)=0
 Get cell with cellId such that: 0 <= cellId < NumberOfCells.
 
virtual vtkCellGetCell (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.
 
vtkIdType FindPoint (double x[3]) override
 Locate the closest point to the global coordinate x.
 
void ShallowCopy (vtkDataObject *src) override
 Shallow and Deep copy.
 
void DeepCopy (vtkDataObject *src) override
 Shallow and Deep copy.
 
- 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.
 
vtkDataSetNewInstance () 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 vtkCellIteratorNewCellIterator ()
 Return an iterator that traverses the cells in this data set.
 
virtual vtkCellGetCell (vtkIdType cellId)=0
 Get cell with cellId such that: 0 <= cellId < NumberOfCells.
 
virtual vtkCellGetCell (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 vtkCellFindAndGetCell (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.
 
vtkCellDataGetCellData ()
 Return a pointer to this dataset's cell data.
 
vtkPointDataGetPointData ()
 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.
 
vtkFieldDataGetAttributesAsFieldData (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.
 
vtkUnsignedCharArrayGetPointGhostArray ()
 Gets the array that defines the ghost type of each point.
 
void UpdatePointGhostArrayCache ()
 Updates the pointer to the point ghost array.
 
vtkUnsignedCharArrayAllocatePointGhostArray ()
 Allocate ghost array for points.
 
vtkUnsignedCharArrayGetCellGhostArray ()
 Get the array that defines the ghost type of each cell.
 
void UpdateCellGhostArrayCache ()
 Updates the pointer to the cell ghost array.
 
vtkUnsignedCharArrayAllocateCellGhostArray ()
 Allocate ghost array for cells.
 
vtkIdType FindPoint (double x, double y, double z)
 Locate the closest point to the global coordinate x.
 
void ShallowCopy (vtkDataObject *src) override
 Shallow and Deep copy.
 
void DeepCopy (vtkDataObject *src) override
 Shallow and Deep copy.
 
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.
 
vtkDataObjectNewInstance () 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 vtkDataSetAttributesGetAttributes (int type)
 Returns the attributes of the data object of the specified attribute type.
 
virtual vtkDataArrayGetGhostArray (int type)
 Returns the ghost arrays of the data object of the specified atribute type.
 
virtual vtkFieldDataGetAttributesAsFieldData (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 vtkInformationGetInformation ()
 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 vtkFieldDataGetFieldData ()
 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.
 
vtkCommandGetCommand (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.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkmDataSetSafeDownCast (vtkObjectBase *o)
 
static vtkmDataSetNew ()
 
- Static Public Member Functions inherited from vtkDataSet
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataSetSafeDownCast (vtkObjectBase *o)
 
static vtkDataSetGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object.
 
static vtkDataSetGetData (vtkInformationVector *v, int i=0)
 Retrieve an instance of this class from an information object.
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObjectNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataObjectSafeDownCast (vtkObjectBase *o)
 
static vtkInformationGetActiveFieldInformation (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 vtkInformationGetNamedFieldInformation (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 vtkInformationSetActiveAttribute (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 vtkInformationStringKeyDATA_TYPE_NAME ()
 
static vtkInformationDataObjectKeyDATA_OBJECT ()
 
static vtkInformationIntegerKeyDATA_EXTENT_TYPE ()
 
static vtkInformationIntegerPointerKeyDATA_EXTENT ()
 
static vtkInformationIntegerVectorKeyALL_PIECES_EXTENT ()
 
static vtkInformationIntegerKeyDATA_PIECE_NUMBER ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_GHOST_LEVELS ()
 
static vtkInformationDoubleKeyDATA_TIME_STEP ()
 
static vtkInformationInformationVectorKeyPOINT_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyCELL_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyVERTEX_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyEDGE_DATA_VECTOR ()
 
static vtkInformationIntegerKeyFIELD_ARRAY_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ASSOCIATION ()
 
static vtkInformationIntegerKeyFIELD_ATTRIBUTE_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ACTIVE_ATTRIBUTE ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_COMPONENTS ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_TUPLES ()
 
static vtkInformationIntegerKeyFIELD_OPERATION ()
 
static vtkInformationDoubleVectorKeyFIELD_RANGE ()
 
static vtkInformationIntegerVectorKeyPIECE_EXTENT ()
 
static vtkInformationStringKeyFIELD_NAME ()
 
static vtkInformationDoubleVectorKeyORIGIN ()
 
static vtkInformationDoubleVectorKeySPACING ()
 
static vtkInformationDoubleVectorKeyDIRECTION ()
 
static vtkInformationDoubleVectorKeyBOUNDING_BOX ()
 
static vtkInformationDataObjectKeySIL ()
 
static vtkDataObjectGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object.
 
static vtkDataObjectGetData (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 vtkObjectNew ()
 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 vtkObjectBaseNew ()
 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.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkmDataSet ()
 
 ~vtkmDataSet () override
 
- Protected Member Functions inherited from vtkDataSet
virtual vtkObjectBaseNewInstanceInternal () 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 vtkObjectBaseNewInstanceInternal () 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 &)
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Protected Attributes inherited from vtkDataSet
vtkCellDataCellData
 
vtkPointDataPointData
 
vtkCallbackCommandDataObserver
 
vtkTimeStamp ComputeTime
 
double Bounds [6]
 
double Center [3]
 
double ScalarRange [2]
 
vtkTimeStamp ScalarRangeComputeTime
 
vtkUnsignedCharArrayPointGhostArray
 These arrays pointers are caches used to avoid a string comparison (when getting ghost arrays using GetArray(name))
 
vtkUnsignedCharArrayCellGhostArray
 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
vtkFieldDataFieldData
 
int DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformationInformation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Definition at line 42 of file vtkmDataSet.h.

Member Typedef Documentation

◆ Superclass

Definition at line 45 of file vtkmDataSet.h.

Constructor & Destructor Documentation

◆ vtkmDataSet()

vtkmDataSet::vtkmDataSet ( )
protected

◆ ~vtkmDataSet()

vtkmDataSet::~vtkmDataSet ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkmDataSet::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 vtkDataSet.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkmDataSet::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDataSet.

◆ NewInstance()

vtkmDataSet * vtkmDataSet::NewInstance ( ) const

◆ PrintSelf()

void vtkmDataSet::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 vtkObjectBase.

◆ New()

static vtkmDataSet * vtkmDataSet::New ( )
static

◆ SetVtkmDataSet()

void vtkmDataSet::SetVtkmDataSet ( const vtkm::cont::DataSet &  ds)

◆ GetVtkmDataSet()

vtkm::cont::DataSet vtkmDataSet::GetVtkmDataSet ( ) const

◆ CopyStructure()

void vtkmDataSet::CopyStructure ( vtkDataSet ds)
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.

Implements vtkDataSet.

◆ GetNumberOfPoints()

vtkIdType vtkmDataSet::GetNumberOfPoints ( )
overridevirtual

Determine the number of points composing the dataset.

Implements vtkDataSet.

◆ GetNumberOfCells()

vtkIdType vtkmDataSet::GetNumberOfCells ( )
overridevirtual

Determine the number of cells composing the dataset.

Implements vtkDataSet.

◆ GetPoint() [1/2]

double * vtkmDataSet::GetPoint ( vtkIdType  ptId)
overridevirtual

Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints.

Implements vtkDataSet.

◆ GetPoint() [2/2]

void vtkmDataSet::GetPoint ( vtkIdType  id,
double  x[3] 
)
overridevirtual

Copy point coordinates into user provided array x[3] for specified point id.

Reimplemented from vtkDataSet.

◆ GetCell() [1/5]

vtkCell * vtkmDataSet::GetCell ( vtkIdType  cellId)
overridevirtual

Get cell with cellId such that: 0 <= cellId < NumberOfCells.

Implements vtkDataSet.

◆ GetCell() [2/5]

void vtkmDataSet::GetCell ( vtkIdType  cellId,
vtkGenericCell cell 
)
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.

◆ GetCellBounds()

void vtkmDataSet::GetCellBounds ( vtkIdType  cellId,
double  bounds[6] 
)
overridevirtual

Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells.

Reimplemented from vtkDataSet.

◆ GetCellType()

int vtkmDataSet::GetCellType ( vtkIdType  cellId)
overridevirtual

Get type of cell with cellId such that: 0 <= cellId < NumberOfCells.

Implements vtkDataSet.

◆ GetCellPoints()

void vtkmDataSet::GetCellPoints ( vtkIdType  cellId,
vtkIdList ptIds 
)
overridevirtual

Topological inquiry to get points defining cell.

Implements vtkDataSet.

◆ GetPointCells()

void vtkmDataSet::GetPointCells ( vtkIdType  ptId,
vtkIdList cellIds 
)
overridevirtual

Topological inquiry to get cells using point.

Implements vtkDataSet.

◆ FindPoint()

vtkIdType vtkmDataSet::FindPoint ( double  x[3])
overridevirtual

Locate the closest point to the global coordinate x.

Return the point id. If point id < 0; then no point found. (This may arise when point is outside of dataset.)

Implements vtkDataSet.

◆ FindCell() [1/2]

vtkIdType vtkmDataSet::FindCell ( double  x[3],
vtkCell cell,
vtkIdType  cellId,
double  tol2,
int &  subId,
double  pcoords[3],
double *  weights 
)
overridevirtual

Locate cell based on global coordinate x and tolerance squared.

If cell and cellId is non-nullptr, then search starts from this cell and looks at immediate neighbors. Returns cellId >= 0 if inside, < 0 otherwise. The parametric coordinates are provided in pcoords[3]. The interpolation weights are returned in weights[]. (The number of weights is equal to the number of points in the found cell). Tolerance is used to control how close the point is to be considered "in" the cell.

Implements vtkDataSet.

◆ FindCell() [2/2]

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

This is a version of the above method that can be used with multithreaded applications.

A vtkGenericCell must be passed in to be used in internal calls that might be made to GetCell()

Implements vtkDataSet.

◆ Squeeze()

void vtkmDataSet::Squeeze ( )
overridevirtual

Reclaim any extra memory used to store data.

Reimplemented from vtkDataSet.

◆ ComputeBounds()

void vtkmDataSet::ComputeBounds ( )
overridevirtual

Compute the data bounding box from data points.

Reimplemented from vtkDataSet.

◆ Initialize()

void vtkmDataSet::Initialize ( )
overridevirtual

Restore data object to initial state.

THIS METHOD IS NOT THREAD SAFE.

Reimplemented from vtkDataObject.

◆ GetMaxCellSize()

int vtkmDataSet::GetMaxCellSize ( )
overridevirtual

Convenience method returns largest cell size in dataset.

This is generally used to allocate memory for supporting data structures.

Implements vtkDataSet.

◆ GetActualMemorySize()

unsigned long vtkmDataSet::GetActualMemorySize ( )
overridevirtual

Return the actual size of the data in kibibytes (1024 bytes).

This number is valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than or equal to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the return value).

Reimplemented from vtkDataObject.

◆ GetDataObjectType()

int vtkmDataSet::GetDataObjectType ( )
inlineoverridevirtual

Return the type of data object.

Reimplemented from vtkDataObject.

Definition at line 173 of file vtkmDataSet.h.

◆ ShallowCopy()

void vtkmDataSet::ShallowCopy ( vtkDataObject src)
overridevirtual

Shallow and Deep copy.

Reimplemented from vtkDataObject.

◆ DeepCopy()

void vtkmDataSet::DeepCopy ( vtkDataObject src)
overridevirtual

Shallow and Deep copy.

Reimplemented from vtkDataObject.

◆ GetCell() [3/5]

virtual vtkCell * vtkDataSet::GetCell ( vtkIdType  cellId)
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.

Warning
Repeat calls to this function for different face ids will change the data stored in the internal member object whose pointer is returned by this function.
THIS METHOD IS NOT THREAD SAFE. For a thread-safe version, please use void GetCell(vtkIdType cellId, vtkGenericCell* cell).

Implements vtkDataSet.

◆ GetCell() [4/5]

virtual vtkCell * vtkDataSet::GetCell ( int   vtkNotUsedi,
int   vtkNotUsedj,
int   vtkNotUsed
)
inlinevirtual

Reimplemented from vtkDataSet.

Definition at line 231 of file vtkDataSet.h.

◆ GetCell() [5/5]

virtual void vtkDataSet::GetCell ( vtkIdType  cellId,
vtkGenericCell cell 
)
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

Implements vtkDataSet.


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