vtkAMRBox Class Reference

#include <vtkAMRBox.h>

List of all members.


Detailed Description

Encloses a rectangular region of voxel like cells.

vtkAMRBox represents a collection of voxel like cells that fill a rectangular region. It's purpose is to facilitate manipulation of cell data arrays and the blocks that they are defined on.

The vtkAMRBox can be either 2D or 3D. For 2D grids, pointers passed in are assumed to be 2 units. The default is 3D.

vtkAMRBox is used in vtkHierarchicalBoxDataSet to compute cell visibilty.

See also:
vtkHierarachicalBoxDataSet, vtkAMRBoxUtilities.hxx
Tests:
vtkAMRBox (Tests)

Definition at line 42 of file vtkAMRBox.h.


Public Member Functions

int DoesContainCell (int i, int j, int k)
int DoesContainBox (vtkAMRBox const &box) const
 vtkAMRBox (int dim=3)
 vtkAMRBox (int ilo, int jlo, int klo, int ihi, int jhi, int khi)
 vtkAMRBox (int ilo, int jlo, int ihi, int jhi)
 vtkAMRBox (int dim, const int lo[3], const int hi[3])
 vtkAMRBox (const int lo[3], const int hi[3])
 vtkAMRBox (int dim, const int dims[6])
 vtkAMRBox (const int dims[6])
 vtkAMRBox (const vtkAMRBox &other)
vtkAMRBoxoperator= (const vtkAMRBox &other)
void Invalidate ()
int GetDimensionality () const
void SetDimensionality (int dim)
void SetDimensions (int ilo, int jlo, int klo, int ihi, int jhi, int khi)
void SetDimensions (const int lo[3], const int hi[3])
void SetDimensions (const int dims[6])
void GetDimensions (int lo[3], int hi[3]) const
void GetDimensions (int dims[6]) const
void GetLoCorner (int lo[3]) const
const int * GetLoCorner () const
void GetHiCorner (int hi[3]) const
const int * GetHiCorner () const
void GetNumberOfCells (int ext[3]) const
vtkIdType GetNumberOfCells () const
void GetNumberOfNodes (int ext[3]) const
vtkIdType GetNumberOfNodes () const
const double * GetGridSpacing () const
void GetGridSpacing (double dX[3]) const
void SetGridSpacing (double dx)
void SetGridSpacing (const double dX[3])
void SetGridSpacing (double dx, double dy, double dz)
const double * GetDataSetOrigin () const
void GetDataSetOrigin (double X0[3]) const
void SetDataSetOrigin (const double X0[3])
void SetDataSetOrigin (double x0, double y0, double z0)
void GetBoxOrigin (double x0[3]) const
void Grow (int byN)
void Shrink (int byN)
void Shift (int i, int j)
void Shift (int i, int j, int k)
void Shift (const int I[3])
bool Empty () const
bool operator== (const vtkAMRBox &other)
void operator &= (const vtkAMRBox &rhs)
bool Contains (int i, int j, int k) const
bool Contains (const int I[3]) const
bool Contains (const vtkAMRBox &other) const
void Refine (int r)
void Coarsen (int r)
ostream & Print (ostream &os) const

Public Attributes

int LoCorner [3]
int HiCorner [3]

Constructor & Destructor Documentation

vtkAMRBox::vtkAMRBox ( int  dim = 3  ) 

Construct the empty box.

vtkAMRBox::vtkAMRBox ( int  ilo,
int  jlo,
int  klo,
int  ihi,
int  jhi,
int  khi 
)

Construct the empty box.

vtkAMRBox::vtkAMRBox ( int  ilo,
int  jlo,
int  ihi,
int  jhi 
)

Construct the empty box.

vtkAMRBox::vtkAMRBox ( int  dim,
const int  lo[3],
const int  hi[3] 
)

Construct the empty box.

vtkAMRBox::vtkAMRBox ( const int  lo[3],
const int  hi[3] 
)

Construct the empty box.

vtkAMRBox::vtkAMRBox ( int  dim,
const int  dims[6] 
)

Construct the empty box.

vtkAMRBox::vtkAMRBox ( const int  dims[6]  ) 

Construct the empty box.

vtkAMRBox::vtkAMRBox ( const vtkAMRBox other  ) 

Construct the empty box.


Member Function Documentation

vtkAMRBox& vtkAMRBox::operator= ( const vtkAMRBox other  ) 

Construct the empty box.

void vtkAMRBox::Invalidate (  ) 

Construct the empty box.

int vtkAMRBox::GetDimensionality (  )  const [inline]

Construct the empty box.

Definition at line 78 of file vtkAMRBox.h.

void vtkAMRBox::SetDimensionality ( int  dim  ) 

Construct the empty box.

