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