VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkStructuredGrid Class Reference

topologically regular array of data More...

#include <vtkStructuredGrid.h>

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

Public Types

typedef vtkPointSet Superclass
 
- Public Types inherited from vtkPointSet
typedef vtkDataSet Superclass
 
- Public Types inherited from vtkDataSet
enum  FieldDataType { DATA_OBJECT_FIELD =0, POINT_DATA_FIELD =1, CELL_DATA_FIELD =2 }
 
typedef vtkDataObject Superclass
 
- Public Types inherited from vtkDataObject
typedef vtkObject Superclass
 
enum  FieldAssociations {
  FIELD_ASSOCIATION_POINTS, FIELD_ASSOCIATION_CELLS, FIELD_ASSOCIATION_NONE, FIELD_ASSOCIATION_POINTS_THEN_CELLS,
  FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, FIELD_ASSOCIATION_ROWS, NUMBER_OF_ASSOCIATIONS
}
 
enum  AttributeTypes {
  POINT, CELL, FIELD, POINT_THEN_CELL,
  VERTEX, EDGE, ROW, NUMBER_OF_ATTRIBUTE_TYPES
}
 
enum  FieldOperations { FIELD_OPERATION_PRESERVED, FIELD_OPERATION_REINTERPOLATED, FIELD_OPERATION_MODIFIED, FIELD_OPERATION_REMOVED }
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int GetDataObjectType ()
 
void CopyStructure (vtkDataSet *ds)
 
int GetDataDimension ()
 
unsigned long GetActualMemorySize ()
 
int GetExtentType ()
 
vtkUnsignedCharArrayGetPointVisibilityArray ()
 
void SetPointVisibilityArray (vtkUnsignedCharArray *pointVisibility)
 
vtkUnsignedCharArrayGetCellVisibilityArray ()
 
void SetCellVisibilityArray (vtkUnsignedCharArray *pointVisibility)
 
unsigned char IsPointVisible (vtkIdType ptId)
 
unsigned char IsCellVisible (vtkIdType cellId)
 
unsigned char GetPointBlanking ()
 
unsigned char GetCellBlanking ()
 
virtual void Crop ()
 
void GetPoint (int i, int j, int k, double p[3], bool adjustForExtent=true)
 
vtkIdType GetNumberOfPoints ()
 
double * GetPoint (vtkIdType ptId)
 
void GetPoint (vtkIdType ptId, double p[3])
 
vtkCell * GetCell (vtkIdType cellId)
 
void GetCell (vtkIdType cellId, vtkGenericCell *cell)
 
void GetCellBounds (vtkIdType cellId, double bounds[6])
 
int GetCellType (vtkIdType cellId)
 
vtkIdType GetNumberOfCells ()
 
void GetCellPoints (vtkIdType cellId, vtkIdList *ptIds)
 
void GetPointCells (vtkIdType ptId, vtkIdList *cellIds)
 
void Initialize ()
 
int GetMaxCellSize ()
 
void GetCellNeighbors (vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds)
 
virtual void GetScalarRange (double range[2])
 
double * GetScalarRange ()
 
void SetDimensions (int i, int j, int k)
 
void SetDimensions (int dim[3])
 
virtual int * GetDimensions ()
 
virtual void GetDimensions (int dim[3])
 
void SetExtent (int extent[6])
 
void SetExtent (int x1, int x2, int y1, int y2, int z1, int z2)
 
virtual int * GetExtent ()
 
virtual void GetExtent (int &, int &, int &, int &, int &, int &)
 
virtual void GetExtent (int[6])
 
void ShallowCopy (vtkDataObject *src)
 
void DeepCopy (vtkDataObject *src)
 
void BlankPoint (vtkIdType ptId)
 
void UnBlankPoint (vtkIdType ptId)
 
void BlankCell (vtkIdType ptId)
 
void UnBlankCell (vtkIdType ptId)
 
- Public Member Functions inherited from vtkPointSet
unsigned long GetMTime ()
 
void ComputeBounds ()
 
void Squeeze ()
 
virtual vtkIdType FindPoint (double x[3])
 
vtkIdType FindPoint (double x, double y, double z)
 
virtual vtkIdType FindCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
 
