src/company_manager_face.h

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   8  */
   9
  10 /** @file company_manager_face.h Functionality related to the company manager's face */
  11
  12 #ifndef COMPANY_MANAGER_FACE_H
  13 #define COMPANY_MANAGER_FACE_H
  14
  15 #include "core/random_func.hpp"
  16 #include "core/bitmath_func.hpp"
  17 #include "table/sprites.h"
  18 #include "company_type.h"
  19
  20 /** The gender/race combinations that we have faces for */
  21 enum GenderEthnicity {
  22         GENDER_FEMALE    = 0, ///< This bit set means a female, otherwise male
  23         ETHNICITY_BLACK  = 1, ///< This bit set means black, otherwise white
  24
  25         GE_WM = 0,                                         ///< A male of Caucasian origin (white)
  26         GE_WF = 1 << GENDER_FEMALE,                        ///< A female of Caucasian origin (white)
  27         GE_BM = 1 << ETHNICITY_BLACK,                      ///< A male of African origin (black)
  28         GE_BF = 1 << ETHNICITY_BLACK | 1 << GENDER_FEMALE, ///< A female of African origin (black)
  29         GE_END,
  30 };
  31 DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) ///< See GenderRace as a bitset
  32
  33 /** Bitgroups of the CompanyManagerFace variable */
  34 enum CompanyManagerFaceVariable {
  35         CMFV_GENDER,
  36         CMFV_ETHNICITY,
  37         CMFV_GEN_ETHN,
  38         CMFV_HAS_MOUSTACHE,
  39         CMFV_HAS_TIE_EARRING,
  40         CMFV_HAS_GLASSES,
  41         CMFV_EYE_COLOUR,
  42         CMFV_CHEEKS,
  43         CMFV_CHIN,
  44         CMFV_EYEBROWS,
  45         CMFV_MOUSTACHE,
  46         CMFV_LIPS,
  47         CMFV_NOSE,
  48         CMFV_HAIR,
  49         CMFV_JACKET,
  50         CMFV_COLLAR,
  51         CMFV_TIE_EARRING,
  52         CMFV_GLASSES,
  53         CMFV_END,
  54 };
  55 DECLARE_POSTFIX_INCREMENT(CompanyManagerFaceVariable)
  56
  57 /** Information about the valid values of CompanyManagerFace bitgroups as well as the sprites to draw */
  58 struct CompanyManagerFaceBitsInfo {
  59         byte     offset;               ///< Offset in bits into the CompanyManagerFace
  60         byte     length;               ///< Number of bits used in the CompanyManagerFace
  61         byte     valid_values[GE_END]; ///< The number of valid values per gender/ethnicity
  62         SpriteID first_sprite[GE_END]; ///< The first sprite per gender/ethnicity
  63 };
  64
  65 /** Lookup table for indices into the CompanyManagerFace, valid ranges and sprites */
  66 static const CompanyManagerFaceBitsInfo _cmf_info[] = {
  67         /* Index                   off len   WM  WF  BM  BF         WM     WF     BM     BF
  68          * CMFV_GENDER          */ {  0, 1, {  2,  2,  2,  2 }, {     0,     0,     0,     0 } }, ///< 0 = male, 1 = female
  69         /* CMFV_ETHNICITY       */ {  1, 2, {  2,  2,  2,  2 }, {     0,     0,     0,     0 } }, ///< 0 = (Western-)Caucasian, 1 = African(-American)/Black
  70         /* CMFV_GEN_ETHN        */ {  0, 3, {  4,  4,  4,  4 }, {     0,     0,     0,     0 } }, ///< Shortcut to get/set gender _and_ ethnicity
  71         /* CMFV_HAS_MOUSTACHE   */ {  3, 1, {  2,  0,  2,  0 }, {     0,     0,     0,     0 } }, ///< Females do not have a moustache
  72         /* CMFV_HAS_TIE_EARRING */ {  3, 1, {  0,  2,  0,  2 }, {     0,     0,     0,     0 } }, ///< Draw the earring for females or not. For males the tie is always drawn.
  73         /* CMFV_HAS_GLASSES     */ {  4, 1, {  2,  2,  2,  2 }, {     0,     0,     0,     0 } }, ///< Whether to draw glasses or not
  74         /* CMFV_EYE_COLOUR      */ {  5, 2, {  3,  3,  1,  1 }, {     0,     0,     0,     0 } }, ///< Palette modification
  75         /* CMFV_CHEEKS          */ {  0, 0, {  1,  1,  1,  1 }, { 0x325, 0x326, 0x390, 0x3B0 } }, ///< Cheeks are only indexed by their gender/ethnicity
  76         /* CMFV_CHIN            */ {  7, 2, {  4,  1,  2,  2 }, { 0x327, 0x327, 0x391, 0x3B1 } },
  77         /* CMFV_EYEBROWS        */ {  9, 4, { 12, 16, 11, 16 }, { 0x32B, 0x337, 0x39A, 0x3B8 } },
  78         /* CMFV_MOUSTACHE       */ { 13, 2, {  3,  0,  3,  0 }, { 0x367,     0, 0x397,     0 } }, ///< Depends on CMFV_HAS_MOUSTACHE
  79         /* CMFV_LIPS            */ { 13, 4, { 12, 10,  9,  9 }, { 0x35B, 0x351, 0x3A5, 0x3C8 } }, ///< Depends on !CMFV_HAS_MOUSTACHE
  80         /* CMFV_NOSE            */ { 17, 3, {  8,  4,  4,  5 }, { 0x349, 0x34C, 0x393, 0x3B3 } }, ///< Depends on !CMFV_HAS_MOUSTACHE
  81         /* CMFV_HAIR            */ { 20, 4, {  9,  5,  5,  4 }, { 0x382, 0x38B, 0x3D4, 0x3D9 } },
  82         /* CMFV_JACKET          */ { 24, 2, {  3,  3,  3,  3 }, { 0x36B, 0x378, 0x36B, 0x378 } },
  83         /* CMFV_COLLAR          */ { 26, 2, {  4,  4,  4,  4 }, { 0x36E, 0x37B, 0x36E, 0x37B } },
  84         /* CMFV_TIE_EARRING     */ { 28, 3, {  6,  3,  6,  3 }, { 0x372, 0x37F, 0x372, 0x3D1 } }, ///< Depends on CMFV_HAS_TIE_EARRING
  85         /* CMFV_GLASSES         */ { 31, 1, {  2,  2,  2,  2 }, { 0x347, 0x347, 0x3AE, 0x3AE } }  ///< Depends on CMFV_HAS_GLASSES
  86 };
  87 /** Make sure the table's size is right. */
  88 assert_compile(lengthof(_cmf_info) == CMFV_END);
  89
  90 /**
  91  * Gets the company manager's face bits for the given company manager's face variable
  92  * @param cmf  the face to extract the bits from
  93  * @param cmfv the face variable to get the data of
  94  * @param ge   the gender and ethnicity of the face
  95  * @pre _cmf_info[cmfv].valid_values[ge] != 0
  96  * @return the requested bits
  97  */
  98 static inline uint GetCompanyManagerFaceBits(CompanyManagerFace cmf, CompanyManagerFaceVariable cmfv, GenderEthnicity ge)
  99 {
 100         assert(_cmf_info[cmfv].valid_values[ge] != 0);
 101
 102         return GB(cmf, _cmf_info[cmfv].offset, _cmf_info[cmfv].length);
 103 }
 104
 105 /**
 106  * Sets the company manager's face bits for the given company manager's face variable
 107  * @param cmf  the face to write the bits to
 108  * @param cmfv the face variable to write the data of
 109  * @param ge   the gender and ethnicity of the face
 110  * @param val  the new value
 111  * @pre val < _cmf_info[cmfv].valid_values[ge]
 112  */
 113 static inline void SetCompanyManagerFaceBits(CompanyManagerFace &cmf, CompanyManagerFaceVariable cmfv, GenderEthnicity ge, uint val)
 114 {
 115         assert(val < _cmf_info[cmfv].valid_values[ge]);
 116
 117         SB(cmf, _cmf_info[cmfv].offset, _cmf_info[cmfv].length, val);
 118 }
 119
 120 /**
 121  * Increase/Decrease the company manager's face variable by the given amount.
 122  * If the new value greater than the max value for this variable it will be set to 0.
 123  * Or is it negative (< 0) it will be set to max value.
 124  *
 125  * @param cmf    the company manager face to write the bits to
 126  * @param cmfv   the company manager face variable to write the data of
 127  * @param ge     the gender and ethnicity of the company manager's face
 128  * @param amount the amount which change the value
 129  *
 130  * @pre 0 <= val < _cmf_info[cmfv].valid_values[ge]
 131  */
 132 static inline void IncreaseCompanyManagerFaceBits(CompanyManagerFace &cmf, CompanyManagerFaceVariable cmfv, GenderEthnicity ge, int8 amount)
 133 {
 134         int8 val = GetCompanyManagerFaceBits(cmf, cmfv, ge) + amount; // the new value for the cmfv
 135
 136         /* scales the new value to the correct scope */
 137         if (val >= _cmf_info[cmfv].valid_values[ge]) {
 138                 val = 0;
 139         } else if (val < 0) {
 140                 val = _cmf_info[cmfv].valid_values[ge] - 1;
 141         }
 142
 143         SetCompanyManagerFaceBits(cmf, cmfv, ge, val); // save the new value
 144 }
 145
 146 /**
 147  * Checks whether the company manager's face bits have a valid range
 148  * @param cmf  the face to extract the bits from
 149  * @param cmfv the face variable to get the data of
 150  * @param ge   the gender and ethnicity of the face
 151  * @return true if and only if the bits are valid
 152  */
 153 static inline bool AreCompanyManagerFaceBitsValid(CompanyManagerFace cmf, CompanyManagerFaceVariable cmfv, GenderEthnicity ge)
 154 {
 155         return GB(cmf, _cmf_info[cmfv].offset, _cmf_info[cmfv].length) < _cmf_info[cmfv].valid_values[ge];
 156 }
 157
 158 /**
 159  * Scales a company manager's face bits variable to the correct scope
 160  * @param cmfv the face variable to write the data of
 161  * @param ge  the gender and ethnicity of the face
 162  * @param val the to value to scale
 163  * @pre val < (1U << _cmf_info[cmfv].length), i.e. val has a value of 0..2^(bits used for this variable)-1
 164  * @return the scaled value
 165  */
 166 static inline uint ScaleCompanyManagerFaceValue(CompanyManagerFaceVariable cmfv, GenderEthnicity ge, uint val)
 167 {
 168         assert(val < (1U << _cmf_info[cmfv].length));
 169
 170         return (val * _cmf_info[cmfv].valid_values[ge]) >> _cmf_info[cmfv].length;
 171 }
 172
 173 /**
 174  * Scales all company manager's face bits to the correct scope
 175  *
 176  * @param cmf the company manager's face to write the bits to
 177  */
 178 static inline void ScaleAllCompanyManagerFaceBits(CompanyManagerFace &cmf)
 179 {
 180         IncreaseCompanyManagerFaceBits(cmf, CMFV_ETHNICITY, GE_WM, 0); // scales the ethnicity
 181
 182         GenderEthnicity ge = (GenderEthnicity)GB(cmf, _cmf_info[CMFV_GEN_ETHN].offset, _cmf_info[CMFV_GEN_ETHN].length); // gender & ethnicity of the face
 183
 184         /* Is a male face with moustache. Need to reduce CPU load in the loop. */
 185         bool is_moust_male = !HasBit(ge, GENDER_FEMALE) && GetCompanyManagerFaceBits(cmf, CMFV_HAS_MOUSTACHE, ge) != 0;
 186
 187         for (CompanyManagerFaceVariable cmfv = CMFV_EYE_COLOUR; cmfv < CMFV_END; cmfv++) { // scales all other variables
 188
 189                 /* The moustache variable will be scaled only if it is a male face with has a moustache */
 190                 if (cmfv != CMFV_MOUSTACHE || is_moust_male) {
 191                         IncreaseCompanyManagerFaceBits(cmf, cmfv, ge, 0);
 192                 }
 193         }
 194 }
 195
 196 /**
 197  * Make a random new face.
 198  * If it is for the advanced company manager's face window then the new face have the same gender
 199  * and ethnicity as the old one, else the gender is equal and the ethnicity is random.
 200  *
 201  * @param cmf the company manager's face to write the bits to
 202  * @param ge  the gender and ethnicity of the old company manager's face
 203  * @param adv if it for the advanced company manager's face window
 204  * @param interactive is the call from within the user interface?
 205  *
 206  * @pre scale 'ge' to a valid gender/ethnicity combination
 207  */
 208 static inline void RandomCompanyManagerFaceBits(CompanyManagerFace &cmf, GenderEthnicity ge, bool adv, bool interactive = true)
 209 {
 210         /* This method is called from a command when not interactive and
 211          * then we must use Random to get the same result on all clients. */
 212         cmf = interactive ? InteractiveRandom() : Random(); // random all company manager's face bits
 213
 214         /* scale ge: 0 == GE_WM, 1 == GE_WF, 2 == GE_BM, 3 == GE_BF (and maybe in future: ...) */
 215         ge = (GenderEthnicity)((uint)ge % GE_END);
 216
 217         /* set the gender (and ethnicity) for the new company manager's face */
 218         if (adv) {
 219                 SetCompanyManagerFaceBits(cmf, CMFV_GEN_ETHN, ge, ge);
 220         } else {
 221                 SetCompanyManagerFaceBits(cmf, CMFV_GENDER, ge, HasBit(ge, GENDER_FEMALE));
 222         }
 223
 224         /* scales all company manager's face bits to the correct scope */
 225         ScaleAllCompanyManagerFaceBits(cmf);
 226 }
 227
 228 /**
 229  * Gets the sprite to draw for the given company manager's face variable
 230  * @param cmf  the face to extract the data from
 231  * @param cmfv the face variable to get the sprite of
 232  * @param ge   the gender and ethnicity of the face
 233  * @pre _cmf_info[cmfv].valid_values[ge] != 0
 234  * @return sprite to draw
 235  */
 236 static inline SpriteID GetCompanyManagerFaceSprite(CompanyManagerFace cmf, CompanyManagerFaceVariable cmfv, GenderEthnicity ge)
 237 {
 238         assert(_cmf_info[cmfv].valid_values[ge] != 0);
 239
 240         return _cmf_info[cmfv].first_sprite[ge] + GB(cmf, _cmf_info[cmfv].offset, _cmf_info[cmfv].length);
 241 }
 242
 243 void DrawCompanyManagerFace(CompanyManagerFace face, int colour, int x, int y);
 244
 245 #endif /* COMPANY_MANAGER_FACE_H */