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