NavVis IVION API
    Preparing search index...

    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 Summary)

    Implemented by

    Index

    Properties

    targetViewport visible

    Methods

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

    Properties

    targetViewport: ViewportInterface

    Target viewport

    visible: boolean

    Layer visibility

    Methods

    • Called after rendering of all viewports

      Parameters

      • camera: Camera

        Camera used to render the view

      Returns void

    • Called after rendering of a viewport

      Parameters

      Returns void

    • Called before rendering

      Parameters

      • camera: Camera

        Camera used to render the view

      Returns void

    • Called before rendering a viewport

      Parameters

      Returns 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

    • Called for mouse clicks and taps

      Parameters

      Returns boolean

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

    • 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

    • 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

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

    • Called when the mouse wheel is used

      Parameters

      Returns boolean

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

    Settings

    Member Visibility

    On This Page

    Properties
    Methods