spatialVrfObjectManager.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2009 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: spatialVrfObjectManager.h,v $ $Revision: 1.19 $ $State: Exp $
*******************************************************************************/
#ifndef spatialVrfObjectManager_H_
#define spatialVrfObjectManager_H_


#include <vlutil/vlConfig.h>
#include "geometry/spatialSubdivision.h"
#include <vrfobjcore/managedObjectList.h>
#include <list>
#include <vector>
#include <boost/unordered_set.hpp>

#include "vrfobjcore/vrfobjcoreDefines.h"


class DT_DLL_vrfobjcore DtSpatialSelectionFunctor
{
public:
   virtual ~DtSpatialSelectionFunctor() {};

   virtual bool operator()(const DtVrfObject *object) = 0;
};


class DT_DLL_vrfobjcore DtSpatialVrfObjectManagerInterface
{
public:
   virtual ~DtSpatialVrfObjectManagerInterface() {};

   virtual void addVrfObjects(const DtManagedObjectListConstPtr& vrfObjects) = 0;

   virtual void removeVrfObject(DtVrfObject * vrfObject) = 0;

   virtual bool setResolutions(unsigned int xRes, unsigned int yRes, 
      unsigned int zRes) = 0;

   virtual void clearVrfObjects() = 0;
   
   virtual void reset(const DtManagedObjectListConstPtr& vrfObjects) = 0;

    


   typedef boost::unordered_set<DtVrfObject*>       DtVrfObjectUniqueContainer;
   typedef boost::unordered_set<const DtVrfObject*> DtVrfConstObjectUniqueContainer;

   typedef std::list<DtVrfObject*>            DtVrfObjectContainer;

   virtual bool getVrfObjects(const DtExtent& extent,
      DtVrfObjectUniqueContainer& objects) = 0;
   virtual bool getVrfObjects(const DtExtent& extent,
      DtVrfConstObjectUniqueContainer& objects) const = 0;

   virtual bool getVrfObjects(DtVrfObjectPredicate& predicate, const DtExtent& extent,
      DtVrfObjectUniqueContainer& objects) = 0;
   virtual bool getVrfObjects(DtVrfObjectPredicate& predicate, const DtExtent& extent,
      DtVrfConstObjectUniqueContainer& objects) const = 0;

   virtual bool getVrfObjects(DtChord& chord, std::list<DtVrfObject*>& objects) = 0;
   virtual bool getVrfObjects(DtChord& chord, std::list<const DtVrfObject*>& objects) const = 0;
   
   virtual bool getVrfObjects(DtVrfObjectPredicate& predicate, DtChord& chord,
      std::list<DtVrfObject*>& objects) = 0;
   virtual bool getVrfObjects(DtVrfObjectPredicate& predicate, DtChord& chord,
      std::list<const DtVrfObject*>& objects) const = 0;


   virtual void visitVrfObjects(const DtExtent& extent, DtSpatialSelectionFunctor &callback) const = 0;
   virtual void visitVrfObjects(const DtChord& chord, DtSpatialSelectionFunctor& callback) const = 0; 
};


class DT_DLL_vrfobjcore DtSpatialVrfObjectManager : public DtSpatialVrfObjectManagerInterface
{
public:
   typedef DtSpatialSubdivision<DtVrfObject*> DtSpatialContainer;
   typedef std::vector<DtVrfObject*> DtNonSpatialContainer;
   typedef DtNonSpatialContainer::iterator DtNonSpatialVrfObjectIter;
   typedef DtNonSpatialContainer::const_iterator DtNonSpatialVrfObjectConstIter;


   DtSpatialVrfObjectManager(unsigned int xRes = 1, unsigned int yRes = 1, 
      unsigned int zRes = 1);

   virtual ~DtSpatialVrfObjectManager();

private:
   DtSpatialVrfObjectManager(const DtSpatialVrfObjectManager& original);
   DtSpatialVrfObjectManager& operator=(const DtSpatialVrfObjectManager& original);

public:

   virtual bool initialize(const DtManagedObjectListConstPtr& vrfObjects,
      unsigned int cellCountX, unsigned int cellCountY, unsigned int cellCountZ);

   virtual void addVrfObjects(const DtManagedObjectListConstPtr& vrfObjects);

   virtual void removeVrfObject(DtVrfObject * vrfObject);

   virtual void clearVrfObjects();
   
   virtual bool setResolutions(unsigned int xRes, unsigned int yRes, 
      unsigned int zRes);

   virtual unsigned int xResolution() const;
   virtual unsigned int yResolution() const;
   virtual unsigned int zResolution() const;

   virtual void resolutions(unsigned int& xRes, unsigned int& yRes, 
      unsigned int& zRes) const;

   virtual void reset(const DtManagedObjectListConstPtr& vrfObjects);

    


   bool getVrfObjects(const DtExtent& extent, DtVrfObjectUniqueContainer& objects);
   bool getVrfObjects(const DtExtent& extent, DtVrfConstObjectUniqueContainer& objects) const;

   bool getVrfObjects(DtVrfObjectPredicate& predicate, const DtExtent& extent,
      DtVrfObjectUniqueContainer& objects);
   bool getVrfObjects(DtVrfObjectPredicate& predicate, const DtExtent& extent,
      DtVrfConstObjectUniqueContainer& objects) const;

   bool getVrfObjects(DtChord& chord, std::list<DtVrfObject*>& objects);
   bool getVrfObjects(DtChord& chord, std::list<const DtVrfObject*>& objects) const;
   
   bool getVrfObjects(DtVrfObjectPredicate& predicate, DtChord& chord,
      std::list<DtVrfObject*>& objects);
   bool getVrfObjects(DtVrfObjectPredicate& predicate, DtChord& chord,
      std::list<const DtVrfObject*>& objects) const;


   void visitVrfObjects(const DtExtent& extent, DtSpatialSelectionFunctor &callback) const;
   void visitVrfObjects(const DtChord& chord, DtSpatialSelectionFunctor& callback) const;
   
   virtual const DtSpatialContainer* spatialContainer() const;
   virtual DtSpatialContainer* spatialContainer();

   virtual const DtNonSpatialContainer* nonSpatiallyOrganizedObjects() const;
   virtual DtNonSpatialContainer* nonSpatiallyOrganizedObjects();

protected:

   virtual bool createSpatialContainer(const DtExtent& extent, unsigned int cellCountX, 
      unsigned int cellCountY, unsigned int cellCountZ);

   virtual void setExtent(const DtManagedObjectListConstPtr& vrfObjects);

   virtual void expandExtent(const DtManagedObjectListConstPtr& vrfObjects, 
      DtExtent& expandedExtent) const;

   bool testInvariant() const;
   

protected:

   DtSpatialContainer* myVrfObjectSpatialContainer;

   DtNonSpatialContainer myNonSpatiallyOrganizedObjects;
};

#endif