ActiViz .NET  5.8.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Private Member Functions
Kitware.VTK.vtkDataSet Class Reference

vtkDataSet - abstract class to specify dataset behavior More...

Inheritance diagram for Kitware.VTK.vtkDataSet:
[legend]
Collaboration diagram for Kitware.VTK.vtkDataSet:
[legend]

List of all members.

Public Types

enum  FieldDataType { CELL_DATA_FIELD = 2, DATA_OBJECT_FIELD = 0, POINT_DATA_FIELD = 1 }
 Shallow and Deep copy. More...
- Public Types inherited from Kitware.VTK.vtkDataObject
enum  AttributeTypes {
  CELL = 1, EDGE = 5, FIELD = 2, NUMBER_OF_ATTRIBUTE_TYPES = 7,
  POINT = 0, POINT_THEN_CELL = 3, ROW = 6, VERTEX = 4
}
 This method crops the data object (if necesary) so that the extent matches the update extent. More...
enum  FieldAssociations {
  FIELD_ASSOCIATION_CELLS = 1, FIELD_ASSOCIATION_EDGES = 5, FIELD_ASSOCIATION_NONE = 2, FIELD_ASSOCIATION_POINTS = 0,
  FIELD_ASSOCIATION_POINTS_THEN_CELLS = 3, FIELD_ASSOCIATION_ROWS = 6, FIELD_ASSOCIATION_VERTICES = 4, NUMBER_OF_ASSOCIATIONS = 7
}
 This method crops the data object (if necesary) so that the extent matches the update extent. More...
enum  FieldOperations { FIELD_OPERATION_MODIFIED = 2, FIELD_OPERATION_PRESERVED = 0, FIELD_OPERATION_REINTERPOLATED = 1, FIELD_OPERATION_REMOVED = 3 }
 Get the number of elements for a specific attribute type (POINT, CELL, etc.). More...

Public Member Functions

 vtkDataSet (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
int CheckAttributes ()
 This method checks to see if the cell and point attributes match the geometry. Many filters will crash if the number of tupples in an array is less than the number of points/cells. This method returns 1 if there is a mismatch, and 0 if everything is ok. It prints an error if an array is too short, and a warning if an array is too long.
virtual void ComputeBounds ()
 Compute the data bounding box from data points. THIS METHOD IS NOT THREAD SAFE.
virtual void CopyAttributes (vtkDataSet ds)
 Copy the attributes associated with the specified dataset to this instance of vtkDataSet. THIS METHOD IS NOT THREAD SAFE.
virtual void CopyStructure (vtkDataSet ds)
 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.
override void DeepCopy (vtkDataObject src)
 Shallow and Deep copy.
virtual vtkCell FindAndGetCell (IntPtr x, vtkCell cell, int cellId, double tol2, ref int subId, IntPtr pcoords, IntPtr weights)
 Locate the cell that contains a point and return the cell. Also returns the subcell id, parametric coordinates and weights for subsequent interpolation. This method combines the derived class methods int FindCell and vtkCell *GetCell. Derived classes may provide a more efficient implementation. See for example vtkStructuredPoints. THIS METHOD IS NOT THREAD SAFE.
virtual int FindCell (IntPtr x, vtkCell cell, int cellId, double tol2, ref int subId, IntPtr pcoords, IntPtr weights)
 Locate cell based on global coordinate x and tolerance squared. If cell and cellId is non-NULL, 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. THIS METHOD IS NOT THREAD SAFE.
virtual int FindCell (IntPtr x, vtkCell cell, vtkGenericCell gencell, int cellId, double tol2, ref int subId, IntPtr pcoords, IntPtr weights)
 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() THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED.
int FindPoint (double x, double y, double z)
 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.) THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED.
virtual int FindPoint (IntPtr x)
 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.) THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED.
virtual void GenerateGhostLevelArray ()
 Normally called by pipeline executives or algoritgms only. This method computes the ghost arrays for a given dataset.
override uint GetActualMemorySize ()
 Return the actual size of the data in kilobytes. 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). THIS METHOD IS THREAD SAFE.
override vtkFieldData GetAttributesAsFieldData (int type)
 Returns the attributes of the data object as a vtkFieldData. This returns non-null values in all the same cases as GetAttributes, in addition to the case of FIELD, which will return the field data for any vtkDataObject subclass.
double[] GetBounds ()
 Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). THIS METHOD IS NOT THREAD SAFE.
void GetBounds (IntPtr bounds)
 Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED.
virtual vtkCell GetCell (int cellId)
 Get cell with cellId such that: 0 <= cellId < NumberOfCells. THIS METHOD IS NOT THREAD SAFE.
virtual void GetCell (int cellId, vtkGenericCell cell)
 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.
virtual void GetCellBounds (int cellId, IntPtr bounds)
 Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells. A subclass may be able to determine the bounds of cell without using an expensive GetCell() method. A default implementation is provided that actually uses a GetCell() call. This is to ensure the method is available to all datasets. Subclasses should override this method to provide an efficient implementation. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED.
vtkCellData GetCellData ()
 Return a pointer to this dataset's cell data. THIS METHOD IS THREAD SAFE.
virtual void GetCellNeighbors (int cellId, vtkIdList ptIds, vtkIdList cellIds)
 Topological inquiry to get all cells using list of points exclusive of cell specified (e.g., cellId). Note that the list consists of only cells that use ALL the points provided. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED.
virtual void GetCellPoints (int cellId, vtkIdList ptIds)
 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.
virtual int GetCellType (int cellId)
 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.
virtual void GetCellTypes (vtkCellTypes types)
 Get a list of types of cells in a dataset. The list consists of an array of types (not necessarily in any order), with a single entry per type. For example a dataset 5 triangles, 3 lines, and 100 hexahedra would result a list of three entries, corresponding to the types VTK_TRIANGLE, VTK_LINE, and VTK_HEXAHEDRON. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED.
