import {DistanceMeasurementsTouchControl} from '@xeokit/xeokit-sdk/src/plugins/DistanceMeasurementsPlugin/DistanceMeasurementsTouchControl.js'
DistanceMeasurementsTouchControl
Extends:
Creates DistanceMeasurements from touch input.
See DistanceMeasurementsPlugin for more info.
Constructor Summary
Public Constructor | ||
public |
Creates a DistanceMeasurementsTouchControl bound to the given DistanceMeasurementsPlugin. |
Member Summary
Public Members | ||
public get |
Gets if this DistanceMeasurementsTouchControl is currently active, where it is responding to input. |
|
public |
The DistanceMeasurementsPlugin that owns this DistanceMeasurementsTouchControl. |
|
public |
markerDiv: * |
|
public |
The DistanceMeasurementsPlugin that owns this DistanceMeasurementsTouchControl. |
|
public |
|
|
public |
pointerLens: * |
|
public set |
Sets whether snap-to-vertex and snap-to-edge are enabled for this DistanceMeasurementsTouchControl. |
|
public get |
Gets whether snap-to-vertex and snap-to-edge are enabled for this DistanceMeasurementsTouchControl. |
Method Summary
Public Methods | ||
public |
activate() Activates this DistanceMeasurementsTouchControl, ready to respond to input. |
|
public |
Deactivates this DistanceMeasurementsTouchControl, making it unresponsive to input. |
|
public |
destroy() Destroys this DistanceMeasurementsTouchControl. |
|
public |
reset() Resets this DistanceMeasurementsTouchControl. |
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 |
scheduleTask(task: *) Schedule a task to perform on the next browser interval |
|
public |
Logs a warning for this component to the JavaScript console. |
From class DistanceMeasurementsControl | ||
public get abstract |
Gets if this DistanceMeasurementsControl is currently active, where it is responding to input. |
|
public get |
Gets whether snap-to-vertex and snap-to-edge are enabled for this DistanceMeasurementsControl. |
|
public set |
Sets whether snap-to-vertex and snap-to-edge are enabled for this DistanceMeasurementsControl. |
|
public abstract |
activate() Activates this DistanceMeasurementsControl, ready to respond to input. |
|
public abstract |
Deactivates this DistanceMeasurementsControl, making it unresponsive to input. |
|
public abstract |
destroy() Destroys this DistanceMeasurementsControl. |
|
public abstract |
reset() Resets this DistanceMeasurementsControl. |
Public Constructors
public constructor() source
Creates a DistanceMeasurementsTouchControl bound to the given DistanceMeasurementsPlugin.
Override:
Component#constructorPublic Members
public get active: Boolean: * source
Gets if this DistanceMeasurementsTouchControl is currently active, where it is responding to input.
Override:
DistanceMeasurementsControl#activepublic distanceMeasurementsPlugin: DistanceMeasurementsPlugin source
The DistanceMeasurementsPlugin that owns this DistanceMeasurementsTouchControl.
public markerDiv: * source
public plugin: DistanceMeasurementsPlugin source
The DistanceMeasurementsPlugin that owns this DistanceMeasurementsTouchControl.
public pointerCircle: * source
public pointerLens: * source
public set snapping(snapping: boolean) source
Sets whether snap-to-vertex and snap-to-edge are enabled for this DistanceMeasurementsTouchControl.
This is true
by default.
Internally, this deactivates then activates the DistanceMeasurementsTouchControl when changed, which means that it will destroy any DistanceMeasurements currently under construction, and incurs some overhead, since it unbinds and rebinds various input handlers.
Override:
DistanceMeasurementsControl#snappingpublic get snapping: boolean: * source
Gets whether snap-to-vertex and snap-to-edge are enabled for this DistanceMeasurementsTouchControl.
This is true
by default.
Override:
DistanceMeasurementsControl#snappingReturn:
boolean | Whether snap-to-vertex and snap-to-edge are enabled for this DistanceMeasurementsTouchControl. |
Public Methods
public activate() source
Activates this DistanceMeasurementsTouchControl, ready to respond to input.
Override:
DistanceMeasurementsControl#activatepublic deactivate() source
Deactivates this DistanceMeasurementsTouchControl, making it unresponsive to input.
Destroys any DistanceMeasurement under construction.
public destroy() source
Destroys this DistanceMeasurementsTouchControl.
Override:
DistanceMeasurementsControl#destroypublic reset() source
Resets this DistanceMeasurementsTouchControl.
Destroys any DistanceMeasurement under construction.
Does nothing if the DistanceMeasurementsTouchControl is not active.