- class Communicator.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.
- OverlayManager.addNodes(index, nodes)
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.
Gets position in pixels of the viewport with the supplied index, or
nullif none has been set. Note: This does not take the anchor point into account
- OverlayManager.setViewport(index, anchor, x, xUnit, y, yUnit, width, widthUnit, height, heightUnit)
Creates an overlay or updates an existing one.
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.
number()) – the x value of the viewport location.
xUnit (OverlayUnit) – the unit type of the x parameter.
number()) – the y value of the viewport location.
yUnit (OverlayUnit) – the unit type of the y parameter.
widthUnit (OverlayUnit) –
heightUnit (OverlayUnit) –
- Return type