Viewer
- class cee.Viewer()
The Viewer manages the
Views
it contains and handles user interaction (navigation and picking).You can add a new view with the
addView
function. The Viewer owns and manages the View, and you delete the view by using thedeleteViewAt
function.A Viewer can have multiple views. A single model can be shared in each view, or multiple different models can be added to specific views. By default, the views are positioned automatically, but you can set the position and size of each view manually using the
ViewLayoutMode
accessor.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
)
Accessors
pixelScaleFactor
viewCount
viewLayoutMode
Methods
Accessors
- cee.pixelScaleFactor()
The current pixel scale factor ( > 1 for ‘retina’/’high-dpi’) screen.
- Return type:
number
- cee.viewCount()
The number of views in the Viewer
- Return type:
number
- cee.viewLayoutMode()
The view layout mode for the viewer
- Return type:
ViewLayoutMode
- cee.viewLayoutMode(layoutMode)
- Arguments:
layoutMode (
ViewLayoutMode
) – None
- Return type:
void
Methods
addView
- Viewer.addView()
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.
- Return type:
View
deleteAllViews
- Viewer.deleteAllViews()
Deletes all views from the viewer.
- Return type:
void
deleteViewAt
- Viewer.deleteViewAt(viewIndex)
- Arguments:
viewIndex (
number
) – None
Deletes the view at the given index.
The index must be zero-based and between 0 and viewCount - 1
- Return type:
void
enableMouseButtonTracking
- Viewer.enableMouseButtonTracking(enable)
- Arguments:
enable (
boolean
) – None
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;
- Return type:
void
flyCameraTo
- Viewer.flyCameraTo(cameraPos, viewDir, upVec, fieldOfViewYDegOrFrontPlaneFrustumHight, animDuration[, view])
- Arguments:
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.
- Return type:
void
getViewArray
- Viewer.getViewArray()
Returns a read only array with all views in the viewer
- Return type:
unknown
getViewAt
- Viewer.getViewAt(viewIndex)
- Arguments:
viewIndex (
number
) – None
Returns the view at the given index.
The index must be zero-based and between 0 and viewCount - 1
- Return type:
View
oglWinPosFromClientCoord
- Viewer.oglWinPosFromClientCoord(clientX, clientY)
- Arguments:
clientX (
number
) – The X coordinate of the mouse pointer in local (DOM content) coordinates.clientY (
number
) – The Y coordinate of the mouse pointer in local (DOM content) coordinates.
Convert from client (DOM content) coordinates to WebGL style coordinates
- Returns:
The WebGL style <x,y> coordinate for the given client coordinate in the viewer.
- Return type:
Vec2
oglWinPosFromCssCoordinate
- Viewer.oglWinPosFromCssCoordinate(cssPixCoordX, cssPixCoordY)
- Arguments:
cssPixCoordX (
number
) – The x coordinate in css pixel coordinates. This is relative to the top left corner of the Viewer’s Canvas element.cssPixCoordY (
number
) – The y coordinate in css pixel coordinates. This is relative to the top left corner of the Viewer’s Canvas element.
Convert from canvas local css (DOM content) coordinates to WebGL style coordinates, similar to offsetX/Y in in MouseEvent.
- Returns:
The WebGL style <x,y> coordinate for the given css coordinate in the viewer. The cssX/Y coordinates local Canvas coordinates in css (DOM content) coordinates. They are local to the Canvas element, so 0,0 is the top left corner of the Canvas element. The coordinates are in css pixels, so they are not affected by the device pixel ratio or any zoom in the browser. These coordinates are related to the MouseEvent.offsetX/Y coordinates. See https://developer.mozilla.org/en-US/docs/Web/CSS/CSSOM_View/Coordinate_systems for more on CSS coordinate systems. They correspond to the “Offset” system.
- Return type:
Vec2
rayFromCssCoordinate
- Viewer.rayFromCssCoordinate(view, cssPixCoordX, cssPixCoordY)
- Arguments:
view (
View
) – NonecssPixCoordX (
number
) – The x coordinate in css pixel coordinates. This is relative to the top left corner of the Viewer’s Canvas element.cssPixCoordY (
number
) – The y coordinate in css pixel coordinates. This is relative to the top left corner of the Viewer’s Canvas element.
Get a ray from the given Canvas/Viewer local CSS coordinate. This coordinate is relative to the top left corner of the canvas/viewer element in css pixels.
- Returns:
A Ray than can be used for rayIntersect() on the various models. The input coordinates can be set from MouseEvent.offsetX/offsetY.
- Return type:
Ray
requestRedraw
- Viewer.requestRedraw()
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.
- Return type:
void
resizeViewer
- Viewer.resizeViewer(canvasDisplayWidthCSSPixels, canvasDisplayHeightCSSPixels)
- Arguments:
canvasDisplayWidthCSSPixels (
number
) – NonecanvasDisplayHeightCSSPixels (
number
) – None
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)
- Return type:
void
rubberBandZoom
- Viewer.rubberBandZoom(view, clientX, clientY, width, height)
- Arguments:
view (
View
) – NoneclientX (
number
) – NoneclientY (
number
) – Nonewidth (
number
) – Noneheight (
number
) – None
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)
NOTE: This is the only method using client coordinates. All other relevant methods use Canvas/Viewer local CSS coordinates. This behavior will change in an upcoming major release.
- Return type:
void
setCameraAnimation
- Viewer.setCameraAnimation(cameraAnimation)
- Arguments:
cameraAnimation (
CameraAnimation
) – None
Sets a camera animation that will be run for this viewer
- Return type:
void
setColorLegendClickHandler
- Viewer.setColorLegendClickHandler(legendClickHandler)
- Arguments:
legendClickHandler (
ColorLegendClickedHandler
) – None
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.
- Return type:
void
setPickHandler
- Viewer.setPickHandler(pickHandler)
- Arguments:
pickHandler (
PickHandler
) – None
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.- Return type:
void
setPixelScaleFactor
- Viewer.setPixelScaleFactor(pixelScaleFactor)
- Arguments:
pixelScaleFactor (
number
) – None
Set pixel scale factor.
- Return type:
void
setShowDebugWindow
- Viewer.setShowDebugWindow(show)
- Arguments:
show (
boolean
) – None
Specifies if the debug overlay info window should be shown or not
- Return type:
void
updatePixelScaleFactor
- Viewer.updatePixelScaleFactor()
Update the current pixel scale factor by querying
window.devicePixelRatio
.- Return type:
void