Reference Source
public class | source

DistanceMeasurementsTouchControl

Extends:

ComponentDistanceMeasurementsControl → DistanceMeasurementsTouchControl

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 get

Gets the DistanceMeasurement under construction by this DistanceMeasurementsTouchControl, if any.

public

The DistanceMeasurementsPlugin that owns this DistanceMeasurementsTouchControl.

public
public

The DistanceMeasurementsPlugin that owns this DistanceMeasurementsTouchControl.

public
public
public set

snapping(snapping: boolean)

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

Activates this DistanceMeasurementsTouchControl, ready to respond to input.

public

Deactivates this DistanceMeasurementsTouchControl, making it unresponsive to input.

public

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

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

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

scheduleTask(task: *)

Schedule a task to perform on the next browser interval

public

warn(message: String)

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 abstract

Gets the DistanceMeasurement under construction by this DistanceMeasurementsControl, if any.

public get

Gets whether snap-to-vertex and snap-to-edge are enabled for this DistanceMeasurementsControl.

public set

snapping(snapping: boolean)

Sets whether snap-to-vertex and snap-to-edge are enabled for this DistanceMeasurementsControl.

public abstract

Activates this DistanceMeasurementsControl, ready to respond to input.

public abstract

Deactivates this DistanceMeasurementsControl, making it unresponsive to input.

public abstract

Destroys this DistanceMeasurementsControl.

public abstract

reset()

Resets this DistanceMeasurementsControl.

Public Constructors

public constructor() source

Creates a DistanceMeasurementsTouchControl bound to the given DistanceMeasurementsPlugin.

Override:

Component#constructor

Public Members

public get active: Boolean: * source

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

Override:

DistanceMeasurementsControl#active

Return:

Boolean

public get currentMeasurement: null | DistanceMeasurement: * source

Gets the DistanceMeasurement under construction by this DistanceMeasurementsTouchControl, if any.

Override:

DistanceMeasurementsControl#currentMeasurement

public 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#snapping

public 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#snapping

Return:

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#activate

public deactivate() source

Deactivates this DistanceMeasurementsTouchControl, making it unresponsive to input.

Destroys any DistanceMeasurement under construction.

Override:

DistanceMeasurementsControl#deactivate

public destroy() source

Destroys this DistanceMeasurementsTouchControl.

Override:

DistanceMeasurementsControl#destroy

public reset() source

Resets this DistanceMeasurementsTouchControl.

Destroys any DistanceMeasurement under construction.

Does nothing if the DistanceMeasurementsTouchControl is not active.

Override:

DistanceMeasurementsControl#reset