Class DistanceUnits

A class that contains helpers for transforming values and points between world space distances and real space distances.

Hierarchy

DistanceUnits

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DistanceUnits(unitType: DistanceUnitType): DistanceUnits

- Defined in packages/viewer/src/lib/types/distanceUnits.ts:122
Parameters
- unitType: DistanceUnitType
Returns DistanceUnits

Properties

Readonly unit

unit: Unit

The unit of this measurement.

Readonly unitType

unitType: DistanceUnitType

Methods

convertRealPointToWorld

convertRealPointToWorld(pt: Vector3): Vector3

- Defined in packages/viewer/src/lib/types/distanceUnits.ts:165
Translates a real space point to a point in world space.

Parameters
- pt: Vector3
  
  A point in real space.
Returns Vector3
A point in world space.

convertRealValueToWorld

convertRealValueToWorld(value: number): number

- Defined in packages/viewer/src/lib/types/distanceUnits.ts:142
Translates a real space value to a world space value.

Parameters
- value: number
  
  A real space value to translate.
Returns number
A world space value.

convertWorldPointToReal

convertWorldPointToReal(pt: Vector3): Vector3

- Defined in packages/viewer/src/lib/types/distanceUnits.ts:152
Translates a world space point to a point in real space.

Parameters
- pt: Vector3
  
  A point in world space.
Returns Vector3
A point in real space.

convertWorldValueToReal

convertWorldValueToReal(value: number): number

- Defined in packages/viewer/src/lib/types/distanceUnits.ts:132
Translates a world space value to a real space value.

Parameters
- value: number
  
  A world space value to translate.
Returns number
A value in real space units.