The current pixel scale factor ( > 1 for 'retina'/'high-dpi') screen.
The number of views in the Viewer
The view layout mode for the viewer
Adds a view to the viewer.
This functions creates a view, adds it to the viewer and returns the newly created view.
You need at least one view in a viewer in order to display a model.
Deletes all views from the viewer.
Deletes the view at the given index.
The index must be zero-based and between 0 and viewCount - 1
Mouse tracking needs to be enabled to use the NavigationConfig.leftAndRightMouseButtons setting.
However, for the mouse tracking to work, the browser context menu needs to be disabled.
Here is one example on how to do this:
// Disable context menu - Required for enableMouseButtonTracking
canvas.addEventListener("contextmenu", (event) => { event.preventDefault()});
// Enable mouse tracking (so we can use leftAndRightMouseButtons)
viewer.enableMouseButtonTracking(true);
// Ceetron style navigation
const navConfig = view.navigation.config;
navConfig.leftMouseButton.noModifier =cee.NavigationType.PAN;
navConfig.rightMouseButton.noModifier =cee.NavigationType.ROTATE;
navConfig.leftAndRightMouseButtons.noModifier =cee.NavigationType.WALK;
navConfig.wheelOrPinch = cee.NavigationType.WALK;Sets the handler function to be called whenever the mouse navigation type changes.
Flies the camera from the current position to the specified new position in the given view.
If the current projection in the active View camera is perspective, the fieldOfViewYDegOrFrontPlaneFrustumHight parameter is the final field of view in Y direction in degrees (as passed to Camera.setProjectionAsPerspective()).
If the current projection is ortho, the fieldOfViewYDegOrFrontPlaneFrustumHight parameter is the final front plane frustum height (as passed to Camera.setProjectionAsOrtho()).
If view is not specified then the operation is performed on the first view.
Returns a read only array with all views in the viewer
Returns the view at the given index.
The index must be zero-based and between 0 and viewCount - 1
Convert from client (DOM content) coordinates to WebGL style coordinates
The X coordinate of the mouse pointer in local (DOM content) coordinates.
The Y coordinate of the mouse pointer in local (DOM content) coordinates.
The WebGL style <x,y> coordinate for the given client coordinate in the viewer.
Notifies that this viewer needs a redraw. This will schedule a redraw on the next timer event.
Use this method to force a redraw if you have changed something that does not update the viewer. This is not usually needed.
Sets the display size of the viewer's canvas in CSS pixels.
Note that the input width and height is in CSS pixels which. This means that the resulting size of the canvas in physical pixels may end up being larger than the specified size depending on the currently set pixel scale factor (devicePixelRatio)
Zooms in or out in the view by the given rubber band rectangle.
clientX and clientY are the Top Left corner of the rectangle, specified in client coordinates (HTML window coordinates) (from e.g. a MouseEvent.clientX/Y)
Sets the handler function to be called whenever the mouse navigation type changes.
Sets a camera animation that will be run for this viewer
Sets the handler function to be called whenever the user clicks on a color legend.
The handler function will be passed the id of the scalar result.
Sets the handler function to be called whenever the user does a "clean click" in the 3D view.
No picking is performed before the given handler is invoked, so the behavior of the click is entirely up to the user.
See PickHandler for more info.
Set pixel scale factor.
Specifies if the debug overlay info window should be shown or not
Update the current pixel scale factor by querying [[window.devicePixelRatio]].
Generated using TypeDoc
The Viewer manages the Views it contains and handles user interaction (navigation and picking).
A Viewer can have multiple Views. You can add a view with the addView. The Viewer owns and manages the View, and you delete the view by using the deleteViewAt function.
The Viewer handles the interaction with the user, both navigation (pan/rotate/zoom/walk) and selection/picking.
You can trigger a redraw of the 3D view(s) with the requestRedraw function.
Examples of the different highlight modes (See ViewerOptions.highlightMode)