Class UnitValue<U, T>

Unit value

Usage

Creation

const value = new UnitValue(5, LengthUnit.METER);

Conversion

const value = new UnitValue(5, LengthUnit.METER);
const converted = value.to(LengthUnit.CENTIMETER);

Type Parameters

U extends Unit = Unit
T extends number | Vector3 = number

Hierarchy

UnitValue

Index

Constructors

constructor

new UnitValue<U, T>(value?: T, unit?: U): UnitValue<U, T>
Type Parameters
- U extends Unit<U> = Unit
- T extends number | Vector3 = number
Parameters
- Optional value: T
- Optional unit: U
Returns UnitValue<U, T>
- Defined in src/utils/unit/UnitValue.ts:33

Properties

`Protected` _unit

_unit: U

`Protected` _value

_value: T

Accessors

unit

get unit(): U
Unit this value is in

Returns
Unit this value is in

Returns U
- Defined in src/utils/unit/UnitValue.ts:57

Methods

clone

clone(): UnitValue<U, T>
Returns UnitValue<U, T>
- Defined in src/utils/unit/UnitValue.ts:85

setValue

setValue(value: T): UnitValue<U, T>
Parameters
- value: T
Returns UnitValue<U, T>
- Defined in src/utils/unit/UnitValue.ts:80

to

to<T>(unit: T): UnitValue<U, T>
Convert the value to another unit

Returns
Converted value
Type Parameters
- T extends Unit<T>
Parameters
- unit: T
  
  Target unit
Returns UnitValue<U, T>
- Defined in src/utils/unit/UnitValue.ts:44

toString

toString(): string
Returns a string representation of an object.

Returns
Unit value as string

Returns string
- Defined in src/utils/unit/UnitValue.ts:66

valueOf

valueOf(): T
Returns the primitive value

Returns
Primitive value

Returns T
- Defined in src/utils/unit/UnitValue.ts:76

Class UnitValue<U, T>

Usage

Creation

Conversion

Type Parameters

U extends Unit = Unit

T extends number | Vector3 = number

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

U extends Unit<U> = Unit

T extends number | Vector3 = number

Parameters

Optional value: T

Optional unit: U

Returns UnitValue<U, T>

Properties

Protected _unit

Protected _value

Accessors

unit

Returns

Returns U

Methods

clone

Returns UnitValue<U, T>

setValue

Parameters

value: T

Returns UnitValue<U, T>

to

Returns

Type Parameters

T extends Unit<T>

Parameters

unit: T

Returns UnitValue<U, T>

toString

Returns

Returns string

valueOf

Returns

Returns T

Settings

Member Visibility

Theme

`Optional` value: T

`Optional` unit: U

`Protected` _unit

`Protected` _value