spatialSubdivision.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2004 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/

#ifndef spatialSubdivision_H_
#define spatialSubdivision_H_

#include "geometry/point.h"
#include "geometry/extent.h"

#include <vlutil/vlConfig.h> 
#include <list>
#include <vector>
#include <assert.h>

#include <vlutil/vlPrint.h>

class DtGdbNode;

template <typename T>
class DtSpatialSubdivision
{
public:
   typedef std::list<T> DtSpatialSubCellType;
   typedef typename DtSpatialSubCellType::iterator DtSpatialSubCellIter;
   typedef typename DtSpatialSubCellType::const_iterator DtSpatialSubCellConstIter;

   typedef int DtSpatialSubCellIndex;
   
   typedef typename std::vector< DtSpatialSubCellType >::iterator DtSpatialSubIter;
   typedef typename std::vector< DtSpatialSubCellType >::const_iterator DtSpatialSubConstIter;


   DtSpatialSubdivision(const DtPoint& origin, 
                        unsigned int cellCountX, 
                        unsigned int cellCountY, 
                        unsigned int cellCountZ,
                        double cellDx, 
                        double cellDy, 
                        double cellDz);

   explicit DtSpatialSubdivision(DtExtent extent, 
                                 unsigned int cellCountX, 
                                 unsigned int cellCountY, 
                                 unsigned int cellCountZ = 1);

   explicit DtSpatialSubdivision(DtExtent extent, 
                                 double cellDx, 
                                 double cellDy,
                                 double cellDz = -1.0);

   virtual ~DtSpatialSubdivision();

public:

   virtual void setExtent(DtExtent extent);

   virtual void setResolutions(unsigned int cellCountX, unsigned int cellCountY, 
      unsigned int cellCountZ = 1);

   virtual void resize(DtExtent extent, unsigned int cellCountX, 
                       unsigned int cellCountY, unsigned int cellCountZ);

   virtual void clear();

   virtual void clearCell(DtSpatialSubIter& cellIter);
   virtual void clearCell(DtSpatialSubIter& startIter, DtSpatialSubIter& endIter);

   virtual bool empty() const;

   virtual unsigned int size() const;

   //
   // Accessors
   //

   virtual DtSpatialSubIter begin();
   virtual DtSpatialSubConstIter begin() const;

   virtual DtSpatialSubIter end();
   virtual DtSpatialSubConstIter end() const;


   virtual DtSpatialSubCellType& at(DtSpatialSubCellIndex index);
   virtual const DtSpatialSubCellType& at(DtSpatialSubCellIndex index) const;

   virtual DtSpatialSubCellType& at(DtSpatialSubCellIndex xIndex, 
      DtSpatialSubCellIndex yIndex, DtSpatialSubCellIndex zIndex);
   virtual const DtSpatialSubCellType& at(DtSpatialSubCellIndex xIndex, 
      DtSpatialSubCellIndex yIndex, DtSpatialSubCellIndex zIndex) const;


   virtual DtSpatialSubCellType& operator[](DtSpatialSubCellIndex index);
   virtual const DtSpatialSubCellType& operator[](DtSpatialSubCellIndex index) const;



   virtual DtSpatialSubCellType& front();
   virtual const DtSpatialSubCellType& front() const;

   virtual DtSpatialSubCellType& back();
   virtual const DtSpatialSubCellType& back() const;


   virtual const DtPoint& origin() const;
   virtual void setOrigin(const DtPoint& newOrigin);


   virtual unsigned int cellCountX() const;
   virtual unsigned int cellCountY() const;
   virtual unsigned int cellCountZ() const;


   virtual double cellDx() const;
   virtual double cellDy() const;
   virtual double cellDz() const;


   virtual bool cell(double x, double y, double z, DtSpatialSubCellType*& cell);
   virtual bool cell(double x, double y, double z, const DtSpatialSubCellType*& cell) const;

   virtual bool cell(const DtPoint& containing, DtSpatialSubCellType*& cell);
   virtual bool cell(const DtPoint& containing, const DtSpatialSubCellType*& cell) const;

   virtual void offsetToIndices(const DtPoint& offset, DtSpatialSubCellIndex& xIndex, 
                                DtSpatialSubCellIndex& yIndex, DtSpatialSubCellIndex& zIndex) const;

   virtual bool indexIsValid(DtSpatialSubCellIndex index) const;
   virtual bool indicesAreValid(DtSpatialSubCellIndex xIndex, 
      DtSpatialSubCellIndex yIndex, DtSpatialSubCellIndex zIndex) const;

   virtual int sizeInBytes() const;

protected:
   bool testInvariant() const;

protected:

   double inverseCellDx() const;
   double inverseCellDy() const;
   double inverseCellDz() const;

   void calculateMinMaxOffsets();

   void calculateInverseDeltas();

   DtPoint myOrigin;

   unsigned int myCellCountX;
   unsigned int myCellCountY;
   unsigned int myCellCountZ;

   double myCellDx;
   double myCellDy;
   double myCellDz;


   double myInverseCellDx;
   double myInverseCellDy;
   double myInverseCellDz;


   double myMaxOffsetX;
   double myMaxOffsetY;
   double myMaxOffsetZ;

   double myMinOffsetX;
   double myMinOffsetY;
   double myMinOffsetZ;

   std::vector< DtSpatialSubCellType > myCells;
};


//------------------------------------------------------
//  INLINE METHODS
//------------------------------------------------------
// include the inline code
#define SPATIALSUBDIVISION_HEADER
#include "geometry/spatialSubdivision.inl"
#undef  SPATIALSUBDIVISION_HEADER

#endif