double[] GetCenter ()
 Get the center of the bounding box. THIS METHOD IS NOT THREAD SAFE.
void GetCenter (IntPtr center)
 Get the center of the bounding box. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED.
override int GetDataObjectType ()
 Return the type of data object.
double GetLength ()
 Return the length of the diagonal of the bounding box. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED.
override uint GetMTime ()
 Datasets are composite objects and need to check each part for MTime THIS METHOD IS THREAD SAFE.
virtual int GetMaxCellSize ()
 Convenience method returns largest cell size in dataset. This is generally used to allocate memory for supporting data structures. THIS METHOD IS THREAD SAFE.
virtual int GetNumberOfCells ()
 Determine the number of cells composing the dataset. THIS METHOD IS THREAD SAFE.
override int GetNumberOfElements (int type)
 Get the number of elements for a specific attribute type (POINT, CELL, etc.).
virtual int GetNumberOfPoints ()
 Determine the number of points composing the dataset. THIS METHOD IS THREAD SAFE.
virtual double[] GetPoint (int ptId)
 Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints. THIS METHOD IS NOT THREAD SAFE.
virtual void GetPoint (int id, IntPtr x)
 Time at which scalar range is computed.
virtual void GetPointCells (int ptId, vtkIdList cellIds)
 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.
vtkPointData GetPointData ()
 Return a pointer to this dataset's point data. THIS METHOD IS THREAD SAFE.
virtual void GetScalarRange (IntPtr range)
 Convenience method to get the range of the scalar data (if there is any scalar data). Returns the (min/max) range of combined point and cell data. If there are no point or cell scalars the method will return (0,1). Note: Update needs to be called to create the scalars. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED.
double[] GetScalarRange ()
 Convenience method to get the range of the scalar data (if there is any scalar data). THIS METHOD IS NOT THREAD SAFE.
override void Initialize ()
 Restore data object to initial state, THIS METHOD IS NOT THREAD SAFE.
override int IsA (string type)
 *Undocumented Block
new vtkDataSet NewInstance ()
 *Undocumented Block
override void ShallowCopy (vtkDataObject src)
 Shallow and Deep copy.
virtual void Squeeze ()
 Reclaim any extra memory used to store data. THIS METHOD IS NOT THREAD SAFE.
- Public Member Functions inherited from Kitware.VTK.vtkDataObject
 vtkDataObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkDataObject ()
 *Undocumented Block
override void Register (vtkObjectBase o)
 Handle the source/data loop.
void CopyInformation (vtkDataObject data)
 Copy the generic information (WholeExtent ...)
virtual void CopyInformationFromPipeline (vtkInformation request)
 Copy information about this data object from the PipelineInformation to its own Information for the given request.
virtual void CopyInformationToPipeline (vtkInformation request, vtkInformation input, vtkInformation output, int forceCopy)
 Copy information about this data object to the output information from its own Information for the given request. If the second argument is not NULL then it is the pipeline information object for the input to this data object's producer. If forceCopy is true, information is copied even if it exists in the output.
void CopyInformationToPipeline (vtkInformation request, vtkInformation input)
 Calls CopyInformationToPipeline(request, input, this->PipelineInformation, 0). Subclasses should not override this method (not virtual)
virtual void CopyTypeSpecificInformation (vtkDataObject data)
 By default, there is no type specific information.
virtual void Crop ()
 This method crops the data object (if necesary) so that the extent matches the update extent.
void DataHasBeenGenerated ()
 This method is called by the source when it executes to generate data. It is sort of the opposite of ReleaseData. It sets the DataReleased flag to 0, and sets a new UpdateTime.
virtual int GetAttributeTypeForArray (vtkAbstractArray arr)
 Retrieves the attribute type that an array came from. This is useful for obtaining which attribute type a input array to an algorithm came from (retrieved from GetInputAbstractArrayToProcesss).
virtual vtkDataSetAttributes GetAttributes (int type)
 Returns the attributes of the data object of the specified attribute type. The type may be: <ul> <li>POINT - Defined in vtkDataSet subclasses. <li>CELL - Defined in vtkDataSet subclasses. <li>VERTEX - Defined in vtkGraph subclasses. <li>EDGE - Defined in vtkGraph subclasses. <li>ROW - Defined in vtkTable. </ul> The other attribute type, FIELD, will return NULL since field data is stored as a vtkFieldData instance, not a vtkDataSetAttributes instance. To retrieve field data, use GetAttributesAsFieldData.
virtual int GetDataReleased ()
 Get the flag indicating the data has been released.
virtual uint GetEstimatedMemorySize ()
 Get the estimated size of this data object itself. Should be called after UpdateInformation() and PropagateUpdateExtent() have both been called. Should be overridden in a subclass - otherwise the default is to assume that this data object requires no memory. The size is returned in kilobytes.
vtkExtentTranslator GetExtentTranslator ()
 An object that will translate pieces into structured extents.
virtual int GetExtentType ()
 The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstructuredGrid. The ExtentType will be changed to VTK_3D_EXTENT for data objects with 3D structure such as vtkImageData (and its subclass vtkStructuredPoints), vtkRectilinearGrid, and vtkStructuredGrid. The default is the have an extent in pieces, with only one piece (no streaming possible).
virtual vtkFieldData GetFieldData ()
 Assign or retrieve a general field data to this data object.
virtual vtkInformation GetInformation ()
 Set/Get the information object associated with this data object.
virtual int GetMaximumNumberOfPieces ()
 Set/Get the maximum number of pieces that can be requested. The maximum number of pieces is meta data for unstructured data sets. It gets set by the source during the update information call. A value of -1 indicates that there is no maximum.
