import {AngleMeasurementsControl} from '@xeokit/xeokit-sdk/src/plugins/AngleMeasurementsPlugin/AngleMeasurementsControl.js'

public interface | source

AngleMeasurementsControl

Extends:

Component → AngleMeasurementsControl

Direct Subclass:

AngleMeasurementsMouseControl, AngleMeasurementsTouchControl

Creates AngleMeasurements in an AngleMeasurementsPlugin from user input.

Member Summary

Public Members
public get abstract	active: boolean Gets if this AngleMeasurementsControl 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 AngleMeasurementsControl.
public get	snapping: boolean: boolean Gets whether snap-to-vertex and snap-to-edge are enabled for this AngleMeasurementsControl.

Method Summary

Public Methods
public abstract	activate() Activates this AngleMeasurementsMouseControl, ready to respond to input.
public abstract	deactivate() Deactivates this AngleMeasurementsControl, making it unresponsive to input.
public abstract	destroy() Destroys this AngleMeasurementsMouseControl.
public abstract	reset() Resets this AngleMeasurementsControl.

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	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 AngleMeasurementsControl is currently active, where it is responding to input.

Return:

boolean

True if this AngleMeassurementsControl is active.

public set snapping(snapping: boolean) source

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

This is true by default.

Internally, this deactivates then activates the AngleMeasurementsControl when changed, which means that it will destroy any AngleMeasurements 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 AngleMeasurementsControl.

This is true by default.

Return:

boolean

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

Public Methods

public abstract activate() source

Activates this AngleMeasurementsMouseControl, ready to respond to input.

public abstract deactivate() source

Deactivates this AngleMeasurementsControl, making it unresponsive to input.

Destroys any AngleMeasurement under construction by this AngleMeasurementsControl.

public abstract destroy() source

Destroys this AngleMeasurementsMouseControl.

Destroys any AngleMeasurement under construction by this AngleMeasurementsControl.

Override:

Component#destroy

public abstract reset() source

Resets this AngleMeasurementsControl.

Destroys any AngleMeasurement under construction by this AngleMeasurementsControl.

Does nothing if the AngleMeasurementsControl is not active.