company_manager_face.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#ifndef COMPANY_MANAGER_FACE_H
#define COMPANY_MANAGER_FACE_H
 
#include "core/random_func.hpp"
#include "core/bitmath_func.hpp"
#include "table/sprites.h"
#include "company_type.h"
 
enum GenderEthnicity : uint8_t {
  GENDER_FEMALE    = 0, 
  ETHNICITY_BLACK  = 1, 
 
  GE_WM = 0,                                         
  GE_WF = 1 << GENDER_FEMALE,                        
  GE_BM = 1 << ETHNICITY_BLACK,                      
  GE_BF = 1 << ETHNICITY_BLACK | 1 << GENDER_FEMALE, 
  GE_END,
};
DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) 
 
 
enum CompanyManagerFaceVariable : uint8_t {
  CMFV_GENDER,
  CMFV_ETHNICITY,
  CMFV_GEN_ETHN,
  CMFV_HAS_MOUSTACHE,
  CMFV_HAS_TIE_EARRING,
  CMFV_HAS_GLASSES,
  CMFV_EYE_COLOUR,
  CMFV_CHEEKS,
  CMFV_CHIN,
  CMFV_EYEBROWS,
  CMFV_MOUSTACHE,
  CMFV_LIPS,
  CMFV_NOSE,
  CMFV_HAIR,
  CMFV_COLLAR,
  CMFV_JACKET,
  CMFV_TIE_EARRING,
  CMFV_GLASSES,
  CMFV_END,
};
DECLARE_INCREMENT_DECREMENT_OPERATORS(CompanyManagerFaceVariable)
 
 
struct CompanyManagerFaceBitsInfo {
  uint8_t     offset;               
  uint8_t     length;               
  uint8_t     valid_values[GE_END]; 
  SpriteID first_sprite[GE_END]; 
};
 
static const CompanyManagerFaceBitsInfo _cmf_info[] = {
  /* Index                   off len   WM  WF  BM  BF         WM     WF     BM     BF
   * CMFV_GENDER          */ {  0, 1, {  2,  2,  2,  2 }, {     0,     0,     0,     0 } }, 
  /* CMFV_ETHNICITY       */ {  1, 2, {  2,  2,  2,  2 }, {     0,     0,     0,     0 } }, 
  /* CMFV_GEN_ETHN        */ {  0, 3, {  4,  4,  4,  4 }, {     0,     0,     0,     0 } }, 
  /* CMFV_HAS_MOUSTACHE   */ {  3, 1, {  2,  0,  2,  0 }, {     0,     0,     0,     0 } }, 
  /* CMFV_HAS_TIE_EARRING */ {  3, 1, {  0,  2,  0,  2 }, {     0,     0,     0,     0 } }, 
  /* CMFV_HAS_GLASSES     */ {  4, 1, {  2,  2,  2,  2 }, {     0,     0,     0,     0 } }, 
  /* CMFV_EYE_COLOUR      */ {  5, 2, {  3,  3,  1,  1 }, {     0,     0,     0,     0 } }, 
  /* CMFV_CHEEKS          */ {  0, 0, {  1,  1,  1,  1 }, { 0x325, 0x326, 0x390, 0x3B0 } }, 
  /* CMFV_CHIN            */ {  7, 2, {  4,  1,  2,  2 }, { 0x327, 0x327, 0x391, 0x3B1 } },
  /* CMFV_EYEBROWS        */ {  9, 4, { 12, 16, 11, 16 }, { 0x32B, 0x337, 0x39A, 0x3B8 } },
  /* CMFV_MOUSTACHE       */ { 13, 2, {  3,  0,  3,  0 }, { 0x367,     0, 0x397,     0 } }, 
  /* CMFV_LIPS            */ { 13, 4, { 12, 10,  9,  9 }, { 0x35B, 0x351, 0x3A5, 0x3C8 } }, 
  /* CMFV_NOSE            */ { 17, 3, {  8,  4,  4,  5 }, { 0x349, 0x34C, 0x393, 0x3B3 } }, 
  /* CMFV_HAIR            */ { 20, 4, {  9,  5,  5,  5 }, { 0x382, 0x38B, 0x3D4, 0x3D9 } },
  /* CMFV_COLLAR          */ { 26, 2, {  4,  4,  4,  4 }, { 0x36E, 0x37B, 0x36E, 0x37B } },
  /* CMFV_JACKET          */ { 24, 2, {  3,  3,  3,  3 }, { 0x36B, 0x378, 0x36B, 0x378 } },
  /* CMFV_TIE_EARRING     */ { 28, 3, {  6,  3,  6,  3 }, { 0x372, 0x37F, 0x372, 0x3D1 } }, 
  /* CMFV_GLASSES         */ { 31, 1, {  2,  2,  2,  2 }, { 0x347, 0x347, 0x3AE, 0x3AE } }  
};
static_assert(lengthof(_cmf_info) == CMFV_END);
 
inline uint GetCompanyManagerFaceBits(CompanyManagerFace cmf, CompanyManagerFaceVariable cmfv, [[maybe_unused]] GenderEthnicity ge)
{
  assert(_cmf_info[cmfv].valid_values[ge] != 0);
 
  return GB(cmf, _cmf_info[cmfv].offset, _cmf_info[cmfv].length);
}
 
inline void SetCompanyManagerFaceBits(CompanyManagerFace &cmf, CompanyManagerFaceVariable cmfv, [[maybe_unused]] GenderEthnicity ge, uint val)
{
  assert(val < _cmf_info[cmfv].valid_values[ge]);
 
  SB(cmf, _cmf_info[cmfv].offset, _cmf_info[cmfv].length, val);
}
 
inline void IncreaseCompanyManagerFaceBits(CompanyManagerFace &cmf, CompanyManagerFaceVariable cmfv, GenderEthnicity ge, int8_t amount)
{
  int8_t val = GetCompanyManagerFaceBits(cmf, cmfv, ge) + amount; // the new value for the cmfv
 
  /* scales the new value to the correct scope */
  while (val < 0) {
    val += _cmf_info[cmfv].valid_values[ge];
  }
  val %= _cmf_info[cmfv].valid_values[ge];
 
  SetCompanyManagerFaceBits(cmf, cmfv, ge, val); // save the new value
}
 
inline bool AreCompanyManagerFaceBitsValid(CompanyManagerFace cmf, CompanyManagerFaceVariable cmfv, GenderEthnicity ge)
{
  return GB(cmf, _cmf_info[cmfv].offset, _cmf_info[cmfv].length) < _cmf_info[cmfv].valid_values[ge];
}
 
inline uint ScaleCompanyManagerFaceValue(CompanyManagerFaceVariable cmfv, GenderEthnicity ge, uint val)
{
  assert(val < (1U << _cmf_info[cmfv].length));
 
  return (val * _cmf_info[cmfv].valid_values[ge]) >> _cmf_info[cmfv].length;
}
 
inline void ScaleAllCompanyManagerFaceBits(CompanyManagerFace &cmf)
{
  IncreaseCompanyManagerFaceBits(cmf, CMFV_ETHNICITY, GE_WM, 0); // scales the ethnicity
 
  GenderEthnicity ge = (GenderEthnicity)GB(cmf, _cmf_info[CMFV_GEN_ETHN].offset, _cmf_info[CMFV_GEN_ETHN].length); // gender & ethnicity of the face
 
  /* Is a male face with moustache. Need to reduce CPU load in the loop. */
  bool is_moust_male = !HasBit(ge, GENDER_FEMALE) && GetCompanyManagerFaceBits(cmf, CMFV_HAS_MOUSTACHE, ge) != 0;
 
  for (CompanyManagerFaceVariable cmfv = CMFV_EYE_COLOUR; cmfv < CMFV_END; cmfv++) { // scales all other variables
 
    /* The moustache variable will be scaled only if it is a male face with has a moustache */
    if (cmfv != CMFV_MOUSTACHE || is_moust_male) {
      IncreaseCompanyManagerFaceBits(cmf, cmfv, ge, 0);
    }
  }
}
 
inline void RandomCompanyManagerFaceBits(CompanyManagerFace &cmf, GenderEthnicity ge, bool adv, Randomizer &randomizer)
{
  cmf = randomizer.Next(); // random all company manager's face bits
 
  /* scale ge: 0 == GE_WM, 1 == GE_WF, 2 == GE_BM, 3 == GE_BF (and maybe in future: ...) */
  ge = (GenderEthnicity)((uint)ge % GE_END);
 
  /* set the gender (and ethnicity) for the new company manager's face */
  if (adv) {
    SetCompanyManagerFaceBits(cmf, CMFV_GEN_ETHN, ge, ge);
  } else {
    SetCompanyManagerFaceBits(cmf, CMFV_GENDER, ge, HasBit(ge, GENDER_FEMALE));
  }
 
  /* scales all company manager's face bits to the correct scope */
  ScaleAllCompanyManagerFaceBits(cmf);
}
 
inline SpriteID GetCompanyManagerFaceSprite(CompanyManagerFace cmf, CompanyManagerFaceVariable cmfv, GenderEthnicity ge)
{
  assert(_cmf_info[cmfv].valid_values[ge] != 0);
 
  return _cmf_info[cmfv].first_sprite[ge] + GB(cmf, _cmf_info[cmfv].offset, _cmf_info[cmfv].length);
}
 
void DrawCompanyManagerFace(CompanyManagerFace face, Colours colour, const Rect &r);
 
#endif /* COMPANY_MANAGER_FACE_H */