virtual vtkInformation GetPipelineInformation ()
 Get/Set the pipeline information object that owns this data object.
uint GetPipelineMTime ()
 Get the cumulative modified time of everything upstream. Does not include the MTime of this object.
virtual vtkAlgorithmOutput GetProducerPort ()
 Get the port currently producing this object.
int GetReleaseDataFlag ()
 Turn on/off flag to control whether this object's data is released after being used by a filter.
virtual int GetRequestExactExtent ()
 This request flag indicates whether the requester can handle more data than requested. Right now it is used in vtkImageData. Image filters can return more data than requested. The the consumer cannot handle this (i.e. DataSetToDataSetFitler) the image will crop itself. This functionality used to be in ImageToStructuredPoints.
virtual vtkSource GetSource ()
 Set/Get the source object creating this data object.
virtual int[] GetUpdateExtent ()
 Set the update extent for data objects that use 3D extents. Using this method on data objects that set extents as pieces (such as vtkPolyData or vtkUnstructuredGrid) has no real effect. Don't use the set macro to set the update extent since we don't want this object to be modified just due to a change in update extent. When the volume of the extent is zero (0, -1,..), then no data is requested, and the source will not execute.
virtual void GetUpdateExtent (ref int x0, ref int x1, ref int y0, ref int y1, ref int z0, ref int z1)
 Set the update extent for data objects that use 3D extents. Using this method on data objects that set extents as pieces (such as vtkPolyData or vtkUnstructuredGrid) has no real effect. Don't use the set macro to set the update extent since we don't want this object to be modified just due to a change in update extent. When the volume of the extent is zero (0, -1,..), then no data is requested, and the source will not execute.
virtual void GetUpdateExtent (IntPtr extent)
 Set the update extent for data objects that use 3D extents. Using this method on data objects that set extents as pieces (such as vtkPolyData or vtkUnstructuredGrid) has no real effect. Don't use the set macro to set the update extent since we don't want this object to be modified just due to a change in update extent. When the volume of the extent is zero (0, -1,..), then no data is requested, and the source will not execute.
virtual int GetUpdateGhostLevel ()
 Set / Get the update ghost level and the update number of ghost levels. Similar to update extent in 3D.
virtual int GetUpdateNumberOfPieces ()
 Set / Get the update piece and the update number of pieces. Similar to update extent in 3D.
virtual int GetUpdatePiece ()
 Set / Get the update piece and the update number of pieces. Similar to update extent in 3D.
uint GetUpdateTime ()
 Used by Threaded ports to determine if they should initiate an asynchronous update (still in development).
virtual double[] GetWholeBoundingBox ()
 Set/Get the whole bounding box of this data object. The whole whole bounding box is meta data for data sets It gets set by the source during the update information call.
virtual void GetWholeBoundingBox (ref double x0, ref double x1, ref double y0, ref double y1, ref double z0, ref double z1)
 Set/Get the whole bounding box of this data object. The whole whole bounding box is meta data for data sets It gets set by the source during the update information call.
virtual void GetWholeBoundingBox (IntPtr extent)
 Set/Get the whole bounding box of this data object. The whole whole bounding box is meta data for data sets It gets set by the source during the update information call.
virtual int[] GetWholeExtent ()
 Set/Get the whole extent of this data object. The whole extent is meta data for structured data sets. It gets set by the source during the update information call.
virtual void GetWholeExtent (ref int x0, ref int x1, ref int y0, ref int y1, ref int z0, ref int z1)
 Set/Get the whole extent of this data object. The whole extent is meta data for structured data sets. It gets set by the source during the update information call.
virtual void GetWholeExtent (IntPtr extent)
 Set/Get the whole extent of this data object. The whole extent is meta data for structured data sets. It gets set by the source during the update information call.
void GlobalReleaseDataFlagOff ()
 Turn on/off flag to control whether every object releases its data after being used by a filter.
void GlobalReleaseDataFlagOn ()
 Turn on/off flag to control whether every object releases its data after being used by a filter.
virtual void PrepareForNewData ()
 make the output data ready for new data to be inserted. For most objects we just call Initialize. But for vtkImageData we leave the old data in case the memory can be reused.
virtual void PropagateUpdateExtent ()
 WARNING: INTERNAL METHOD - NOT FOR GENERAL USE. THIS METHOD IS PART OF THE PIPELINE UPDATE FUNCTIONALITY. The update extent for this object is propagated up the pipeline. This propagation may early terminate based on the PipelineMTime.
void ReleaseData ()
 Release data back to system to conserve memory resource. Used during visualization network execution. Releasing this data does not make down-stream data invalid, so it does not modify the MTime of this data object.
virtual void ReleaseDataFlagOff ()
 Turn on/off flag to control whether this object's data is released after being used by a filter.
virtual void ReleaseDataFlagOn ()
 Turn on/off flag to control whether this object's data is released after being used by a filter.
virtual void RequestExactExtentOff ()
 This request flag indicates whether the requester can handle more data than requested. Right now it is used in vtkImageData. Image filters can return more data than requested. The the consumer cannot handle this (i.e. DataSetToDataSetFitler) the image will crop itself. This functionality used to be in ImageToStructuredPoints.
virtual void RequestExactExtentOn ()
 This request flag indicates whether the requester can handle more data than requested. Right now it is used in vtkImageData. Image filters can return more data than requested. The the consumer cannot handle this (i.e. DataSetToDataSetFitler) the image will crop itself. This functionality used to be in ImageToStructuredPoints.
void SetExtentTranslator (vtkExtentTranslator translator)
 An object that will translate pieces into structured extents.
virtual void SetFieldData (vtkFieldData arg0)
 Assign or retrieve a general field data to this data object.
virtual void SetInformation (vtkInformation arg0)
 Set/Get the information object associated with this data object.
