topologically regular array of data More...

#include <vtkStructuredGrid.h>

Inheritance diagram for vtkStructuredGrid:

Collaboration diagram for vtkStructuredGrid:

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 int	IsA (const char *type)

vtkStructuredGrid *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

int	GetDataObjectType ()

void	CopyStructure (vtkDataSet *ds)

int	GetDataDimension ()

unsigned long	GetActualMemorySize ()

int	GetExtentType ()

unsigned char	IsPointVisible (vtkIdType ptId)

unsigned char	IsCellVisible (vtkIdType cellId)

virtual bool	HasAnyBlankPoints ()

virtual bool	HasAnyBlankCells ()

void	GetCellDims (int cellDims[3])

virtual void	Crop (const int *updateExtent)

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)


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
vtkPointSet *	NewInstance () const

vtkCellIterator *	NewCellIterator ()

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 vtkPoints *	GetPoints ()

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

Public Member Functions inherited from vtkDataSet
vtkDataSet *	NewInstance () const

virtual void	CopyAttributes (vtkDataSet *ds)

virtual void	GetCellTypes (vtkCellTypes *types)

vtkCellData *	GetCellData ()

vtkPointData *	GetPointData ()

double *	GetBounds ()

void	GetBounds (double bounds[6])

double *	GetCenter ()

void	GetCenter (double center[3])

double	GetLength ()

virtual void	GetScalarRange (double range[2])

double *	GetScalarRange ()

int	CheckAttributes ()

virtual vtkFieldData *	GetAttributesAsFieldData (int type)

virtual vtkIdType	GetNumberOfElements (int type)

bool	HasAnyGhostCells ()

bool	HasAnyGhostPoints ()

vtkUnsignedCharArray *	GetPointGhostArray ()

void	UpdatePointGhostArrayCache ()

vtkUnsignedCharArray *	AllocatePointGhostArray ()

vtkUnsignedCharArray *	GetCellGhostArray ()

void	UpdateCellGhostArrayCache ()

vtkUnsignedCharArray *	AllocateCellGhostArray ()

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)

virtual void	GenerateGhostArray (int zeroExt[6])

virtual void	GenerateGhostArray (int zeroExt[6], bool cellOnly)

Public Member Functions inherited from vtkDataObject
vtkDataObject *	NewInstance () const

void	ReleaseData ()

unsigned long	GetUpdateTime ()

virtual void	CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))

void	DataHasBeenGenerated ()

virtual void	PrepareForNewData ()

virtual vtkDataSetAttributes *	GetAttributes (int type)

virtual int	GetAttributeTypeForArray (vtkAbstractArray *arr)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

virtual int	GetDataReleased ()

virtual void	SetFieldData (vtkFieldData *)

virtual vtkFieldData *	GetFieldData ()

virtual void	CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))

void	GlobalReleaseDataFlagOn ()

void	GlobalReleaseDataFlagOff ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool 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)

