import {DistanceMeasurementsControl} from '@xeokit/xeokit-sdk/src/plugins/DistanceMeasurementsPlugin/DistanceMeasurementsControl.js'

public class | source

DistanceMeasurementsControl

Extends:

Component → DistanceMeasurementsControl

Creates DistanceMeasurements from mouse and touch input.

Belongs to a DistanceMeasurementsPlugin. Located at DistanceMeasurementsPlugin#control.

Once the DistanceMeasurementControl is activated, the first click on any Entity begins constructing a DistanceMeasurement, fixing its origin to that Entity. The next click on any Entity will complete the DistanceMeasurement, fixing its target to that second Entity. The DistanceMeasurementControl will then wait for the next click on any Entity, to begin constructing another DistanceMeasurement, and so on, until deactivated.

See DistanceMeasurementsPlugin for more info.

Member Summary

Public Members
public get	active: Boolean: * Gets if this DistanceMeasurementsControl is currently active, where it is responding to input.
public	plugin: DistanceMeasurementsPlugin The DistanceMeasurementsPlugin that owns this DistanceMeasurementsControl.

Method Summary

Public Methods
public	activate() Activates this DistanceMeasurementsControl, ready to respond to input.
public	deactivate() Deactivates this DistanceMeasurementsControl, making it unresponsive to input.
public	reset() Resets this DistanceMeasurementsControl.

Inherited Summary

From class Component
public get	owner: Component The Component that owns the lifecycle of this Component, if any.
public	destroyed: Boolean True as soon as this Component has been destroyed
public	id: String \| Number ID of this Component, unique within the Scene.
public	meta: * Arbitrary, user-defined metadata on this component.
public	scene: Scene The parent Scene that contains this Component.
public	viewer: Viewer The viewer that contains this Scene.
public	clear() Destroys all Components that are owned by this.
public	destroy() Destroys this component.
public	error(message: String) Logs an error for this component to the JavaScript console.
public	fire(event: String, value: Object, forget: Boolean) Fires an event on this component.
public	hasSubs(event: String): Boolean Returns true if there are any subscribers to the given event on this component.
public	isType(type: ): : Boolean Tests if this component is of the given type, or is a subclass of the given type.
public	log(message: String) Logs a console debugging message for this component.
public	off(subId: String) Cancels an event subscription that was previously made with Component#on or Component#once.
public	on(event: String, callback: Function, scope: Object): String Subscribes to an event on this component.
public	once(event: String, callback: Function, scope: Object) Subscribes to the next occurrence of the given event, then un-subscribes as soon as the event is subIdd.
public	warn(message: String) Logs a warning for this component to the JavaScript console.

Public Members

public get active: Boolean: * source

Gets if this DistanceMeasurementsControl is currently active, where it is responding to input.

Return:

Boolean

public plugin: DistanceMeasurementsPlugin source

The DistanceMeasurementsPlugin that owns this DistanceMeasurementsControl.

Public Methods

public activate() source

Activates this DistanceMeasurementsControl, ready to respond to input.

public deactivate() source

Deactivates this DistanceMeasurementsControl, making it unresponsive to input.

Destroys any DistanceMeasurement under construction.

public reset() source

Resets this DistanceMeasurementsControl.

Destroys any DistanceMeasurement under construction.

Does nothing if the DistanceMeasurementsControl is not active.