virtual vtkIdType FindCell (double x[3], vtkCell *cell, vtkGenericCell *gencell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
 
virtual void SetPoints (vtkPoints *)
 
virtual vtkPointsGetPoints ()
 
- Public Member Functions inherited from vtkDataSet
virtual void CopyAttributes (vtkDataSet *ds)
 
virtual void GetCellTypes (vtkCellTypes *types)
 
vtkCellDataGetCellData ()
 
vtkPointDataGetPointData ()
 
double * GetBounds ()
 
void GetBounds (double bounds[6])
 
double * GetCenter ()
 
void GetCenter (double center[3])
 
double GetLength ()
 
double * GetScalarRange ()
 
int CheckAttributes ()
 
virtual void GenerateGhostLevelArray ()
 
virtual vtkFieldDataGetAttributesAsFieldData (int type)
 
virtual vtkIdType GetNumberOfElements (int type)
 
vtkIdType FindPoint (double x, double y, double z)
 
virtual vtkCell * FindAndGetCell (double x[3], vtkCell *cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double *weights)
 
- Public Member Functions inherited from vtkDataObject
virtual vtkAlgorithmOutputGetProducerPort ()
 
void ReleaseData ()
 
int ShouldIReleaseData ()
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
virtual void Update ()
 
virtual void UpdateInformation ()
 
virtual void PropagateUpdateExtent ()
 
virtual void TriggerAsynchronousUpdate ()
 
virtual void UpdateData ()
 
virtual unsigned long GetEstimatedMemorySize ()
 
unsigned long GetUpdateTime ()
 
void SetUpdateExtentToWholeExtent ()
 
unsigned long GetPipelineMTime ()
 
void CopyInformation (vtkDataObject *data)
 
virtual void CopyInformationFromPipeline (vtkInformation *request)
 
void DataHasBeenGenerated ()
 
virtual void PrepareForNewData ()
 
virtual vtkDataSetAttributesGetAttributes (int type)
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 
virtual vtkSourceGetSource ()
 
void SetSource (vtkSource *s)
 
virtual vtkInformationGetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual vtkInformationGetPipelineInformation ()
 
virtual void SetPipelineInformation (vtkInformation *)
 
virtual int GetDataReleased ()
 
void SetReleaseDataFlag (int)
 
int GetReleaseDataFlag ()
 
virtual void ReleaseDataFlagOn ()
 
virtual void ReleaseDataFlagOff ()
 
virtual void SetFieldData (vtkFieldData *)
 
virtual vtkFieldDataGetFieldData ()
 
virtual void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int piece, int numPieces)
 
virtual void SetUpdateExtent (int x0, int x1, int y0, int y1, int z0, int z1)
 
virtual void SetUpdateExtent (int extent[6])
 
virtual int * GetUpdateExtent ()
 
virtual void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
virtual void GetUpdateExtent (int extent[6])
 
virtual void CopyTypeSpecificInformation (vtkDataObject *data)
 
void SetUpdatePiece (int piece)
 
void SetUpdateNumberOfPieces (int num)
 
virtual int GetUpdatePiece ()
 
virtual int GetUpdateNumberOfPieces ()
 
void SetUpdateGhostLevel (int level)
 
virtual int GetUpdateGhostLevel ()
 
virtual void SetRequestExactExtent (int flag)
 
virtual int GetRequestExactExtent ()
 
virtual void RequestExactExtentOn ()
 
virtual void RequestExactExtentOff ()
 
virtual void SetWholeExtent (int x0, int x1, int y0, int y1, int z0, int z1)
 
virtual void SetWholeExtent (int extent[6])
 
virtual int * GetWholeExtent ()
 
virtual void GetWholeExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
virtual void GetWholeExtent (int extent[6])
 
virtual void SetWholeBoundingBox (double x0, double x1, double y0, double y1, double z0, double z1)
 
virtual void SetWholeBoundingBox (double bb[6])
 
virtual double * GetWholeBoundingBox ()
 
virtual void GetWholeBoundingBox (double &x0, double &x1, double &y0, double &y1, double &z0, double &z1)
 
virtual void GetWholeBoundingBox (double extent[6])
 
virtual void SetMaximumNumberOfPieces (int)
 
virtual int GetMaximumNumberOfPieces ()
 
virtual void CopyInformationToPipeline (vtkInformation *request, vtkInformation *input, vtkInformation *output, int forceCopy)
 
void CopyInformationToPipeline (vtkInformation *request, vtkInformation *input)
 
void SetExtentTranslator (vtkExtentTranslator *translator)
 
