src/company_manager_face.h

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