MRUnitSettings.h

Go to the documentation of this file.

#pragma once
 
#include "exports.h"
#include "MRUnits.h"
 
// This abstracts away the UI measurement unit configuration. Internally this uses `setDefaultUnitParams()`.
 
namespace MR::UnitSettings
{
 
// Reset to some sane default.
MRVIEWER_API void resetToDefaults();
 
// Common:
 
// True: `0.1`, false: `.1`.
[[nodiscard]] MRVIEWER_API bool getShowLeadingZero();
MRVIEWER_API void setShowLeadingZero( bool show );
 
// Can be '\0' to indicate no separator.
// `fractional == true` means to the right of the fractional point, if any.
[[nodiscard]] MRVIEWER_API char getThousandsSeparator();
MRVIEWER_API void setThousandsSeparator( char ch );
 
// Length:
 
// Set "targetUnit" for Length based dimensions, which reflects on UI suffix
// Length based dimensions: length, speed, area, volume, etc
// This can be null to indicate "no unit".
// If `setPreferredLeadingZero == true`, will call `setShowLeadingZero()` to match this unit (currently inches = false, everything else = true).
[[nodiscard]] MRVIEWER_API std::optional<LengthUnit> getUiLengthUnit();
MRVIEWER_API void setUiLengthUnit( std::optional<LengthUnit> unit, bool setPreferredLeadingZero );
 
// Set "sourceUnit" for Length based dimensions, which reflects on scaling input data to match "targetUnit"
// Length based dimensions: length, speed, area, volume, etc
// This can be null to indicate "no unit".
[[nodiscard]] MRVIEWER_API std::optional<LengthUnit> getModelLengthUnit();
MRVIEWER_API void setModelLengthUnit( std::optional<LengthUnit> unit );
 
// Angle:
 
[[nodiscard]] MRVIEWER_API DegreesMode getDegreesMode();
MRVIEWER_API void setDegreesMode( DegreesMode mode, bool setPreferredPrecision );
 
// Precision:
 
// Whether this means total number of digits or the number of digits after the decimal point depends
//   on another setting (`getDefaultUnitParams().style`) that's currently not exposed in this file.
[[nodiscard]] MRVIEWER_API int getUiLengthPrecision();
MRVIEWER_API void setUiLengthPrecision( int precision );
 
[[nodiscard]] MRVIEWER_API int getUiAnglePrecision();
MRVIEWER_API void setUiAnglePrecision( int precision );
 
[[nodiscard]] MRVIEWER_API int getUiRatioPrecision();
MRVIEWER_API void setUiRatioPrecision( int precision );
 
}