Singleton class for topologically regular data. More...
#include <vtkStructuredData.h>
Public Types | |
| typedef vtkObject | Superclass |
Public Member Functions | |
| virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
| vtkStructuredData * | NewInstance () const |
 Public Member Functions inherited from vtkObject | |
| vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
| virtual void | DebugOn () |
| Turn debugging output on. More... | |
| virtual void | DebugOff () |
| Turn debugging output off. More... | |
| bool | GetDebug () |
| Get the value of the debug flag. More... | |
| void | SetDebug (bool debugFlag) |
| Set the value of the debug flag. More... | |
| virtual void | Modified () |
| Update the modification time for this object. More... | |
| virtual vtkMTimeType | GetMTime () |
| Return this object's modified time. More... | |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More... | |
| void | RemoveObserver (unsigned long tag) |
| void | RemoveObservers (unsigned long event) |
| void | RemoveObservers (const char *event) |
| void | RemoveAllObservers () |
| vtkTypeBool | HasObserver (unsigned long event) |
| vtkTypeBool | HasObserver (const char *event) |
| int | InvokeEvent (unsigned long event) |
| int | InvokeEvent (const char *event) |
| unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkCommand * | GetCommand (unsigned long tag) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObserver (vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Allow user to set the AbortFlagOn() with the return value of the callback method. More... | |
| int | InvokeEvent (unsigned long event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More... | |
| int | InvokeEvent (const char *event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More... | |
| Public Member Functions inherited from vtkObjectBase | |
| const char * | GetClassName () const |
| Return the class name as a string. More... | |
| virtual void | Delete () |
| Delete a VTK object. More... | |
| virtual void | FastDelete () |
| Delete a reference to this object. More... | |
| void | InitializeObjectBase () |
| void | Print (ostream &os) |
| Print an object to an ostream. More... | |
| virtual void | Register (vtkObjectBase *o) |
| Increase the reference count (mark as used by another object). More... | |
| virtual void | UnRegister (vtkObjectBase *o) |
| Decrease the reference count (release by another object). More... | |
| int | GetReferenceCount () |
| Return the current reference count of this object. More... | |
| void | SetReferenceCount (int) |
| Sets the reference count. More... | |
| void | PrintRevisions (ostream &) |
| Legacy. More... | |
| virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
| virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
Static Public Member Functions | |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkStructuredData * | SafeDownCast (vtkObjectBase *o) |
| static vtkIdType | GetNumberOfPoints (int ext[6], int dataDescription=VTK_EMPTY) |
| Given the grid extent, this method returns the total number of points within the extent. More... | |
| static vtkIdType | GetNumberOfCells (int ext[6], int dataDescription=VTK_EMPTY) |
| Given the grid extent, this method returns the total number of cells within the extent. More... | |
| static void | GetCellExtentFromPointExtent (int pntExtent[6], int cellExtent[6], int dataDescription=VTK_EMPTY) |
| Given the point extent of a grid, this method computes the corresponding cell extent for the grid. More... | |
| static void | GetDimensionsFromExtent (int ext[6], int dims[3], int dataDescription=VTK_EMPTY) |
| Computes the structured grid dimensions based on the given extent. More... | |
| static void | GetCellDimensionsFromExtent (int ext[6], int celldims[3], int dataDescription=VTK_EMPTY) |
| Returns the cell dimensions, i.e., the number of cells along the i,j,k for the grid with the given grid extent. More... | |
| static void | GetCellDimensionsFromPointDimensions (int pntdims[3], int cellDims[3]) |
| Given the dimensions of the grid, in pntdims, this method returns the corresponding cell dimensions for the given grid. More... | |
| static void | GetLocalStructuredCoordinates (int ijk[3], int ext[6], int lijk[3], int dataDescription=VTK_EMPTY) |
| Given the global structured coordinates for a point or cell, ijk, w.r.t. More... | |
| static void | GetGlobalStructuredCoordinates (int lijk[3], int ext[6], int ijk[3], int dataDescription=VTK_EMPTY) |
| Given local structured coordinates, and the corresponding global sub-grid extent, this method computes the global ijk coordinates. More... | |
| static void | GetCellPoints (vtkIdType cellId, vtkIdList *ptIds, int dataDescription, int dim[3]) |
| Get the points defining a cell. More... | |
| static void | GetPointCells (vtkIdType ptId, vtkIdList *cellIds, int dim[3]) |
| Get the cells using a point. More... | |
| static void | GetCellNeighbors (vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds, int dim[3]) |
| Get the cells using the points ptIds, exclusive of the cell cellId. More... | |
| static void | GetCellNeighbors (vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds, int dim[3], int seedLoc[3]) |
| static vtkIdType | ComputePointIdForExtent (int extent[6], int ijk[3], int dataDescription=VTK_EMPTY) |
| Given a location in structured coordinates (i-j-k), and the extent of the structured dataset, return the point id. More... | |
| static vtkIdType | ComputeCellIdForExtent (int extent[6], int ijk[3], int dataDescription=VTK_EMPTY) |
| Given a location in structured coordinates (i-j-k), and the extent of the structured dataset, return the point id. More... | |
| static vtkIdType | ComputePointId (int dim[3], int ijk[3], int dataDescription=VTK_EMPTY) |
| Given a location in structured coordinates (i-j-k), and the dimensions of the structured dataset, return the point id. More... | |
| static vtkIdType | ComputeCellId (int dim[3], int ijk[3], int dataDescription=VTK_EMPTY) |
| Given a location in structured coordinates (i-j-k), and the dimensions of the structured dataset, return the cell id. More... | |
| static void | ComputeCellStructuredCoordsForExtent (const vtkIdType cellIdx, int ext[6], int ijk[3], int dataDescription=VTK_EMPTY) |
| Given the global grid extent and the linear index of a cell within the grid extent, this method computes the corresponding structured coordinates of the given cell. More... | |
| static void | ComputeCellStructuredCoords (const vtkIdType cellId, int dim[3], int ijk[3], int dataDescription=VTK_EMPTY) |
| Given a cellId and grid dimensions 'dim', get the structured coordinates (i-j-k). More... | |
| static void | ComputePointStructuredCoordsForExtent (const vtkIdType ptId, int ext[6], int ijk[3], int dataDescription=VTK_EMPTY) |
| Given a pointId and the grid extent ext, get the structured coordinates (i-j-k). More... | |
| static void | ComputePointStructuredCoords (const vtkIdType ptId, int dim[3], int ijk[3], int dataDescription=VTK_EMPTY) |
| Given a pointId and grid dimensions 'dim', get the structured coordinates (i-j-k). More... | |
| static int | SetDimensions (int inDim[3], int dim[3]) |
| Specify the dimensions of a regular, rectangular dataset. More... | |
| static int | SetExtent (int inExt[6], int ext[6]) |
| Specify the dimensions of a regular, rectangular dataset. More... | |
| static int | GetDataDescription (int dims[3]) |
| Returns the data description given the dimensions (eg. More... | |
| static int | GetDataDescriptionFromExtent (int ext[6]) |
| Returns the data description given the dimensions (eg. More... | |
| static int | GetDataDimension (int dataDescription) |
| Return the topological dimension of the data (e.g., 0, 1, 2, or 3D). More... | |
| static int | GetDataDimension (int ext[6]) |
| Return the topological dimension of the data (e.g., 0, 1, 2, or 3D). More... | |
| Static Public Member Functions inherited from vtkObject | |
| static vtkObject * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
| static void | BreakOnError () |
| This method is called when vtkErrorMacro executes. More... | |
| static void | SetGlobalWarningDisplay (int val) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static void | GlobalWarningDisplayOn () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static void | GlobalWarningDisplayOff () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static int | GetGlobalWarningDisplay () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| Static Public Member Functions inherited from vtkObjectBase | |
| static vtkTypeBool | IsTypeOf (const char *name) |
| Return 1 if this class type is the same type of (or a subclass of) the named class. More... | |
| static vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| vtkStructuredData () | |
| ~vtkStructuredData () override | |
| Protected Member Functions inherited from vtkObject | |
| vtkObject () | |
| ~vtkObject () override | |
| void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
| void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
| void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
| These methods allow a command to exclusively grab all events. More... | |
| void | InternalReleaseFocus () |
| These methods allow a command to exclusively grab all events. More... | |
| Protected Member Functions inherited from vtkObjectBase | |
| vtkObjectBase () | |
| virtual | ~vtkObjectBase () |
| virtual void | CollectRevisions (ostream &) |
| virtual void | ReportReferences (vtkGarbageCollector *) |
| vtkObjectBase (const vtkObjectBase &) | |
| void | operator= (const vtkObjectBase &) |
Static Protected Member Functions | |
| static vtkIdType | GetLinearIndex (const int i, const int j, const int k, const int N1, const int N2) |
| Computes the linear index for the given i-j-k structured of a grid with of N1 and N2 dimensions along its principal directions. More... | |
| template<typename T > | |
| static T | Max (const T &a, const T &b) |
| static void | GetStructuredCoordinates (const vtkIdType idx, const int N1, const int N2, int &i, int &j, int &k) |
| Returns the structured coordinates (i,j,k) for the given linear index of a grid with N1 and N2 dimensions along its principal directions. More... | |
Additional Inherited Members | |
| Protected Attributes inherited from vtkObject | |
| bool | Debug |
| vtkTimeStamp | MTime |
| vtkSubjectHelper * | SubjectHelper |
| Protected Attributes inherited from vtkObjectBase | |
| vtkAtomicInt32 | ReferenceCount |
| vtkWeakPointerBase ** | WeakPointers |
Detailed Description
Singleton class for topologically regular data.
vtkStructuredData is a singleton class that provides an interface for topologically regular data. Regular data is data that can be accessed in rectangular fashion using an i-j-k index. A finite difference grid, a volume, or a pixmap are all considered regular.
Definition at line 51 of file vtkStructuredData.h.
Member Typedef Documentation
Definition at line 54 of file vtkStructuredData.h.
Constructor & Destructor Documentation
|
inlineprotected |
Definition at line 240 of file vtkStructuredData.h.
|
inlineoverrideprotected |
Definition at line 241 of file vtkStructuredData.h.
Member Function Documentation
|
static |
|
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 vtkObjectBase.
|
static |
|
protectedvirtual |
| vtkStructuredData* vtkStructuredData::NewInstance | ( | ) | const |
Specify the dimensions of a regular, rectangular dataset.
The input is the new dimensions (inDim) and the current dimensions (dim). The function returns the dimension of the dataset (0-3D). If the dimensions are improperly specified a -1 is returned. If the dimensions are unchanged, a value of 100 is returned.
Specify the dimensions of a regular, rectangular dataset.
The input is the new dimensions (inDim) and the current dimensions (dim). The function returns the dimension of the dataset (0-3D). If the dimensions are improperly specified a -1 is returned. If the dimensions are unchanged, a value of 100 is returned.
Returns the data description given the dimensions (eg.
VTK_SINGLE_POINT, VTK_X_LINE, VTK_XY_PLANE etc.)
Returns the data description given the dimensions (eg.
VTK_SINGLE_POINT, VTK_X_LINE, VTK_XY_PLANE etc.)
Return the topological dimension of the data (e.g., 0, 1, 2, or 3D).
Return the topological dimension of the data (e.g., 0, 1, 2, or 3D).
|
inlinestatic |
Given the grid extent, this method returns the total number of points within the extent.
The dataDescription field is not used.
Definition at line 311 of file vtkStructuredData.h.
|
inlinestatic |
Given the grid extent, this method returns the total number of cells within the extent.
The dataDescription field is not used.
Definition at line 319 of file vtkStructuredData.h.
|
inlinestatic |
Given the point extent of a grid, this method computes the corresponding cell extent for the grid.
The dataDescription field is not used.
Definition at line 337 of file vtkStructuredData.h.
|
inlinestatic |
Computes the structured grid dimensions based on the given extent.
The dataDescription field is not used.
Definition at line 350 of file vtkStructuredData.h.
|
inlinestatic |
Returns the cell dimensions, i.e., the number of cells along the i,j,k for the grid with the given grid extent.
Note, the grid extent is the number of points. The dataDescription field is not used.
Definition at line 286 of file vtkStructuredData.h.
|
inlinestatic |
Given the dimensions of the grid, in pntdims, this method returns the corresponding cell dimensions for the given grid.
The dataDescription field is not used.
Definition at line 359 of file vtkStructuredData.h.
|
inlinestatic |
Given the global structured coordinates for a point or cell, ijk, w.r.t.
as well as, the global sub-grid cell or point extent, this method computes the corresponding local structured coordinates, lijk, starting from 0. The dataDescription argument is not used.
Definition at line 368 of file vtkStructuredData.h.
|
inlinestatic |
Given local structured coordinates, and the corresponding global sub-grid extent, this method computes the global ijk coordinates.
The dataDescription parameter is not used.
Definition at line 377 of file vtkStructuredData.h.
|
static |
Get the points defining a cell.
(See vtkDataSet for more info.)
|
static |
Get the cells using a point.
(See vtkDataSet for more info.)
|
static |
Get the cells using the points ptIds, exclusive of the cell cellId.
(See vtkDataSet for more info.)
|
static |
|
inlinestatic |
Given a location in structured coordinates (i-j-k), and the extent of the structured dataset, return the point id.
The dataDescription argument is not used.
Definition at line 386 of file vtkStructuredData.h.
|
inlinestatic |
Given a location in structured coordinates (i-j-k), and the extent of the structured dataset, return the point id.
The dataDescription argument is not used.
Definition at line 399 of file vtkStructuredData.h.
|
inlinestatic |
Given a location in structured coordinates (i-j-k), and the dimensions of the structured dataset, return the point id.
This method does not adjust for the beginning of the extent. The dataDescription argument is not used.
Definition at line 295 of file vtkStructuredData.h.
|
inlinestatic |
Given a location in structured coordinates (i-j-k), and the dimensions of the structured dataset, return the cell id.
This method does not adjust for the beginning of the extent. The dataDescription argument is not used.
Definition at line 302 of file vtkStructuredData.h.
|
inlinestatic |
Given the global grid extent and the linear index of a cell within the grid extent, this method computes the corresponding structured coordinates of the given cell.
This method adjusts for the beginning of the extent. The dataDescription argument is not used.
Definition at line 421 of file vtkStructuredData.h.
|
inlinestatic |
Given a cellId and grid dimensions 'dim', get the structured coordinates (i-j-k).
This method does not adjust for the beginning of the extent. The dataDescription argument is not used.
Definition at line 412 of file vtkStructuredData.h.
|
inlinestatic |
Given a pointId and the grid extent ext, get the structured coordinates (i-j-k).
This method adjusts for the beginning of the extent. The dataDescription argument is not used.
Definition at line 442 of file vtkStructuredData.h.
|
inlinestatic |
Given a pointId and grid dimensions 'dim', get the structured coordinates (i-j-k).
This method does not adjust for the beginning of the extent. The dataDescription argument is not used.
Definition at line 434 of file vtkStructuredData.h.
|
inlinestaticprotected |
Computes the linear index for the given i-j-k structured of a grid with of N1 and N2 dimensions along its principal directions.
For example, the principal directions of a 3-D grid are Ni and Nj and likewise for a 2-D grid along the XY plane. For a grid in the XZ plane however, the principal directions are Ni and Nk.
Definition at line 250 of file vtkStructuredData.h.
|
inlinestaticprotected |
Returns the structured coordinates (i,j,k) for the given linear index of a grid with N1 and N2 dimensions along its principal directions.
NOTE: i,j,k are relative to the frame of reference of the grid. For example, if the grid is on the XZ-Plane, then i=>i, j=>k, k=>j.
Definition at line 263 of file vtkStructuredData.h.
|
inlinestaticprotected |
Definition at line 275 of file vtkStructuredData.h.
The documentation for this class was generated from the following file:
- /home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Common/DataModel/vtkStructuredData.h
