DistanceMeasurementsPlugin | @xeokit/xeokit-sdk

Viewer plugin for measuring point-to-point distances.

Hierarchy

Plugin
- DistanceMeasurementsPlugin

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new DistanceMeasurementsPlugin(viewer: Viewer, cfg?: DistanceMeasurementsPluginConfiguration): DistanceMeasurementsPlugin

Overrides Plugin.constructor
- Defined in plugins/DistanceMeasurementsPlugin/DistanceMeasurementsPlugin.d.ts:37
Parameters
- viewer: Viewer
  
  The Viewer.
- Optional cfg: DistanceMeasurementsPluginConfiguration
Returns DistanceMeasurementsPlugin

Properties

id

id: string

ID for this Plugin, unique within its Viewer.

viewer

viewer: Viewer

The Viewer that contains this Plugin.

Accessors

control

get control(): DistanceMeasurementsControl

- Defined in plugins/DistanceMeasurementsPlugin/DistanceMeasurementsPlugin.d.ts:63
Gets the {@link DistanceMeasurementsControl}, which creates {@link DistanceMeasurement}s from user input.

Returns DistanceMeasurementsControl

labelMinAxisLength

get labelMinAxisLength(): number
set labelMinAxisLength(arg: number): void

- Defined in plugins/DistanceMeasurementsPlugin/DistanceMeasurementsPlugin.d.ts:56
Gets the minimum length, in pixels, of an axis wire beyond which its label is shown.

The axis wire's label is not shown when its length is less than this value.

This is 25 pixels by default.

Must not be less than 1.

Returns number
- Defined in plugins/DistanceMeasurementsPlugin/DistanceMeasurementsPlugin.d.ts:50
Sets the minimum length, in pixels, of an axis wire beyond which its label is shown.

The axis wire's label is not shown when its length is less than this value.

This is 25 pixels by default.

Must not be less than 1.

Parameters
- arg: number
Returns void

measurements

get measurements(): {}

- Defined in plugins/DistanceMeasurementsPlugin/DistanceMeasurementsPlugin.d.ts:70
Gets the existing {@link DistanceMeasurement}s, each mapped to its {@link DistanceMeasurement.id}.

Returns {}
- [key: string]: DistanceMeasurement

Methods

clear

clear(): void

- Defined in plugins/DistanceMeasurementsPlugin/DistanceMeasurementsPlugin.d.ts:119
Destroys all {@link DistanceMeasurement}s.

Returns void

createMeasurement

createMeasurement(params?: { axisVisible?: boolean; color?: string; id: string; origin: { entity: Entity; worldPos: number[] }; originVisible?: boolean; target: { entity: Entity; worldPos: number[] }; targetVisible?: boolean; visible?: boolean; wireVisible?: boolean }): DistanceMeasurement

- Defined in plugins/DistanceMeasurementsPlugin/DistanceMeasurementsPlugin.d.ts:91
Creates a {@link DistanceMeasurement}.

The DistanceMeasurement is then registered by {@link DistanceMeasurement.id} in DistanceMeasurementsPlugin.measurements.

Parameters
- Optional params: { axisVisible?: boolean; color?: string; id: string; origin: { entity: Entity; worldPos: number[] }; originVisible?: boolean; target: { entity: Entity; worldPos: number[] }; targetVisible?: boolean; visible?: boolean; wireVisible?: boolean }
  
  {@link DistanceMeasurement} configuration.
  - Optional axisVisible?: boolean
  - Optional color?: string
  - id: string
    
    Unique ID to assign to {@link DistanceMeasurement.id}. The DistanceMeasurement will be registered by this in DistanceMeasurementsPlugin.measurements and {@link Scene.components}. Must be unique among all components in the Viewer.
  - origin: { entity: Entity; worldPos: number[] }
    - entity: Entity
    - worldPos: number[]
  - Optional originVisible?: boolean
  - target: { entity: Entity; worldPos: number[] }
    - entity: Entity
    - worldPos: number[]
  - Optional targetVisible?: boolean
  - Optional visible?: boolean
  - Optional wireVisible?: boolean
Returns DistanceMeasurement
The new {@link DistanceMeasurement}.

destroy

destroy(): void

