1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
/*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#pragma once
/** \file
* \ingroup bke
*/
#ifdef __cplusplus
extern "C" {
#endif
struct UnitSettings;
/* In all cases the value is assumed to be scaled by the user-preference. */
/**
* Humanly readable representation of a value in units (used for button drawing).
*/
size_t BKE_unit_value_as_string_adaptive(
char *str, int len_max, double value, int prec, int system, int type, bool split, bool pad);
size_t BKE_unit_value_as_string(char *str,
int len_max,
double value,
int prec,
int type,
const struct UnitSettings *settings,
bool pad);
/**
* Replace units with values, used before python button evaluation.
*
* Make a copy of the string that replaces the units with numbers.
* This is only used when evaluating user input and can afford to be a bit slower
*
* This is to be used before python evaluation so:
* `10.1km -> 10.1*1000.0`
* ...will be resolved by Python.
*
* Values will be split by an add sign:
* `5'2" -> 5*0.3048 + 2*0.0254`
*
* \param str_prev: is optional, when valid it is used to get a base unit when none is set.
*
* \return True of a change was made.
*/
bool BKE_unit_replace_string(
char *str, int len_max, const char *str_prev, double scale_pref, int system, int type);
/**
* \return true if the string contains any valid unit for the given type.
*/
bool BKE_unit_string_contains_unit(const char *str, int type);
/**
* If user does not specify a unit, this converts it to the unit from the settings.
*/
double BKE_unit_apply_preferred_unit(const struct UnitSettings *settings, int type, double value);
/**
* Make string keyboard-friendly, e.g: `10µm -> 10um`.
*/
void BKE_unit_name_to_alt(char *str, int len_max, const char *orig_str, int system, int type);
/**
* The size of the unit used for this value (used for calculating the click-step).
*/
double BKE_unit_closest_scalar(double value, int system, int type);
/**
* Base scale for these units.
*/
double BKE_unit_base_scalar(int system, int type);
/**
* \return true is the unit system exists.
*/
bool BKE_unit_is_valid(int system, int type);
/**
* Loop over scales, could add names later.
*/
// double bUnit_Iter(void **unit, char **name, int system, int type);
void BKE_unit_system_get(int system, int type, const void **r_usys_pt, int *r_len);
int BKE_unit_base_get(const void *usys_pt);
int BKE_unit_base_of_type_get(int system, int type);
const char *BKE_unit_name_get(const void *usys_pt, int index);
const char *BKE_unit_display_name_get(const void *usys_pt, int index);
const char *BKE_unit_identifier_get(const void *usys_pt, int index);
double BKE_unit_scalar_get(const void *usys_pt, int index);
bool BKE_unit_is_suppressed(const void *usys_pt, int index);
/** Aligned with #PropertyUnit. */
enum {
B_UNIT_NONE = 0,
B_UNIT_LENGTH = 1,
B_UNIT_AREA = 2,
B_UNIT_VOLUME = 3,
B_UNIT_MASS = 4,
B_UNIT_ROTATION = 5,
B_UNIT_TIME = 6,
B_UNIT_TIME_ABSOLUTE = 7,
B_UNIT_VELOCITY = 8,
B_UNIT_ACCELERATION = 9,
B_UNIT_CAMERA = 10,
B_UNIT_POWER = 11,
B_UNIT_TEMPERATURE = 12,
B_UNIT_TYPE_TOT = 13,
};
#ifdef __cplusplus
}
#endif
|
