gemrb/core/CharAnimations.h

   1 /* GemRB - Infinity Engine Emulator
   2  * Copyright (C) 2003 The GemRB Project
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the 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 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  *
  18  *
  19  */
  20
  21 #ifndef CHARANIMATIONS_H
  22 #define CHARANIMATIONS_H
  23
  24 #include "Animation.h"
  25 #include "RGBAColor.h"
  26 #include "TableMgr.h"
  27 #include <vector>
  28 #include "Palette.h"
  29 #include "exports.h"
  30
  31 #define AV_PREFIX1      0
  32 #define AV_PREFIX2      1
  33 #define AV_PREFIX3      2
  34 #define AV_PREFIX4      3
  35 #define AV_ANIMTYPE     4
  36 #define AV_CIRCLESIZE   5
  37 #define AV_USE_PALETTE  6
  38 #define AV_SIZE         7
  39
  40 #define MAX_ANIMS                               19
  41
  42 #define IE_ANI_ATTACK                   0
  43 #define IE_ANI_AWAKE                    1
  44 #define IE_ANI_CAST                     2
  45 #define IE_ANI_CONJURE                  3
  46 #define IE_ANI_DAMAGE                   4
  47 #define IE_ANI_DIE                      5
  48 #define IE_ANI_HEAD_TURN                6
  49 #define IE_ANI_READY                    7
  50 #define IE_ANI_SHOOT                    8
  51 #define IE_ANI_TWITCH                   9
  52 #define IE_ANI_WALK                     10
  53 #define IE_ANI_ATTACK_SLASH             11
  54 #define IE_ANI_ATTACK_BACKSLASH         12
  55 #define IE_ANI_ATTACK_JAB               13
  56 #define IE_ANI_EMERGE                   14
  57 #define IE_ANI_HIDE                     15
  58 #define IE_ANI_RUN                      15 //pst has no hide, i hope
  59 #define IE_ANI_SLEEP                    16
  60 #define IE_ANI_GET_UP                   17
  61 #define IE_ANI_PST_START                18
  62
  63 //BG2, IWD animation types
  64 #define IE_ANI_CODE_MIRROR              0
  65 #define IE_ANI_ONE_FILE                 1
  66 #define IE_ANI_FOUR_FILES               2
  67 #define IE_ANI_TWO_FILES                3
  68 #define IE_ANI_CODE_MIRROR_2            4
  69 #define IE_ANI_SIX_FILES_2              5    //MOGR
  70 #define IE_ANI_TWENTYTWO                6
  71 #define IE_ANI_BIRD                             7
  72 #define IE_ANI_SIX_FILES                8    //MCAR/MWYV
  73 #define IE_ANI_TWO_FILES_3              9    //iwd animations
  74 #define IE_ANI_TWO_FILES_2              10   //low res bg1 anim
  75 #define IE_ANI_FOUR_FRAMES              11   //wyvern anims
  76 #define IE_ANI_NINE_FRAMES              12   //dragon anims
  77 #define IE_ANI_FRAGMENT                 13   //fragment animation
  78 #define IE_ANI_FOUR_FILES_2             14 //METT
  79 #define IE_ANI_CODE_MIRROR_3    15 //MSPS
  80 #define IE_ANI_TWO_FILES_3B             16    //iwd animations (eg. MBBM)
  81
  82 //PST animation types
  83 #define IE_ANI_PST_ANIMATION_1          56   //full animation
  84 #define IE_ANI_PST_GHOST                57   //no orientations
  85 #define IE_ANI_PST_STAND                58   //has orientations
  86 #define IE_ANI_PST_ANIMATION_2          59   //full animation std-->stc
  87 #define IE_ANI_PST_ANIMATION_3          60   //full animation stc-->std
  88
  89 //armour levels
  90 #define IE_ANI_NO_ARMOR                 0
  91 #define IE_ANI_LIGHT_ARMOR              1
  92 #define IE_ANI_MEDIUM_ARMOR             2
  93 #define IE_ANI_HEAVY_ARMOR              3
  94
  95 #define IE_ANI_WEAPON_1H                0
  96 #define IE_ANI_WEAPON_2H                1
  97 #define IE_ANI_WEAPON_2W                2
  98
  99 #define IE_ANI_RANGED_BOW               0
 100 #define IE_ANI_RANGED_XBOW              1
 101 #define IE_ANI_RANGED_THROW             2
 102
 103 struct AvatarStruct {
 104         unsigned int AnimID;
 105         ieResRef Prefixes[4];
 106         unsigned int PaletteType;
 107         unsigned char AnimationType;
 108         unsigned char CircleSize;
 109         char Size;
 110
 111         /* resdata entries */
 112         unsigned int WalkScale; /* 1000 / walkscale */
 113         unsigned int RunScale; /* 1000 / runscale */
 114         int Bestiary;
 115 };
 116
 117 struct EquipResRefData;
 118
 119 class GEM_EXPORT CharAnimations {
 120 private:
 121         Animation** Anims[MAX_ANIMS][MAX_ORIENT];
 122         char HelmetRef[2];
 123         char WeaponRef[2];
 124         char OffhandRef[2];
 125 public:
 126         const ieDword *Colors;  //these are the custom color indices
 127         RGBModifier ColorMods[32]; // color modification effects
 128         unsigned long lastModUpdate;
 129         RGBModifier GlobalColorMod; // global color modification effect
 130
 131         Palette* palette[4];
 132         Palette* modifiedPalette[4];
 133         unsigned int AvatarsRowNum;
 134         unsigned char ArmorType, WeaponType, RangedType;
 135         ieResRef ResRef;
 136         ieResRef PaletteResRef;
 137         unsigned char nextStanceID, StanceID;
 138         bool autoSwitchOnEnd;
 139         bool lockPalette;
 140 public:
 141         CharAnimations(unsigned int AnimID, ieDword ArmourLevel);
 142         ~CharAnimations(void);
 143         static void ReleaseMemory();
 144         void SetArmourLevel(int ArmourLevel);
 145         void SetRangedType(int Ranged);
 146         void SetWeaponType(int WeaponType);
 147         void SetHelmetRef(const char* ref);
 148         void SetWeaponRef(const char* ref);
 149         void SetOffhandRef(const char* ref);
 150         void SetupColors(PaletteType type);
 151         void SetColors(const ieDword *Colors);
 152         void LockPalette(const ieDword *Colors);
 153
 154         // returns an array of animations of size GetTotalPartCount()
 155         Animation** GetAnimation(unsigned char Stance, unsigned char Orient);
 156         int GetTotalPartCount() const;
 157         const int* GetZOrder(unsigned char Orient);
 158
 159         // returns Palette for a given part (unlocked)
 160         Palette* GetPartPalette(int part); // TODO: clean this up
 161
 162 public: //attribute functions
 163         static int GetAvatarsCount();
 164         static AvatarStruct *GetAvatarStruct(int RowNum);
 165         unsigned int GetAnimationID() const;
 166         int GetCircleSize() const;
 167         int NoPalette() const;
 168         int GetAnimType() const;
 169         char GetSize() const;
 170
 171         void PulseRGBModifiers();
 172
 173 private:
 174         void DropAnims();
 175         void InitAvatarsTable();
 176         int GetActorPartCount() const;
 177         void AddPSTSuffix(char* ResRef, unsigned char AnimID,
 178                 unsigned char& Cycle, unsigned char Orient);
 179         void AddFFSuffix(char* ResRef, unsigned char AnimID,
 180                 unsigned char& Cycle, unsigned char Orient, int Part);
 181         void AddNFSuffix(char* ResRef, unsigned char AnimID,
 182                 unsigned char& Cycle, unsigned char Orient, int Part);
 183         void AddVHR2Suffix(char* ResRef, unsigned char AnimID,
 184                 unsigned char& Cycle, unsigned char Orient);
 185         void AddVHRSuffix(char* ResRef, unsigned char AnimID,
 186                 unsigned char& Cycle, unsigned char Orient, EquipResRefData*& equip);
 187         void AddVHR3Suffix(char* ResRef, unsigned char AnimID,
 188                 unsigned char& Cycle, unsigned char Orient);
 189         void GetVHREquipmentRef(char* ResRef, unsigned char& Cycle,
 190                 const char* equipRef, bool offhand, EquipResRefData* equip);
 191         void AddSixSuffix(char* ResRef, unsigned char AnimID,
 192                 unsigned char& Cycle, unsigned char Orient);
 193         void AddMHRSuffix(char* ResRef, unsigned char AnimID,
 194                 unsigned char& Cycle, unsigned char Orient, EquipResRefData*& equip);
 195         void GetMHREquipmentRef(char* ResRef, unsigned char& Cycle,
 196                 const char* equipRef, bool offhand, EquipResRefData* equip);
 197         void AddMMRSuffix(char* ResRef, unsigned char AnimID,
 198                 unsigned char& Cycle, unsigned char Orient);
 199         void AddMMR2Suffix(char* ResRef, unsigned char AnimID,
 200                 unsigned char& Cycle, unsigned char Orient);
 201         void AddTwoFileSuffix(char* ResRef, unsigned char AnimID,
 202                 unsigned char& Cycle, unsigned char Orient);
 203         void AddLRSuffix(char* ResRef, unsigned char AnimID,
 204                 unsigned char& Cycle, unsigned char Orient, EquipResRefData*& equip);
 205         void AddLRSuffix2( char* ResRef, unsigned char StanceID,
 206                 unsigned char& Cycle, unsigned char Orient, EquipResRefData *&EquipData);
 207         void GetLREquipmentRef(char* ResRef, unsigned char& Cycle,
 208                 const char* equipRef, bool offhand, EquipResRefData* equip);
 209         void AddLR2Suffix(char* ResRef, unsigned char AnimID,
 210                 unsigned char& Cycle, unsigned char Orient);
 211         void AddLR3Suffix(char* ResRef, unsigned char AnimID,
 212                 unsigned char& Cycle, unsigned char Orient);
 213         void GetAnimResRef(unsigned char AnimID, unsigned char Orient,
 214                 char* ResRef, unsigned char& Cycle, int Part, EquipResRefData*& equip);
 215         void GetEquipmentResRef(const char* equipRef, bool offhand,
 216                 char* ResRef, unsigned char& Cycle, EquipResRefData* equip);
 217 };
 218
 219 #endif