Interface SceneLayerInterface

A scene layer that displays objects in the 3D scene. This interface serves as a template to construct your own custom data layers. Public methods described in this class act as callbacks to particular events occurring in the view (Main or Map view) to which the scene layer is added.

Note: The mouse or touch event callbacks can also be added to individual THREE.Mesh objects inside data layers. In case of multiple callbacks, Mesh objects are prioritized over data layers. For a complete reference of all of the events supported on THREE.Mesh, see: MouseEventReceiverInterface

interface SceneLayerInterface {
    targetViewport: ViewportInterface;
    visible: boolean;
    onAfterRender(camera: Camera): void;
    onAfterRenderViewport(viewport: ViewportInterface): void;
    onBeforeRender(camera: Camera): void;
    onBeforeRenderViewport(viewport: ViewportInterface): void;
    onCameraMoveEnd(asyncWork: Promise<void>): void;
    onClick(pos: MouseEventCoordinatesInterface, cursorPos?: Vector3): boolean;
    onContextMenu(pos: MouseEventCoordinatesInterface): OnContextMenuResult | Promise<OnContextMenuResult>;
    onDoubleClick(pos: MouseEventCoordinatesInterface): boolean;
    onHold(pos: MouseEventCoordinatesInterface): boolean;
    onKeyDown(event: KeyboardEvent): boolean;
    onKeyUp(event: KeyboardEvent): boolean;
    onMouseMove(pos: MouseEventCoordinatesInterface): void;
    onMouseWheel(pos: MouseEventCoordinatesInterface, delta: number): boolean;
    onTransitionEnd(event: TransitionEndEventInterface): void;
    onTransitionStart(event: TransitionStartEventInterface): void;
}

Hierarchy (view full)

Implemented by

Properties

targetViewport visible

Methods

onAfterRender onAfterRenderViewport onBeforeRender onBeforeRenderViewport onCameraMoveEnd onClick onContextMenu onDoubleClick onHold onKeyDown onKeyUp onMouseMove onMouseWheel onTransitionEnd onTransitionStart

Properties

targetViewport

targetViewport: ViewportInterface

Target viewport

visible

visible: boolean

Layer visibility

Methods

onAfterRender

  • onAfterRender(camera): void

  • Called after rendering of all viewports

    Parameters

    • camera: Camera

      Camera used to render the view

    Returns void

onAfterRenderViewport

  • onAfterRenderViewport(viewport): void

  • Called after rendering of a viewport

    Parameters

    Returns void

onBeforeRender

  • onBeforeRender(camera): void

  • Called before rendering

    Parameters

    • camera: Camera

      Camera used to render the view

    Returns void

onBeforeRenderViewport

  • onBeforeRenderViewport(viewport): void

  • Called before rendering a viewport

    Parameters

    Returns void

onCameraMoveEnd

  • onCameraMoveEnd(asyncWork): void

  • Called shortly after the camera has stopped moving

    Parameters

    • asyncWork: Promise<void>

      Promise which blocks until the AbstractViewInterface has completed any asynchronous work, independent of whether it rejects or resolves.

    Returns void

onClick

  • onClick(pos, cursorPos?): boolean

  • Called for mouse clicks and taps

    Parameters

    Returns boolean

    Return true to consume the event, false to pass it on

onContextMenu

onDoubleClick

  • onDoubleClick(pos): boolean

  • Called for double clicks and double taps

    Parameters

    Returns boolean

    Return true to consume the event, false to pass it on

onHold

  • onHold(pos): boolean

  • Called for click-and-hold and touch-and-hold

    Parameters

    Returns boolean

    Return true to consume the event, false to pass it on

onKeyDown

  • onKeyDown(event): boolean

  • Called when a key is pressed down

    Parameters

    • event: KeyboardEvent

      Key event data

    Returns boolean

    Return true to consume the event, false to pass it on to other layers

onKeyUp

  • onKeyUp(event): boolean

  • Called when a key is released

    Parameters

    • event: KeyboardEvent

      Key event data

    Returns boolean

    Return true to consume the event, false to pass it on to other layers

    Note

    released keys on a physical keyboard connected to an iOS device do not fire the keyup event

onMouseMove

onMouseWheel

  • onMouseWheel(pos, delta): boolean

  • Called when the mouse wheel is used

    Parameters

    Returns boolean

    Return true to consume the event, false to pass it on

onTransitionEnd

  • onTransitionEnd(event): void

  • Called after location transition has completed

    Parameters

    Returns void

onTransitionStart

  • onTransitionStart(event): void

  • Called when a location transition is started

    Parameters

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods