BKE_unit.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include "BLI_sys_types.h"

 
struct UnitSettings;
 
/* In all cases the value is assumed to be scaled by the user-preference. */

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);
size_t BKE_unit_value_as_string(char *str,
                                int str_maxncpy,
                                double value,
                                int prec,
                                int type,
                                const UnitSettings &settings,
                                bool pad);

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 BKE_unit_replace_string(
    char *str, int str_maxncpy, 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 UnitSettings &settings, int type, double value);

void BKE_unit_name_to_alt(char *str, int str_maxncpy, 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);

double BKE_unit_value_scale(const UnitSettings &settings, int unit_type, double value);

// 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);

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_WAVELENGTH = 13,
  B_UNIT_COLOR_TEMPERATURE = 14,
  B_UNIT_FREQUENCY = 15,
  B_UNIT_TYPE_TOT = 16,
};