Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > Math > FNumericUnit

Light Theme

Dark Theme

FNumericUnit

[FNumericUnit](API\Runtime\Core\Math\FNumericUnit) is a numeric type that wraps the templated type, whilst a specified unit.

Windows

MacOS

Linux

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Math/UnitConversion.h
Include	#include "Math/UnitConversion.h"

Syntax

template<typename NumericType>
struct FNumericUnit

Remarks

FNumericUnit is a numeric type that wraps the templated type, whilst a specified unit. It handles conversion to/from related units automatically. The units are considered not to contribute to the type's state, and as such should be considered immutable once set.

Forward declaration of types defined in UnitConversion.h

Variables

		Name	Description
	const EUnit	Units	The associated units for the value.
	NumericType	Value	The numeric (scalar) value

Constructors

	Name	Description
	FNumericUnit()	Constructors
	FNumericUnit ( const FNumericUnit& Other )	Copy construction/assignment from the same type
	FNumericUnit ( const FNumericUnit< OtherType >& O... )	Templated Copy construction/assignment from differing numeric types.
	FNumericUnit ( const NumericType& InValue, EUnit InUnits )

Functions

	Name	Description
TOptional< F...	ConvertTo ( EUnit ToUnits )	Convert this quantity to a different unit
FNumericUnit...	QuantizeUnitsToBestFit()	Quantizes this number to the most appropriate unit for user friendly presentation (e.g. 1000m returns 1km).
TValueOrErro...	TryParseExpression ( const TCHAR* InExpression, EUnit InDefaultUnit, const FNumericUnit< NumericType >&... )	Try and parse an expression into a numeric unit
TOptional< F...	TryParseString ( const TCHAR* InSource )	Parse a numeric unit from a string

Operators

		Name	Description
	FNumericUnit...	operator= ( const FNumericUnit& Other )
	FNumericUnit...	operator= ( const FNumericUnit< OtherType >& O... )
	FNumericUnit...	operator= ( const FNumericUnit< OtherType >& O... )

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss