remove/comment unused defines.
[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 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
31 /* in all cases the value is assumed to be scaled by the user preference */
32
33 /* humanly readable representation of a value in units (used for button drawing) */
34 void    bUnit_AsString(char *str, int len_max, double value, int prec, int system, int type, int split, int pad);
35
36 /* replace units with values, used before python button evaluation */
37 int             bUnit_ReplaceString(char *str, int len_max, char *str_prev, double scale_pref, int system, int type);
38
39 /* make string keyboard-friendly: 10┬Ám --> 10um */
40 void bUnit_ToUnitAltName(char *str, int len_max, char *orig_str, int system, int type);
41
42 /* the size of the unit used for this value (used for calculating the ckickstep) */
43 double bUnit_ClosestScalar(double value, int system, int type);
44
45 /* base scale for these units */
46 double bUnit_BaseScalar(int system, int type);
47
48 /* return true is the unit system exists */
49 int bUnit_IsValid(int system, int type);
50
51 /* loop over scales, coudl add names later */
52 //double bUnit_Iter(void **unit, char **name, int system, int type);
53
54 void            bUnit_GetSystem(void **usys_pt, int *len, int system, int type);
55 int                     bUnit_GetBaseUnit(void *usys_pt);
56 const char*     bUnit_GetName(void *usys_pt, int index);
57 const char*     bUnit_GetNameDisplay(void *usys_pt, int index);
58 double          bUnit_GetScaler(void *usys_pt, int index);
59
60 /* aligned with PropertyUnit */
61 #define         B_UNIT_NONE 0
62 #define         B_UNIT_LENGTH 1
63 #define         B_UNIT_AREA 2
64 #define         B_UNIT_VOLUME 3
65 #define         B_UNIT_MASS 4
66 #define         B_UNIT_ROTATION 5
67 #define         B_UNIT_TIME 6
68 #define         B_UNIT_VELOCITY 7
69 #define         B_UNIT_ACCELERATION 8
70 #define         B_UNIT_TYPE_TOT 9
71
72 #ifdef __cplusplus
73 }
74 #endif
75
76 #endif /* BKE_UNIT_H */