ryzom/server/src/frontend_service/prioritizer.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This program is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU Affero General Public License as
   6 // published by the Free Software Foundation, either version 3 of the
   7 // License, or (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 Affero General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Affero General Public License
  15 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17
  18
  19 #ifndef NL_PRIORITIZER_H
  20 #define NL_PRIORITIZER_H
  21
  22 #include "nel/misc/types_nl.h"
  23 #include "game_share/entity_types.h"
  24 #include "fe_types.h"
  25 #include "processing_spreader.h"
  26
  27
  28 /*
  29  * Forward declarations
  30  */
  31 class CPairSelector;
  32 class CVisionArray;
  33 class CPropertyDispatcher;
  34 class CPropertyIdTranslator;
  35 class CHistory;
  36 class TPairCE;
  37
  38
  39 /**
  40  * Prioritizer.
  41  * It knows how to calculate the priority of pairs <Client, Entity>.
  42  *
  43  * \author Olivier Cado
  44  * \author Nevrax France
  45  * \date 2002
  46  */
  47 class CPrioritizer
  48 {
  49 public:
  50
  51         /// Type of priority strategy
  52         enum TPrioStrategy { DistanceOnly = 0, DistanceDelta = 1 };
  53
  54         /// Constructor
  55         CPrioritizer();
  56
  57         /// Initialization
  58         void                                    init( CVisionArray *va,
  59                                                                   CPropertyIdTranslator* pt, CHistory *h );
  60
  61         /// Calculate the priorities
  62         void                                    calculatePriorities();
  63
  64         CLFECOMMON::TCoord              getDeltaPos( TEntityIndex entityindex, TClientId clientid, CLFECOMMON::TCLEntityId ceid );
  65
  66         CLFECOMMON::TCoord              getDeltaOrientation( TEntityIndex entityindex, TClientId clientid, CLFECOMMON::TCLEntityId ceid );
  67
  68         /// Return the priority strategy
  69         TPrioStrategy                   prioStrategy() const { return _PrioStrategy; }
  70
  71         // Set the priority strategy
  72         //void                                  setPrioStrategy( TPrioStrategy ps );
  73
  74         // Constants (obsolete)
  75         /*
  76         static const TCoord             DeltaMinThreshold;
  77         static const TCoord             DeltaMaxThreshold;
  78         static const TCoord             DistMinThreshold;
  79         static const TCoord             DistMaxThreshold;
  80         */
  81         static const CLFECOMMON::TCoord MaxDelta;
  82
  83         CProcessingSpreader             PositionSpreader, OrientationSpreader, DiscreetSpreader;
  84
  85 protected:
  86
  87         /// Calculate the priorities of position for the current cycle
  88         void                                    calculatePriorityOfPosition();
  89
  90         /// Calculate the priorities of orientation for the current cycle
  91         void                                    calculatePriorityOfOrientation();
  92
  93         /// Calculate the priorities of discreet props for the current cycle
  94         void                                    calculatePriorityOfDiscreet();
  95
  96 private:
  97
  98         /// Vision Array
  99         CVisionArray                    *_VisionArray;
 100
 101         /// Property Id Translator
 102         CPropertyIdTranslator   *_PropTranslator;
 103
 104         /// History
 105         CHistory                                *_History;
 106
 107         /// Strategy
 108         TPrioStrategy                   _PrioStrategy;
 109
 110 };
 111
 112
 113 #endif // NL_PRIORITIZER_H
 114
 115 /* End of prioritizer.h */