MRUnitInfo.h

Go to the documentation of this file.

#pragma once
 
#include <MRCMisc/exports.h>
 
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct MR_std_string_view MR_std_string_view; // Defined in `#include <MRCMisc/std_string_view.h>`.
 
 
// A stub measurement unit representing no unit.
typedef enum MR_NoUnit
{
    MR_NoUnit__count = 0,
} MR_NoUnit;
 
// Measurement units of length.
typedef enum MR_LengthUnit
{
    MR_LengthUnit_microns = 0,
    MR_LengthUnit_millimeters = 1,
    MR_LengthUnit_centimeters = 2,
    MR_LengthUnit_meters = 3,
    MR_LengthUnit_inches = 4,
    MR_LengthUnit_feet = 5,
    MR_LengthUnit__count = 6,
} MR_LengthUnit;
 
// Measurement units of angle.
typedef enum MR_AngleUnit
{
    MR_AngleUnit_radians = 0,
    MR_AngleUnit_degrees = 1,
    MR_AngleUnit__count = 2,
} MR_AngleUnit;
 
// Measurement units of screen sizes.
typedef enum MR_PixelSizeUnit
{
    MR_PixelSizeUnit_pixels = 0,
    MR_PixelSizeUnit__count = 1,
} MR_PixelSizeUnit;
 
// Measurement units for factors / ratios.
typedef enum MR_RatioUnit
{
    // 0..1 x
    MR_RatioUnit_factor = 0,
    // 0..100 %
    MR_RatioUnit_percents = 1,
    MR_RatioUnit__count = 2,
} MR_RatioUnit;
 
// Measurement units for time.
typedef enum MR_TimeUnit
{
    MR_TimeUnit_seconds = 0,
    MR_TimeUnit_milliseconds = 1,
    MR_TimeUnit__count = 2,
} MR_TimeUnit;
 
// Measurement units for movement speed.
typedef enum MR_MovementSpeedUnit
{
    MR_MovementSpeedUnit_micronsPerSecond = 0,
    MR_MovementSpeedUnit_millimetersPerSecond = 1,
    MR_MovementSpeedUnit_centimetersPerSecond = 2,
    MR_MovementSpeedUnit_metersPerSecond = 3,
    MR_MovementSpeedUnit_inchesPerSecond = 4,
    MR_MovementSpeedUnit_feetPerSecond = 5,
    MR_MovementSpeedUnit__count = 6,
} MR_MovementSpeedUnit;
 
// Measurement units for surface area.
typedef enum MR_AreaUnit
{
    MR_AreaUnit_microns2 = 0,
    MR_AreaUnit_millimeters2 = 1,
    MR_AreaUnit_centimeters2 = 2,
    MR_AreaUnit_meters2 = 3,
    MR_AreaUnit_inches2 = 4,
    MR_AreaUnit_feet2 = 5,
    MR_AreaUnit__count = 6,
} MR_AreaUnit;
 
// Measurement units for body volume.
typedef enum MR_VolumeUnit
{
    MR_VolumeUnit_microns3 = 0,
    MR_VolumeUnit_millimeters3 = 1,
    MR_VolumeUnit_centimeters3 = 2,
    MR_VolumeUnit_meters3 = 3,
    MR_VolumeUnit_inches3 = 4,
    MR_VolumeUnit_feet3 = 5,
    MR_VolumeUnit__count = 6,
} MR_VolumeUnit;
 
// Measurement units for 1/length.
typedef enum MR_InvLengthUnit
{
    MR_InvLengthUnit_inv_microns = 0,
    MR_InvLengthUnit_inv_millimeters = 1,
    MR_InvLengthUnit_inv_centimeters = 2,
    MR_InvLengthUnit_inv_meters = 3,
    MR_InvLengthUnit_inv_inches = 4,
    MR_InvLengthUnit_inv_feet = 5,
    MR_InvLengthUnit__count = 6,
} MR_InvLengthUnit;
 
// Information about a single measurement unit.
typedef struct MR_UnitInfo MR_UnitInfo;
 
// This is used to convert between units.
// To convert from A to B, multiply by A's factor and divide by B's.
MRC_API const float *MR_UnitInfo_Get_conversionFactor(const MR_UnitInfo *_this);
 
// This is used to convert between units.
// To convert from A to B, multiply by A's factor and divide by B's.
MRC_API void MR_UnitInfo_Set_conversionFactor(MR_UnitInfo *_this, float value);
 
// This is used to convert between units.
// To convert from A to B, multiply by A's factor and divide by B's.
MRC_API float *MR_UnitInfo_GetMutable_conversionFactor(MR_UnitInfo *_this);
 
MRC_API const MR_std_string_view *MR_UnitInfo_Get_prettyName(const MR_UnitInfo *_this);
 
MRC_API void MR_UnitInfo_Set_prettyName(MR_UnitInfo *_this, const char *value, const char *value_end);
 
MRC_API MR_std_string_view *MR_UnitInfo_GetMutable_prettyName(MR_UnitInfo *_this);
 
// The short unit name that's placed after values.
// This may or may not start with a space.
MRC_API const MR_std_string_view *MR_UnitInfo_Get_unitSuffix(const MR_UnitInfo *_this);
 
// The short unit name that's placed after values.
// This may or may not start with a space.
MRC_API void MR_UnitInfo_Set_unitSuffix(MR_UnitInfo *_this, const char *value, const char *value_end);
 
// The short unit name that's placed after values.
// This may or may not start with a space.
MRC_API MR_std_string_view *MR_UnitInfo_GetMutable_unitSuffix(MR_UnitInfo *_this);
 
MRC_API MR_UnitInfo *MR_UnitInfo_DefaultConstruct(void);
 
MRC_API MR_UnitInfo *MR_UnitInfo_DefaultConstructArray(size_t num_elems);
 
MRC_API MR_UnitInfo *MR_UnitInfo_ConstructFrom(float conversionFactor, const char *prettyName, const char *prettyName_end, const char *unitSuffix, const char *unitSuffix_end);
 
MRC_API const MR_UnitInfo *MR_UnitInfo_OffsetPtr(const MR_UnitInfo *ptr, ptrdiff_t i);
 
MRC_API MR_UnitInfo *MR_UnitInfo_OffsetMutablePtr(MR_UnitInfo *ptr, ptrdiff_t i);
 
MRC_API MR_UnitInfo *MR_UnitInfo_ConstructFromAnother(const MR_UnitInfo *_other);
 
MRC_API void MR_UnitInfo_Destroy(const MR_UnitInfo *_this);
 
MRC_API void MR_UnitInfo_DestroyArray(const MR_UnitInfo *_this);
 
MRC_API MR_UnitInfo *MR_UnitInfo_AssignFromAnother(MR_UnitInfo *_this, const MR_UnitInfo *_other);
 
#ifdef __cplusplus
} // extern "C"
#endif