virtual void SetMaximumNumberOfPieces (int arg0)
 Set/Get the maximum number of pieces that can be requested. The maximum number of pieces is meta data for unstructured data sets. It gets set by the source during the update information call. A value of -1 indicates that there is no maximum.
virtual void SetPipelineInformation (vtkInformation arg0)
 Get/Set the pipeline information object that owns this data object.
void SetReleaseDataFlag (int arg0)
 Turn on/off flag to control whether this object's data is released after being used by a filter.
virtual void SetRequestExactExtent (int flag)
 This request flag indicates whether the requester can handle more data than requested. Right now it is used in vtkImageData. Image filters can return more data than requested. The the consumer cannot handle this (i.e. DataSetToDataSetFitler) the image will crop itself. This functionality used to be in ImageToStructuredPoints.
void SetSource (vtkSource s)
 Set/Get the source object creating this data object.
virtual void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
 A generic way of specifying an update extent. Subclasses must decide what a piece is. When the NumberOfPieces is zero, then no data is requested, and the source will not execute.
void SetUpdateExtent (int piece, int numPieces)
 A generic way of specifying an update extent. Subclasses must decide what a piece is. When the NumberOfPieces is zero, then no data is requested, and the source will not execute.
virtual void SetUpdateExtent (int x0, int x1, int y0, int y1, int z0, int z1)
 Set the update extent for data objects that use 3D extents. Using this method on data objects that set extents as pieces (such as vtkPolyData or vtkUnstructuredGrid) has no real effect. Don't use the set macro to set the update extent since we don't want this object to be modified just due to a change in update extent. When the volume of the extent is zero (0, -1,..), then no data is requested, and the source will not execute.
virtual void SetUpdateExtent (IntPtr extent)
 Set the update extent for data objects that use 3D extents. Using this method on data objects that set extents as pieces (such as vtkPolyData or vtkUnstructuredGrid) has no real effect. Don't use the set macro to set the update extent since we don't want this object to be modified just due to a change in update extent. When the volume of the extent is zero (0, -1,..), then no data is requested, and the source will not execute.
void SetUpdateExtentToWholeExtent ()
 If the whole input extent is required to generate the requested output extent, this method can be called to set the input update extent to the whole input extent. This method assumes that the whole extent is known (that UpdateInformation has been called)
void SetUpdateGhostLevel (int level)
 Set / Get the update ghost level and the update number of ghost levels. Similar to update extent in 3D.
void SetUpdateNumberOfPieces (int num)
 Set / Get the update piece and the update number of pieces. Similar to update extent in 3D.
void SetUpdatePiece (int piece)
 Set / Get the update piece and the update number of pieces. Similar to update extent in 3D.
virtual void SetWholeBoundingBox (double x0, double x1, double y0, double y1, double z0, double z1)
 Set/Get the whole bounding box of this data object. The whole whole bounding box is meta data for data sets It gets set by the source during the update information call.
virtual void SetWholeBoundingBox (IntPtr bb)
 Set/Get the whole bounding box of this data object. The whole whole bounding box is meta data for data sets It gets set by the source during the update information call.
virtual void SetWholeExtent (int x0, int x1, int y0, int y1, int z0, int z1)
 Set/Get the whole extent of this data object. The whole extent is meta data for structured data sets. It gets set by the source during the update information call.
virtual void SetWholeExtent (IntPtr extent)
 Set/Get the whole extent of this data object. The whole extent is meta data for structured data sets. It gets set by the source during the update information call.
int ShouldIReleaseData ()
 Return flag indicating whether data should be released after use by a filter.
virtual void TriggerAsynchronousUpdate ()
 WARNING: INTERNAL METHOD - NOT FOR GENERAL USE. THIS METHOD IS PART OF THE PIPELINE UPDATE FUNCTIONALITY. Propagate back up the pipeline for ports and trigger the update on the other side of the port to allow for asynchronous parallel processing in the pipeline. This propagation may early terminate based on the PipelineMTime.
virtual void Update ()
 Provides opportunity for the data object to insure internal consistency before access. Also causes owning source/filter (if any) to update itself. The Update() method is composed of UpdateInformation(), PropagateUpdateExtent(), TriggerAsynchronousUpdate(), and UpdateData().
virtual void UpdateData ()
 WARNING: INTERNAL METHOD - NOT FOR GENERAL USE. THIS METHOD IS PART OF THE PIPELINE UPDATE FUNCTIONALITY. Propagate the update back up the pipeline, and perform the actual work of updating on the way down. When the propagate arrives at a port, block and wait for the asynchronous update to finish on the other side. This propagation may early terminate based on the PipelineMTime.
virtual void UpdateInformation ()
 WARNING: INTERNAL METHOD - NOT FOR GENERAL USE. THIS METHOD IS PART OF THE PIPELINE UPDATE FUNCTIONALITY. Update all the "easy to update" information about the object such as the extent which will be used to control the update. This propagates all the way up then back down the pipeline. As a by-product the PipelineMTime is updated.
