unit grid snap while transforming, display units in the header.
[blender-staging.git] / source / blender / blenkernel / intern / unit.c
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 #include <stdlib.h>
25 #include <stdio.h>
26 #include <ctype.h>
27 #include <string.h>
28 #include <math.h>
29
30 /* define a single unit */
31 typedef struct bUnitDef {
32         char *name;
33         char *name_plural;      /* abused a bit for the display name */
34         char *name_short;       /* this is used for display*/
35         char *name_alt;         /* can be NULL */
36         
37         double scalar;
38         double bias;            /* not used yet, needed for converting temperature */
39         int flag;
40 } bUnitDef;
41
42 #define B_UNIT_DEF_NONE 0
43 #define B_UNIT_DEF_SUPPRESS 1 /* Use for units that are not used enough to be translated into for common use */
44
45 /* define a single unit */
46 typedef struct bUnitCollection {
47         struct bUnitDef *units;
48         int base_unit;                          /* use for 0.0, or none given */
49         int flag;                                       /* options for this system */
50         int length;                                     /* to quickly find the last item */
51 } bUnitCollection;
52
53 /* Dummy */
54 static struct bUnitDef buDummyDef[] = {
55         {"", NULL, "", NULL,    1.0, 0.0},
56         {NULL, NULL, NULL,      NULL, 0.0, 0.0}
57 };
58 static struct bUnitCollection buDummyCollecton = {buDummyDef, 0, 0, sizeof(buDummyDef)};
59
60
61 /* Lengths */
62 static struct bUnitDef buMetricLenDef[] = {
63         {"kilometer", "Kilometers",             "km", NULL,     1000.0, 0.0,            B_UNIT_DEF_NONE},
64         {"hectometer", "100 Meters",    "hm", NULL,     100.0, 0.0,                     B_UNIT_DEF_SUPPRESS},
65         {"dekameter", "10 Meters",              "dkm",NULL,     10.0, 0.0,                      B_UNIT_DEF_SUPPRESS},
66         {"meter", "Meters",                             "m",  NULL,     1.0, 0.0,                       B_UNIT_DEF_NONE}, /* base unit */
67         {"decimetre", "10 Centimeters", "dm", NULL,     0.1, 0.0,                       B_UNIT_DEF_SUPPRESS},
68         {"centimeter", "Centimeters",   "cm", NULL,     0.01, 0.0,                      B_UNIT_DEF_NONE},
69         {"millimeter", "Millimeters",   "mm", NULL,     0.001, 0.0,                     B_UNIT_DEF_NONE},
70         {"micrometer", "Micrometers",   "um", "┬Ám",    0.000001, 0.0,          B_UNIT_DEF_NONE}, // micron too?
71
72         /* These get displayed because of float precision problems in the transform header,
73          * could work around, but for now probably people wont use these */
74         /*
75         {"nanometer", "Nanometers",             "nm", NULL,     0.000000001, 0.0,       B_UNIT_DEF_NONE},
76         {"picometer", "Picometers",             "pm", NULL,     0.000000000001, 0.0,B_UNIT_DEF_NONE},
77         */
78         {NULL, NULL, NULL,      NULL, 0.0, 0.0}
79 };
80 static struct bUnitCollection buMetricLenCollecton = {buMetricLenDef, 3, 0, sizeof(buMetricLenDef)/sizeof(bUnitDef)};
81
82 static struct bUnitDef buImperialLenDef[] = {
83         {"mile", "Miles",                               "mi", "m",      1609.344, 0.0,  B_UNIT_DEF_NONE},
84         {"furlong", "Furlongs",                 "fur", NULL,201.168, 0.0,       B_UNIT_DEF_SUPPRESS},
85         {"yard", "Yards",                               "yd", NULL,     0.9144, 0.0,    B_UNIT_DEF_NONE},
86         {"foot", "Feet",                                "'", "ft",      0.3048, 0.0,    B_UNIT_DEF_NONE},
87         {"inch", "Inches",                              "\"", "in",     0.0254, 0.0,    B_UNIT_DEF_NONE}, /* base unit */
88         {"thou", "Thous",                               "mil", NULL,0.0000254, 0.0,     B_UNIT_DEF_NONE},
89         {NULL, NULL, NULL, NULL, 0.0, 0.0}
90 };
91 static struct bUnitCollection buImperialLenCollecton = {buImperialLenDef, 3, 0, sizeof(buImperialLenDef)/sizeof(bUnitDef)};
92
93
94 /* Time */
95 static struct bUnitDef buNaturalTimeDef[] = {
96         /* weeks? - probably not needed for blender */
97         {"day", "Days",                                 "d", NULL,      90000.0, 0.0,   B_UNIT_DEF_NONE},
98         {"hour", "Hours",                               "hr", "h",      3600.0, 0.0,    B_UNIT_DEF_NONE},
99         {"minute", "Minutes",                   "min", "m",     60.0, 0.0,              B_UNIT_DEF_NONE},
100         {"second", "Seconds",                   "sec", "s",     1.0, 0.0,               B_UNIT_DEF_NONE}, /* base unit */
101         {"millisecond", "Milliseconds", "ms", NULL,     0.001, 0.0      ,       B_UNIT_DEF_NONE},
102         {"microsecond", "Microseconds", "us", NULL,     0.000001, 0.0,  B_UNIT_DEF_NONE},
103         {NULL, NULL, NULL, NULL, 0.0, 0.0}
104 };
105 static struct bUnitCollection buNaturalTimeCollecton = {buNaturalTimeDef, 3, 0, sizeof(buNaturalTimeDef)/sizeof(bUnitDef)};
106
107 #define UNIT_SYSTEM_MAX 3
108 static struct bUnitCollection *bUnitSystems[][8] = {
109         {0,0,0,0,0,0,0,0},
110         {0,&buMetricLenCollecton, 0,0,0,0, &buNaturalTimeCollecton,0}, /* metric */
111         {0,&buImperialLenCollecton, 0,0,0,0, &buNaturalTimeCollecton,0}, /* imperial */
112         {0,0,0,0,0,0,0,0}
113 };
114
115 /* internal, has some option not exposed */
116 static bUnitCollection *unit_get_system(int system, int type)
117 {
118         return bUnitSystems[system][type]; /* select system to use, metric/imperial/other? */
119 }
120
121 static bUnitDef *unit_default(bUnitCollection *usys)
122 {
123         return &usys->units[usys->base_unit];
124 }
125
126 static bUnitDef *unit_best_fit(double value, bUnitCollection *usys, bUnitDef *unit_start, int suppress)
127 {
128         bUnitDef *unit;
129         double value_abs= value>0.0?value:-value;
130
131         for(unit= unit_start ? unit_start:usys->units; unit->name; unit++) {
132
133                 if(suppress && (unit->flag & B_UNIT_DEF_SUPPRESS))
134                         continue;
135
136                 if (value_abs >= unit->scalar*0.9999) /* scale down scalar so 1cm doesnt convert to 10mm because of float error */
137                         return unit;
138         }
139
140         return unit_default(usys);
141 }
142
143
144
145 /* convert into 2 units and 2 values for "2ft, 3inch" syntax */
146 static void unit_dual_convert(double value, bUnitCollection *usys,
147                 bUnitDef **unit_a, bUnitDef **unit_b, double *value_a, double *value_b)
148 {
149         bUnitDef *unit= unit_best_fit(value, usys, NULL, 1);
150
151         *value_a= floor(value/unit->scalar) * unit->scalar;
152         *value_b= value - (*value_a);
153
154         *unit_a=        unit;
155         *unit_b=        unit_best_fit(*value_b, usys, *unit_a, 1);
156 }
157
158 static int unit_as_string(char *str, double value, int prec, bUnitCollection *usys,
159                 /* non exposed options */
160                 bUnitDef *unit, char pad)
161 {
162         double value_conv;
163         int len, i;
164         
165         if(unit) {
166                 /* use unit without finding the best one */
167         }
168         else if(value == 0.0) {
169                 /* use the default units since there is no way to convert */
170                 unit= unit_default(usys);
171         }
172         else {
173                 unit= unit_best_fit(value, usys, NULL, 1);
174         }
175
176         value_conv= value/unit->scalar;
177
178         /* Convert to a string */
179         {
180                 char conv_str[5] = {'%', '.', '0'+prec, 'f', '\0'}; /* "%.2f" when prec is 2, must be under 10 */
181                 len= sprintf(str, conv_str, (float)value_conv);
182         }
183         
184         
185         /* Add unit prefix and strip zeros */
186         {
187                 /* replace trailing zero's with spaces 
188                  * so the number is less complicated but allignment in a button wont
189                  * jump about while dragging */
190                 int j;
191                 i= len-1;
192
193         
194                 while(i>0 && str[i]=='0') { /* 4.300 -> 4.3 */
195                         str[i--]= pad;
196                 }
197                 
198                 if(i>0 && str[i]=='.') { /* 10. -> 10 */
199                         str[i--]= pad;
200                 }
201                 
202                 /* Now add the suffix */
203                 i++;
204                 j=0;
205                 while(unit->name_short[j]) {
206                         str[i++]= unit->name_short[j++];
207                 }
208
209                 if(pad) {
210                         /* this loop only runs if so many zeros were removed that
211                          * the unit name only used padded chars,
212                          * In that case add padding for the name. */
213
214                         while(i<=len+j) {
215                                 str[i++]= pad;
216                         }
217                 }
218                 
219                 /* terminate no matter whats done with padding above */
220                 str[i] = '\0';
221         }
222
223         return i;
224 }
225
226
227 /* Used for drawing number buttons, try keep fast */
228 void bUnit_AsString(char *str, double value, int prec, int system, int type, int split, int pad)
229 {
230         bUnitCollection *usys = unit_get_system(system, type);
231
232         if(usys==NULL || usys->units[0].name==NULL)
233                 usys= &buDummyCollecton;
234
235         if(split) {
236                 int i;
237                 bUnitDef *unit_a, *unit_b;
238                 double value_a, value_b;
239
240                 unit_dual_convert(value, usys,          &unit_a, &unit_b, &value_a, &value_b);
241
242                 /* check the 2 is a smaller unit */
243                 if(unit_b > unit_a) {
244                         i= unit_as_string(str, value_a, prec, usys,  unit_a, '\0');
245                         str[i++]= ',';
246                         str[i++]= ' ';
247
248                         /* use low precision since this is a smaller unit */
249                         unit_as_string(str+i, value_b, prec?1:0, usys,  unit_b, '\0');
250                         return;
251                 }
252         }
253
254         unit_as_string(str, value, prec, usys,    NULL, pad?' ':'\0');
255 }
256
257
258 static int unit_scale_str(char *str, char *str_tmp, double scale_pref, bUnitDef *unit, char *replace_str)
259 {
260         char *str_found;
261         int change= 0;
262
263         if(replace_str==NULL || replace_str[0] == '\0')
264                 return 0;
265
266         if((str_found= strstr(str, replace_str))) {
267                 /* previous char cannot be a letter */
268                 if (str_found == str || isalpha(*(str_found-1))==0) {
269                         int len_name = strlen(replace_str);
270
271                         /* next char cannot be alphanum */
272                         if (!isalpha(*(str_found+len_name))) {
273                                 int len= strlen(str);
274                                 int len_num= sprintf(str_tmp, "*%g", unit->scalar/scale_pref);
275                                 memmove(str_found+len_num, str_found+len_name, (len+1)-(int)((str_found+len_name)-str)); /* may grow or shrink the string, 1+ to copy the string terminator */
276                                 memcpy(str_found, str_tmp, len_num); /* without the string terminator */
277                                 change= 1;
278                         }
279                 }
280         }
281         return change;
282 }
283
284 static int unit_replace(char *str, char *str_tmp, double scale_pref, bUnitDef *unit)
285 {       
286         int change= 0;
287         change |= unit_scale_str(str, str_tmp, scale_pref, unit, unit->name_short);
288         change |= unit_scale_str(str, str_tmp, scale_pref, unit, unit->name_plural);
289         change |= unit_scale_str(str, str_tmp, scale_pref, unit, unit->name_alt);
290         change |= unit_scale_str(str, str_tmp, scale_pref, unit, unit->name);
291         return change;
292 }
293
294 /* make a copy of the string that replaces the units with numbers
295  * this is used before parsing
296  * This is only used when evaluating user input and can afford to be a bit slower
297  * 
298  * This is to be used before python evaluation so..
299  * 10.1km -> 10.1*1000.0
300  * ...will be resolved by python.
301  * 
302  * str_prev is optional, when valid it is used to get a base unit when none is set.
303  *
304  * return true of a change was made.
305  */
306 int bUnit_ReplaceString(char *str, char *str_orig, char *str_prev, double scale_pref, int system, int type)
307 {
308         bUnitCollection *usys = unit_get_system(system, type);
309
310         bUnitDef *unit;
311         char str_tmp[256];
312         int change= 0;
313         
314         strcpy(str, str_orig);
315
316         if(usys==NULL || usys->units[0].name==NULL) {
317                 return 0;
318         }
319         
320         for(unit= usys->units; unit->name; unit++) {
321
322                 if(unit->flag & B_UNIT_DEF_SUPPRESS)
323                         continue;
324
325                 /* incase there are multiple instances */
326                 while(unit_replace(str, str_tmp, scale_pref, unit))
327                         change= 1;
328         }
329         unit= NULL;
330
331         {
332                 /* try other unit systems now, so we can evaluate imperial when metric is set for eg. */
333                 bUnitCollection *usys_iter;
334                 int system_iter;
335
336                 for(system_iter= 1; system_iter<UNIT_SYSTEM_MAX; system_iter++) {
337                         if (system_iter != system) {
338                                 usys_iter= unit_get_system(system_iter, type);
339                                 for(unit= usys_iter->units; unit->name; unit++) {
340
341                                         if(unit->flag & B_UNIT_DEF_SUPPRESS)
342                                                 continue;
343
344                                         /* incase there are multiple instances */
345                                         while(unit_replace(str, str_tmp, scale_pref, unit))
346                                                 change= 1;
347                                 }
348                         }
349                 }
350         }
351         unit= NULL;
352
353         if(change==0) {
354                 /* no units given so infer a unit from the previous string or default */
355                 if(str_prev) {
356                         /* see which units the original value had */
357                         strcpy(str, str_prev); /* temp overwrite */
358                         for(unit= usys->units; unit->name; unit++) {
359
360                                 if(unit->flag & B_UNIT_DEF_SUPPRESS)
361                                         continue;
362
363                                 if (unit_replace(str, str_tmp, scale_pref, unit))
364                                         break;
365                         }
366                         strcpy(str, str_orig); /* temp overwrite */
367                 }
368
369                 if(unit==NULL)
370                         unit= unit_default(usys);
371
372                 /* add the unit prefic and re-run */
373                 sprintf(str_tmp, "%s %s", str, unit->name);
374
375                 return bUnit_ReplaceString(str, str_tmp, NULL, scale_pref, system, type);
376         }
377
378         // printf("replace %s\n", str);
379         return change;
380 }
381
382
383 double bUnit_ClosestScalar(double value, int system, int type)
384 {
385         bUnitCollection *usys = unit_get_system(system, type);
386         bUnitDef *unit;
387
388         if(usys==NULL)
389                 return -1;
390
391         unit= unit_best_fit(value, usys, NULL, 1);
392         if(unit==NULL)
393                 return -1;
394
395         return unit->scalar;
396 }
397
398 double bUnit_BaseScalar(int system, int type)
399 {
400         bUnitCollection *usys = unit_get_system(system, type);
401         return unit_default(usys)->scalar;
402 }
403
404 /* external access */
405 void bUnit_GetSystem(void **usys_pt, int *len, int system, int type)
406 {
407         bUnitCollection *usys = unit_get_system(system, type);
408         *usys_pt= usys;
409
410         if(usys==NULL) {
411                 *len= 0;
412                 return;
413         }
414
415         *len= usys->length;
416 }
417
418 char *bUnit_GetName(void *usys_pt, int index)
419 {
420         return ((bUnitCollection *)usys_pt)->units[index].name;
421 }
422 char *bUnit_GetNamePlural(void *usys_pt, int index)
423 {
424         return ((bUnitCollection *)usys_pt)->units[index].name_plural;
425 }
426
427 double bUnit_GetScaler(void *usys_pt, int index)
428 {
429         return ((bUnitCollection *)usys_pt)->units[index].scalar;
430 }