Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AngleMeasurementsPlugin

Viewer plugin for measuring angles.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

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(): AngleMeasurementsControl

measurements

  • get measurements(): {}

Methods

clear

  • clear(): void

createMeasurement

  • createMeasurement(params?: { corner: { entity: Entity; worldPos: number[] }; id: string; origin: { entity: Entity; worldPos: number[] }; target: { entity: Entity; worldPos: number[] }; visible?: boolean }): AngleMeasurement

  • Creates an {@link AngleMeasurement}.

    The AngleMeasurement is then registered by {@link AngleMeasurement.id} in AngleMeasurementsPlugin.measurements.

    Parameters

    • Optional params: { corner: { entity: Entity; worldPos: number[] }; id: string; origin: { entity: Entity; worldPos: number[] }; target: { entity: Entity; worldPos: number[] }; visible?: boolean }

      {@link AngleMeasurement} configuration.

      • corner: { entity: Entity; worldPos: number[] }
        • entity: Entity
        • worldPos: number[]
      • id: string

        Unique ID to assign to {@link AngleMeasurement.id}. The AngleMeasurement will be registered by this in AngleMeasurementsPlugin.measurements and {@link Scene.components}. Must be unique among all components in the Viewer.

      • origin: { entity: Entity; worldPos: number[] }
        • entity: Entity
        • worldPos: number[]
      • target: { entity: Entity; worldPos: number[] }
        • entity: Entity
        • worldPos: number[]
      • Optional visible?: boolean

    Returns AngleMeasurement

    The new {@link AngleMeasurement}.

destroy

  • destroy(): void

destroyMeasurement

  • destroyMeasurement(id: string): void

error

  • error(msg: string): void

  • 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

  • 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

  • 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: AngleMeasurement) => void): void
  • on(event: "measurementDestroyed", callback: (measurement: AngleMeasurement) => void): void

  • Fires when a measurement is created.

    Parameters

    • event: "measurementCreated"

      The measurementCreated event

    • callback: (measurement: AngleMeasurement) => void

      Callback fired on the event

        • (measurement: AngleMeasurement): void

        • Parameters

          • measurement: AngleMeasurement

          Returns void

    Returns void

  • Fires when a measurement is destroyed.

    Parameters

    • event: "measurementDestroyed"

      The measurementDestroyed event

    • callback: (measurement: AngleMeasurement) => void

      Callback fired on the event

        • (measurement: AngleMeasurement): void

        • Parameters

          • measurement: AngleMeasurement

          Returns void

    Returns void

warn

  • warn(msg: string): void

  • Logs a warning message to the JavaScript developer console, prefixed with the ID of this Plugin.

    Parameters

    • msg: string

      The error message

    Returns void

Generated using TypeDoc