vtkExtentTranslatorGetExtentTranslator ()
 
void GlobalReleaseDataFlagOn ()
 
void GlobalReleaseDataFlagOff ()
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static vtkStructuredGridNew ()
 
static int IsTypeOf (const char *type)
 
static vtkStructuredGridSafeDownCast (vtkObject *o)
 
static vtkStructuredGridGetData (vtkInformation *info)
 
static vtkStructuredGridGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkPointSet
static int IsTypeOf (const char *type)
 
static vtkPointSetSafeDownCast (vtkObject *o)
 
static vtkPointSetGetData (vtkInformation *info)
 
static vtkPointSetGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkDataSet
static int IsTypeOf (const char *type)
 
static vtkDataSetSafeDownCast (vtkObject *o)
 
static vtkDataSetGetData (vtkInformation *info)
 
static vtkDataSetGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDataObjectSafeDownCast (vtkObject *o)
 
static const char * GetAssociationTypeAsString (int associationType)
 
static vtkInformationStringKeyDATA_TYPE_NAME ()
 
static
vtkInformationDataObjectKey
DATA_OBJECT ()
 
static vtkInformationIntegerKeyDATA_EXTENT_TYPE ()
 
static
vtkInformationIntegerPointerKey
DATA_EXTENT ()
 
static vtkInformationIntegerKeyDATA_PIECE_NUMBER ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_GHOST_LEVELS ()
 
static vtkInformationDoubleKeyDATA_RESOLUTION ()
 
static
vtkInformationDoubleVectorKey
DATA_TIME_STEPS ()
 
static
vtkInformationInformationVectorKey
POINT_DATA_VECTOR ()
 
static
vtkInformationInformationVectorKey
CELL_DATA_VECTOR ()
 
static
vtkInformationInformationVectorKey
VERTEX_DATA_VECTOR ()
 
static
vtkInformationInformationVectorKey
EDGE_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
vtkInformationDoubleVectorKey
FIELD_RANGE ()
 
static
vtkInformationDoubleVectorKey
PIECE_FIELD_RANGE ()
 
static vtkInformationStringKeyFIELD_ARRAY_NAME ()
 
static
vtkInformationIntegerVectorKey
PIECE_EXTENT ()
 
static vtkInformationStringKeyFIELD_NAME ()
 
static
vtkInformationDoubleVectorKey
ORIGIN ()
 
static
vtkInformationDoubleVectorKey
SPACING ()
 
static vtkInformationIntegerKeyDATA_GEOMETRY_UNMODIFIED ()
 
static
vtkInformationDataObjectKey
SIL ()
 
static vtkInformationGetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
 
static vtkInformationGetNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 
static vtkInformationSetActiveAttribute (vtkInformation *info, int fieldAssociation, const char *attributeName, int attributeType)
 
static void SetActiveAttributeInfo (vtkInformation *info, int fieldAssociation, int attributeType, const char *name, int arrayType, int numComponents, int numTuples)
 
static void SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
 
static vtkDataObjectGetData (vtkInformation *info)
 
static vtkDataObjectGetData (vtkInformationVector *v, int i=0)
 
static void SetGlobalReleaseDataFlag (int val)
 
static int GetGlobalReleaseDataFlag ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkStructuredGrid ()
 
 ~vtkStructuredGrid ()
 
void SetPointVisibility (vtkStructuredVisibilityConstraint *pointVisibility)
 
virtual
vtkStructuredVisibilityConstraint
GetPointVisibility ()
 
void SetCellVisibility (vtkStructuredVisibilityConstraint *cellVisibility)
 
virtual
vtkStructuredVisibilityConstraint
GetCellVisibility ()
 
- Protected Member Functions inherited from vtkPointSet
 vtkPointSet ()
 
 ~vtkPointSet ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
- Protected Member Functions inherited from vtkDataSet
 vtkDataSet ()
 
 ~vtkDataSet ()
 
virtual void ComputeScalarRange ()
 
- Protected Member Functions inherited from vtkDataObject
 vtkDataObject ()
 
 ~vtkDataObject ()
 
vtkExecutiveGetExecutive ()
 
int GetPortNumber ()
 
vtkStreamingDemandDrivenPipelineTrySDDP (const char *method)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &os)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkVertex * Vertex
 
vtkLineLine
 
vtkQuadQuad
 
