import {DistanceMeasurementsControl} from '@xeokit/xeokit-sdk/src/plugins/DistanceMeasurementsPlugin/DistanceMeasurementsControl.js'
DistanceMeasurementsControl
Extends:
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 |
Gets if this DistanceMeasurementsControl is currently active, where it is responding to input. |
|
public |
The DistanceMeasurementsPlugin that owns this DistanceMeasurementsControl. |
Method Summary
Public Methods | ||
public |
activate() Activates this DistanceMeasurementsControl, ready to respond to input. |
|
public |
Deactivates this DistanceMeasurementsControl, making it unresponsive to input. |
|
public |
reset() Resets this DistanceMeasurementsControl. |
Inherited Summary
From class Component | ||
public get |
The Component that owns the lifecycle of this Component, if any. |
|
public |
True as soon as this Component has been destroyed |
|
public |
ID of this Component, unique within the Scene. |
|
public |
meta: * Arbitrary, user-defined metadata on this component. |
|
public |
The parent Scene that contains this Component. |
|
public |
The viewer that contains this Scene. |
|
public |
clear() Destroys all Components that are owned by this. |
|
public |
destroy() Destroys this component. |
|
public |
Logs an error for this component to the JavaScript console. |
|
public |
Fires an event on this component. |
|
public |
Returns true if there are any subscribers to the given event on this component. |
|
public |
Tests if this component is of the given type, or is a subclass of the given type. |
|
public |
Logs a console debugging message for this component. |
|
public |
Cancels an event subscription that was previously made with Component#on or Component#once. |
|
public |
Subscribes to an event on this component. |
|
public |
Subscribes to the next occurrence of the given event, then un-subscribes as soon as the event is subIdd. |
|
public |
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.
public plugin: DistanceMeasurementsPlugin source
The DistanceMeasurementsPlugin that owns this DistanceMeasurementsControl.
Public Methods
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.