- Public Member Functions inherited from Kitware.VTK.vtkObject
 vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObject ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint AddObserver (uint arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
uint AddObserver (string arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void DebugOff ()
 Turn debugging output off.
virtual void DebugOn ()
 Turn debugging output on.
vtkCommand GetCommand (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
byte GetDebug ()
 Get the value of the debug flag.
int HasObserver (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void Modified ()
 Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void RemoveAllObservers ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (vtkCommand arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void SetDebug (byte debugFlag)
 Set the value of the debug flag. A non-zero value turns debugging on.
override string ToString ()
 Returns the result of calling vtkObject::Print as a C# string.
delegate void vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
 Generic signature for all vtkObject events.
void RemoveAllHandlersForAllEvents ()
 Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
- Public Member Functions inherited from Kitware.VTK.vtkObjectBase
 vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObjectBase ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void FastDelete ()
 Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string GetClassName ()
 Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int GetReferenceCount ()
 Return the current reference count of this object.
void SetReferenceCount (int arg0)
 Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions

static new vtkDataSet GetData (vtkInformation info)
 Normally called by pipeline executives or algoritgms only. This method computes the ghost arrays for a given dataset.
static new vtkDataSet GetData (vtkInformationVector v, int i)
 Normally called by pipeline executives or algoritgms only. This method computes the ghost arrays for a given dataset.
static new int IsTypeOf (string type)
 *Undocumented Block
static new vtkDataSet SafeDownCast (vtkObjectBase o)
 *Undocumented Block
- Static Public Member Functions inherited from Kitware.VTK.vtkDataObject
static new vtkDataObject New ()
 *Undocumented Block
static
vtkInformationInformationVectorKey 
CELL_DATA_VECTOR ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static
vtkInformationIntegerPointerKey 
DATA_EXTENT ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static vtkInformationIntegerKey DATA_EXTENT_TYPE ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static vtkInformationIntegerKey DATA_GEOMETRY_UNMODIFIED ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static vtkInformationIntegerKey DATA_NUMBER_OF_GHOST_LEVELS ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static vtkInformationIntegerKey DATA_NUMBER_OF_PIECES ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static vtkInformationDataObjectKey DATA_OBJECT ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static vtkInformationIntegerKey DATA_PIECE_NUMBER ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static vtkInformationDoubleKey DATA_RESOLUTION ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static
vtkInformationDoubleVectorKey 
DATA_TIME_STEPS ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static vtkInformationStringKey DATA_TYPE_NAME ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static
vtkInformationInformationVectorKey 
EDGE_DATA_VECTOR ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static vtkInformationIntegerKey FIELD_ACTIVE_ATTRIBUTE ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static vtkInformationStringKey FIELD_ARRAY_NAME ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static vtkInformationIntegerKey FIELD_ARRAY_TYPE ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static vtkInformationIntegerKey FIELD_ASSOCIATION ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static vtkInformationIntegerKey FIELD_ATTRIBUTE_TYPE ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static vtkInformationStringKey FIELD_NAME ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static vtkInformationIntegerKey FIELD_NUMBER_OF_COMPONENTS ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static vtkInformationIntegerKey FIELD_NUMBER_OF_TUPLES ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static vtkInformationIntegerKey FIELD_OPERATION ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static
vtkInformationDoubleVectorKey 
FIELD_RANGE ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
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 string GetAssociationTypeAsString (int associationType)
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static int GetGlobalReleaseDataFlag ()
 Turn on/off flag to control whether every object releases its data after being used by a filter.
static vtkInformation GetNamedFieldInformation (vtkInformation info, int fieldAssociation, string 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
vtkInformationDoubleVectorKey 
ORIGIN ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static
vtkInformationIntegerVectorKey 
PIECE_EXTENT ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static
vtkInformationDoubleVectorKey 
PIECE_FIELD_RANGE ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static
vtkInformationInformationVectorKey 
POINT_DATA_VECTOR ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static void RemoveNamedFieldInformation (vtkInformation info, int fieldAssociation, string name)
 Remove the info associated with an array.
static vtkInformationDataObjectKey SIL ()
 Key used to put SIL information in the output information by readers.
static
vtkInformationDoubleVectorKey 
SPACING ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
static vtkInformation SetActiveAttribute (vtkInformation info, int fieldAssociation, string 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). Returns the active field information object and creates on entry if one not found.
static void SetActiveAttributeInfo (vtkInformation info, int fieldAssociation, int attributeType, string 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). If there is not an active attribute of the specified type, an entry in the information object is created. If arrayType, numComponents, or numTuples equal to -1, or name=NULL the value is not changed.
static void SetGlobalReleaseDataFlag (int val)
 Turn on/off flag to control whether every object releases its data after being used by a filter.
static void SetPointDataActiveScalarInfo (vtkInformation info, int arrayType, int numComponents)
 Convenience version of previous method for use (primarily) by the Imaging filters. If arrayType or numComponents == -1, the value is not changed.
static
vtkInformationInformationVectorKey 
VERTEX_DATA_VECTOR ()
 Given an integer association type, this static method returns a string type for the attribute (i.e. type = 0: returns "Points").
- Static Public Member Functions inherited from Kitware.VTK.vtkObject
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. It allows the debugger to break on error.
static int GetGlobalWarningDisplay ()
 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 void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkDataSet"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkDataObject
- Public Attributes inherited from Kitware.VTK.vtkObject
- Public Attributes inherited from Kitware.VTK.vtkObjectBase
- Public Attributes inherited from Kitware.VTK.WrappedObject
const string vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
 Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
 Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
 Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
 Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
 Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
 Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
 Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
 Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
 Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
 Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
 Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
 Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
 Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
 Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
 Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes

static new readonly string MRClassNameKey = "10vtkDataSet"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkDataObject
- Static Public Attributes inherited from Kitware.VTK.vtkObject
- Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Static Private Member Functions

static vtkDataSet ()
 Automatically generated type registration mechanics.

Detailed Description

vtkDataSet - abstract class to specify dataset behavior

Description vtkDataSet is an abstract class that specifies an interface for dataset objects. vtkDataSet also provides methods to provide informations about the data, such as center, bounding box, and representative length.

In vtk a dataset consists of a structure (geometry and topology) and attribute data. The structure is defined implicitly or explicitly as a collection of cells. The geometry of the structure is contained in point coordinates plus the cell interpolation functions. The topology of the dataset structure is defined by cell types and how the cells share their defining points.

Attribute data in vtk is either point data (data at points) or cell data (data at cells). Typically filters operate on point data, but some may operate on cell data, both cell and point data, either one, or none.


Member Enumeration Documentation

Shallow and Deep copy.

Enumerator:
CELL_DATA_FIELD 

enum member

DATA_OBJECT_FIELD 

enum member

POINT_DATA_FIELD 

enum member


Constructor & Destructor Documentation

static Kitware.VTK.vtkDataSet.vtkDataSet ( )
staticprivate

Automatically generated type registration mechanics.

Kitware.VTK.vtkDataSet.vtkDataSet ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.


Member Function Documentation

int Kitware.VTK.vtkDataSet.CheckAttributes ( )

This method checks to see if the cell and point attributes match the geometry. Many filters will crash if the number of tupples in an array is less than the number of points/cells. This method returns 1 if there is a mismatch, and 0 if everything is ok. It prints an error if an array is too short, and a warning if an array is too long.

virtual void Kitware.VTK.vtkDataSet.ComputeBounds ( )
virtual

Compute the data bounding box from data points. THIS METHOD IS NOT THREAD SAFE.

Reimplemented in Kitware.VTK.vtkPolyData, Kitware.VTK.vtkImageData, Kitware.VTK.vtkRectilinearGrid, and Kitware.VTK.vtkPointSet.

virtual void Kitware.VTK.vtkDataSet.CopyAttributes ( vtkDataSet  ds)
virtual

Copy the attributes associated with the specified dataset to this instance of vtkDataSet. THIS METHOD IS NOT THREAD SAFE.

virtual void Kitware.VTK.vtkDataSet.CopyStructure ( vtkDataSet  ds)
virtual

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.

Reimplemented in Kitware.VTK.vtkPolyData, Kitware.VTK.vtkImageData, Kitware.VTK.vtkHyperOctree, Kitware.VTK.vtkUnstructuredGrid, Kitware.VTK.vtkRectilinearGrid, Kitware.VTK.vtkStructuredGrid, Kitware.VTK.vtkUniformGrid, and Kitware.VTK.vtkPointSet.

override void Kitware.VTK.vtkDataSet.DeepCopy ( vtkDataObject  src)
virtual
override void Kitware.VTK.vtkDataSet.Dispose ( bool  disposing)
protected
virtual vtkCell Kitware.VTK.vtkDataSet.FindAndGetCell ( IntPtr  x,
vtkCell  cell,
int  cellId,
double  tol2,
ref int  subId,
IntPtr  pcoords,
IntPtr  weights 
)
virtual

Locate the cell that contains a point and return the cell. Also returns the subcell id, parametric coordinates and weights for subsequent interpolation. This method combines the derived class methods int FindCell and vtkCell *GetCell. Derived classes may provide a more efficient implementation. See for example vtkStructuredPoints. THIS METHOD IS NOT THREAD SAFE.

Reimplemented in Kitware.VTK.vtkImageData, Kitware.VTK.vtkRectilinearGrid, and Kitware.VTK.vtkUniformGrid.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkDataSet.FindCell ( IntPtr  x,
vtkCell  cell,
int  cellId,
double  tol2,
ref int  subId,
IntPtr  pcoords,
IntPtr  weights 
)
virtual

Locate cell based on global coordinate x and tolerance squared. If cell and cellId is non-NULL, 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. THIS METHOD IS NOT THREAD SAFE.

Reimplemented in Kitware.VTK.vtkImageData, Kitware.VTK.vtkHyperOctree, Kitware.VTK.vtkRectilinearGrid, Kitware.VTK.vtkUniformGrid, Kitware.VTK.vtkLabelHierarchy, and Kitware.VTK.vtkPointSet.

virtual int Kitware.VTK.vtkDataSet.FindCell ( IntPtr  x,
vtkCell  cell,
vtkGenericCell  gencell,
int  cellId,
double  tol2,
ref int  subId,
IntPtr  pcoords,
IntPtr  weights 
)
virtual

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() THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED.

Reimplemented in Kitware.VTK.vtkImageData, Kitware.VTK.vtkHyperOctree, Kitware.VTK.vtkRectilinearGrid, Kitware.VTK.vtkUniformGrid, Kitware.VTK.vtkLabelHierarchy, and Kitware.VTK.vtkPointSet.

int Kitware.VTK.vtkDataSet.FindPoint ( double  x,
double  y,
double  z 
)

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.) THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED.

Reimplemented in Kitware.VTK.vtkImageData, Kitware.VTK.vtkRectilinearGrid, and Kitware.VTK.vtkPointSet.

virtual int Kitware.VTK.vtkDataSet.FindPoint ( IntPtr  x)
virtual

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.) THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED.

Reimplemented in Kitware.VTK.vtkImageData, Kitware.VTK.vtkHyperOctree, Kitware.VTK.vtkRectilinearGrid, and Kitware.VTK.vtkPointSet.

virtual void Kitware.VTK.vtkDataSet.GenerateGhostLevelArray ( )
virtual

Normally called by pipeline executives or algoritgms only. This method computes the ghost arrays for a given dataset.

override uint Kitware.VTK.vtkDataSet.GetActualMemorySize ( )
virtual

Return the actual size of the data in kilobytes. 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). THIS METHOD IS THREAD SAFE.

Reimplemented from Kitware.VTK.vtkDataObject.

Reimplemented in Kitware.VTK.vtkImageData, Kitware.VTK.vtkPolyData, Kitware.VTK.vtkHyperOctree, Kitware.VTK.vtkRectilinearGrid, Kitware.VTK.vtkUnstructuredGrid, Kitware.VTK.vtkStructuredGrid, and Kitware.VTK.vtkPointSet.

override vtkFieldData Kitware.VTK.vtkDataSet.GetAttributesAsFieldData ( int  type)
virtual

Returns the attributes of the data object as a vtkFieldData. This returns non-null values in all the same cases as GetAttributes, in addition to the case of FIELD, which will return the field data for any vtkDataObject subclass.

Reimplemented from Kitware.VTK.vtkDataObject.

Here is the call graph for this function:

double [] Kitware.VTK.vtkDataSet.GetBounds ( )

Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). THIS METHOD IS NOT THREAD SAFE.

void Kitware.VTK.vtkDataSet.GetBounds ( IntPtr  bounds)

Return a pointer to the geometry bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED.

virtual vtkCell Kitware.VTK.vtkDataSet.GetCell ( int  cellId)
virtual

Get cell with cellId such that: 0 <= cellId < NumberOfCells. THIS METHOD IS NOT THREAD SAFE.

Reimplemented in Kitware.VTK.vtkImageData, Kitware.VTK.vtkPolyData, Kitware.VTK.vtkHyperOctree, Kitware.VTK.vtkRectilinearGrid, Kitware.VTK.vtkUnstructuredGrid, Kitware.VTK.vtkLabelHierarchy, Kitware.VTK.vtkUniformGrid, and Kitware.VTK.vtkStructuredGrid.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkDataSet.GetCell ( int  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.

Reimplemented in Kitware.VTK.vtkImageData, Kitware.VTK.vtkPolyData, Kitware.VTK.vtkHyperOctree, Kitware.VTK.vtkRectilinearGrid, Kitware.VTK.vtkUnstructuredGrid, Kitware.VTK.vtkLabelHierarchy, Kitware.VTK.vtkUniformGrid, and Kitware.VTK.vtkStructuredGrid.

virtual void Kitware.VTK.vtkDataSet.GetCellBounds ( int  cellId,
IntPtr  bounds 
)
virtual

Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells. A subclass may be able to determine the bounds of cell without using an expensive GetCell() method. A default implementation is provided that actually uses a GetCell() call. This is to ensure the method is available to all datasets. Subclasses should override this method to provide an efficient implementation. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED.

Reimplemented in Kitware.VTK.vtkImageData, Kitware.VTK.vtkPolyData, Kitware.VTK.vtkRectilinearGrid, Kitware.VTK.vtkUnstructuredGrid, and Kitware.VTK.vtkStructuredGrid.

vtkCellData Kitware.VTK.vtkDataSet.GetCellData ( )

Return a pointer to this dataset's cell data. THIS METHOD IS THREAD SAFE.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkDataSet.GetCellNeighbors ( int  cellId,
vtkIdList  ptIds,
vtkIdList  cellIds 
)
virtual

Topological inquiry to get all cells using list of points exclusive of cell specified (e.g., cellId). Note that the list consists of only cells that use ALL the points provided. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED.

Reimplemented in Kitware.VTK.vtkPolyData, Kitware.VTK.vtkUnstructuredGrid, Kitware.VTK.vtkHyperOctree, Kitware.VTK.vtkRectilinearGrid, and Kitware.VTK.vtkStructuredGrid.

virtual void Kitware.VTK.vtkDataSet.GetCellPoints ( int  cellId,
vtkIdList  ptIds 
)
virtual

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.

Reimplemented in Kitware.VTK.vtkImageData, Kitware.VTK.vtkPolyData, Kitware.VTK.vtkUnstructuredGrid, Kitware.VTK.vtkHyperOctree, Kitware.VTK.vtkRectilinearGrid, Kitware.VTK.vtkStructuredGrid, Kitware.VTK.vtkUniformGrid, and Kitware.VTK.vtkLabelHierarchy.

virtual int Kitware.VTK.vtkDataSet.GetCellType ( int  cellId)
virtual

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.

Reimplemented in Kitware.VTK.vtkImageData, Kitware.VTK.vtkPolyData, Kitware.VTK.vtkUnstructuredGrid, Kitware.VTK.vtkHyperOctree, Kitware.VTK.vtkRectilinearGrid, Kitware.VTK.vtkStructuredGrid, Kitware.VTK.vtkUniformGrid, and Kitware.VTK.vtkLabelHierarchy.

virtual void Kitware.VTK.vtkDataSet.GetCellTypes ( vtkCellTypes  types)
virtual

Get a list of types of cells in a dataset. The list consists of an array of types (not necessarily in any order), with a single entry per type. For example a dataset 5 triangles, 3 lines, and 100 hexahedra would result a list of three entries, corresponding to the types VTK_TRIANGLE, VTK_LINE, and VTK_HEXAHEDRON. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED.

double [] Kitware.VTK.vtkDataSet.GetCenter ( )

Get the center of the bounding box. THIS METHOD IS NOT THREAD SAFE.

void Kitware.VTK.vtkDataSet.GetCenter ( IntPtr  center)

Get the center of the bounding box. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED.

static new vtkDataSet Kitware.VTK.vtkDataSet.GetData ( vtkInformation  info)
static

Normally called by pipeline executives or algoritgms only. This method computes the ghost arrays for a given dataset.

Reimplemented from Kitware.VTK.vtkDataObject.

Reimplemented in Kitware.VTK.vtkImageData, Kitware.VTK.vtkUnstructuredGrid, Kitware.VTK.vtkPolyData, Kitware.VTK.vtkHyperOctree, Kitware.VTK.vtkRectilinearGrid, Kitware.VTK.vtkStructuredGrid, Kitware.VTK.vtkUniformGrid, and Kitware.VTK.vtkPointSet.

Here is the call graph for this function:

static new vtkDataSet Kitware.VTK.vtkDataSet.GetData ( vtkInformationVector  v,
int  i 
)
static

Normally called by pipeline executives or algoritgms only. This method computes the ghost arrays for a given dataset.

Reimplemented from Kitware.VTK.vtkDataObject.

Reimplemented in Kitware.VTK.vtkImageData, Kitware.VTK.vtkUnstructuredGrid, Kitware.VTK.vtkPolyData, Kitware.VTK.vtkHyperOctree, Kitware.VTK.vtkRectilinearGrid, Kitware.VTK.vtkStructuredGrid, Kitware.VTK.vtkUniformGrid, and Kitware.VTK.vtkPointSet.

Here is the call graph for this function:

override int Kitware.VTK.vtkDataSet.GetDataObjectType ( )
virtual
double Kitware.VTK.vtkDataSet.GetLength ( )

Return the length of the diagonal of the bounding box. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED.

virtual int Kitware.VTK.vtkDataSet.GetMaxCellSize ( )
virtual

Convenience method returns largest cell size in dataset. This is generally used to allocate memory for supporting data structures. THIS METHOD IS THREAD SAFE.

Reimplemented in Kitware.VTK.vtkImageData, Kitware.VTK.vtkUnstructuredGrid, Kitware.VTK.vtkPolyData, Kitware.VTK.vtkHyperOctree, Kitware.VTK.vtkRectilinearGrid, Kitware.VTK.vtkStructuredGrid, Kitware.VTK.vtkLabelHierarchy, and Kitware.VTK.vtkUniformGrid.

override uint Kitware.VTK.vtkDataSet.GetMTime ( )
virtual

Datasets are composite objects and need to check each part for MTime THIS METHOD IS THREAD SAFE.

Reimplemented from Kitware.VTK.vtkDataObject.

Reimplemented in Kitware.VTK.vtkPointSet.

virtual int Kitware.VTK.vtkDataSet.GetNumberOfCells ( )
virtual
override int Kitware.VTK.vtkDataSet.GetNumberOfElements ( int  type)
virtual

Get the number of elements for a specific attribute type (POINT, CELL, etc.).

Reimplemented from Kitware.VTK.vtkDataObject.

virtual int Kitware.VTK.vtkDataSet.GetNumberOfPoints ( )
virtual

Determine the number of points composing the dataset. THIS METHOD IS THREAD SAFE.

Reimplemented in Kitware.VTK.vtkImageData, Kitware.VTK.vtkHyperOctree, Kitware.VTK.vtkRectilinearGrid, Kitware.VTK.vtkStructuredGrid, and Kitware.VTK.vtkPointSet.

virtual double [] Kitware.VTK.vtkDataSet.GetPoint ( int  ptId)
virtual

Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints. THIS METHOD IS NOT THREAD SAFE.

Reimplemented in Kitware.VTK.vtkImageData, Kitware.VTK.vtkHyperOctree, Kitware.VTK.vtkRectilinearGrid, Kitware.VTK.vtkStructuredGrid, and Kitware.VTK.vtkPointSet.

virtual void Kitware.VTK.vtkDataSet.GetPoint ( int  id,
IntPtr  x 
)
virtual
virtual void Kitware.VTK.vtkDataSet.GetPointCells ( int  ptId,
vtkIdList  cellIds 
)
virtual

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.

Reimplemented in Kitware.VTK.vtkImageData, Kitware.VTK.vtkHyperOctree, Kitware.VTK.vtkUnstructuredGrid, Kitware.VTK.vtkPolyData, Kitware.VTK.vtkRectilinearGrid, Kitware.VTK.vtkStructuredGrid, Kitware.VTK.vtkLabelHierarchy, and Kitware.VTK.vtkUniformGrid.

vtkPointData Kitware.VTK.vtkDataSet.GetPointData ( )

Return a pointer to this dataset's point data. THIS METHOD IS THREAD SAFE.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkDataSet.GetScalarRange ( IntPtr  range)
virtual

Convenience method to get the range of the scalar data (if there is any scalar data). Returns the (min/max) range of combined point and cell data. If there are no point or cell scalars the method will return (0,1). Note: Update needs to be called to create the scalars. THIS METHOD IS THREAD SAFE IF FIRST CALLED FROM A SINGLE THREAD AND THE DATASET IS NOT MODIFIED.

Reimplemented in Kitware.VTK.vtkStructuredGrid.

double [] Kitware.VTK.vtkDataSet.GetScalarRange ( )

Convenience method to get the range of the scalar data (if there is any scalar data). THIS METHOD IS NOT THREAD SAFE.

Reimplemented in Kitware.VTK.vtkStructuredGrid.

override void Kitware.VTK.vtkDataSet.Initialize ( )
virtual
override int Kitware.VTK.vtkDataSet.IsA ( string  type)
virtual
static new int Kitware.VTK.vtkDataSet.IsTypeOf ( string  type)
static
new vtkDataSet Kitware.VTK.vtkDataSet.NewInstance ( )
static new vtkDataSet Kitware.VTK.vtkDataSet.SafeDownCast ( vtkObjectBase  o)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkDataObject.

Reimplemented in Kitware.VTK.vtkImageData, Kitware.VTK.vtkPolyData, Kitware.VTK.vtkHyperOctree, Kitware.VTK.vtkUnstructuredGrid, Kitware.VTK.vtkRectilinearGrid, Kitware.VTK.vtkStructuredGrid, Kitware.VTK.vtkLabelHierarchy, Kitware.VTK.vtkUniformGrid, Kitware.VTK.vtkPointSet, and Kitware.VTK.vtkStructuredPoints.

Here is the call graph for this function:

override void Kitware.VTK.vtkDataSet.ShallowCopy ( vtkDataObject  src)
virtual
virtual void Kitware.VTK.vtkDataSet.Squeeze ( )
virtual

Reclaim any extra memory used to store data. THIS METHOD IS NOT THREAD SAFE.

Reimplemented in Kitware.VTK.vtkPolyData, Kitware.VTK.vtkUnstructuredGrid, and Kitware.VTK.vtkPointSet.


Member Data Documentation

new readonly string Kitware.VTK.vtkDataSet.MRClassNameKey = "10vtkDataSet"
static
new const string Kitware.VTK.vtkDataSet.MRFullTypeName = "Kitware.VTK.vtkDataSet"

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