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