src/framework/GameSystem/Grid.h

   1 /*
   2  * Copyright (C) 2005-2013 MaNGOS <http://getmangos.com/>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  */
  18
  19 #ifndef MANGOS_GRID_H
  20 #define MANGOS_GRID_H
  21
  22 /*
  23   @class Grid
  24   Grid is a logical segment of the game world represented inside MaNGOS.
  25   Grid is bind at compile time to a particular type of object which
  26   we call it the object of interested.  There are many types of loader,
  27   specially, dynamic loader, static loader, or on-demand loader.  There's
  28   a subtle difference between dynamic loader and on-demand loader but
  29   this is implementation specific to the loader class.  From the
  30   Grid's perspective, the loader meets its API requirement is suffice.
  31 */
  32
  33 #include "Platform/Define.h"
  34 #include "Policies/ThreadingModel.h"
  35 #include "TypeContainer.h"
  36 #include "TypeContainerVisitor.h"
  37
  38 // forward declaration
  39 template<class A, class T, class O> class GridLoader;
  40
  41 template
  42 <
  43 class ACTIVE_OBJECT,
  44       class WORLD_OBJECT_TYPES,
  45       class GRID_OBJECT_TYPES
  46       >
  47 class MANGOS_DLL_DECL Grid
  48 {
  49         // allows the GridLoader to access its internals
  50         template<class A, class T, class O> friend class GridLoader;
  51
  52     public:
  53
  54         /** destructor to clean up its resources. This includes unloading the
  55         grid if it has not been unload.
  56         */
  57         ~Grid() {}
  58
  59         /** an object of interested enters the grid
  60          */
  61         template<class SPECIFIC_OBJECT>
  62         bool AddWorldObject(SPECIFIC_OBJECT* obj)
  63         {
  64             return i_objects.template insert<SPECIFIC_OBJECT>(obj);
  65         }
  66
  67         /** an object of interested exits the grid
  68          */
  69         template<class SPECIFIC_OBJECT>
  70         bool RemoveWorldObject(SPECIFIC_OBJECT* obj)
  71         {
  72             return i_objects.template remove<SPECIFIC_OBJECT>(obj);
  73         }
  74
  75         /** Grid visitor for grid objects
  76          */
  77         template<class T>
  78         void Visit(TypeContainerVisitor<T, TypeMapContainer<GRID_OBJECT_TYPES> >& visitor)
  79         {
  80             visitor.Visit(i_container);
  81         }
  82
  83         /** Grid visitor for world objects
  84          */
  85         template<class T>
  86         void Visit(TypeContainerVisitor<T, TypeMapContainer<WORLD_OBJECT_TYPES> >& visitor)
  87         {
  88             visitor.Visit(i_objects);
  89         }
  90
  91         /** Returns the number of object within the grid.
  92          */
  93         uint32 ActiveObjectsInGrid() const
  94         {
  95             return m_activeGridObjects.size() + i_objects.template Count<ACTIVE_OBJECT>();
  96         }
  97
  98         /** Inserts a container type object into the grid.
  99          */
 100         template<class SPECIFIC_OBJECT>
 101         bool AddGridObject(SPECIFIC_OBJECT* obj)
 102         {
 103             if (obj->isActiveObject())
 104                 m_activeGridObjects.insert(obj);
 105
 106             return i_container.template insert<SPECIFIC_OBJECT>(obj);
 107         }
 108
 109         /** Removes a containter type object from the grid
 110          */
 111         template<class SPECIFIC_OBJECT>
 112         bool RemoveGridObject(SPECIFIC_OBJECT* obj)
 113         {
 114             if (obj->isActiveObject())
 115                 m_activeGridObjects.erase(obj);
 116
 117             return i_container.template remove<SPECIFIC_OBJECT>(obj);
 118         }
 119
 120     private:
 121
 122         TypeMapContainer<GRID_OBJECT_TYPES> i_container;
 123         TypeMapContainer<WORLD_OBJECT_TYPES> i_objects;
 124         typedef std::set<void*> ActiveGridObjects;
 125         ActiveGridObjects m_activeGridObjects;
 126 };
 127
 128 #endif