a dataset that is topologically regular with variable spacing in the three coordinate directions More...

#include <vtkRectilinearGrid.h>

Inheritance diagram for vtkRectilinearGrid:

Collaboration diagram for vtkRectilinearGrid:

Public Types
typedef vtkDataSet	Superclass

Public Types inherited from vtkDataSet
enum	FieldDataType { DATA_OBJECT_FIELD =0, POINT_DATA_FIELD =1, CELL_DATA_FIELD =2 }

typedef vtkDataObject	Superclass

Public Types inherited from vtkDataObject
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)

vtkRectilinearGrid *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

int	GetDataObjectType ()

void	CopyStructure (vtkDataSet *ds)

void	Initialize ()

void	GetPoints (vtkPoints *pnts)

int	GetDataDimension ()

int	ComputeStructuredCoordinates (double x[3], int ijk[3], double pcoords[3])

vtkIdType	ComputePointId (int ijk[3])

vtkIdType	ComputeCellId (int ijk[3])

void	GetPoint (const int i, const int j, const int k, double p[3])

unsigned long	GetActualMemorySize ()

int	GetExtentType ()

virtual void	Crop (const int *updateExtent)


vtkIdType	GetNumberOfCells ()

vtkIdType	GetNumberOfPoints ()

double *	GetPoint (vtkIdType ptId)

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

vtkCell *	GetCell (vtkIdType cellId)

void	GetCell (vtkIdType cellId, vtkGenericCell *cell)

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

vtkIdType	FindPoint (double x, double y, double z)

vtkIdType	FindPoint (double x[3])

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

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

vtkCell *	FindAndGetCell (double x[3], vtkCell cell, vtkIdType cellId, double tol2, int &subId, double pcoords[3], double weights)

int	GetCellType (vtkIdType cellId)

void	GetCellPoints (vtkIdType cellId, vtkIdList *ptIds)

void	GetPointCells (vtkIdType ptId, vtkIdList *cellIds)

void	ComputeBounds ()

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 data[3])


virtual void	SetXCoordinates (vtkDataArray *)

virtual vtkDataArray *	GetXCoordinates ()


virtual void	SetYCoordinates (vtkDataArray *)

virtual vtkDataArray *	GetYCoordinates ()


virtual void	SetZCoordinates (vtkDataArray *)

virtual vtkDataArray *	GetZCoordinates ()


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)

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

virtual void	CopyAttributes (vtkDataSet *ds)

virtual vtkCellIterator *	NewCellIterator ()

virtual void	GetCellTypes (vtkCellTypes *types)

unsigned long int	GetMTime ()

vtkCellData *	GetCellData ()

vtkPointData *	GetPointData ()

virtual void	Squeeze ()

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 void	GenerateGhostArray (int zeroExt[6])

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

virtual bool	HasAnyBlankCells ()

virtual bool	HasAnyBlankPoints ()

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)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

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

static int	IsTypeOf (const char *type)

static vtkRectilinearGrid *	SafeDownCast (vtkObjectBase *o)


static vtkRectilinearGrid *	GetData (vtkInformation *info)

static vtkRectilinearGrid *	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

	vtkRectilinearGrid ()

	~vtkRectilinearGrid ()

Protected Member Functions inherited from vtkDataSet
	vtkDataSet ()

	~vtkDataSet ()

virtual void	ComputeScalarRange ()

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

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkVertex *	Vertex

vtkLine *	Line

vtkPixel *	Pixel

vtkVoxel *	Voxel

int	Dimensions [3]

int	DataDescription

int	Extent [6]

vtkDataArray *	XCoordinates

vtkDataArray *	YCoordinates

vtkDataArray *	ZCoordinates

double	PointReturn [3]

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

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

a dataset that is topologically regular with variable spacing in the three coordinate directions

vtkRectilinearGrid is a data object that is a concrete implementation of vtkDataSet. vtkRectilinearGrid represents a geometric structure that is topologically regular with variable spacing in the three coordinate directions x-y-z.

To define a vtkRectilinearGrid, you must specify the dimensions of the data and provide three arrays of values specifying the coordinates along the x-y-z axes. The coordinate arrays are specified using three vtkDataArray objects (one for x, one for y, one for z).

Warning: Make sure that the dimensions of the grid match the number of coordinates in the x-y-z directions. If not, unpredictable results (including program failure) may result. Also, you must supply coordinates in all three directions, even if the dataset topology is 2D, 1D, or 0D.

Examples:: vtkRectilinearGrid (Examples)

Tests:: vtkRectilinearGrid (Tests)

Definition at line 55 of file vtkRectilinearGrid.h.

Member Typedef Documentation

typedef vtkDataSet vtkRectilinearGrid::Superclass

Definition at line 60 of file vtkRectilinearGrid.h.

Constructor & Destructor Documentation

vtkRectilinearGrid::vtkRectilinearGrid ( )

protected

vtkRectilinearGrid::~vtkRectilinearGrid ( )

protected

Member Function Documentation

static vtkRectilinearGrid* vtkRectilinearGrid::New ( )

static

static int vtkRectilinearGrid::IsTypeOf ( const char * type )

static

virtual int vtkRectilinearGrid::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataSet.

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

static

virtual vtkObjectBase* vtkRectilinearGrid::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDataSet.

vtkRectilinearGrid* vtkRectilinearGrid::NewInstance ( ) const

void vtkRectilinearGrid::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 vtkDataSet.

int vtkRectilinearGrid::GetDataObjectType ( )

inlinevirtual

Return what type of dataset this is.

Reimplemented from vtkDataSet.

Definition at line 64 of file vtkRectilinearGrid.h.

void vtkRectilinearGrid::CopyStructure ( vtkDataSet * ds )

virtual

Copy the geometric and topological structure of an input rectilinear grid object.

Implements vtkDataSet.

void vtkRectilinearGrid::Initialize ( )

virtual

Restore object to initial state. Release memory back to system.

Reimplemented from vtkDataSet.

vtkIdType vtkRectilinearGrid::GetNumberOfCells ( )

inlinevirtual