Create a new emscripten renderer
An empty div element that will be used as a wrapper for all the renderer elements
Optional initializationOptions: RendererInititializationOptionsInitialization Options
Returns the alignment cofiguration handler of the BimCT scene models.
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 animations.
The animations.
Gets the base path for assets.
The base path for assets.
Gets the auto camera reset state after model is loaded.
Sets the auto camera reset state after model is loaded.
Gets the base canvas.
The base canvas.
Gets the base path for the BimCT additional functions server.
The base path for the BimCT server.
Sets the canvas cursor.
The canvas cursor to set.
Gets the clipping.
The clipping.
Gets the comparison viewer.
Gets the context menu.
The context menu.
Gets the context menu event.
The context menu event.
Gets the display format.
Gets the div element.
The div element.
Gets the dynamic elements.
The dynamic elements.
Gets the elements.
The elements.
Gets the GUI actions locked event.
The GUI actions locked event.
Checks if the comparison viewer is available.
Checks if the context menu is available.
Whether the context menu is available.
Checks if the home toolbar is available.
Whether the home toolbar is available.
Checks if the left toolbar is available.
Whether the left toolbar is available.
Checks if the message window is available.
Whether the message window is available.
Checks if the comparison viewer is available.
Checks if the selection label is enabled.
Whether the selection label is enabled.
Checks if the settings window is available.
Whether the settings window is available.
Checks if the share window is available.
Whether the share window is available.
Checks if the snapshot window is available.
Whether the snapshot window is available.
Checks if the time changer window is available.
Whether the time changer window is available.
Checks if the toolbar is available.
Whether the toolbar is available.
Checks if the touch widget is available.
Whether the touch widget is available.
Checks if the views manager is available.
Whether the views manager is available.
Checks if the WebXR window is available.
Whether the WebXR window is available.
Gets the home toolbar.
The home toolbar.
Gets the input handler.
Checks if the renderer is currently drawing.
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.
Gets the language changed event.
The language changed event.
Gets the left toolbar.
The left toolbar.
Gets the visibility change event.
The visibility change event.
Gets the measurement system.
The measurement system.
Gets the measurements state.
The measurements state.
Gets the measurements point push back event.
The measurements point push back event.
Gets the measurements selected event.
The measurements selected event.
Gets the measurements updated event.
The measurements updated event.
Gets the message window.
The message window.
Gets the metadata accessor.
The metadata accessor.
Gets the instance of the minimap viewer.
The instance of the minimap viewer.
Gets the model loaded event.
The model loaded event.
Gets the model removed event.
The model removed event.
Gets the mouse right clicked event.
The mouse right clicked event.
Gets the overlay.
The overlay.
Gets the pick lines state.
Gets the pick lines updated event.
The pick lines updated event.
Gets the pin clicked event.
The pin clicked event.
Gets the pin dehighlighted event.
The pin dehighlighted event.
Gets the pin highlighted event.
The pin highlighted event.
Gets the pin insert event.
The pin insert event.
Gets the pin moved event.
The pin moved event.
Returns the WebGL2 rendering context.
Gets the resized event.
The resized event.
Gets the selected elements.
The selected elements.
Gets the selection change event.
The selection change event.
Gets the sensor manager.
The sensor manager.
Gets the settings changed event.
The settings changed event.
Gets the settings window.
The settings window.
Gets the shading mode.
The shading mode.
Sets the shading mode of the renderer.
The shading mode to set.
Gets the share window.
The share window.
Gets the show progress state while model is loading.
Sets the show progress state while model is loading.
Gets whether snapping is enabled.
Whether snapping is enabled.
Gets the snapshot window.
The snapshot window.
Gets the state of the renderer.
The state of the renderer.
Gets the state changed event.
The state changed event.
Gets the solar position changed event.
The the solar position changed event.
Gets the toolbar.
The toolbar.
Gets the touch widget.
The touch widget.
Gets the transformation gismo.
The transformation gismo.
Gets the views manager.
The views manager.
Gets the visibility change event.
The visibility change event.
Gets the WebXR window.
The WebXR window.
Gets the XR session event.
The XR session event.
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.
Adds a comparison renderer.
The renderer to be added for comparison.
Adds a new custom scale by allowing the user to define it interactively.
Adds a new measurement.
A promise that resolves to the new measurement.
Clones a model that was already loaded to the scene using a URL.
A promise that resolves to the ModelInfo object of the cloned model.
The ID of the model to clone.
Optional sceneView: SceneViewThe scene view to use for the model.
Optional transition: booleanWhether to use a transition when loading the model.
Optional matrix: number[]The matrix to apply to the model.
Optional mapping: ModelIdMappingThe mapping to apply to the model.
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.
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.
Gets the state of the camera. The state number array includes:
A promise that resolves to a CameraState object.
Gets the state of clipping regions.
A promise that resolves to a ClippingRegionsState object.
Gets the colorization state.
A promise that resolves to a ColorizationState object.
Gets the cutting planes state.
A promise that resolves to a CuttingPlanesState object.
Retrieves the current state of dynamic elements.
A promise that resolves to a DynamicElementsState object.
Gets the bounding box of elements.
A promise that resolves to the bounding box of the elements.
The internal IDs of the elements.
Gets the bounding box of faces.
A promise that resolves to the bounding box of the faces.
The internal IDs of the faces.
Gets the highlighted state.
A promise that resolves to a HighlightedState object.
Gets the hybrid state.
A promise that resolves to a HybridState object.
Gets the markup state.
A promise that resolves to a MarkupState object.
Gets the measurements state.
A promise that resolves to a MeasurementState object.
Gets the pick mode.
The pick mode.
Gets the bounding box of the scene.
A promise that resolves to the bounding box of the scene.
Gets the scene view.
A promise that resolves to a SceneView object.
Whether to include the settings state.
Optional includePinsState: booleanWhether to include the pins state.
Optional incudeSensorsState: booleanWhether to include the sensors state.
Optional includeDynamicElementsState: booleanWhether to include the dynamic elements state.
Gets the viewer settings state.
A promise that resolves to a ViewerSettingsState object.
Whether to include geo position and time.
Gets the visibility state.
A promise that resolves to a VisibilityState object.
Gets the bounding box of visible elements.
A promise that resolves to the bounding box of visible elements.
Gets the visible internal IDs.
A promise that resolves to an array of visible internal IDs.
Whether to include static elements.
Whether to include dynamic elements.
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.
Hides the share window.
Optional initializationFunction: ((renderer: BimCTOpenGL4Renderer) => void)Shows an input number message box.
A promise that resolves to the input number.
The message to display.
The title of the message box.
The default value of the input.
The icon for the message box.
Shows an input text message box.
A promise that resolves to the input text.
The message to display.
The title of the message box.
The default value of the input.
The icon for the message box.
Shows an input number message box.
A promise that resolves to the input number in millimeters
The message to display.
The title of the message box.
The default value of the input in millimeters
The icon for the message box.
Checks if the share window is showing.
Whether the share window is showing.
Loads data from a MsgPack payload.
A promise that resolves when the model is loaded.
The payload to load.
Optional sceneView: 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.
Optional transition: booleanWhether to animate the transition to the new model.
Loads a model from a payload.
A promise that resolves to the ModelInfo object of the loaded model.
The payload of the model to load.
Optional sceneView: 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.
Optional transition: booleanWhether to use a transition when loading the model.
Optional matrix: number[]The matrix to apply to the model.
Optional mapping: ModelIdMappingThe mapping to apply to the model.
Loads a model from a URL and caches it in the browser.
A promise that resolves when the model is loaded.
The URL to load the model from.
Optional sceneView: 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.
Optional transition: booleanWhether to animate the transition to the new model.
Optional matrix: number[]The matrix to apply to the model.
Optional mapping: ModelIdMappingThe mapping to apply to the model.
Loads a model from an XMLHttpRequest and caches it in the browser.
A promise that resolves when the model is loaded.
The XMLHttpRequest to load the model from.
The UUID of the model.
Optional sceneView: 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.
Optional transition: booleanWhether to animate the transition to the new model.
Optional matrix: number[]The matrix to apply to the model.
Optional mapping: ModelIdMappingThe mapping to apply to the model.
Loads a model from a URL.
A promise that resolves to the ModelInfo object of the loaded model.
The URL of the model to load.
Optional sceneView: 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.
Optional transition: booleanWhether to use a transition when loading the model.
Optional matrix: number[]The matrix to apply to the model.
Optional mapping: ModelIdMappingThe mapping to apply to the model.
Loads a skymap by its ID.
A promise that resolves to a boolean indicating success or failure.
The ID of the skymap.
Whether to show the loading screen.
Looks at the specified bounding box.
A promise that resolves to a boolean indicating success or failure.
The bounding box to look at.
Whether to animate the transition.
Shows a message box.
A promise that resolves to the result of the message box.
The message to display.
The title of the message box.
The options for the message box.
The icon for the message box.
Picks element IDs within the specified rectangle.
A promise that resolves to an array of picked element IDs.
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.
Picks the face ID at the specified coordinates.
A promise that resolves to the picked face ID.
The x-coordinate.
The y-coordinate.
Whether to prefer 2D paper face.
Picks face IDs within the specified rectangle.
A promise that resolves to an array of picked face IDs.
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.
Picks element IDs within the specified rubberband rectangle.
A promise that resolves to an array of picked element IDs.
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.
Picks face IDs within the specified rubberband rectangle.
A promise that resolves to an array of picked face IDs.
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.
Picks measurement IDs within the specified rubberband rectangle.
A promise that resolves to an array of picked measurement IDs.
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.
Removes a specified clipping region from the list of regions.
A promise that resolves to true if the region was successfully removed, or false if the region was not found.
The BimCTClippingRegion object to be removed.
If true, will not ask the user to delete any measurements that overlap with this region.
Removes a comparison renderer.
The renderer to be removed from comparison.
Resets the 3D camera to the specified position.
The position to reset the camera to.
Whether to animate the transition.
Rotates the 2D camera to the specified position.
A promise that resolves to a boolean indicating success or failure.
The position to rotate the camera to.
Converts screen coordinates to world position without taking depth into account.
A promise that resolves to the world position.
The x-coordinate on the screen.
The y-coordinate on the screen.
Selects and highlights visible elements on the scene according to static or dynamic type.
A promise that resolves to a boolean indicating success or failure.
Whether to include static elements.
Whether to include dynamic elements.
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.
A promise that resolves to a boolean indicating success or failure.
The class name.
Selects and highlights the elements using an ElementInfo structure.
The elements to select and highlight.
Selects and highlights the elements on the scene according to filters.
A promise that resolves to a boolean indicating success or failure.
The filters to apply.
Selects and highlights the elements on the scene according to the material name defined in the file.
A promise that resolves to a boolean indicating success or failure.
The material name.
Selects and highlights the elements on the scene according to the membership defined in the file.
A promise that resolves to a boolean indicating success or failure.
The membership name or global ID.
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.
A promise that resolves to a boolean indicating success or failure.
The type name.
Selects and highlights the elements sharing the same property.
A promise that resolves to a boolean indicating success or failure.
The property to filter by.
The group of the property.
Sets the 2D bounding box.
The 2D bounding box to set.
Sets the 2D visualizer on or off.
Whether to set the 2D visualizer on or off.
Whether to animate the transition.
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.
Sets the state of the camera. The state number array includes:
The state to set.
Whether to animate the transition.
Whether to dispatch the state changed event default is true
Sets the camera type.
The camera type to set.
Whether panning is preferred.
Sets the state of clipping regions.
The state to set.
Sets the colorization state.
The state to set.
Sets the cutting planes state.
The state to set.
Sets the state of dynamic elements.
The state to set.
Sets elements to hybrid opaque state.
The internal IDs of the elements.
The hybrid opaque state.
Whether to clear the highlights.
Sets the highlighted state.
The state to set.
Sets the hybrid state.
The state to set.
Sets the markup state.
The state to set.
Whether to enable edit mode.
Sets the measurement system.
The measurement system to set.
Sets the measurements state.
The state to set.
Sets the models with URL state.
A promise that resolves when the state is set.
The state to set.
Whether to unload all models with URL before setting the state.
Sets the RENDERER_PICK_MODE of the viewer
Sets the scene view.
The scene view to set.
Whether to transition to the view.
Whether to enable markup editing.
Whether to show the loading splashscreen.
Sets the viewer settings state.
The state to set.
Sets the visibility state.
The state to set.
Whether to recompute snapping points.
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
Pust 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
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
Optional color: stringof the image in html color format
Optional userObject: unknownOptional orientation: 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
Optional userObject: unknownOptional orientation: PinClickedPointOrientationTakes a snapshot image and maintains aspect ratio.
A promise that resolves to a URI that contains the image to download or use.
Optional width: numberThe requested width.
Optional height: numberThe requested height.
Manually update the selection.
The local element nodes to update the selection with.
Whether to use internal IDs for selection.
Converts world coordinates to screen space position.
A promise that resolves to the screen space position and whether it is inside the frustum.
The world coordinates.
Zooms to elements by internal IDs.
A promise that resolves to a boolean indicating success or failure.
The internal IDs of the elements.
Whether to animate the transition.
The main BimCT OpenGL 4.6 Renderer API entry point