Reference Source
public interface | source

DistanceMeasurementsControl

Extends:

Component → DistanceMeasurementsControl

Creates DistanceMeasurements in a DistanceMeasurementsPlugin from user input.

Member Summary

Public Members
public get abstract

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

public set

snapping(snapping: boolean)

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

public get

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

Method Summary

Public Methods
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.

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.

Public Members

public get abstract active: boolean source

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

Return:

boolean

True if this DistanceMeasurementsControl is active.

public set snapping(snapping: boolean) source

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

This is true by default.

Internally, this deactivates then activates the DistanceMeasurementsControl 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.

public get snapping: boolean: boolean source

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

This is true by default.

Return:

boolean

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

Public Methods

public abstract activate() source

Activates this DistanceMeasurementsControl, ready to respond to input.

public abstract deactivate() source

Deactivates this DistanceMeasurementsControl, making it unresponsive to input.

Destroys any DistanceMeasurement under construction by this DistanceMeasurementsControl.

public abstract destroy() source

Destroys this DistanceMeasurementsControl.

Destroys any DistanceMeasurement under construction by this DistanceMeasurementsControl.

Override:

Component#destroy

public abstract reset() source

Resets this DistanceMeasurementsControl.

Destroys any DistanceMeasurement under construction by this DistanceMeasurementsControl.

Does nothing if the DistanceMeasurementsControl is not active.