ryzom/server/src/ai_service/profile.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  * This file defines the classes:
  19  * - CProfileOwner
  20  * - IAIProfileFactory
  21  * - CAIGenericProfileFactory
  22  * - CAIBaseProfile
  23  * - CProfilePtr
  24  */
  25
  26 #ifndef RYAI_AI_PROFILE_H
  27 #define RYAI_AI_PROFILE_H
  28
  29
  30 //#pragma warning (disable : 4355)      //      warning C4355: 'this' : used in base member initializer list
  31
  32 // This is the base class for defining NPC behaviour profiles
  33 // The team infrastructure manages the allocation of AI profiles to bots
  34
  35 class CProfilePtr;
  36 class IAIProfile;
  37
  38 //////////////////////////////////////////////////////////////////////////////
  39 // CProfileOwner                                                            //
  40 //////////////////////////////////////////////////////////////////////////////
  41
  42 class CProfileOwner
  43 {
  44 public:
  45         virtual ~CProfileOwner() { }
  46 };
  47
  48 //////////////////////////////////////////////////////////////////////////////
  49 // IAIProfileFactory                                                       //
  50 //////////////////////////////////////////////////////////////////////////////
  51
  52 class IAIProfileFactory
  53 : public NLMISC::CDbgRefCount<IAIProfileFactory>
  54 {
  55 public:
  56         friend class CProfilePtr;
  57         virtual ~IAIProfileFactory() { }
  58         virtual NLMISC::CSmartPtr<IAIProfile> createAIProfile(CProfileOwner *owner) = 0;
  59 };
  60
  61 #define RYAI_DECLARE_PROFILE_FACTORY(ProfileClass) RYAI_DECLARE_FACTORY(IAIProfileFactory, ProfileClass, std::string);
  62 #define RYAI_REGISTER_PROFILE_FACTORY(ProfileClass, KeyValue) RYAI_REGISTER_FACTORY(IAIProfileFactory, ProfileClass, std::string, std::string(KeyValue));
  63
  64 //////////////////////////////////////////////////////////////////////////////
  65 // CAIGenericProfileFactory                                                 //
  66 //////////////////////////////////////////////////////////////////////////////
  67
  68 template <class TProfile>
  69 class CAIGenericProfileFactory
  70 : public IAIProfileFactory
  71 {
  72 public:
  73         NLMISC::CSmartPtr<IAIProfile> createAIProfile(CProfileOwner* owner)
  74         {
  75                 return new TProfile(owner);
  76         }
  77 };
  78
  79 //////////////////////////////////////////////////////////////////////////////
  80 // CAIBaseProfile                                                           //
  81 //////////////////////////////////////////////////////////////////////////////
  82
  83 class IAIProfile
  84 : public NLMISC::CRefCount
  85 {
  86 public:
  87         virtual ~IAIProfile() { }
  88
  89         /// @name Virtual interface
  90         //@{
  91         // routine called when a profOwner starts to use a given profile
  92         // note that bots have a data member called 'void *aiProfileData' reserved for the use of the profile code
  93         // this data member should be setup here if it is to be used by the profile
  94         virtual void beginProfile() = 0;
  95         // routine called every time the profOwner is updated (frequency depends on player proximity, etc)
  96         virtual void updateProfile(uint ticksSinceLastUpdate) = 0;
  97         // routine called just before profOwner starts to use a new profile or when a profOwner dies
  98         virtual void endProfile() = 0;
  99         virtual AITYPES::TProfiles getAIProfileType() const = 0;
 100         virtual std::string getOneLineInfoString() const = 0;
 101         // routine called every time the profOwner's group changes state but profOwner maintains same ai profile
 102         virtual void stateChangeProfile() = 0;
 103         virtual void resumeProfile() = 0;
 104         //@}
 105 };
 106
 107 //////////////////////////////////////////////////////////////////////////////
 108 // CAIBaseProfile                                                           //
 109 //////////////////////////////////////////////////////////////////////////////
 110
 111 class CAIBaseProfile
 112 : public IAIProfile
 113 {
 114 public:
 115         virtual ~CAIBaseProfile() { }
 116
 117         /// @name IAIProfile base implementation
 118         //@{
 119         virtual void stateChangeProfile() { beginProfile(); }
 120         virtual void resumeProfile() { }
 121         //@}
 122 };
 123
 124 //////////////////////////////////////////////////////////////////////////////
 125 // CProfilePtr                                                              //
 126 //////////////////////////////////////////////////////////////////////////////
 127
 128 class CProfilePtr
 129 {
 130 public:
 131         enum TStartProfileType
 132         {
 133                 START_BEGIN = 0,
 134                 START_RESUME
 135         };
 136
 137 public:
 138         CProfilePtr();
 139
 140         virtual ~CProfilePtr();
 141
 142 //      std::string buildProfileDebugString() const;
 143         virtual std::string getOneLineInfoString() const;
 144
 145         AITYPES::TProfiles      getAIProfileType() const;
 146
 147         template <class T>
 148         void setAIProfile(T* obj, IAIProfileFactory* profile, bool callStateChangedIfSame) const
 149         {
 150                 if (profile)
 151                 {
 152                         setAIProfile(profile->createAIProfile(obj), callStateChangedIfSame);
 153                 }
 154         }
 155
 156         void setAIProfile(NLMISC::CSmartPtr<IAIProfile> profile, bool callStateChangedIfSame = false, TStartProfileType startType = START_BEGIN) const;
 157
 158         void updateProfile(uint ticks) const;
 159
 160         void mayUpdateProfile(uint ticks) const;
 161
 162         IAIProfile* getAIProfile() const { return _AiProfile; }
 163         NLMISC::CSmartPtr<IAIProfile> const& getAISpawnProfile() const { return _AiProfile; }
 164
 165 private:
 166         mutable NLMISC::CSmartPtr<IAIProfile>   _AiProfile;
 167         mutable NLMISC::CSmartPtr<IAIProfile>   _NextAiProfile;
 168         mutable bool                            _NextAiProfileCallStateChangedIfSame;
 169
 170         mutable TStartProfileType       _NextStartType;
 171         mutable bool                            _IsUpdating;
 172 };
 173
 174 //////////////////////////////////////////////////////////////////////////////
 175 // Global functions                                                         //
 176 //////////////////////////////////////////////////////////////////////////////
 177
 178 /// the lookup routine that serves as a kind of repository interface
 179 IAIProfileFactory* lookupAIGrpProfile(char const* name);
 180
 181 /****************************************************************************/
 182 /* Inlined methods                                                          */
 183 /****************************************************************************/
 184
 185 //////////////////////////////////////////////////////////////////////////////
 186 // CProfilePtr                                                              //
 187 //////////////////////////////////////////////////////////////////////////////
 188
 189 inline
 190 CProfilePtr::CProfilePtr()
 191 : _AiProfile(NULL)
 192 , _NextAiProfile(NULL)
 193 , _NextStartType(START_BEGIN)
 194 , _IsUpdating(false)
 195 {
 196 }
 197
 198 inline
 199 CProfilePtr::~CProfilePtr()
 200 {
 201         _NextAiProfile = NULL;
 202         _AiProfile = NULL;
 203 }
 204
 205 inline
 206 std::string CProfilePtr::getOneLineInfoString() const
 207 {
 208         if (_AiProfile.isNull())
 209                 return std::string("No Profile");
 210         return _AiProfile->getOneLineInfoString();
 211 }
 212
 213 inline
 214 AITYPES::TProfiles CProfilePtr::getAIProfileType() const
 215 {
 216         if (!_AiProfile.isNull())
 217                 return _AiProfile->getAIProfileType();
 218         return AITYPES::BAD_TYPE;       // unknown
 219 }
 220
 221 inline
 222 void CProfilePtr::setAIProfile(NLMISC::CSmartPtr<IAIProfile> profile, bool callStateChangedIfSame, TStartProfileType startType) const
 223 {
 224         // :NOTE: profile can be NULL
 225         if (_IsUpdating)
 226         {
 227                 _NextAiProfileCallStateChangedIfSame = callStateChangedIfSame;
 228                 _NextAiProfile = profile;
 229                 _NextStartType = startType;
 230                 return;
 231         }
 232
 233         if (!_AiProfile.isNull())
 234         {
 235                 // we may use the == operator because it doesn't take account of parameters (which is bad) :(
 236                 if (callStateChangedIfSame==true && _AiProfile->getAIProfileType ()==profile->getAIProfileType ())      // if we already have this profile, then call its stateChangeProfile method
 237                 {
 238                         _AiProfile->stateChangeProfile();
 239                         return;
 240                 }
 241
 242                 _AiProfile->endProfile();
 243                 _AiProfile = NULL;
 244         }
 245
 246         if (!profile.isNull())
 247         {
 248                 _AiProfile = profile;
 249                 if (startType==START_BEGIN)
 250                         _AiProfile->beginProfile();
 251                 else
 252                         _AiProfile->resumeProfile();
 253         }
 254 }
 255
 256 inline
 257 void CProfilePtr::updateProfile(uint ticks) const
 258 {
 259         BOMB_IF(_AiProfile.isNull(),"Attempting updateProfile() with _AiProfile.isNull()",return);
 260
 261         _IsUpdating = true;
 262         _AiProfile->updateProfile(ticks);
 263         _IsUpdating = false;
 264
 265         if      (!_NextAiProfile.isNull())
 266         {
 267                 setAIProfile(_NextAiProfile, _NextAiProfileCallStateChangedIfSame, _NextStartType);
 268                 _NextAiProfile = NULL;
 269         }
 270 }
 271
 272 inline
 273 void CProfilePtr::mayUpdateProfile(uint ticks) const
 274 {
 275         if (_AiProfile)
 276                 updateProfile(ticks);
 277 }
 278
 279 #endif