import {MarqueePickerMouseControl} from '@xeokit/xeokit-sdk/src/extras/MarqueePicker/MarqueePickerMouseControl.js'

public class | source

MarqueePickerMouseControl

Extends:

Component → MarqueePickerMouseControl

Controls a MarqueePicker with mouse input.

See MarqueePicker for usage example.

When the MarqueePickerMouseControl is active:

Long-click, drag and release on the canvas to define a marque box that picks Entitys.
Drag left-to-right to pick Entities that intersect the box.
Drag right-to-left to pick Entities that are fully inside the box.
On release, the MarqueePicker will fire a "picked" event with IDs of the picked Entities , if any.

Constructor Summary

Public Constructor
public	constructor(cfg: *) Creates a new MarqueePickerMouseControl.

Method Summary

Public Methods
public	destroy()
public	getActive(): boolean Gets if this MarqueePickerMouseControl is active.
public	setActive(active: boolean) Activates or deactivates this MarqueePickerMouseControl.

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 Constructors

public constructor(cfg: *) source

Creates a new MarqueePickerMouseControl.

Override:

Component#constructor

Params:

Name	Type	Attribute	Description
cfg	*		Configuration
cfg.marqueePicker	MarqueePicker		The MarqueePicker to control.

Public Methods

public destroy() source

Destroys this component.

Override:

Component#destroy

public getActive(): boolean source

Gets if this MarqueePickerMouseControl is active.

Return:

boolean

public setActive(active: boolean) source

Activates or deactivates this MarqueePickerMouseControl.

Params:

Name	Type	Attribute	Description
active	boolean		Whether or not to activate.