vtkHexahedronHexahedron
 
vtkEmptyCellEmptyCell
 
int Dimensions [3]
 
int DataDescription
 
int Extent [6]
 
vtkStructuredVisibilityConstraintPointVisibility
 
vtkStructuredVisibilityConstraintCellVisibility
 
- Protected Attributes inherited from vtkPointSet
vtkPointsPoints
 
vtkPointLocatorLocator
 
- Protected Attributes inherited from vtkDataSet
vtkCellDataCellData
 
vtkPointDataPointData
 
vtkTimeStamp ComputeTime
 
double Bounds [6]
 
double Center [3]
 
double ScalarRange [2]
 
vtkTimeStamp ScalarRangeComputeTime
 
- Protected Attributes inherited from vtkDataObject
vtkFieldDataFieldData
 
vtkSourceSource
 
int DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformationInformation
 
vtkInformationPipelineInformation
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Protected Types inherited from vtkDataObject
typedef
vtkStreamingDemandDrivenPipeline 
SDDP
 
- Static Protected Attributes inherited from vtkDataObject
static const char AssociationNames [NUMBER_OF_ASSOCIATIONS][55]
 
- Friends inherited from vtkObject

Detailed Description

topologically regular array of data

vtkStructuredGrid is a data object that is a concrete implementation of vtkDataSet. vtkStructuredGrid represents a geometric structure that is a topologically regular array of points. The topology is that of a cube that has been subdivided into a regular array of smaller cubes. Each point/cell can be addressed with i-j-k indices. Examples include finite difference grids.

The order and number of points must match that specified by the dimensions of the grid. The point order increases in i fastest (from 0<=i<dims[0]), then j (0<=j<dims[1]), then k (0<=k<dims[2]) where dims[] are the dimensions of the grid in the i-j-k topological directions. The number of points is dims[0]*dims[1]*dims[2]. The same is true for the cells of the grid. The order and number of cells must match that specified by the dimensions of the grid. The cell order increases in i fastest (from 0<=i<(dims[0]-1)), then j (0<=j<(dims[1]-1)), then k (0<=k<(dims[2]-1)) The number of cells is (dims[0]-1)*(dims[1]-1)*(dims[2]-1).

A unusual feature of vtkStructuredGrid is the ability to blank, or "turn-off" points and cells in the dataset. This is controlled by defining a "blanking array" whose values (0,1) specify whether a point should be blanked or not.

Examples:
vtkStructuredGrid (Examples)
Tests:
vtkStructuredGrid (Tests)

Definition at line 62 of file vtkStructuredGrid.h.

Member Typedef Documentation

Definition at line 67 of file vtkStructuredGrid.h.

Constructor & Destructor Documentation

vtkStructuredGrid::vtkStructuredGrid ( )
protected
vtkStructuredGrid::~vtkStructuredGrid ( )
protected

Member Function Documentation

static vtkStructuredGrid* vtkStructuredGrid::New ( )
static
virtual const char* vtkStructuredGrid::GetClassName ( )
virtual

Reimplemented from vtkPointSet.

static int vtkStructuredGrid::IsTypeOf ( const char *  type)
static
virtual int vtkStructuredGrid::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 vtkPointSet.

static vtkStructuredGrid* vtkStructuredGrid::SafeDownCast ( vtkObject o)
static
void vtkStructuredGrid::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

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 vtkPointSet.

int vtkStructuredGrid::GetDataObjectType ( )
inlinevirtual

Return what type of dataset this is.

Reimplemented from vtkDataSet.

Definition at line 71 of file vtkStructuredGrid.h.

void vtkStructuredGrid::CopyStructure ( vtkDataSet ds)
virtual

Copy the geometric and topological structure of an input poly data object.

Reimplemented from vtkPointSet.

vtkIdType vtkStructuredGrid::GetNumberOfPoints ( )
inlinevirtual

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkPointSet.

Definition at line 79 of file vtkStructuredGrid.h.

double* vtkStructuredGrid::GetPoint ( vtkIdType  ptId)
inlinevirtual

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkPointSet.

Definition at line 80 of file vtkStructuredGrid.h.

void vtkStructuredGrid::GetPoint ( vtkIdType  ptId,
double  p[3] 
)
inlinevirtual

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkPointSet.

Definition at line 81 of file vtkStructuredGrid.h.

