Blender
V3.3
|
Go to the source code of this file.
Enumerations | |
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 } |
Functions | |
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) |
bool | BKE_unit_replace_string (char *str, int len_max, const char *str_prev, double scale_pref, int system, int type) |
bool | BKE_unit_string_contains_unit (const char *str, int type) |
double | BKE_unit_apply_preferred_unit (const struct UnitSettings *settings, int type, double value) |
void | BKE_unit_name_to_alt (char *str, int len_max, const char *orig_str, int system, int type) |
double | BKE_unit_closest_scalar (double value, int system, int type) |
double | BKE_unit_base_scalar (int system, int type) |
bool | BKE_unit_is_valid (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) |
anonymous enum |
Aligned with PropertyUnit and bpyunits_ucategories_items
in bpy_utils_units.c
.
Definition at line 99 of file BKE_unit.h.
double BKE_unit_apply_preferred_unit | ( | const struct UnitSettings * | settings, |
int | type, | ||
double | value | ||
) |
If user does not specify a unit, this converts it to the unit from the settings.
Definition at line 1080 of file unit.c.
References bUnitDef::bias, BKE_unit_base_scalar(), get_preferred_display_unit_if_used(), NULL, preferred_units_from_UnitSettings(), bUnitDef::scalar, PreferredUnits::system, and type.
Referenced by user_string_to_number().
int BKE_unit_base_get | ( | const void * | usys_pt | ) |
Definition at line 1264 of file unit.c.
Referenced by ED_scene_grid_scale(), and ED_view3d_grid_steps().
int BKE_unit_base_of_type_get | ( | int | system, |
int | type | ||
) |
Definition at line 1269 of file unit.c.
References bUnitCollection::base_unit, type, and unit_get_system().
Referenced by blo_do_versions_280(), and scene_init_data().
double BKE_unit_base_scalar | ( | int | system, |
int | type | ||
) |
Base scale for these units.
Definition at line 1236 of file unit.c.
References bUnitDef::scalar, type, unit_default(), and unit_get_system().
Referenced by BKE_unit_apply_preferred_unit(), and ui_numedit_apply_snapf().
The size of the unit used for this value (used for calculating the click-step).
Definition at line 1220 of file unit.c.
References NULL, bUnitDef::scalar, type, unit_best_fit(), and unit_get_system().
Referenced by ui_get_but_step_unit().
const char* BKE_unit_display_name_get | ( | const void * | usys_pt, |
int | index | ||
) |
Definition at line 1278 of file unit.c.
Referenced by ED_scene_grid_scale(), and ED_view3d_grid_view_scale().
const char* BKE_unit_identifier_get | ( | const void * | usys_pt, |
int | index | ||
) |
Definition at line 1282 of file unit.c.
References BLI_assert_msg, bUnitDef::identifier, and NULL.
Definition at line 1296 of file unit.c.
References B_UNIT_DEF_SUPPRESS.
bool BKE_unit_is_valid | ( | int | system, |
int | type | ||
) |
Definition at line 1246 of file unit.c.
References B_UNIT_TYPE_TOT, and UNIT_SYSTEM_TOT.
Referenced by bpyunits_validate(), and ui_numedit_apply_snapf().
const char* BKE_unit_name_get | ( | const void * | usys_pt, |
int | index | ||
) |
void BKE_unit_name_to_alt | ( | char * | str, |
int | len_max, | ||
const char * | orig_str, | ||
int | system, | ||
int | type | ||
) |
Make string keyboard-friendly, e.g: 10µm -> 10um
.
Definition at line 1180 of file unit.c.
References B_UNIT_DEF_CASE_SENSITIVE, BLI_strncpy_rlen(), bUnitDef::name, offset, str, type, unit_find_str(), unit_get_system(), and bUnitCollection::units.
Referenced by bpyunits_to_string(), and ui_but_convert_to_unit_alt_name().
bool BKE_unit_replace_string | ( | char * | str, |
int | len_max, | ||
const char * | str_prev, | ||
double | scale_pref, | ||
int | system, | ||
int | type | ||
) |
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
str_prev | is optional, when valid it is used to get a base unit when none is set. |
Definition at line 1091 of file unit.c.
References BLI_snprintf(), ch_is_op(), ELEM, is_valid_unit_collection(), bUnitDef::name, bUnitDef::scalar, SEP_CHR, str, TEMP_STR_SIZE, type, unit_detect_from_str(), unit_distribute_negatives(), unit_get_system(), unit_replace(), UNIT_SYSTEM_TOT, and bUnitCollection::units.
Referenced by bpyunits_to_value(), and user_string_to_number().
Definition at line 1291 of file unit.c.
Referenced by ED_scene_grid_scale(), and ED_view3d_grid_steps().
bool BKE_unit_string_contains_unit | ( | const char * | str, |
int | type | ||
) |
Definition at line 1063 of file unit.c.
References is_valid_unit_collection(), bUnitCollection::length, str, type, unit_find(), unit_get_system(), UNIT_SYSTEM_TOT, and bUnitCollection::units.
Referenced by user_string_to_number().
Loop over scales, could add names later.
Definition at line 1251 of file unit.c.
References bUnitCollection::length, NULL, type, and unit_get_system().
Referenced by ED_scene_grid_scale(), ED_view3d_grid_steps(), and ED_view3d_grid_view_scale().
size_t BKE_unit_value_as_string | ( | char * | str, |
int | len_max, | ||
double | value, | ||
int | prec, | ||
int | type, | ||
const struct UnitSettings * | settings, | ||
bool | pad | ||
) |
Representation of a value in units. Negative precision is used to disable stripping of zeroes. This reduces text jumping when changing values.
Referenced by applyShrinkFatten(), depthdropper_depth_sample_pt(), DRW_text_edit_mesh_measure_stats(), edbm_bevel_update_status_text(), edbm_inset_update_header(), knifetool_draw_angle(), knifetool_draw_visible_distances(), ruler_item_as_string(), translate_dist_to_str(), ui_get_but_string_unit(), and voxel_size_edit_draw().
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 | ||
) |
Humanly readable representation of a value in units (used for button drawing).
Definition at line 665 of file unit.c.
References PreferredUnits::length, PreferredUnits::mass, pad, PreferredUnits::rotation, blender::io::alembic::split(), str, PreferredUnits::system, PreferredUnits::temperature, PreferredUnits::time, type, unit_as_string_main(), and USER_UNIT_ADAPTIVE.
Referenced by bpyunits_to_string(), outputNumInput(), and value_to_editstr().