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