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