svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r22875:22935
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 /* the size of the unit used for this value (used for calculating the ckickstep) */
40 double bUnit_ClosestScalar(double value, int system, int type);
41
42 /* base scale for these units */
43 double bUnit_BaseScalar(int system, int type);
44
45 /* loop over scales, coudl add names later */
46 //double bUnit_Iter(void **unit, char **name, int system, int type);
47
48 void    bUnit_GetSystem(void **usys_pt, int *len, int system, int type);
49 char*   bUnit_GetName(void *usys_pt, int index);
50 char*   bUnit_GetNameDisplay(void *usys_pt, int index);
51 double  bUnit_GetScaler(void *usys_pt, int index);
52
53 /* aligned with PropertyUnit */
54 #define         B_UNIT_NONE 0
55 #define         B_UNIT_LENGTH 1
56 #define         B_UNIT_AREA 2
57 #define         B_UNIT_VOLUME 3
58 #define         B_UNIT_MASS 4
59 #define         B_UNIT_ROTATION 5
60 #define         B_UNIT_TIME 6
61 #define         B_UNIT_VELOCITY 7
62 #define         B_UNIT_ACCELERATION 8
63
64 #ifdef __cplusplus
65 }
66 #endif
67
68 #endif /* BKE_UNIT_H */