Inherited from Plugin.destroy
- Defined in viewer/Plugin.d.ts:68
Destroys this Plugin and removes it from its Viewer.

Returns void

destroyMeasurement

destroyMeasurement(id: string): void

- Defined in plugins/DistanceMeasurementsPlugin/DistanceMeasurementsPlugin.d.ts:114
Destroys a {@link DistanceMeasurement}.

Parameters
- id: string
  
  ID of DistanceMeasurement to destroy.
Returns void

error

error(msg: string): void

Inherited from Plugin.error
- Defined in viewer/Plugin.d.ts:63
Logs an error message to the JavaScript developer console, prefixed with the ID of this Plugin.

Parameters
- msg: string
  
  The error message
Returns void

fire

fire(event: string, value: any): void

Inherited from Plugin.fire
- Defined in viewer/Plugin.d.ts:42
Fires an event at this Plugin.

Parameters
- event: string
  
  The event type name
- value: any
  
  The event parameters
Returns void

log

log(msg: string): void

Inherited from Plugin.log
- Defined in viewer/Plugin.d.ts:49
Logs a message to the JavaScript developer console, prefixed with the ID of this Plugin.

Parameters
- msg: string
  
  The error message
Returns void

on

on(event: "measurementCreated", callback: (measurement: DistanceMeasurement) => void): void
on(event: "measurementDestroyed", callback: (measurement: DistanceMeasurement) => void): void

Overrides Plugin.on
- Defined in plugins/DistanceMeasurementsPlugin/DistanceMeasurementsPlugin.d.ts:126
Fires when a measurement is created.

Parameters
- event: "measurementCreated"
  
  The measurementCreated event
- callback: (measurement: DistanceMeasurement) => void
  
  Callback fired on the event
  - - (measurement: DistanceMeasurement): void
    - Parameters
      - measurement: DistanceMeasurement
      Returns void
Returns void
Overrides Plugin.on
- Defined in plugins/DistanceMeasurementsPlugin/DistanceMeasurementsPlugin.d.ts:133
Fires when a measurement is destroyed.

Parameters
- event: "measurementDestroyed"
  
  The measurementDestroyed event
- callback: (measurement: DistanceMeasurement) => void
  
  Callback fired on the event
  - - (measurement: DistanceMeasurement): void
    - Parameters
      - measurement: DistanceMeasurement
      Returns void
Returns void

warn

warn(msg: string): void

Inherited from Plugin.warn
- Defined in viewer/Plugin.d.ts:56
Logs a warning message to the JavaScript developer console, prefixed with the ID of this Plugin.

Parameters
- msg: string
  
  The error message
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

viewer: Viewer

Optional cfg: DistanceMeasurementsPluginConfiguration

Returns DistanceMeasurementsPlugin

Properties

id

viewer

Accessors

control

Returns DistanceMeasurementsControl

labelMinAxisLength

Returns number

Parameters

arg: number

Returns void

measurements

Returns {}

[key: string]: DistanceMeasurement

Methods

clear

Returns void

createMeasurement

Parameters

Optional params: { axisVisible?: boolean; color?: string; id: string; origin: { entity: Entity; worldPos: number[] }; originVisible?: boolean; target: { entity: Entity; worldPos: number[] }; targetVisible?: boolean; visible?: boolean; wireVisible?: boolean }

Optional axisVisible?: boolean

Optional color?: string

id: string

origin: { entity: Entity; worldPos: number[] }

entity: Entity

worldPos: number[]

Optional originVisible?: boolean

target: { entity: Entity; worldPos: number[] }

entity: Entity

worldPos: number[]

Optional targetVisible?: boolean

Optional visible?: boolean

Optional wireVisible?: boolean

Returns DistanceMeasurement

destroy

Returns void

destroyMeasurement

Parameters

id: string

Returns void

error

Parameters

msg: string

Returns void

fire

Parameters

event: string

value: any

Returns void

log

Parameters

msg: string

Returns void

on

Parameters

event: "measurementCreated"

callback: (measurement: DistanceMeasurement) => void

Parameters

measurement: DistanceMeasurement

Returns void

Returns void

Parameters

event: "measurementDestroyed"

callback: (measurement: DistanceMeasurement) => void

Parameters

measurement: DistanceMeasurement

Returns void

Returns void