vtkCell* vtkStructuredGrid::GetCell ( vtkIdType  cellId)
virtual

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

void vtkStructuredGrid::GetCell ( vtkIdType  cellId,
vtkGenericCell cell 
)
virtual

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

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

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkDataSet.

int vtkStructuredGrid::GetCellType ( vtkIdType  cellId)
virtual

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

vtkIdType vtkStructuredGrid::GetNumberOfCells ( )
inlinevirtual

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Definition at line 254 of file vtkStructuredGrid.h.

void vtkStructuredGrid::GetCellPoints ( vtkIdType  cellId,
vtkIdList ptIds 
)
virtual

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

void vtkStructuredGrid::GetPointCells ( vtkIdType  ptId,
vtkIdList cellIds 
)
inlinevirtual

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Definition at line 89 of file vtkStructuredGrid.h.

void vtkStructuredGrid::Initialize ( )
virtual

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkPointSet.

int vtkStructuredGrid::GetMaxCellSize ( )
inlinevirtual

Standard vtkDataSet API methods. See vtkDataSet for more information.

Implements vtkDataSet.

Definition at line 94 of file vtkStructuredGrid.h.

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

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkDataSet.

virtual void vtkStructuredGrid::GetScalarRange ( double  range[2])
virtual

Standard vtkDataSet API methods. See vtkDataSet for more information.

Reimplemented from vtkDataSet.

double* vtkStructuredGrid::GetScalarRange ( )
inline

Standard vtkDataSet API methods. See vtkDataSet for more information.

Definition at line 98 of file vtkStructuredGrid.h.

void vtkStructuredGrid::SetDimensions ( int  i,
int  j,
int  k 
)

following methods are specific to structured grid

void vtkStructuredGrid::SetDimensions ( int  dim[3])

following methods are specific to structured grid

virtual int* vtkStructuredGrid::GetDimensions ( )
virtual

Get dimensions of this structured points dataset.

virtual void vtkStructuredGrid::GetDimensions ( int  dim[3])
virtual

Get dimensions of this structured points dataset.

int vtkStructuredGrid::GetDataDimension ( )
inline

Return the dimensionality of the data.

Definition at line 276 of file vtkStructuredGrid.h.

void vtkStructuredGrid::SetExtent ( int  extent[6])

Different ways to set the extent of the data array. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z).

void vtkStructuredGrid::SetExtent ( int  x1,
int  x2,
int  y1,
int  y2,
int  z1,
int  z2 
)

Different ways to set the extent of the data array. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z).

virtual int* vtkStructuredGrid::GetExtent ( )
virtual

Different ways to set the extent of the data array. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z).

virtual void vtkStructuredGrid::GetExtent ( int &  ,
int &  ,
int &  ,
int &  ,
int &  ,
int &   
)
virtual

Different ways to set the extent of the data array. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z).

virtual void vtkStructuredGrid::GetExtent ( int  [6])
virtual

Different ways to set the extent of the data array. The extent should be set before the "Scalars" are set or allocated. The Extent is stored in the order (X, Y, Z).

unsigned long vtkStructuredGrid::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 vtkPointSet.

void vtkStructuredGrid::ShallowCopy ( vtkDataObject src)
virtual

Shallow and Deep copy.

Reimplemented from vtkPointSet.

void vtkStructuredGrid::DeepCopy ( vtkDataObject src)
virtual

Shallow and Deep copy.

Reimplemented from vtkPointSet.

int vtkStructuredGrid::GetExtentType ( )
inlinevirtual

The extent type is a 3D extent

Reimplemented from vtkDataObject.

Definition at line 139 of file vtkStructuredGrid.h.

void vtkStructuredGrid::BlankPoint ( vtkIdType  ptId)

Methods for supporting blanking of cells. Blanking turns on or off points in the structured grid, and hence the cells connected to them. These methods should be called only after the dimensions of the grid are set.

void vtkStructuredGrid::UnBlankPoint ( vtkIdType  ptId)

Methods for supporting blanking of cells. Blanking turns on or off points in the structured grid, and hence the cells connected to them. These methods should be called only after the dimensions of the grid are set.

void vtkStructuredGrid::BlankCell ( vtkIdType  ptId)

Methods for supporting blanking of cells. Blanking turns on or off cells in the structured grid, and hence the cells connected to them. These methods should be called only after the dimensions of the grid are set.

void vtkStructuredGrid::UnBlankCell ( vtkIdType  ptId)