vtkCommand *	GetCommand (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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(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 &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkStructuredGrid *	New ()

static int	IsTypeOf (const char *type)

static vtkStructuredGrid *	SafeDownCast (vtkObjectBase *o)


static vtkStructuredGrid *	GetData (vtkInformation *info)

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

Static Public Member Functions inherited from vtkPointSet
static int	IsTypeOf (const char *type)

static vtkPointSet *	SafeDownCast (vtkObjectBase *o)

static vtkPointSet *	GetData (vtkInformation *info)

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

Static Public Member Functions inherited from vtkDataSet
static int	IsTypeOf (const char *type)

static vtkDataSet *	SafeDownCast (vtkObjectBase *o)

static vtkDataSet *	GetData (vtkInformation *info)

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

Static Public Member Functions inherited from vtkDataObject
static vtkDataObject *	New ()

static int	IsTypeOf (const char *type)

static vtkDataObject *	SafeDownCast (vtkObjectBase *o)

static const char *	GetAssociationTypeAsString (int associationType)

static int	GetAssociationTypeFromString (const char *associationType)

static vtkInformationStringKey *	DATA_TYPE_NAME ()

static vtkInformationDataObjectKey *	DATA_OBJECT ()

static vtkInformationIntegerKey *	DATA_EXTENT_TYPE ()

static vtkInformationIntegerPointerKey *	DATA_EXTENT ()

static vtkInformationIntegerVectorKey *	ALL_PIECES_EXTENT ()

static vtkInformationIntegerKey *	DATA_PIECE_NUMBER ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_PIECES ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_GHOST_LEVELS ()

static vtkInformationDoubleKey *	DATA_TIME_STEP ()

static vtkInformationInformationVectorKey *	POINT_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	CELL_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	VERTEX_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	EDGE_DATA_VECTOR ()

static vtkInformationIntegerKey *	FIELD_ARRAY_TYPE ()

static vtkInformationIntegerKey *	FIELD_ASSOCIATION ()

static vtkInformationIntegerKey *	FIELD_ATTRIBUTE_TYPE ()

static vtkInformationIntegerKey *	FIELD_ACTIVE_ATTRIBUTE ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_COMPONENTS ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_TUPLES ()

static vtkInformationIntegerKey *	FIELD_OPERATION ()

static vtkInformationDoubleVectorKey *	FIELD_RANGE ()

static vtkInformationIntegerVectorKey *	PIECE_EXTENT ()

static vtkInformationStringKey *	FIELD_NAME ()

static vtkInformationDoubleVectorKey *	ORIGIN ()

static vtkInformationDoubleVectorKey *	SPACING ()

static vtkInformationDoubleVectorKey *	BOUNDING_BOX ()

static vtkInformationDataObjectKey *	SIL ()

static vtkInformation *	GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)

static vtkInformation *	GetNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)

static void	RemoveNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)

static vtkInformation *	SetActiveAttribute (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 vtkDataObject *	GetData (vtkInformation *info)

static vtkDataObject *	GetData (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 vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

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 vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkStructuredGrid ()

	~vtkStructuredGrid ()

virtual void	ComputeScalarRange ()

Protected Member Functions inherited from vtkPointSet
	vtkPointSet ()

	~vtkPointSet ()

virtual void	ReportReferences (vtkGarbageCollector *)

Protected Member Functions inherited from vtkDataSet
	vtkDataSet ()

	~vtkDataSet ()

bool	IsAnyBitSet (vtkUnsignedCharArray *a, int bitFlag)

Protected Member Functions inherited from vtkDataObject
	vtkDataObject ()

	~vtkDataObject ()

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 &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkVertex *	Vertex

vtkLine *	Line

vtkQuad *	Quad

vtkHexahedron *	Hexahedron

vtkEmptyCell *	EmptyCell

int	Dimensions [3]

int	DataDescription

int	Extent [6]

Protected Attributes inherited from vtkPointSet
vtkPoints *	Points

vtkPointLocator *	Locator

Protected Attributes inherited from vtkDataSet
vtkCellData *	CellData

vtkPointData *	PointData

vtkCallbackCommand *	DataObserver

vtkTimeStamp	ComputeTime

double	Bounds [6]

double	Center [3]

double	ScalarRange [2]

vtkTimeStamp	ScalarRangeComputeTime

vtkUnsignedCharArray *	PointGhostArray

vtkUnsignedCharArray *	CellGhostArray

bool	PointGhostArrayCached

bool	CellGhostArrayCached

Protected Attributes inherited from vtkDataObject
vtkFieldData *	FieldData

int	DataReleased

vtkTimeStamp	UpdateTime

vtkInformation *	Information

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

vtkStructuredGrid has the ability to blank, or "turn-off" points and cells in the dataset. This is done by setting vtkDataSetAttributes::HIDDENPOINT or vtkDataSetAttributes::HIDDENCELL in the ghost array for each point / cell that needs to be blanked.

Examples:: vtkStructuredGrid (Examples)

Tests:: vtkStructuredGrid (Tests)

Definition at line 62 of file vtkStructuredGrid.h.

Member Typedef Documentation

typedef vtkPointSet vtkStructuredGrid::Superclass

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

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 ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkStructuredGrid::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkPointSet.

vtkStructuredGrid* vtkStructuredGrid::NewInstance ( ) const

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