import {ZonesMouseControl} from '@xeokit/xeokit-sdk/src/plugins/ZonesPlugin/index.js'
ZonesMouseControl
Extends:
Creates Zones in a ZonesPlugin from mouse input.
Usage
import {Viewer, XKTLoaderPlugin, ZonesPlugin, ZonesMouseControl} from "xeokit-sdk.es.js";
const viewer = new Viewer({
canvasId: "myCanvas",
});
viewer.camera.eye = [-3.93, 2.85, 27.01];
viewer.camera.look = [4.40, 3.72, 8.89];
viewer.camera.up = [-0.01, 0.99, 0.039];
const xktLoader = new XKTLoaderPlugin(viewer);
const sceneModel = xktLoader.load({
id: "myModel",
src: "Duplex.xkt"
});
const zones = new ZonesPlugin(viewer);
const zonesControl = new ZonesMouseControl(Zones)
Constructor Summary
Public Constructor | ||
public |
constructor(zonesPlugin: ZonesPlugin, cfg: *) Creates a ZonesMouseControl bound to the given ZonesPlugin. |
Member Summary
Public Members | ||
public get |
active: * |
|
public |
pointerLens: * |
|
public |
zonesPlugin: * |
Method Summary
Public Methods | ||
public |
activate(zoneAltitude: *, zoneHeight: *, zoneColor: *, zoneAlpha: *) |
|
public |
|
|
public |
destroy() Destroys this ZonesMouseControl. |
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. |
Public Constructors
public constructor(zonesPlugin: ZonesPlugin, cfg: *) source
Creates a ZonesMouseControl bound to the given ZonesPlugin.
Override:
Component#constructorParams:
Name | Type | Attribute | Description |
zonesPlugin | ZonesPlugin | The ZonesPlugin to control. |
|
cfg | * |
|
Configuration |
cfg.pointerLens | PointerLens |
|
A PointerLens to use to provide a magnified view of the cursor when snapping is enabled. |
Public Members
public get active: * source
public pointerLens: * source
public zonesPlugin: * source
Public Methods
public activate(zoneAltitude: *, zoneHeight: *, zoneColor: *, zoneAlpha: *) source
Params:
Name | Type | Attribute | Description |
zoneAltitude | * | ||
zoneHeight | * | ||
zoneColor | * | ||
zoneAlpha | * |
public deactivate() source
public destroy() source
Destroys this ZonesMouseControl.
Destroys any Zone under construction by this ZonesMouseControl.