Methods for supporting blanking of cells. Blanking turns on or off cells in the structured grid, and hence the cells connected to them. These methods should be called only after the dimensions of the grid are set.

vtkUnsignedCharArray* vtkStructuredGrid::GetPointVisibilityArray ( )

Get the array that defines the blanking (visibility) of each point.

void vtkStructuredGrid::SetPointVisibilityArray ( vtkUnsignedCharArray pointVisibility)

Set an array that defines the (blanking) visibility of the points in the grid. Make sure that length of the visibility array matches the number of points in the grid.

vtkUnsignedCharArray* vtkStructuredGrid::GetCellVisibilityArray ( )

Get the array that defines the blanking (visibility) of each cell.

void vtkStructuredGrid::SetCellVisibilityArray ( vtkUnsignedCharArray pointVisibility)

Set an array that defines the (blanking) visibility of the cells in the grid. Make sure that length of the visibility array matches the number of points in the grid.

unsigned char vtkStructuredGrid::IsPointVisible ( vtkIdType  ptId)

Return non-zero value if specified point is visible. These methods should be called only after the dimensions of the grid are set.

unsigned char vtkStructuredGrid::IsCellVisible ( vtkIdType  cellId)

Return non-zero value if specified point is visible. These methods should be called only after the dimensions of the grid are set.

unsigned char vtkStructuredGrid::GetPointBlanking ( )

Returns 1 if there is any visibility constraint on the points, 0 otherwise.

unsigned char vtkStructuredGrid::GetCellBlanking ( )

Returns 1 if there is any visibility constraint on the cells, 0 otherwise.

virtual void vtkStructuredGrid::Crop ( )
virtual

Reallocates and copies to set the Extent to the UpdateExtent. This is used internally when the exact extent is requested, and the source generated more than the update extent.

Reimplemented from vtkDataObject.

static vtkStructuredGrid* vtkStructuredGrid::GetData ( vtkInformation info)
static

Retrieve an instance of this class from an information object.

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

Retrieve an instance of this class from an information object.

void vtkStructuredGrid::GetPoint ( int  i,
int  j,
int  k,
double  p[3],
bool  adjustForExtent = true 
)

Get a point in the grid. If adjustForExtent is true, (i,j,k) is interpreted as a position relative to the beginning of the extent. If adjustForExtent is false, (i,j,k) is interpreted literally and the (i,j,k) point of the grid is returned regardless of the extent beginning. The point coordinate is returned in 'p'. The default adjustForExtent is true.

void vtkStructuredGrid::SetPointVisibility ( vtkStructuredVisibilityConstraint pointVisibility)
protected
virtual vtkStructuredVisibilityConstraint* vtkStructuredGrid::GetPointVisibility ( )
protectedvirtual
void vtkStructuredGrid::SetCellVisibility ( vtkStructuredVisibilityConstraint cellVisibility)
protected
virtual vtkStructuredVisibilityConstraint* vtkStructuredGrid::GetCellVisibility ( )
protectedvirtual

Member Data Documentation

vtkVertex* vtkStructuredGrid::Vertex
protected

Definition at line 217 of file vtkStructuredGrid.h.

vtkLine* vtkStructuredGrid::Line
protected

Definition at line 218 of file vtkStructuredGrid.h.

vtkQuad* vtkStructuredGrid::Quad
protected

Definition at line 219 of file vtkStructuredGrid.h.

vtkHexahedron* vtkStructuredGrid::Hexahedron
protected

Definition at line 220 of file vtkStructuredGrid.h.

vtkEmptyCell* vtkStructuredGrid::EmptyCell
protected

Definition at line 221 of file vtkStructuredGrid.h.

int vtkStructuredGrid::Dimensions[3]
protected

Definition at line 223 of file vtkStructuredGrid.h.

int vtkStructuredGrid::DataDescription
protected

Definition at line 224 of file vtkStructuredGrid.h.

int vtkStructuredGrid::Extent[6]
protected

Definition at line 226 of file vtkStructuredGrid.h.

vtkStructuredVisibilityConstraint* vtkStructuredGrid::PointVisibility
protected

Definition at line 228 of file vtkStructuredGrid.h.

vtkStructuredVisibilityConstraint* vtkStructuredGrid::CellVisibility
protected

Definition at line 231 of file vtkStructuredGrid.h.


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