ryzom/server/src/frontend_service/vision_receiver.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_VISION_RECEIVER_H
  20 #define NL_VISION_RECEIVER_H
  21
  22 #include "nel/misc/types_nl.h"
  23 #include "game_share/player_vision_delta.h"
  24 #include "entity_container.h"
  25 #include <queue>
  26
  27
  28 /**
  29  * <Class description>
  30  * \author Olivier Cado
  31  * \author Nevrax France
  32  * \date 2002
  33  */
  34 class CVisionReceiver
  35 {
  36 public:
  37
  38         /// Constructor
  39         CVisionReceiver();
  40
  41         /// Initialisation
  42         void                                    init();
  43
  44         /// Vision management : Get the first modified vision since the last EndUpdatedVision
  45         inline TEntityIndex             getFirstUpdatedVision()
  46         {
  47                 return( _FirstUpdatedEntityVision );
  48         }
  49
  50         /// Vision management : Get the next modified vision
  51         inline TEntityIndex             getNextUpdatedVision( const TEntityIndex& entityIndex )
  52         {
  53                 return( TheEntityContainer->getEntity(entityIndex)->NextUpdatedEntityVision );
  54         }
  55
  56         /// Vision management : Allow to loop on vision updates
  57         inline bool                             visionChanged()
  58         {
  59                 return _HasPendingDelta;
  60         }
  61
  62         /// End an updating session
  63         void                                    endUpdatedVision();
  64
  65 protected:
  66
  67         /// Apply a new delta of vision
  68         bool                                    setVision( const CPlayerVisionDelta &visionDelta );
  69
  70         /// UpdateVision, unserial update vision message and process it
  71         void                                    updateNewVision( NLNET::CMessage& msgin );
  72
  73         friend void cbDeltaNewVision( NLNET::CMessage& msgin, const std::string &serviceName, NLNET::TServiceId serviceId );
  74
  75 private:
  76
  77         TEntityIndex                                                                            _FirstUpdatedEntityVision;
  78
  79         // Queue to allow merging of several vision updates receives within the same cycle
  80         bool                                                                                            _HasPendingDelta;
  81         std::queue< std::list<CPlayerVisionDelta> >                     _NextDeltas;
  82 };
  83
  84
  85 // Callback for delta vision update received
  86 void cbDeltaNewVision( NLNET::CMessage& msgin, const std::string &serviceName, NLNET::TServiceId serviceId );
  87
  88 #endif // NL_VISION_RECEIVER_H
  89
  90 /* End of vision_receiver.h */