Create a new emscripten renderer
An empty div element that will be used as a wrapper for all the renderer elements
OptionalinitializationOptions: RendererInitializationOptionsInitialization Options
Gets the list of companion renderers.
Gets the base path for assets.
The base path for assets.
Gets the base path for the BimCT additional functions server.
The base path for the BimCT server.
Checks if the touch widget is available.
Whether the touch widget is available.
Gets the touch widget.
The touch widget.
Checks if the left toolbar is available.
Whether the left toolbar is available.
Checks if the home toolbar is available.
Whether the home toolbar is available.
Checks if the toolbar is available.
Whether the toolbar is available.
Checks if the context menu is available.
Whether the context menu is available.
Checks if the split elements UI is available.
Whether the split elements UI is available.
Checks if the settings window is available.
Whether the settings window is available.
Checks if the time changer window is available.
Whether the time changer window is available.
Checks if the comparison viewer is available.
Gets the comparison viewer.
Checks if the comparison viewer is available.
Gets the instance of the minimap viewer.
The instance of the minimap viewer.
Checks if the share window is available.
Whether the share window is available.
Checks if the WebXR window is available.
Whether the WebXR window is available.
Gets the WebXR window.
The WebXR window.
Checks if the snapshot window is available.
Whether the snapshot window is available.
Gets if export to map window is available.
Whether the export to map window is available.
Gets the export to map window.
The export to map window.
Checks if the views manager is available.
Whether the views manager is available.
Checks if the message window is available.
Whether the message window is available.
Gets the animations.
The animations.
Gets whether picking 2D elements is allowed.
Whether picking 2D elements is allowed.
Sets whether picking 2D elements is allowed.
Whether to allow picking 2D elements.
Gets the div element.
The div element.
Keeps tracking of loaded models and elements. See [[SceneState]].
The scene state.
Gets the display format.
Gets the terrain manager.
The terrain manager.
Returns the alignment cofiguration handler of the BimCT scene models.
Gets the GUI actions locked event.
The GUI actions locked event.
Gets the solar position changed event.
The the solar position changed event.
Gets the selection change event.
The selection change event.
Gets the map position change event.
The map position change event.
Gets the pin dehighlighted event.
The pin dehighlighted event.
Gets the mouse right clicked event.
The mouse right clicked event.
Gets the model loaded event, called after a sceneView is also loaded
The model loaded event.
Gets the model added event, called directly after model is loaded into GPU. (no scenes after that)
the model added event
Gets the pick lines updated event.
The pick lines updated event.
Gets the measurements selected event.
The measurements selected event.
Gets the measurements updated event.
The measurements updated event.
Gets the measurements deleted event.
The measurements deleted event.
Gets the measurements point push back event.
The measurements point push back event.
Gets whether the renderer is rotating or panning.
Whether the renderer is rotating or panning.
Sets whether the renderer is rotating or panning.
Whether the renderer is rotating or panning.
Checks if the selection label is enabled.
Whether the selection label is enabled.
Gets the cutting elements manager.
The cutting elements manager.
Sets the shading mode of the renderer.
The shading mode to set.
Gets whether snapping is enabled.
Whether snapping is enabled.
Gets the settings changed event.
The settings changed event.
Gets the camera change event.
The camera state change event.
Gets the resized event.
The resized event.
Gets the language changed event.
The language changed event.
Gets the resized event.
The resized event.
Returns the WebGL2 rendering context.
Returns the GPU information.
Gets the auto camera reset state after model is loaded.
Sets the auto camera reset state after model is loaded.
Gets the show progress state while model is loading.
Sets the show progress state while model is loading.
Checks if the renderer is currently drawing.
Gets the input handler.
Gets the pick lines state.
Registers a companion renderer.
The renderer to register.
Unregisters a companion renderer.
The renderer to unregister.
Unregisters all companion renderers.
Changes the language of the renderer.
The language to change to.
Converts screen coordinates to world position.
The x-coordinate on the screen.
The y-coordinate on the screen.
A promise that resolves to the world position.
Converts screen coordinates to world position without taking depth into account.
The x-coordinate on the screen.
The y-coordinate on the screen.
A promise that resolves to the world position.
Converts 3D world position to real earth coordinates, using the current scene wgs84 center coordinate as a reference. If you have another reference other than the scene center, you can use [[cartesianToWGS84]] directly.
The world coordinates.
OptionalsceneBoundingBox: BoundingBox3DOptional bounding box of the scene to use as reference. If not provided, the scene bounding box will be used.
Optionalalignment: WGS84AlignmentA promise that resolves to the earth coordinates.
Converts earth coordinates to 3D world space position, using the current scene wgs84 center coordinate as a reference. If you have another reference other than the scene center, you can use [[wgs84ToCartesian]] directly.
The earth coordinates.
OptionalsceneBoundingBox: BoundingBox3DOptional bounding box of the scene to use as reference. If not provided, the scene bounding box will be used.
Optionalalignment: WGS84AlignmentOptional alignment information for the scene. If not provided, the scene alignment will be used better to provide it if you have it already calculated for performance reasons.
A promise that resolves to the world space position.
Checks if GUI actions are locked.
Whether GUI actions are locked.
Checks if a key is pressed.
The key code to check.
Whether the key is pressed.
Checks if roll over is enabled.
Whether roll over is enabled.
Reverts the previous roll over.
Whether to reset the roll over.
Performs roll over at the specified coordinates.
The x-coordinate.
The y-coordinate.
Marks that a mouse action event has been made.
Gets the skymap IDs.
A map of skymap IDs.
Removes the skymap.
Loads a skymap by its ID.
The ID of the skymap.
Whether to show the loading screen.
A promise that resolves to a boolean indicating success or failure.
Loads a skymap from URLs.
The URL of the skymap.
The URL of the clouds.
Sets SSAO (Screen Space Ambient Occlusion) enabled or disabled.
Whether to enable or disable SSAO.
Sets ground shadow enabled or disabled.
Whether to enable or disable ground shadow.
Sets the scene date and time.
The date and time to set.
OptionalshowDateTimePopup: booleanWhether to show the date and time popup.
Refreshes the position of the clouds.
Sets sun light enabled or disabled.
Whether to enable or disable sun light.
Sets sun flare enabled or disabled.
Whether to enable or disable sun flare.
Sets the pixel size of point clouds.
The pixel size.
Sets the grid enabled or disabled.
Whether to enable or disable the grid.
Sets the measurement system.
The measurement system to set.
Dispatches the context menu event.
The pointer event.
Dispatches the state changed event.
Clears the selection.
Checks if the properties window is showing.
Whether the properties window is showing.
Hides the properties window.
Checks if the design tree window is showing.
Whether the design tree window is showing.
Hides the design tree window.
Checks if the views window is showing.
Whether the views window is showing.
Shows the views window.
Hides the views window.
Checks if the filter elements window is showing.
Whether the filter elements window is showing.
Hides the filter elements window.
Checks if the settings window is showing.
Whether the settings window is showing.
Checks if the share window is showing.
Whether the share window is showing.
Checks if the WebXR window is showing.
Whether the WebXR window is showing.
Checks if the snapshot window is showing.
Whether the snapshot window is showing.
Checks if the map export window is showing.
Whether the map export window is showing.
Checks if any views windows are showing.
Whether any views windows are showing.
Checks if the message window is showing.
Whether the message window is showing.
Hides the settings window.
Hides the share window.
Hides the WebXR window.
Hides the snapshot window.
Hides the map export window.
Hides all views windows.
Hides the message window.
Shows a message box.
The message to display.
The title of the message box.
The options for the message box.
The icon for the message box.
A promise that resolves to the result of the message box.
Shows an input text message box.
The message to display.
The title of the message box.
The default value of the input.
The icon for the message box.
A promise that resolves to the input text.
Shows an input number message box.
The message to display.
The title of the message box.
The default value of the input.
The icon for the message box.
A promise that resolves to the input number.
Shows an input number message box.
The message to display.
The title of the message box.
The default value of the input in millimeters
The icon for the message box.
A promise that resolves to the input number in millimeters
Hides all windows.
Checks if the context menu is showing.
Whether the context menu is showing.
Hides the menus.
Whether the context menu was hidden.
Hides the context menu.
Whether the context menu was hidden.
When set to true, the pick mode and setSelectionType change will clear measurements. By default, this is true.
Whether the pick mode change clears measurements.
Checks if picking elements is enabled.
Whether picking elements is enabled.
Checks if picking faces is enabled.
Whether picking faces is enabled.
Checks if picking faces or elements is enabled.
Whether picking faces or elements is enabled.
Checks if picking measurements is enabled.
Whether picking measurements is enabled.
Checks if picking lines is enabled.
Whether picking lines is enabled.
Checks if picking isometric is enabled.
Whether picking isometric is enabled.
Recomputes the snapping points.
A promise that resolves to a boolean indicating success or failure.
Recomputes the camera movement settings.
Starts occlusion culling.
Stops occlusion culling.
Gets the bounding box of the scene.
A promise that resolves to the bounding box of the scene.
Gets the geolocated center of the scene at ground level.
OptionalsceneBoundingBox: BoundingBox3Dthe scene bounding box to use, if not provided it will be fetched
A promise that resolves to the WGS84 coordinates of the center point at ground level.
Gets the bounding box of the scene.
whether to use altitude from minimap viewer
OptionalsceneBoundingBox: BoundingBox3Dthe scene bounding box to use, if not provided it will be fetched
A promise that resolves to the bounding box of the scene.
Returns the visible region of the scene in 2D Visualuzer mode only
A promise that resolves to the bounding box of the visible region in 3D scene coordinates.
Gets the bounding box of visible elements.
A promise that resolves to the bounding box of visible elements.
Gets the bounding box of a model.
The ID of the model.
Whether to force recalculation of the bounding box.
A promise that resolves to the bounding box of the model.
Calculates the geolocated bounding box in WGS84 coordinates from the Ground Level center.
The 3D bounding box to be converted.
OptionalsceneBoundingBox: BoundingBox3DOptional scene bounding box to use for center calculation if not provided it will be fetched.
OptionaluseAltitude: booleanA new WGS84BoundingBox object representing the geolocated bounding box.
Sets the visibility of a bounding box.
The bounding box to set visibility for.
Whether to set the bounding box visible or not.
The color of the bounding box.
Checks if the bounding box is visible.
Whether the bounding box is visible.
Redraws the bounding box if it is visible.
Gets the bounding box of elements.
The internal IDs of the elements.
A promise that resolves to the bounding box of the elements.
Gets the bounding box of faces.
The internal IDs of the faces.
A promise that resolves to the bounding box of the faces.
Rotates the 2D camera to the specified position.
The position to rotate the camera to.
A promise that resolves to a boolean indicating success or failure.
Sets the 2D visualizer on or off.
Whether to set the 2D visualizer on or off.
Whether to animate the transition.
Checks if the element is a 3D element.
The renderer ID of the element.
A promise that resolves to a boolean indicating if the element is a 3D element.
Picks element IDs within the specified rectangle.
The x-coordinate of the top-left corner of the rectangle.
The y-coordinate of the top-left corner of the rectangle.
The width of the rectangle.
The height of the rectangle.
A promise that resolves to an array of picked element IDs.
Picks element IDs within the specified rubberband rectangle.
The x-coordinate of the start point.
The y-coordinate of the start point.
The x-coordinate of the end point.
The y-coordinate of the end point.
A promise that resolves to an array of picked element IDs.
Picks measurement IDs within the specified rubberband rectangle.
The x-coordinate of the start point.
The y-coordinate of the start point.
The x-coordinate of the end point.
The y-coordinate of the end point.
A promise that resolves to an array of picked measurement IDs.
Picks face IDs within the specified rubberband rectangle.
The x-coordinate of the start point.
The y-coordinate of the start point.
The x-coordinate of the end point.
The y-coordinate of the end point.
A promise that resolves to an array of picked face IDs.
Picks the normal vector at the specified coordinates.
The x-coordinate.
The y-coordinate.
A promise that resolves to the normal vector.
Picks the face ID at the specified coordinates.
The x-coordinate.
The y-coordinate.
Whether to prefer 2D paper face.
A promise that resolves to the picked face ID.
Gets the elements selection mode.
A promise that resolves to the elements selection mode.
Picks face IDs within the specified rectangle.
The x-coordinate of the top-left corner of the rectangle.
The y-coordinate of the top-left corner of the rectangle.
The width of the rectangle.
The height of the rectangle.
Whether to prefer 2D paper face.
A promise that resolves to an array of picked face IDs.
Sets whether the selection label is enabled.
Whether to enable the selection label.
Updates the selection label.
Updates the selection from the highlight.
Updates the selection by internal IDs.
The internal IDs to update the selection with.
Whether to highlight the selection.
Manually update the selection.
The local element nodes to update the selection with.
Whether to use internal IDs for selection.
Updates the selection by element IDs.
The element IDs to update the selection with.
Updates the selection by global IDs.
The global IDs to update the selection with.
Shows all elements.
Whether to show 3D elements.
Whether to show 2D elements.
Gets the highlighted internal IDs. May include Split Internal IDs that are not directly mappable to elements.
A promise that resolves to an array of highlighted internal IDs.
Resets the hybrid mode.
Whether to clear the highlights.
Sets elements to hybrid opaque state.
The internal IDs of the elements.
The hybrid opaque state.
Whether to clear the highlights.
Colorizes elements by internal IDs.
The internal IDs of the elements.
The red component of the color.
The green component of the color.
The blue component of the color.
Whether to dehighlight after colorizing.
Decolorizes elements by internal IDs.
The internal IDs of the elements.
Colorizes the selected elements.
The red component of the color.
The green component of the color.
The blue component of the color.
Decolorizes the selected elements.
Whether to ensure the decolorized elements are shown (sets shading mode to solid colors if needed).
Decolorizes all elements.
Whether to ensure the decolorized elements are shown (sets shading mode to solid colors if needed).
Gets the visible internal IDs.
Whether to include static elements.
Whether to include dynamic elements.
A promise that resolves to an array of visible internal IDs.
Selects and highlights all elements on the scene.
Selects and highlights the elements by element ID.
The element IDs as defined on the metadata file.
Selects and highlights the elements by engine internal IDs.
The internal IDs (different on every scene loading).
Selects and highlights the elements using an ElementInfo structure.
The elements to select and highlight.
Selects and highlights visible elements on the scene according to static or dynamic type.
Whether to include static elements.
Whether to include dynamic elements.
Whether to return only hybrid opaque elements.
A promise that resolves to a boolean indicating success or failure.
Selects and highlights the elements on the scene according to model name.
The name of the model.
A promise that resolves to a boolean indicating success or failure.
Selects and highlights the elements on the scene according to the class name. Names for all file types are similar to Ifc Standard without the Ifc prefix.
The class name.
A promise that resolves to a boolean indicating success or failure.
Selects and highlights the elements on the scene according to the layer name defined in the file.
The layer name.
A promise that resolves to a boolean indicating success or failure.
Selects and highlights the elements on the scene according to the material name defined in the file.
The material name.
A promise that resolves to a boolean indicating success or failure.
Selects and highlights the elements on the scene according to the type defined in the file. Note: For Revit, this is usually the family name.
The type name.
A promise that resolves to a boolean indicating success or failure.
Selects and highlights the elements on the scene according to the storey defined in the file.
The storey name.
A promise that resolves to a boolean indicating success or failure.
Selects and highlights the elements on the scene according to the membership defined in the file.
The membership name or global ID.
A promise that resolves to a boolean indicating success or failure.
Selects and highlights the elements on the scene according to filters.
The filters to apply.
A promise that resolves to a boolean indicating success or failure.
Selects and highlights the elements sharing the same property.
The property to filter by.
The group of the property.
A promise that resolves to a boolean indicating success or failure.
Hides the selected elements.
Hides elements by global ID.
The global IDs of the elements to hide.
Hides elements by internal ID.
The internal IDs of the elements to hide.
Whether to recompute snapping points.
Hides elements by element ID.
The element IDs of the elements to hide.
Whether to recompute snapping points.
Shows elements by global ID.
The global IDs of the elements to show.
Shows elements by element ID.
The element IDs of the elements to show.
Isolates the selected elements.
Isolates the specified elements by their internal IDs.
The internal IDs of the elements to isolate.
Sets the visibility of elements by internal IDs.
The internal IDs of the elements.
Whether to set the elements visible or not.
Checks if an element is visible.
The internal ID of the element.
A promise that resolves to a boolean indicating if the element is visible.
Sets the key for the renderer.
The key to set.
Zooms to elements by global IDs.
The global IDs of the elements.
Zooms to elements by element IDs.
The element IDs of the elements.
Zooms to the selected elements.
A promise that resolves to a boolean indicating success or failure.
Zooms to the selection.
A promise that resolves to a boolean indicating success or failure.
Looks at the specified bounding box.
The bounding box to look at.
Whether to animate the transition.
A promise that resolves to a boolean indicating success or failure.
Resets the camera to the home position.
Checks if the game mode is on.
Whether the game mode is on.
Sets the camera type.
The camera type to set.
Whether panning is preferred.
Gets the selection type.
The selection type.
Resets the 3D camera to the specified position.
The position to reset the camera to.
Whether to animate the transition.
Starts isometric measurement.
Whether the measurement is negative.
Starts auto count measurement.
Get the Measurement Options that are used while creating measurements.
measurementOptions
Clears the Measurement Options that are used while creating measurements. The default options will be used
Clears the measurements.
Clears the pins.
Focuses the renderer.
Refreshes the cutting plane label.
The index of the cutting plane.
Clears the cutting planes.
Activates a cutting plane.
The index of the cutting plane.
Deactivates a cutting plane.
The index of the cutting plane.
Checks if a cutting plane is enabled.
Whether a cutting plane is enabled.
Checks if a cutting plane is active.
The index of the cutting plane.
Whether the cutting plane is active.
Gets the image data.
Whether to flip the image upside down.
A promise that resolves to the image data.
Gets the gzipped image data.
A promise that resolves to the gzipped image data.
Checks if the renderer is initialized.
Whether the renderer is initialized.
Unloads all models in the scene.
Refreshes the camera cube.
Sets the camera cube visible or not.
Whether to set the camera cube visible or not.
Checks if the camera cube is visible.
Whether the camera cube is visible.
Sets the camera compass visible or not.
Whether to set the camera compass visible or not.
Checks if the camera compass is visible.
Whether the camera compass is visible.
Zooms to elements by internal IDs.
The internal IDs of the elements.
Whether to animate the transition.
A promise that resolves to a boolean indicating success or failure.
Zooms to the extents of the scene, 2D mode only
A promise that resolves to a boolean indicating success or failure.
Checks if elements are showing.
The internal IDs of the elements.
A promise that resolves to a boolean indicating if the elements are showing.
Takes a snapshot image and maintains aspect ratio.
Optionalwidth: numberThe requested width.
Optionalheight: numberThe requested height.
A promise that resolves to a URI that contains the image to download or use.
Takes a snapshot image and gets the URL to access it
Optionalwidth: numberThe requested width.
Optionalheight: numberThe requested height.
A promise that resolves to a URI that contains the image to download or use.
Retrieves the current state of dynamic elements.
A promise that resolves to a DynamicElementsState object.
Sets the state of dynamic elements.
The state to set.
Gets the state of clipping regions.
A promise that resolves to a ClippingRegionsState object.
Sets the state of clipping regions.
The state to set.
Gets the state of the camera. The state number array includes:
A promise that resolves to a CameraState object.
Sets the state of the camera. The state number array includes:
The state to set.
Whether to animate the transition (will not animate if minimap is showing)
Whether to dispatch the state changed event default is true
Gets the visibility state.
A promise that resolves to a VisibilityState object.
Sets the visibility state.
The state to set.
Whether to recompute snapping points.
Gets the colorization state.
OptionalfilterIds: Set<bigint>A promise that resolves to a ColorizationState object.
Sets the markup state.
The state to set.
Whether to enable edit mode.
Gets the sensors state.
A promise that resolves to a SensorsState object.
Sets the sensors state.
The state to set.
Sets the colorization state.
The state to set.
Gets the viewer settings state.
Whether to include geo position and time.
A promise that resolves to a ViewerSettingsState object.
Sets the viewer settings state.
The state to set.
Gets the highlighted state.
A promise that resolves to a HighlightedState object.
Sets the highlighted state.
The state to set.
Gets the measurements state.
A promise that resolves to a MeasurementState object.
Sets the measurements state.
The state to set.
Gets the cutting planes state.
A promise that resolves to a CuttingPlanesState object.
Gets the splitted elements state.
Sets the splitted elements state.
The state to set.
Sets the cutting planes state.
The state to set.
Gets the scene view.
Whether to include the settings state.
OptionalincludePinsState: booleanWhether to include the pins state.
OptionalincudeSensorsState: booleanWhether to include the sensors state.
OptionalincludeDynamicElementsState: booleanWhether to include the dynamic elements state.
A promise that resolves to a SceneView object.
Sets the scene view.
The scene view to set.
Whether to transition to the view (will not transition if minimap is showing).
Whether to enable markup editing.
Whether to show the loading splashscreen.
Checks if the renderer is a mobile renderer.
Whether the renderer is a mobile renderer.
Asynchronously initializes the renderer.
OptionalinitializationFunction: (renderer: LocalBIMRenderer) => voidRemove a model from the renderer
Starts the drawing loop.
Refreshes the redraw needed state.
Asynchronously cleans up and releases resources used by the viewer. This may include removing event listeners, freeing memory, and terminating ongoing processes or operations.
It is important to ensure that this method is called when the object is no longer needed to prevent memory leaks and ensure optimal application performance.
A promise that resolves when the destruction process is complete, indicating that all resources have been released successfully.
Sets the RENDERER_PICK_MODE of the viewer
Resets the last redraw executed time.
Requests the user to select a line and measures its length.
This method focuses the renderer, locks GUI actions, and sets up the input state for rubberband selection. It displays an optional notification, waits for the user to select a line, and then restores the previous state.
OptionalinfoText: stringOptional informational text to display as a notification during the selection process.
A promise that resolves to the length of the selected line.
Requests a scale measurement from the user.
OptionalinfoText: stringOptional informational text to display as a notification during the selection process.
The length of the selected line, or -1 if the selection was canceled.
Disables any GUI actions and forces the user to select a Rubberband area on screen Pressing Escape will return null
OptionalinfoText: stringThe text to display in the notification or leave empty to avoid showing a notification.
A promise that resolves to the selection Rectangle or null if the operation fails.
Adds a new custom scale by allowing the user to define it interactively.
Cancels the custom scale selection process to terminate the waiting for a custom scale in addCustomScale.
True if the custom scale selection was cancelled, false otherwise.
Adds a new clipping region by allowing the user to define it interactively.
A promise that resolves to the created BimCTClippingRegion or null if the operation fails.
Removes a specified clipping region from the list of regions.
The BimCTClippingRegion object to be removed.
If true, will not ask the user to delete any measurements that overlap with this region.
A promise that resolves to true if the region was successfully removed, or false if the region was not found.
Puts the renderer into Pin Addition mode, using inner pin SVG images that can change color You need to subscribe to pinInsertEvent to listen to when and if an image will be actually added
Optionalcolor: stringof the image in html color format
OptionaluserObject: unknownOptionalorientation: PinClickedPointOrientationPuts the renderer into Pin Addition mode, the image used is in the image URL Original Width and Height of the image is required You need to subscribe to pinInsertEvent to listen to when and if an image will be actually added
OptionaluserObject: unknownOptionalorientation: PinClickedPointOrientationPust the renderer in Length Measurement Pick Mode and starts addition of a Length Measurement You need to subscribe to measurementsPointPushBackEvent to Listen to measurement point changes
whether it is positive or negative Length Measurement
Pust the renderer in Area Measurement Pick Mode and starts addition of a Length Measurement You need to subscribe to measurementsPointPushBackEvent to Listen to measurement point changes
whether it is positive or negative Length Measurement
Puts the renderer in Count Measurement Pick Mode and starts addition of a Length Measurement You need to subscribe to measurementsPointPushBackEvent to Listen to measurement point changes
Loads data from a MsgPack payload.
The payload to load.
OptionalsceneView: SceneViewThe scene view to use for the model or undefined to use the default scene view. if you dont want to change the camera or the view use autoCameraResetAfterModelLoaded = true prior to calling this function.
Optionaltransition: booleanWhether to animate the transition to the new model.
A promise that resolves when the model is loaded.
Loads a model from a URL and caches it in the browser.
The URL to load the model from.
OptionalsceneView: SceneViewThe scene view to use for the model or undefined to use the default scene view. if you dont want to change the camera or the view use autoCameraResetAfterModelLoaded = true prior to calling this function.
Optionaltransition: booleanWhether to animate the transition to the new model.
Optionalmatrix: number[]The matrix to apply to the model.
Optionalmapping: ModelIdMappingThe mapping to apply to the model.
A promise that resolves when the model is loaded.
Loads a model from an XMLHttpRequest and caches it in the browser.
The XMLHttpRequest to load the model from.
The UUID of the model.
OptionalsceneView: SceneViewThe scene view to use for the model or undefined to use the default scene view. if you dont want to change the camera or the view use autoCameraResetAfterModelLoaded = true prior to calling this function.
Optionaltransition: booleanWhether to animate the transition to the new model.
Optionalmatrix: number[]The matrix to apply to the model.
Optionalmapping: ModelIdMappingThe mapping to apply to the model.
A promise that resolves when the model is loaded.
Gets the models with URL state.
The model IDs to get the state for.
Sets the models with URL state.
The state to set.
Whether to unload all models with URL before setting the state.
A promise that resolves when the state is set.
Loads a model from a URL.
The URL of the model to load.
OptionalsceneView: SceneViewThe scene view to use for the model or undefined to use the default scene view. if you dont want to change the camera or the view use autoCameraResetAfterModelLoaded = true prior to calling this function.
Optionaltransition: booleanWhether to use a transition when loading the model.
Optionalmatrix: number[]The matrix to apply to the model.
Optionalmapping: ModelIdMappingThe mapping to apply to the model.
A promise that resolves to the ModelInfo object of the loaded model.
Clones a model that was already loaded to the scene using a URL.
The ID of the model to clone.
OptionalsceneView: SceneViewThe scene view to use for the model.
Optionaltransition: booleanWhether to use a transition when loading the model.
Optionalmatrix: number[]The matrix to apply to the model.
Optionalmapping: ModelIdMappingThe mapping to apply to the model.
A promise that resolves to the ModelInfo object of the cloned model.
Reloads a model that was already loaded to the scene using a URL. But with the specified matrix.
the ID of the model to reload.
the matrix to apply to the model.
Loads a model from a payload.
The payload of the model to load.
OptionalsceneView: SceneViewThe scene view to use for the model or undefined to use the default scene view. if you dont want to change the camera or the view use autoCameraResetAfterModelLoaded = true prior to calling this function.
Optionaltransition: booleanWhether to use a transition when loading the model.
Optionalmatrix: number[]The matrix to apply to the model.
Optionalmapping: ModelIdMappingThe mapping to apply to the model.
A promise that resolves to the ModelInfo object of the loaded model.
Stops the rendering animation loop and waits for the current frame to finish rendering. This is useful when you want to stop rendering and wait for the current frame to finish rendering before doing something else.
Starts the rendering animation loop. This is useful when you want to start rendering after stopping it.
Returns whether the rendering is stopped.
Checks if VR is supported.
Checks if a VR session is started.
Stops the VR session.
Sets the XR preview to canvas state.
Resets the XR visibility state.
Starts the VR session.
Adds a comparison renderer.
The renderer to be added for comparison.
Removes a comparison renderer.
The renderer to be removed from comparison.
whether the renderer is comparing.
Locks or unlocks GUI actions.
Whether to lock or unlock GUI actions.
The main BimCT WebGL2 Renderer API entry point