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

Index

Constructors

constructor

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

Properties

`Protected` _unit

_unit: U

`Protected` _value

_value: T

Accessors

unit

get unit(): U
Unit this value is in

Returns U
Unit this value is in
- Defined in src/utils/unit/UnitValue.ts:54

Methods

clone

clone(): this
Returns this
- Defined in src/utils/unit/UnitValue.ts:80

setValue

setValue(value): this
Parameters
- value: T
Returns this
- Defined in src/utils/unit/UnitValue.ts:75

to

to<T>(unit): this
Convert the value to another unit
Type Parameters
- T extends Unit
Parameters
- unit: T
  Target unit
Returns this
Converted value
- Defined in src/utils/unit/UnitValue.ts:42

toString

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

Returns string
Unit value as string
- Defined in src/utils/unit/UnitValue.ts:62

valueOf

valueOf(): T
Returns the primitive value

Returns T
Primitive value
- Defined in src/utils/unit/UnitValue.ts:71

Class UnitValue<U, T>

Usage

Creation

Conversion

Type Parameters

U extends Unit = Unit

T extends number | Vector3 = number

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

U extends Unit = 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 U

Methods

clone

Returns this

setValue

Parameters

value: T

Returns this

to

Type Parameters

T extends Unit

Parameters

unit: T

Returns this

toString

Returns string

valueOf

Returns T

Settings

Member Visibility

Theme

On This Page

`Optional` value: T

`Optional` unit: U

`Protected` _unit

`Protected` _value