ClangFormat: apply to source, most of intern
[blender.git] / source / blender / blenkernel / BKE_unit.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 #ifndef __BKE_UNIT_H__
18 #define __BKE_UNIT_H__
19
20 /** \file
21  * \ingroup bke
22  */
23
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27
28 struct UnitSettings;
29
30 /* in all cases the value is assumed to be scaled by the user preference */
31
32 /* humanly readable representation of a value in units (used for button drawing) */
33 size_t bUnit_AsString(
34     char *str, int len_max, double value, int prec, int system, int type, bool split, bool pad);
35 size_t bUnit_AsString2(char *str,
36                        int len_max,
37                        double value,
38                        int prec,
39                        int type,
40                        const struct UnitSettings *settings,
41                        bool pad);
42
43 /* replace units with values, used before python button evaluation */
44 bool bUnit_ReplaceString(
45     char *str, int len_max, const char *str_prev, double scale_pref, int system, int type);
46
47 /* return true if the string contains any valid unit for the given type */
48 bool bUnit_ContainsUnit(const char *str, int type);
49
50 /* if user does not specify a unit, multiply with this value */
51 double bUnit_PreferredInputUnitScalar(const struct UnitSettings *settings, int type);
52
53 /* make string keyboard-friendly: 10┬Ám --> 10um */
54 void bUnit_ToUnitAltName(char *str, int len_max, const char *orig_str, int system, int type);
55
56 /* the size of the unit used for this value (used for calculating the ckickstep) */
57 double bUnit_ClosestScalar(double value, int system, int type);
58
59 /* base scale for these units */
60 double bUnit_BaseScalar(int system, int type);
61
62 /* return true is the unit system exists */
63 bool bUnit_IsValid(int system, int type);
64
65 /* loop over scales, could add names later */
66 //double bUnit_Iter(void **unit, char **name, int system, int type);
67
68 void bUnit_GetSystem(int system, int type, void const **r_usys_pt, int *r_len);
69 int bUnit_GetBaseUnit(const void *usys_pt);
70 int bUnit_GetBaseUnitOfType(int system, int type);
71 const char *bUnit_GetName(const void *usys_pt, int index);
72 const char *bUnit_GetNameDisplay(const void *usys_pt, int index);
73 const char *bUnit_GetIdentifier(const void *usys_pt, int index);
74 double bUnit_GetScaler(const void *usys_pt, int index);
75 bool bUnit_IsSuppressed(const void *usys_pt, int index);
76
77 /* aligned with PropertyUnit */
78 enum {
79   B_UNIT_NONE = 0,
80   B_UNIT_LENGTH = 1,
81   B_UNIT_AREA = 2,
82   B_UNIT_VOLUME = 3,
83   B_UNIT_MASS = 4,
84   B_UNIT_ROTATION = 5,
85   B_UNIT_TIME = 6,
86   B_UNIT_VELOCITY = 7,
87   B_UNIT_ACCELERATION = 8,
88   B_UNIT_CAMERA = 9,
89   B_UNIT_POWER = 10,
90   B_UNIT_TYPE_TOT = 11,
91 };
92
93 #ifdef __cplusplus
94 }
95 #endif
96
97 #endif /* __BKE_UNIT_H__ */