Class Metrics

Configures its View's measurement unit and mapping between the Real-space and World-space 3D Cartesian coordinate systems.

Located at View.metrics.
Metrics.units configures the Real-space unit type, which is constants!MetersUnit by default.
Metrics.scale configures the number of Real-space units represented by each unit within the World-space 3D coordinate system. This is 1.0 by default.
Metrics.origin configures the 3D Real-space origin, in current Real-space units, at which this View's World-space coordinate origin sits, This is [0,0,0] by default.

Usage

import {Viewer, constants} from "xeokit-viewer.es.js";

const viewer = new Viewer();

const view1 = myViewer.createView({
     id: "myView",
     elementId: "myCanvas1"
});

const metrics = view1.metrics;

metrics.units = MetersUnit;
metrics.scale = 10.0;
metrics.origin = [100.0, 0.0, 200.0];

Hierarchy (View Summary)

Component
- Metrics

Index

Properties

destroyed

destroyed: boolean

True once this Component has been destroyed.

Don't use this Component if this is true.

`Protected`dirty

dirty: boolean

id

id: string

Unique ID of this Component.

Accessors

origin

get origin(): FloatArrayParam
Gets the 3D Real-space origin, in Real-space units, at which this View's World-space coordinate origin [0,0,0] sits.

Returns FloatArrayParam
- Defined in packages/sdk/src/viewer/Metriqs.ts:201
set origin(value: FloatArrayParam): void
Sets the Real-space 3D origin, in Real-space units, at which this View's World-space coordinate origin [0,0,0] sits.
Parameters
- value: FloatArrayParam
Returns void
- Defined in packages/sdk/src/viewer/Metriqs.ts:208

scale

get scale(): number
Gets the number of Real-space units represented by each unit of the View's World-space coordinate system.

Returns number
- Defined in packages/sdk/src/viewer/Metriqs.ts:179
set scale(value: number): void
Sets the number of Real-space units represented by each unit of the View's World-space coordinate system.

For example, if Metrics.units is constants!MetersUnit, and there are ten meters per World-space coordinate system unit, then scale would have a value of 10.0.
Parameters
- value: number
Returns void
- Defined in packages/sdk/src/viewer/Metriqs.ts:188

units

get units(): number
Gets the View's Real-space unit type.

Returns number
- Defined in packages/sdk/src/viewer/Metriqs.ts:153
set units(value: number): void
Sets the View's Real-space unit type.

Accepted values are constants!MetersUnit, constants!CentimetersUnit, constants!MillimetersUnit, constants!YardsUnit, constants!FeetUnit and constants!InchesUnit.
Parameters
- value: number
Returns void
- Defined in packages/sdk/src/viewer/Metriqs.ts:162

unitsInfo

get unitsInfo(): {}

Gets info about the supported Real-space unit types.

With constants indicating each unit type, the info will be:

{
    [MetersUnit]: {
        abbrev: "m"
    },
    [CentimetersUnit]: {
        abbrev: "cm"
    },
    [MillimetersUnit]: {
        abbrev: "mm"
    },
    [YardsUnit]: {
        abbrev: "yd"
    },
    [FeetUnit]: {
        abbrev: "ft"
    },
    [InchesUnit]: {
        abbrev: "in"
    }
}

Returns {}

Methods

`Protected`clean

clean(): void
Forces this component to action any deferred state updates.

Returns void
Inherited from Component.clean
- Defined in packages/sdk/src/core/Component.ts:119

`Protected`cleanIfDirty

cleanIfDirty(): void
Gives this component an opportunity to action any defered state updates.

Returns void
Inherited from Component.cleanIfDirty
- Defined in packages/sdk/src/core/Component.ts:109

`Protected`error

error(message: string): void
Protected
Logs an error for this component to the JavaScript console.

The console message will have this format: [ERROR] [<component type> =<component id>: <message>
Parameters
- message: string
  The error message to log
Returns void
Inherited from Component.error
- Defined in packages/sdk/src/core/Component.ts:95

`Protected`log

log(message: string): void
Protected
Logs a message for this component.

The message will have this format: [LOG] [<component type> <component id>: <message>
Parameters
- message: string
  The message to log
Returns void
Inherited from Component.log
- Defined in packages/sdk/src/core/Component.ts:71

realToWorldPos

realToWorldPos(
realPos: FloatArrayParam,
worldPos?: FloatArrayParam,
): FloatArrayParam
Converts a 3D position from Real-space to World-space.

This is equivalent to worldPos = (worldPos - #origin) / #scale.
Parameters
- realPos: FloatArrayParam
  Real-space 3D position.
- OptionalworldPos: FloatArrayParam = ...
  Destination for World-space 3D position.
Returns FloatArrayParam
World-space 3D position.
- Defined in packages/sdk/src/viewer/Metriqs.ts:246

`Protected`setDirty

setDirty(): void
Flags this component as having a defered state updates it needs to perform.

Returns void
Inherited from Component.setDirty
- Defined in packages/sdk/src/core/Component.ts:102

`Protected`warn

warn(message: string): void
Protected
Logs a warning for this component to the JavaScript console.

The console message will have this format: [WARN] [<component type> =<component id>: <message>
Parameters
- message: string
  The warning message to log
Returns void
Inherited from Component.warn
- Defined in packages/sdk/src/core/Component.ts:83

worldToRealPos

worldToRealPos(
worldPos: FloatArrayParam,
realPos?: FloatArrayParam,
): FloatArrayParam
Converts a 3D position from World-space to Real-space.

This is equivalent to realPos = #origin + (worldPos * #scale).
Parameters
- worldPos: FloatArrayParam
  World-space 3D position, in World coordinate system units.
- OptionalrealPos: FloatArrayParam = ...
  Destination for Real-space 3D position.
Returns FloatArrayParam
Real-space 3D position, in units indicated by Metrics#units.
- Defined in packages/sdk/src/viewer/Metriqs.ts:230

Events

onDestroyed

onDestroyed: EventEmitter<Component, null>

Emits an event when the Component has been destroyed.

`Readonly`onOrigin

onOrigin: EventEmitter<Metrics, FloatArrayParam>

Emits an event each time Metrics.origin changes.

`Readonly`onScale

onScale: EventEmitter<Metrics, number>

Emits an event each time Metrics.scale changes.

`Readonly`onUnits

onUnits: EventEmitter<Metrics, number>

Emits an event each time Metrics.units changes.

Class Metrics

Usage

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Events

Properties

destroyed

Protecteddirty

id

Accessors

origin

Returns FloatArrayParam

Parameters

Returns void

scale

Returns number

Parameters

Returns void

units

Returns number

Parameters

Returns void

unitsInfo

Returns {}

Methods

Protectedclean

Returns void

ProtectedcleanIfDirty

Returns void

Protectederror

Parameters

Returns void

Protectedlog

Parameters

Returns void

realToWorldPos

Parameters

Returns FloatArrayParam

ProtectedsetDirty

Returns void

Protectedwarn

Parameters

Returns void

worldToRealPos

Parameters

Returns FloatArrayParam

Events

onDestroyed

ReadonlyonOrigin

ReadonlyonScale

ReadonlyonUnits

Settings

On This Page

`Protected`dirty

`Protected`clean

`Protected`cleanIfDirty

`Protected`error

`Protected`log

`Protected`setDirty

`Protected`warn

`Readonly`onOrigin

`Readonly`onScale

`Readonly`onUnits