Communicator.OverlayManager

 OverlayManager

The OverlayManager exposes functionality for creating overlays that are layered on top of the 3d scene. More information can be found here. An overlay defines a viewport on the screen with an associated camera. These overlays are useful for creating axis triads, navigational cubes, or similar elements. The overlays are not designed to create multiple views of a model. Therefore, inserting large amounts of geometry into overlays isn't recommended.

Methods

addNodes

  • Adds nodes into the overlay at the given index. They will no longer be rendered in the main window or any other overlay. This method should not be called before the model structure ready callback has been triggered.

    Parameters

    • index: OverlayIndex

      the overlay index to add nodes into.

    • nodes: NodeId[]

      the nodes to add into the overlay.

    Returns DeprecatedPromise

destroy

  • Removes an overlay from the system. All nodes that have been assigned to this overlay will be returned to the default view.

    Parameters

    Returns DeprecatedPromise

getViewportAnchor

  • Get the anchor point of the viewport with the supplied index, or null if none has been set.

    Parameters

    • index: OverlayIndex

      The index of the overlay to get the anchor of.

    Returns OverlayAnchor | null

getViewportPixelOffsetInCanvas

  • Gets the calculated position of the upper-left corner of the viewport with the supplied index, or null if none has been set.

    Parameters

    • index: OverlayIndex

      The index of the overlay to get the offset of

    Returns Point2 | null

getViewportPixelPosition

  • Gets position in pixels of the viewport with the supplied index, or null if none has been set. Note: This does not take the anchor point into account

    Parameters

    • index: OverlayIndex

      The index of the overlay to get the position of.

    Returns Point2 | null

getViewportPixelSize

  • Gets size in pixels of the viewport with the supplied index, or null if none has been set.

    Parameters

    • index: OverlayIndex

      The index of the overlay to get the size of.

    Returns Point2 | null

maxIndex

  • Gets the maximum index value that can be used for indexing overlays.

    Returns OverlayIndex

    the maximum index value.

setCamera

setViewport

  • Creates an overlay or updates an existing one.

    Parameters

    • index: OverlayIndex

      the index of the overlay. This value may be any number between 1 and maxIndex(). If No overlay exists for this index one will be created.

    • anchor: OverlayAnchor

      the anchor point for the viewport.

    • x: number

      the x value of the viewport location.

    • xUnit: OverlayUnit

      the unit type of the x parameter.

    • y: number

      the y value of the viewport location.

    • yUnit: OverlayUnit

      the unit type of the y parameter.

    • width: number
    • widthUnit: OverlayUnit
    • height: number
    • heightUnit: OverlayUnit

    Returns DeprecatedPromise

setVisibility

  • Sets the visibility state for the given viewport.

    Parameters

    • index: OverlayIndex

      the overlay index.

    • visibility: boolean

      boolean value indicating whether the overlay should be rendered.

    Returns DeprecatedPromise