#include <vtkAMRBox.h>
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.
Definition at line 42 of file vtkAMRBox.h.
Public Member Functions | |
| vtkAMRBox (int dim=3) | |
| vtkAMRBox (const vtkAMRBox &other) | |
| vtkAMRBox & | operator= (const vtkAMRBox &other) |
| void | Invalidate () |
| 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 | GetBoxOrigin (double x0[3]) const |
| void | Grow (int byN) |
| void | Shrink (int byN) |
| bool | Empty () const |
| bool | operator== (const vtkAMRBox &other) |
| void | operator &= (const vtkAMRBox &rhs) |
| bool | Contains (const vtkAMRBox &other) const |
| void | Refine (int r) |
| void | Coarsen (int r) |
| ostream & | Print (ostream &os) const |
| int | DoesContainCell (int i, int j, int k) |
| int | DoesContainBox (vtkAMRBox const &box) const |
| 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]) | |
| int | GetDimensionality () const |
| void | SetDimensionality (int dim) |
| void | SetDimensions (int ilo, int jlo, int klo, int ihi, int jhi, int khi) |
| 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 | Shift (int i, int j) |
| void | Shift (int i, int j, int k) |
| void | Shift (const int I[3]) |
| bool | Contains (int i, int j, int k) const |
| bool | Contains (const int I[3]) const |
Public Attributes | |
| int | LoCorner [3] |
| int | HiCorner [3] |
| vtkAMRBox::vtkAMRBox | ( | int | dim = 3 |
) |
Construct the empty box.
| vtkAMRBox::vtkAMRBox | ( | int | ilo, | |
| int | jlo, | |||
| int | klo, | |||
| int | ihi, | |||
| int | jhi, | |||
| int | khi | |||
| ) |
Construct a specific 3D box.
| vtkAMRBox::vtkAMRBox | ( | int | ilo, | |
| int | jlo, | |||
| int | ihi, | |||
| int | jhi | |||
| ) |
Construct a specific 2D box.
| vtkAMRBox::vtkAMRBox | ( | int | dim, | |
| const int | lo[3], | |||
| const int | hi[3] | |||
| ) |
Construct a specific box. (ilo,jlo,klo,)(ihi,jhi,khi)
| vtkAMRBox::vtkAMRBox | ( | const int | lo[3], | |
| const int | hi[3] | |||
| ) |
Construct a specific box. (ilo,jlo,klo,)(ihi,jhi,khi)
| vtkAMRBox::vtkAMRBox | ( | int | dim, | |
| const int | dims[6] | |||
| ) |
Construct a specific box. (ilo,ihi, jlo,jhi, klo,khi)
| vtkAMRBox::vtkAMRBox | ( | const int | dims[6] | ) |
Construct a specific box. (ilo,ihi, jlo,jhi, klo,khi)
| vtkAMRBox::vtkAMRBox | ( | const vtkAMRBox & | other | ) |
Copy construct this box from another.
| void vtkAMRBox::Invalidate | ( | ) |
Set the box to null;
| int vtkAMRBox::GetDimensionality | ( | ) | const [inline] |
Get/Set the spatial dimension of the box. Only 2 and 3 are valid.
Definition at line 85 of file vtkAMRBox.h.
| void vtkAMRBox::SetDimensionality | ( | int | dim | ) |
Get/Set the spatial dimension of the box. Only 2 and 3 are valid.
| void vtkAMRBox::SetDimensions | ( | int | ilo, | |
| int | jlo, | |||
| int | klo, | |||
| int | ihi, | |||
| int | jhi, | |||
| int | khi | |||
| ) |
Set the dimensions of the box. ilo,jlo,klo,ihi,jhi,khi
| void vtkAMRBox::SetDimensions | ( | const int | lo[3], | |
| const int | hi[3] | |||
| ) |
Set the dimensions of the box. (ilo,jlo,klo),(ihi,jhi,khi)
| void vtkAMRBox::SetDimensions | ( | const int | dims[6] | ) |
Set the dimensions of the box. (ilo,ihi,jlo,jhi,klo,khi)
| void vtkAMRBox::GetDimensions | ( | int | lo[3], | |
| int | hi[3] | |||
| ) | const |
Get the dimensions of this box. (ilo,jlo,jhi),(ihi,jhi,khi)
| void vtkAMRBox::GetDimensions | ( | int | dims[6] | ) | const |
Get the dimensions of this box. (ilo,ihi, jlo,jhi, klo,khi)
| void vtkAMRBox::GetLoCorner | ( | int | lo[3] | ) | const |
Get the low corner index.
| const int* vtkAMRBox::GetLoCorner | ( | ) | const [inline] |
Get the low corner index.
Definition at line 111 of file vtkAMRBox.h.
| void vtkAMRBox::GetHiCorner | ( | int | hi[3] | ) | const |
Copy the high corner index.
| const int* vtkAMRBox::GetHiCorner | ( | ) | const [inline] |
Copy the high corner index.
Definition at line 117 of file vtkAMRBox.h.
| void vtkAMRBox::GetNumberOfCells | ( | int | ext[3] | ) | const |
Gets the number of cells enclosed by the box.
| vtkIdType vtkAMRBox::GetNumberOfCells | ( | ) | const |
Gets the number of cells enclosed by the box.
| void vtkAMRBox::GetNumberOfNodes | ( | int | ext[3] | ) | const |
Gets the number of nodes required to construct a physical representation of the box.
| vtkIdType vtkAMRBox::GetNumberOfNodes | ( | ) | const |
Gets the number of nodes required to construct a physical representation of the box.
| const double* vtkAMRBox::GetGridSpacing | ( | ) | const [inline] |
Set/Get grid spacing. Refine/coarsen operations update the grid spacing.
Definition at line 136 of file vtkAMRBox.h.
| void vtkAMRBox::GetGridSpacing | ( | double | dX[3] | ) | const |
Set/Get grid spacing. Refine/coarsen operations update the grid spacing.
| void vtkAMRBox::SetGridSpacing | ( | double | dx | ) |
Set/Get grid spacing. Refine/coarsen operations update the grid spacing.
| void vtkAMRBox::SetGridSpacing | ( | const double | dX[3] | ) |
Set/Get grid spacing. Refine/coarsen operations update the grid spacing.
| void vtkAMRBox::SetGridSpacing | ( | double | dx, | |
| double | dy, | |||
| double | dz | |||
| ) |
Set/Get grid spacing. Refine/coarsen operations update the grid spacing.
| const double* vtkAMRBox::GetDataSetOrigin | ( | ) | const [inline] |
Set/Get world space origin of the data set, The origin is the location of the low corner cell's low corner node of the data set. Which is not necessarilly the origin of this box! For that use GetBoxOrigin().
Definition at line 148 of file vtkAMRBox.h.
| void vtkAMRBox::GetDataSetOrigin | ( | double | X0[3] | ) | const |
Set/Get world space origin of the data set, The origin is the location of the low corner cell's low corner node of the data set. Which is not necessarilly the origin of this box! For that use GetBoxOrigin().
| void vtkAMRBox::SetDataSetOrigin | ( | const double | X0[3] | ) |
Set/Get world space origin of the data set, The origin is the location of the low corner cell's low corner node of the data set. Which is not necessarilly the origin of this box! For that use GetBoxOrigin().
| void vtkAMRBox::SetDataSetOrigin | ( | double | x0, | |
| double | y0, | |||
| double | z0 | |||
| ) |
Set/Get world space origin of the data set, The origin is the location of the low corner cell's low corner node of the data set. Which is not necessarilly the origin of this box! For that use GetBoxOrigin().
| void vtkAMRBox::GetBoxOrigin | ( | double | x0[3] | ) | const |
Get the world space origin of this box. The origin is the location of the lower corner cell's lower corner node, which is not necessarilly the orgin of the data set! For that use GetDataSetOrigin(). The value is computed each time, so that operations on the box are are appropriately reflected.
| void vtkAMRBox::Grow | ( | int | byN | ) |
Grows the box in all directions.
| void vtkAMRBox::Shrink | ( | int | byN | ) |
Shrinks the box in all directions.
| void vtkAMRBox::Shift | ( | int | i, | |
| int | j | |||
| ) |
Shifts the box in index space.
| void vtkAMRBox::Shift | ( | int | i, | |
| int | j, | |||
| int | k | |||
| ) |
Shifts the box in index space.
| void vtkAMRBox::Shift | ( | const int | I[3] | ) |
Shifts the box in index space.
| bool vtkAMRBox::Empty | ( | ) | const |
Test if this box is empty/valid.
| bool vtkAMRBox::operator== | ( | const vtkAMRBox & | other | ) |
Test if this box has the same dimensions as another.
| void vtkAMRBox::operator &= | ( | const vtkAMRBox & | rhs | ) |
Intersect this box with another box in place.
| bool vtkAMRBox::Contains | ( | int | i, | |
| int | j, | |||
| int | k | |||
| ) | const |
Test to see if a given cell index is inside this box.
| bool vtkAMRBox::Contains | ( | const int | I[3] | ) | const |
Test to see if a given cell index is inside this box.
| bool vtkAMRBox::Contains | ( | const vtkAMRBox & | other | ) | const |
Test to see if a given box is inside this box.
| void vtkAMRBox::Refine | ( | int | r | ) |
Refine the box.
| void vtkAMRBox::Coarsen | ( | int | r | ) |
Coarsen the box.
| ostream& vtkAMRBox::Print | ( | ostream & | os | ) | const |
Send the box to a stream. "(ilo,jlo,jhi),(ihi,jhi,khi)"
| int vtkAMRBox::DoesContainCell | ( | int | i, | |
| int | j, | |||
| int | k | |||
| ) |
| int vtkAMRBox::DoesContainBox | ( | vtkAMRBox const & | box | ) | const |
| int vtkAMRBox::LoCorner[3] |
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 216 of file vtkAMRBox.h.
| int vtkAMRBox::HiCorner[3] |
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 217 of file vtkAMRBox.h.
1.5.6