void vtkAMRBox::SetDimensions ( int  ilo,
int  jlo,
int  klo,
int  ihi,
int  jhi,
int  khi 
)

Construct the empty box.

void vtkAMRBox::SetDimensions ( const int  lo[3],
const int  hi[3] 
)

Construct the empty box.

void vtkAMRBox::SetDimensions ( const int  dims[6]  ) 

Construct the empty box.

void vtkAMRBox::GetDimensions ( int  lo[3],
int  hi[3] 
) const

Construct the empty box.

void vtkAMRBox::GetDimensions ( int  dims[6]  )  const

Construct the empty box.

void vtkAMRBox::GetLoCorner ( int  lo[3]  )  const

Construct the empty box.

const int* vtkAMRBox::GetLoCorner (  )  const [inline]

Construct the empty box.

Definition at line 100 of file vtkAMRBox.h.

void vtkAMRBox::GetHiCorner ( int  hi[3]  )  const

Construct the empty box.

const int* vtkAMRBox::GetHiCorner (  )  const [inline]

Construct the empty box.

Definition at line 104 of file vtkAMRBox.h.

void vtkAMRBox::GetNumberOfCells ( int  ext[3]  )  const

Construct the empty box.

vtkIdType vtkAMRBox::GetNumberOfCells (  )  const

Construct the empty box.

void vtkAMRBox::GetNumberOfNodes ( int  ext[3]  )  const

Construct the empty box.

vtkIdType vtkAMRBox::GetNumberOfNodes (  )  const

Construct the empty box.

const double* vtkAMRBox::GetGridSpacing (  )  const [inline]

Construct the empty box.

Definition at line 117 of file vtkAMRBox.h.

void vtkAMRBox::GetGridSpacing ( double  dX[3]  )  const

Construct the empty box.

void vtkAMRBox::SetGridSpacing ( double  dx  ) 

Construct the empty box.

void vtkAMRBox::SetGridSpacing ( const double  dX[3]  ) 

Construct the empty box.

void vtkAMRBox::SetGridSpacing ( double  dx,
double  dy,
double  dz 
)

Construct the empty box.

const double* vtkAMRBox::GetDataSetOrigin (  )  const [inline]

Construct the empty box.

Definition at line 127 of file vtkAMRBox.h.

void vtkAMRBox::GetDataSetOrigin ( double  X0[3]  )  const

Construct the empty box.

void vtkAMRBox::SetDataSetOrigin ( const double  X0[3]  ) 

Construct the empty box.

void vtkAMRBox::SetDataSetOrigin ( double  x0,
double  y0,
double  z0 
)

Construct the empty box.

void vtkAMRBox::GetBoxOrigin ( double  x0[3]  )  const

Construct the empty box.

void vtkAMRBox::Grow ( int  byN  ) 

Construct the empty box.

void vtkAMRBox::Shrink ( int  byN  ) 

Construct the empty box.

void vtkAMRBox::Shift ( int  i,
int  j 
)

Construct the empty box.

void vtkAMRBox::Shift ( int  i,
int  j,
int  k 
)

Construct the empty box.

void vtkAMRBox::Shift ( const int  I[3]  ) 

Construct the empty box.

bool vtkAMRBox::Empty (  )  const

Construct the empty box.

bool vtkAMRBox::operator== ( const vtkAMRBox other  ) 

Construct the empty box.

void vtkAMRBox::operator &= ( const vtkAMRBox rhs  ) 

Construct the empty box.

bool vtkAMRBox::Contains ( int  i,
int  j,
int  k 
) const

Construct the empty box.

bool vtkAMRBox::Contains ( const int  I[3]  )  const

Construct the empty box.

bool vtkAMRBox::Contains ( const vtkAMRBox other  )  const

Construct the empty box.

void vtkAMRBox::Refine ( int  r  ) 

Construct the empty box.

void vtkAMRBox::Coarsen ( int  r  ) 

Construct the empty box.

ostream& vtkAMRBox::Print ( ostream &  os  )  const

Construct the empty box.

int vtkAMRBox::DoesContainCell ( int  i,
int  j,
int  k 
)

int vtkAMRBox::DoesContainBox ( vtkAMRBox const &  box  )  const


Member Data Documentation

These are public for backward compatibility only. If your code uses these, it will break in the future when this class is fixed. Use the above Set/Get'ers. See Get/SetDimensions, Get/SetXCorner, and the many constructors above.

Definition at line 191 of file vtkAMRBox.h.

These are public for backward compatibility only. If your code uses these, it will break in the future when this class is fixed. Use the above Set/Get'ers. See Get/SetDimensions, Get/SetXCorner, and the many constructors above.

Definition at line 192 of file vtkAMRBox.h.


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

Generated on Wed Jun 3 18:53:02 2009 for VTK by  doxygen 1.5.6