prj/cam/src/ai/aimovsug.h

   1 /*
   2 @Copyright Looking Glass Studios, Inc.
   3 1996,1997,1998,1999,2000 Unpublished Work.
   4 */
   5
   6 ///////////////////////////////////////////////////////////////////////////////
   7 // $Header: r:/t2repos/thief2/src/ai/aimovsug.h,v 1.4 1998/10/03 10:30:40 TOML Exp $
   8 //
   9 // Movement suggestions: the heart of the locomotion movement suggestion
  10 // system
  11 //
  12
  13 #ifndef __AIMOVSUG_H
  14 #define __AIMOVSUG_H
  15
  16 #include <dynarray.h>
  17 #include <aitype.h>
  18
  19 #pragma once
  20 #pragma pack(4)
  21
  22 struct sAIMoveSuggestion;
  23
  24 ///////////////////////////////////////////////////////////////////////////////
  25 //
  26 // Constants
  27 //
  28
  29 enum eAIMoveSuggKindEnum
  30 {
  31    // Suggestion is an idle action
  32    kAIMS_Idle,
  33
  34    // Suggestion is a normal locomotion
  35    kAIMS_Loco,
  36
  37    // Suggestion is a combat maneuver
  38    kAIMS_Combat,
  39
  40    // Suggestion is an object avoidance/attraction
  41    kAIMS_Object,
  42
  43    // Suggestion is an danger avoidance
  44    kAIMS_Danger,
  45
  46    kAIMS_InMax = 0xffffffff
  47 };
  48
  49 typedef unsigned eAIMoveSuggKind;
  50
  51 ///////////////////////////////////////
  52
  53 enum eAIFacing
  54 {
  55    // Doesn't matter
  56    kAIF_Any,
  57
  58    // Face direction of movement
  59    kAIF_MoveDir,
  60
  61    // Face the ultimate destination
  62    kAIF_Dest,
  63
  64    // Face an alternative position
  65    kAIF_AltPos,
  66
  67    // Face a specific direction
  68    kAIF_SpecificDir,
  69
  70    kAIF_TypeMax=0xffffffff // force it use an int
  71 };
  72
  73 ///////////////////////////////////////
  74
  75 enum eAISuggestionFlags
  76 {
  77    // Is it a regulation suggestion, as opposed to a positive ability-driven one?
  78    kAISF_IsRegulation = 0x01,
  79 };
  80
  81 ///////////////////////////////////////////////////////////////////////////////
  82 //
  83 // FUNCTION: AIComputeWeightedBias
  84 //
  85 // For any given suggestion, the creator assigns a 0-100 rating
  86 // indicating confidence about the NEED for the suggestion. This function
  87 // weighs the suggestion relative to other suggestions, based on
  88 // the kind of suggestion it is
  89 //
  90
  91 int AIComputeWeightedBias(eAIMoveSuggKind kind, int baseBias);
  92
  93 ///////////////////////////////////////////////////////////////////////////////
  94 //
  95 // CLASS: cAIMoveSuggestions
  96 //
  97 // @Note (toml 03-31-98): Suggestions are always owned and cleaned up by suggestor
  98 //
  99
 100 class cAIMoveSuggestions : public cDynArray_<sAIMoveSuggestion *, 2>
 101 {
 102 public:
 103    cAIMoveSuggestions();
 104
 105    void Add(const cAIMoveSuggestions &);
 106
 107    void DestroyAll();
 108 };
 109
 110 ///////////////////////////////////////////////////////////////////////////////
 111 //
 112 // STRUCT: sAIFacing
 113 //
 114
 115 struct sAIFacing
 116 {
 117    eAIFacing     type;
 118    union
 119    {
 120       float      ang; // if kAIF_SpecificDir
 121       mxs_vector pos; // if kAIF_AltPos
 122    };
 123 };
 124
 125 ///////////////////////////////////////////////////////////////////////////////
 126 //
 127 // STRUCT: sAIMoveGoal
 128 //
 129 // This is the lowest-level instantaneous movement goal of an AI in motion,
 130 // the result of boiling down of numerous movement suggestions
 131 //
 132
 133 struct sAIMoveGoal
 134 {
 135    sAIMoveGoal();
 136
 137    // The goal direction, 0 = east
 138    floatang   dir;
 139
 140    // The final goal of the movement process, if any
 141    cMxsVector dest;
 142
 143    // Facing requirements
 144    sAIFacing  facing;
 145
 146    // How fast should we move
 147    eAISpeed   speed;
 148
 149    // @TBD (toml 03-26-98): Tags?
 150 };
 151
 152 ///////////////////////////////////////////////////////////////////////////////
 153 //
 154 // STRUCT: sAIMoveSuggestion
 155 //
 156
 157 struct sAIMoveSuggestion
 158 {
 159    sAIMoveSuggestion();
 160    sAIMoveSuggestion(const sAIMoveSuggestion &);
 161
 162    // Set the kind and weighted bias
 163    void SetWeightedBias(eAIMoveSuggKind newKind, int newBias);
 164
 165    // The kind of the suggestion
 166    eAIMoveSuggKind kind;
 167
 168    // Suggestion bias (-100%..+100%)
 169    int             bias;
 170
 171    // Flags
 172    unsigned        flags;
 173
 174    // The goal direction, 0 = east
 175    floatarc        dirArc;
 176
 177    // The final goal of the movement process, if any
 178    cMxsVector      dest;
 179
 180    // Facing requirements
 181    sAIFacing       facing;
 182
 183    // How fast should we move
 184    eAISpeed        speed;
 185
 186    // @TBD (toml 03-26-98): Tags?
 187 };
 188
 189 ///////////////////////////////////////////////////////////////////////////////
 190
 191 inline cAIMoveSuggestions::cAIMoveSuggestions()
 192 {
 193 }
 194
 195 ///////////////////////////////////////
 196
 197 inline void cAIMoveSuggestions::Add(const cAIMoveSuggestions & from)
 198 {
 199    if (from.Size())
 200    {
 201       const int oldSize = Size();
 202       Grow(from.Size());
 203       memcpy(AsPointer() + oldSize, from.AsPointer(), sizeof(sAIMoveSuggestion *) * from.Size());
 204    }
 205 }
 206
 207 ///////////////////////////////////////
 208
 209 inline void cAIMoveSuggestions::DestroyAll()
 210 {
 211    for (int i = 0; i < Size(); i++)
 212    {
 213       delete (AsPointer()[i]);
 214    }
 215    SetSize(0);
 216 }
 217
 218 ///////////////////////////////////////////////////////////////////////////////
 219
 220 inline sAIMoveGoal::sAIMoveGoal()
 221 {
 222    memset(this, 0, sizeof(sAIMoveGoal));
 223 }
 224
 225 ///////////////////////////////////////////////////////////////////////////////
 226
 227 inline sAIMoveSuggestion::sAIMoveSuggestion()
 228 {
 229    memset(this, 0, sizeof(sAIMoveSuggestion));
 230 }
 231
 232 ///////////////////////////////////////
 233
 234 inline sAIMoveSuggestion::sAIMoveSuggestion(const sAIMoveSuggestion &from)
 235 {
 236    memcpy(this, &from, sizeof(sAIMoveSuggestion));
 237 }
 238
 239 ///////////////////////////////////////
 240
 241 inline void sAIMoveSuggestion::SetWeightedBias(eAIMoveSuggKind newKind, int newBias)
 242 {
 243    kind = newKind;
 244    bias = AIComputeWeightedBias(kind, newBias);
 245 }
 246
 247 ///////////////////////////////////////////////////////////////////////////////
 248
 249 #pragma pack()
 250
 251 #endif /* !__AIMOVSUG_H */