Blender V5.3
BKE_unit.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#pragma once
6
7#include "BLI_sys_types.hh"
8
9namespace blender {
10
14
15struct UnitSettings;
16
17/* In all cases the value is assumed to be scaled by the user-preference. */
18
32size_t BKE_unit_value_as_string(char *str,
33 int str_maxncpy,
34 double value,
35 int prec,
36 int type,
37 const UnitSettings &settings,
38 bool pad,
39 bool do_unit_suffix);
40
47 int str_maxncpy,
48 double value,
49 int prec,
50 int system,
51 int type,
52 bool split,
53 bool pad,
54 bool do_unit_suffix);
55
62 int str_maxncpy,
63 double value,
64 int prec,
65 int type,
66 const UnitSettings &settings,
67 bool pad,
68 bool do_unit_suffix);
69
88 char *str, int str_maxncpy, const char *str_prev, double scale_pref, int system, int type);
89
93bool BKE_unit_string_contains_unit(const char *str, int type);
94
98double BKE_unit_apply_preferred_unit(const UnitSettings &settings, int type, double value);
99
103void BKE_unit_name_to_alt(char *str, int str_maxncpy, const char *orig_str, int system, int type);
104
108double BKE_unit_closest_scalar(double value, int system, int type);
109
113double BKE_unit_base_scalar(int system, int type);
114
118bool BKE_unit_is_valid(int system, int type);
119
124double BKE_unit_value_scale(const UnitSettings &settings, int unit_type, double value);
125
129// double bUnit_Iter(void **unit, char **name, int system, int type);
130
131void BKE_unit_system_get(int system, int type, const void **r_usys_pt, int *r_len);
132int BKE_unit_base_get(const void *usys_pt);
133int BKE_unit_base_of_type_get(int system, int type);
138int BKE_preffered_unit_of_type_or_base_get(const UnitSettings &settings, int type);
139const char *BKE_unit_name_get(const void *usys_pt, int index);
140const char *BKE_unit_display_name_get(const void *usys_pt, int index);
141const char *BKE_unit_display_name_short_get(const void *usys_pt, int index);
142const char *BKE_unit_identifier_get(const void *usys_pt, int index);
143double BKE_unit_scalar_get(const void *usys_pt, int index);
144bool BKE_unit_is_suppressed(const void *usys_pt, int index);
145bool BKE_unit_is_adaptive(const UnitSettings &settings, int type);
146
152 public:
153 double scalar = 1.0;
154 double bias = 0.0;
155};
156
162
164enum {
182};
183
184} // namespace blender
#define final(a, b, c)
Definition BLI_hash_c.hh:21
int pad[32 - sizeof(int)]
#define str(s)
void split(const std::string &s, const char delim, std::vector< std::string > &tokens)
Definition abc_util.cc:68
BMesh Iterators.
double BKE_unit_scalar_get(const void *usys_pt, int index)
Definition unit.cc:2638
double BKE_unit_value_scale(const UnitSettings &settings, int unit_type, double value)
Definition unit.cc:1963
const char * BKE_unit_identifier_get(const void *usys_pt, int index)
Definition unit.cc:2627
double BKE_unit_base_scalar(int system, int type)
Definition unit.cc:2561
bool BKE_unit_is_suppressed(const void *usys_pt, int index)
Definition unit.cc:2645
UnitConversion BKE_unit_preferred_conversion_get(const UnitSettings &settings, int unit_type)
Definition unit.cc:2658
int BKE_unit_base_of_type_get(int system, int type)
Definition unit.cc:2594
const char * BKE_unit_display_name_short_get(const void *usys_pt, int index)
Definition unit.cc:2621
bool BKE_unit_replace_string(char *str, int str_maxncpy, const char *str_prev, double scale_pref, int system, int type)
Definition unit.cc:2414
int BKE_preffered_unit_of_type_or_base_get(const UnitSettings &settings, int type)
Definition unit.cc:2599
size_t BKE_unit_value_as_string_adaptive(char *str, int str_maxncpy, double value, int prec, int system, int type, bool split, bool pad, bool do_unit_suffix)
Definition unit.cc:1908
void BKE_unit_system_get(int system, int type, const void **r_usys_pt, int *r_len)
Definition unit.cc:2576
size_t BKE_unit_value_as_string(char *str, int str_maxncpy, double value, int prec, int type, const UnitSettings &settings, bool pad, bool do_unit_suffix)
Definition unit.cc:1929
bool BKE_unit_string_contains_unit(const char *str, int type)
Definition unit.cc:2388
bool BKE_unit_is_valid(int system, int type)
Definition unit.cc:2571
size_t BKE_unit_value_as_string_scaled(char *str, int str_maxncpy, double value, int prec, int type, const UnitSettings &settings, bool pad, bool do_unit_suffix)
Definition unit.cc:1944
double BKE_unit_closest_scalar(double value, int system, int type)
Definition unit.cc:2545
const char * BKE_unit_name_get(const void *usys_pt, int index)
Definition unit.cc:2609
int BKE_unit_base_get(const void *usys_pt)
Definition unit.cc:2589
void BKE_unit_name_to_alt(char *str, int str_maxncpy, const char *orig_str, int system, int type)
Definition unit.cc:2504
const char * BKE_unit_display_name_get(const void *usys_pt, int index)
Definition unit.cc:2615
@ B_UNIT_CAMERA
Definition BKE_unit.hh:175
@ B_UNIT_MASS
Definition BKE_unit.hh:169
@ B_UNIT_AREA
Definition BKE_unit.hh:167
@ B_UNIT_LENGTH
Definition BKE_unit.hh:166
@ B_UNIT_TYPE_TOT
Definition BKE_unit.hh:181
@ B_UNIT_ACCELERATION
Definition BKE_unit.hh:174
@ B_UNIT_TIME
Definition BKE_unit.hh:171
@ B_UNIT_VELOCITY
Definition BKE_unit.hh:173
@ B_UNIT_VOLUME
Definition BKE_unit.hh:168
@ B_UNIT_TIME_ABSOLUTE
Definition BKE_unit.hh:172
@ B_UNIT_POWER
Definition BKE_unit.hh:176
@ B_UNIT_NONE
Definition BKE_unit.hh:165
@ B_UNIT_ROTATION
Definition BKE_unit.hh:170
@ B_UNIT_FREQUENCY
Definition BKE_unit.hh:180
@ B_UNIT_TEMPERATURE
Definition BKE_unit.hh:177
@ B_UNIT_COLOR_TEMPERATURE
Definition BKE_unit.hh:179
@ B_UNIT_WAVELENGTH
Definition BKE_unit.hh:178
bool BKE_unit_is_adaptive(const UnitSettings &settings, int type)
Definition unit.cc:2652
double BKE_unit_apply_preferred_unit(const UnitSettings &settings, int type, double value)
Definition unit.cc:2402