Abstract A div element that will be used as the container of the renderer. It must have an already specified size
Optional initializationOptions: RendererInititializationOptionsReturns 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.
Abstract BR3BR3D_AddDynamicElement Add and set the geometric data of the dynamic element
Parameters:
Returns the dynamic element unique ID. If the ID is negative then the operation was not successful.
Abstract BR3BR3D_AddElement Add an element to a model
Requirements: The model must already exists in the engine. Must only be called after AddModel.
Parameters:
Returns the Engine's unique ID of the Element. If the ID is negative then the operation was not successful.
Abstract BR3BR3D_AddElementFace Add a face for the specific element
Requirements: The model and element must already exists in the engine. Must only be called after AddModel, AddElement and SetElementVertices.
Parameters:
Returns the Engine's unique ID of the packed (Element, Face). If the ID is negative then the operation was not successful.
Abstract BR3BR3D_AddElementLinePatternVertices Add line pattern's data of an element
Requirements: The model and element must already exists in the engine. Must only be called after AddModel and AddElement;
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_AddElementLinePatternVertices Add line pattern's data of an element
Requirements: The model and element must already exists in the engine. Must only be called after AddModel and AddElement;
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_AddModel Adds a model with the given properties to the scenegraph REQUIRED: for adding elements to a model
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_AddPointCloud Add and set the geometric data of a point cloud Parameters:
Returns the point cloud id. If the ID is 0xFFFFFFFF then the operation was not successful.
Abstract BR3Abstract BR3BR3D_AddSensorChannel Add sensor channel with a value range [low, high]
Parameters:
Returns id of the channel if operation was successful. -1 if operation failed.
Abstract BR3Abstract BR3Abstract BR3BR3D_AddTexture
Parameters:
Returns the id of the texture or -1 if the operation was not successful.
Abstract BR3///////////////////////////////////////////////////////////////////////////////////////////////////// TextureElement3D API
BR3D_AddTextureElement Registers a 3D Texture Element. The Texture Element is associated with an existing 2D Drawing and is rendered at the provided rectangle positions. To ensure that the 2D Drawing is displayed in the entire Texture Element, it must have been generated using the expected aspect ratio of the Texture Element. Otherwise, the Texture Element rectangle will be resized (without exceeding the rectangles dimensions) to fit the associated 2D drawing.
Parameters: texture_element_id, a unique id for the Texture Element drawing_id, the drawing id of an existing 2D Drawing pos_top_left_(x,y,z), the top left 3D position of the Texture Element in world coordinates pos_bottom_left_(x,y,z), the top left 3D position of the Texture Element in world coordinates pos_bottom_left_(x,y,z), the top left 3D position of the Texture Element in world coordinates pos_top_right_(x,y,z), the top left 3D position of the Texture Element in world coordinates
Returns true if operation was successful.
Abstract BR3BR3D_AddTextureElementRaster Registers a 3D Texture Element. The Texture Element is associated with a provided RGB data buffer and is rendered at the provided rectangle positions. To ensure that the provided RGB data is displayed in the entire Texture Element, it must have been generated using the expected aspect ratio of the Texture Element. Otherwise, the Texture Element rectangle will be resized (without exceeding the rectangles dimensions) to fit the associated RGB data.
Parameters: texture_element_id, a unique id for the Texture Element rgb_data, a buffer containing RGB data information. The size of the buffer must be width * height * 3. width, the width of the RGB buffer height, the height of the RGB buffer pos_top_left_(x,y,z), the top left 3D position of the Texture Element in world coordinates pos_bottom_left_(x,y,z), the top left 3D position of the Texture Element in world coordinates pos_bottom_left_(x,y,z), the top left 3D position of the Texture Element in world coordinates pos_top_right_(x,y,z), the top left 3D position of the Texture Element in world coordinates
Returns true if operation was successful.
Abstract BR3Abstract BR3BR3D_AntiAliasingSetMode Set 3D renderer anti aliasing mode
Parameters:
Abstract BR3BR3D_AttachDrawingToMinimap Registers, attaches and renders a 2D Drawing to a specific minimap. The Drawing is rendered orthographically in outline mode using the specified bounding box parameters and top (BCP_TOP) camera position. The dimensions of the drawings are automatically assigned to fit the minimap window.
Parameters:
Returns true if operation was successful.
Abstract BR3Abstract BR3Abstract BR3Returns true if the operation was succesfull.
Abstract BR3BR3D_ChangeDynamicElementBillboardActive Set whether the dynamic element should be shown as a billboard
Parameters:
Returns true if the operation was succesfull.
Abstract BR3BR3D_ChangeDynamicElementBillboardTexture Set the billboard texture of the dynamic element. The caller is responsible for lifetime management of the texture.
Parameters:
Abstract BR3BR3D_ChangeDynamicElementColor Chnage the color data of the dynamic element
Parameters:
Returns true if the operation was succesfull.
Abstract BR3Abstract BR3Abstract BR3Abstract BR3BR3D_CheckMeasurementPolygon Check the polygon for self intersection. It also works on Measurements with holes.
Parameters:
Abstract BR3Abstract BR3BR3D_ClearMeasurement Clears the point and segment data from a measurement
Parameters:
Abstract BR3Abstract BR3Abstract BR3Abstract BR3BR3D_CloseMeasurement Close the measurement in order to create a closed polygon. It is necessary in order to compute other functions (e.g. GetArea())
Parameters:
Abstract BR3Abstract BR3Abstract BR3BR3D_MergeFaceAndElementID Merges the face and element id
Parameters:
Abstract BR3BR3D_ConvertFromDXToOpenGL Convert the interleaved vertex with normals vertex array and index array from DX format to OpenGL
Parameters:
Abstract BR3BR3D_CreateMeasurement Create a 3D measurement. MeasurementID should be unique and it is handled by the application, in order to be stored and manipulated more efficient. The measurement id should be greater than zero. ID -1 is reserved for the ghost measurement and cannot be created or deleted.
Parameters:
Abstract BR3///////////////////////////////////////////////////////////////////////////////////////////////////// Minimap3D API
BR3D_CreateMinimap Registers a minimap that will be displayed on the screen. A 2D Drawing must be attached to the minimap before it can be displayed. More than one minimaps can be registered, indicating different models present in the renderer.
Parameters:
Returns true if operation was successful.
Abstract BR3Abstract BR3Abstract BR3Abstract BR3BR3D_DeleteMeasurementPoint Removes a point from the measurement. It also collapses the neighboring segments into a line.
Parameters:
Abstract BR3Abstract BR3BR3D_EditTextureElement Edits the position of a 3D Texture Element. Note that this forces a re-allocation of the buffers for the requested Texture Element.
Parameters: texture_element_id, the Texture Element id width, the width of the Texture Element height, the height of the Texture Element pos_top_left_(x,y,z), the top left 3D position of the Texture Element in world coordinates pos_bottom_left_(x,y,z), the top left 3D position of the Texture Element in world coordinates pos_bottom_left_(x,y,z), the top left 3D position of the Texture Element in world coordinates pos_top_right_(x,y,z), the top left 3D position of the Texture Element in world coordinates
Returns true if operation was successful.
Abstract BR3BR3D_EndComputingNormals Ends the computation of the normals
Parameters:
Abstract BR3BR3D_ForceMinimapRender Forces a render of the associated drawings within the Minimap. This can be used in case the associated data of the Minimap have changed, e.g. a 2D Drawing has been attached after it has become active or if offscreen has been disabled/enabled and in-between the window dimensions have changed.
Returns true if operation was successful.
Abstract BR3///////////////////////////////////////////////////////////////////////////////////////////////////// Drawing3D API
BR3D_Generate2DDrawingID Registers a 2D Drawing of dimensions (width, height).
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_Generate2DDrawingID Registers a 2D Drawing of dimensions (width, height).
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_Get2DDrawingBackground Retrieves the background color for the 2D drawings.
Parameters:
Abstract BR3BR3D_Get2DDrawingCameraBox Retrieves the camera space bounding box used for the drawing. This can be used for placing a texture element correctly in world space (using the x, y dimensions of the box).
Parameters:
Returns true if operation was successful.
Abstract BR3Get2DDrawingCameraUVW Retrieves the camera coordinate system for the requested drawing. This can be used for placing a texture element correctly in world space.
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_Get2DDrawingData Retrieves the rgb data of a 2D drawing
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_Get2DDrawingDefaultDrawingTypeInfo Retrieves the default color and line width for all drawing types that have not been set specifically (through BR3D_Set2DDrawingType).
Parameters:
Abstract BR3BR3D_Get2DDrawingDimensions Retrieves the dimensions for a 2D drawing
Parameters:
Returns true if operation was successful.
Abstract BR3Abstract BR3BR3D_Get2DDrawingTypeInfo Retrieves the color and line width that have been set for a particular IFC type
Parameters:
Abstract BR3BR3D_Get2DDrawingZoomOutPercentage Retrieves the percentage that the camera is zoomed out for the 2D drawings
Parameters:
Abstract BR3BR3D_GetActiveMinimapCameraParameters Retrieves the color and size (in pixels) of the camera icon
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_GetActiveMinimapData Retrieves the rgb data of the active minimap. This is used only if offscreen rendering is enabled
Parameters:
Returns true if operation was successful.
Abstract BR3Abstract BR3Abstract BR3BR3D_GetActiveMinimapWindowPosition Retrieves the viewport pixel positions of the active minimap. Any changes to these parameters force a new render of the associated 2D Drawings.
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_GetActiveMinimapWindowThicknessParameters Retrieves the stroke's color and thickness (in pixels) of the minimap window
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_GetAll2DDrawingIDs Retrieves the ids of the registered 2D Drawings.
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_GetAll2DDrawingIDs Retrieves the ids of the registered Minimaps.
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_GetAllTextureElementIDs Retrieves the ids of the registered Texture Elements.
Parameters:
Returns true if operation was successful.
Abstract BR3Abstract BR3Abstract BR3BR3D_GetArea Retrieves the measurement area. To be performed the measurement should be closed.
Parameters:
Abstract BR3Abstract BR3Abstract BR3Abstract BR3BR3D_GetCameraCubeDimensions Retrieves the dimensions of the viewport displaying the cube.
Parameters:
Returns true if operation was successful.
Abstract BR3Abstract BR3BR3D_GetCameraState Retrieves the camera state for the requested camera
Parameters:
Abstract BR3BR3D_GetClosestNormalToPoint Retrieves the normal of the specified element ID that is closed to the given point
Parameters:
Abstract BR3BR3D_GetClosestPoint Get the closest segment id and distance, on the measurement based on the given position.
Parameters:
Abstract BR3BR3D_GetClosestPointAndOutline Retrieves closest point and outline Data Format: (endpoint_xyz, distance_to_endpoint) (line_endpoint1_xyz, distance_to_line) (line_endpoint2_xyz, distance_to_line) (closest_point_on_line, distance_to_line) (second_line_endpoint1_xyz, distance_to_line) GL ES 3 ONLY (second_line_endpoint2_xyz, distance_to_line) GL ES 3 ONLY
Parameters:
Abstract BR3BR3D_GetClosestSegment Get the closest segment id and distance, on the measurement based on the given position.
Parameters:
Abstract BR3BR3D_GetCurrentCameraProjectionType Retrieves the camera's angular speed
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_GetCurrentCameraLinearSpeed Retrieves the camera's linear speed
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_GetCurrentCameraProjectionType Retrieves the camera projection type (perspective or orthographic mode). Note that rotations are disabled when on orthographic mode
Parameters:
Returns true if operation was successful.
Abstract BR3Abstract BR3BR3D_GetCurrentCameraState Retrieves the current camera's state
Parameters:
Abstract BR3Abstract BR3BR3D_GetCurrentCameraZoomBlendFactors Retrieves the camera's zoom blend factors
Parameters:
Returns true if operation was successful.
Abstract BR3Abstract BR3BR3D_GetCursorFromWorldSpacePosition3D Get the cursor position from a world space position.
Parameters
Returns true if operation was successful.
Abstract BR3Abstract BR3BR3D_GetCursorWorldSpacePosition3D Get the world space position of the cursor.
Parameters
Returns true if operation was successful.
Abstract BR3Abstract BR3Abstract BR3BR3D_GetCuttingPlaneParameters Get the various parameters of the cutting plane
Parameters:
Abstract BR3BR3D_GetCuttingPlaneVisualizationParameters Get the visualization parameters of the cutting plane
Parameters:
Abstract BR3BR3D_GetElementArea Retrieves the selected area of the element (only static element)
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_GetElementFirstColor Gets the first material color (original or current of an Element) RGB is in [0 1] range
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_GetElementIDFromFromFullID Retrieves the element id from the given fullID (including faceID)
Parameters:
Abstract BR3BR3D_GetElementPerimeter Retrieves the selected perimeter of the element in millimeter (only static element)
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_GetElementPixelCenter Retrieves the pixel center of a particular element
Parameters:
Abstract BR3BR3D_GetElementsArea Retrieves the area of the requested elements (both static and dynamic on GL43)
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_GetElementsBoundingBox Retrieves the bounding box of a list of elements (both static and dynamic on GL43)
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_GetElementsBoundingBoxDistance Retrieves the distance of the camera's center of projection to the center of the bounding box from a list of elements
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_GetElementsHighLightedIDs Retrieves the current list of highlighted IDs
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_GetElementsIDs Retrieves the ids of the given globalIDs
Parameters:
Abstract BR3Abstract BR3BR3D_GetElementsVolume Retrieves the volume of the requested elements (both static and dynamic on GL43)
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_GetEnhancedSilhouetteHideThreshold Retrieves the Enhanced Silhouette hide threshold
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_GetFaceFirstNormal Retrieves the normal of the first triangle with the given elementFaceID
Parameters:
Abstract BR3Abstract BR3BR3D_GetFacesArea Retrieves the area of the requested faces (only static element)
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_GetFacesBoundingBox Retrieves the bounding box of the requested faces (only static element)
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_GetGlobalClosestPoint Get the closest measurement id, point id and distance from the given position.
Parameters:
Abstract BR3BR3D_GetGlobalClosestSegment Get the closest measurement id, segment id and distance, from the given position.
Parameters:
Abstract BR3BR3D_GetGlobalIDFromElementsID Retrieves the ids of the given globalIDs
Parameters:
Abstract BR3Abstract BR3Abstract BR3BR3D_GetGlobalTransparencyValue Retrieves the global transparency value for the transparent visualization option
Parameters:
Returns true if operation was successful.
Abstract BR3Abstract BR3BR3D_GetGridLevelAttributes Retrieves various attributes for a particular resolution level of the grid
Parameters:
Abstract BR3BR3D_GetBackgroundColor Retrieves the color for a particular resolution level of the grid
Parameters:
Abstract BR3Abstract BR3Abstract BR3BR3D_GetGroundSurfaceShadowRecomputeState Get the recomputation state of the ground surface shadow technique.
Parameters: -enable, state Returns true if the operation was performed
Abstract BR3Abstract BR3BR3D_GetLastSegmentLength Retrieves the length of the last added segment on the measurement.
Parameters:
Abstract BR3BR3D_GetLengthFromPixelSize Returns the world space size from pixel size at a given position. Works in perspective cameras
Parameters:
Abstract BR3Abstract BR3Abstract BR3BR3D_GetMeasurement3DDataSize Get the size of the generated measurement byte buffer
Parameters:
Abstract BR3BR3D_GetMeasurement3DDataSize Get the size of the generated measurement byte buffer
Parameters:
Abstract BR3Abstract BR3BR3D_GetMeasurementDrawOrder Retrieves the draw order of the current measurement
Parameters:
Abstract BR3GetMeasurementFillColor Retrieves the fill color of the measurement
Parameters:
Abstract BR3BR3D_GetMeasurementFillPattern Retrieves the fill pattern of the measurement
Parameters:
Abstract BR3BR3D_GetMeasurementLineColor Retrieves the line color of the measurement
Parameters:
Abstract BR3BR3D_GetMeasurementLineWidth Retrieves the line width of the measurement
Parameters:
Abstract BR3Abstract BR3GetMeasurementPointColor Retrieves the point color of the measurement
Parameters:
Abstract BR3BR3D_GetMeasurementPointSize Retrieves the point size of the measurement
Parameters:
Abstract BR3Abstract BR3BR3D_GetMeasurementPreviewMode Get the preview mode of the measurement
Parameters:
Abstract BR3BR3D_GetMeasurementSegmentIDs Get the segment ids of the given segment. Use the function with segment_ids = null, to get the number of segments in number_of_segments variable. (BR3D_GetMeasurementSegmentIDs(ID, NULL, &number_of_segments); Then preallocate an array of size equal or greater than number_of_segments. (segmentArray = new int[number_of_segments]). Use the function to fill the array with the segments ids. (BR3D_GetMeasurementSegmentIDs(ID, segmentArray, number_of_segments);
Parameters:
Abstract BR3GetMeasurementVisualizationMode Retrieves the visualization mode of the measurement
Parameters:
Abstract BR3BR3D_GetMeasurementXRayMode Get the xray mode of the measurement
Parameters:
Abstract BR3BR3D_GetMeasurementsBoundingBox Get the Bounding Box of the Measurements
Parameters:
Abstract BR3Abstract BR3Abstract BR3BR3D_GetNumTextureElements Retrieves the number of registered Texture Elements
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_GetOutlineElementColorVisualization Get the mode for rendering the outlines with the element color or black.
Parameters: -enable, render with the element color or not Returns true if the operation was performed
Abstract BR3Abstract BR3Abstract BR3Abstract BR3BR3D_GetPointAdjacentPointIDs Get the adjacent point ids from the given point id connected with segments through the point id.
Parameters:
Abstract BR3BR3D_GetPointCloudBoundingBox Retrieves the bounding box of the requested point cloud
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_GetPointCloudPointSize Get the point size of the point cloud
Parameters:
Returns the point size of the point cloud. Returns -1 if not successful
Abstract BR3BR3D_GetPointCloudVisibility Get the visibility of the point cloud
Parameters:
Returns the visibility of the point cloud.
Abstract BR3BR3D_GetPointPosition Get position of a point id
Parameters:
Abstract BR3BR3D_GetSSAOHideThreshold Retrieves the SSAO hide threshold
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_GetSceneBoundingBox Retrieves the bounding box of the entire scene
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_GetSegmentLength Retrieves the length of the requested segment on the measurement.
Parameters:
Abstract BR3BR3D_GetSegmentPointIDs Get the point ids of the given segment.
Parameters:
Abstract BR3BR3D_GetSelectedIDs Get the concatenated IDs of the selected elements. The returned buffer contains the IDS and is managed by the BIMRenderer Engine. Do not use it inside the application as an extra buffer. Only use it to get the selected ids and copy them into the application memory
Parameters:
Returns the number of selected IDS (which is also the size of the IDS buffer)
Abstract BR3BR3D_GetSelectedMeasurements3DIDs Get the selected measurements IDs. IDs are used as 32 bit values. Will be changed in the future in only int or unsigned int.
Parameters:
Abstract BR3BR3D_GetSelectedMeasurements3DPointIDs Get the selected measurements IDs and point ids. IDs are used as 32 bit values. Will be changed in the future in only int or unsigned int.
Parameters:
Abstract BR3BR3D_GetSelectiveOutlineRendering Retrieves the selective outline rendering state
Parameters:
Returns true if operation was successful.
Abstract BR3Abstract BR3Abstract BR3Abstract BR3Abstract BR3BR3D_GetSunLightingProperties Gets sun light properties
Parameters:
Returns true if operation was successful.
Abstract BR3GetTextureElementActive BR3D_Retrieves the rendering status of the Texture Element.
Parameters: texture_element_id, the Texture Element id active, a flag indicating whether the Texture Element will be rendered
Returns true if operation was successful.
Abstract BR3BR3D_GetTextureElementParameters Retrieves the dimension and position of a 3D Texture Element. Note that this forces a re-allocation of the buffers for the requested Texture Element.
Parameters: texture_element_id, the Texture Element id pos_top_left_(x,y,z), the top left 3D position of the Texture Element in world coordinates pos_bottom_left_(x,y,z), the top left 3D position of the Texture Element in world coordinates pos_bottom_left_(x,y,z), the top left 3D position of the Texture Element in world coordinates pos_top_right_(x,y,z), the top left 3D position of the Texture Element in world coordinates
Returns true if operation was successful.
Abstract BR3BR3D_GetTotalLength Retrieves the length of the measurement.
Parameters:
Abstract BR3Abstract BR3Abstract BR3BR3D_GetTransformGizmoRotationOffset Gets the initial rotation offset of the 3D Transform Gizmo
Parameters:
Abstract BR3Abstract BR3BR3D_GetTransformGizmoTransformState Returns the transfomation state of the 3D Transform Gizmo Parameters:
Abstract BR3BR3D_GetTransformGizmoVisibilityState Returns the visibility state of the 3D Transform Gizmo
Returns the visibility state of the gizmo
Abstract BR3Abstract BR3BR3D_HiddenLineGetColor Get geometry fill color for the Hidden Line rendering mode
Parameters:
Abstract BR3///////////////////////////////////////////////////////////////////////////////////////////////////// Hidden Line API BR3D_HiddenLineSetColor Set geometry fill color for the Hidden Line rendering mode
Parameters:
Abstract BR3BR3D_InsertMeasurementPoint Insert a point at a given position and breaks the given segment into two new segments connected with the new point.
Parameters:
Abstract BR3BR3D_IsActiveMinimapOffscreenRenderingEnabled Retrieves the offscreen rendering status for the minimap. This can be useful if the minimap should be rendered on an external overlay window (for resize, etc)
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_IsCameraCompassClicked Retrieves a flag indicating whether the given mouse click event has clicked the camera cube, along with the selected camera cube position
Parameters:
Abstract BR3Abstract BR3Abstract BR3BR3D_IsCameraCubeClicked Retrieves a flag indicating whether the given mouse click event has clicked the camera cube, along with the selected camera cube position
Parameters:
Abstract BR3Abstract BR3Abstract BR3Abstract BR3BR3D_IsMeasurementClosed Check if the measurement is closed.
Parameters:
Abstract BR3BR3D_IsPointControlPoint Get is_control_point of a point id
Parameters:
Abstract BR3Abstract BR3BR3D_LoadMeasurement3DData Load a measurement from a byte buffer
Parameters:
Abstract BR3Abstract BR3BR3D_MirrorMeasurement Mirror the measurement in 2D space
Parameters:
Abstract BR3BR3D_MirrorMeasurementPivotPoint Mirror the measurement in 2D space
Parameters:
Abstract BR3BR3D_MirrorMeasurements Mirror the measurements in 2D space
Parameters:
Abstract BR3BR3D_MirrorMeasurementsOnPlane Mirror the measurements in 2D space
Parameters:
Abstract BR3BR3D_MoveMeasurement Move the measurement at a given direction
Parameters:
Abstract BR3BR3D_MoveMeasurementPoint Move the point of the measurement at the given location.
Parameters:
Abstract BR3BR3D_MoveMeasurementPointOverPlaneWithSnapping Move the point of the measurement over plane at the given location.
Parameters:
Abstract BR3BR3D_MoveMeasurementPointWithSnapping Move the point of the measurement at the given location.
Parameters:
Abstract BR3BR3D_MoveMeasurementSegment Move the measurement segment at a given direction
Parameters:
Abstract BR3BR3D_MoveMeasurements Move the measurements at a given direction
Parameters:
Abstract BR3BR3D_PushBackMeasurementPoint Append a point on the measurement and create a line
Parameters:
Abstract BR3BR3D_QuickCorner Find the nearest intersection point in 2D raster/pixel space based on the current cursor position.
Parameters:
Abstract BR3BR3D_QuickEdgePoint Find the nearest intersection point in 2D raster/pixel space based on the current cursor position.
Parameters:
Abstract BR3BR3D_QuickMeasurement
BR3D_CreateMeasurement Creates a a new measurement using the rasterized image of the scene's outlines. This procedure, first checks if the provided screen coords point to empty space (no outlines or geometry) on the drawing. If the space is empty, it proceeds to find the empty fill-area around that point in order to construct a measuremnet for the empty space around that pixel. The threshold is used to control the conditions of the expansion. After finding the fill-area, a measurement is constructed using the provided measurement_id.
Parameters:
Abstract BR3Abstract BR3BR3D_RemoveDynamicElement Remove the dynamic element
Parameters:
Returns true if the operation was succesfull.
Abstract BR3BR3D_RemoveElement Remove the element from the model
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_RemoveMeasurement Removes the 3D measurement and deletes the data.
Parameters:
Abstract BR3BR3D_RemoveModel Remove a model of the given name and ID from the scenegraph
Parameters:
Returns true if operation was successful.
Abstract BR3Abstract BR3Abstract BR3BR3D_RemoveSensorChannel Delete the channel with id 'channel_id' that was previosuly created by a call to 'BR3D_AddSensorChannel'
Parameters:
Returns true if operation was successful.
Abstract BR3Abstract BR3Abstract BR3Abstract BR3Abstract BR3BR3D_Render2DDrawing Renders a registered 2D Drawing. The Drawing is rendered orthographically in outline mode using the specified bounding box parameters and camera position.
Parameters:
Returns true if operation was successful.
Abstract BR3Abstract BR3///////////////////////////////////////////////////////////////////////////////////////////////////// Camera3D API
BR3D_ResetCameras Reset the position and properties of the cameras based on the loaded model
Returns true if operation was successful.
Abstract BR3BR3D_RevertElementsColor Pass a list of IDs of the elements to be reverted to their original color
Requirements: Element IDs must already exists in the engine. Must only be called after AddModel, AddElement and SetElementVertices.
Parameters:
Returns true if operation was successful.
Abstract BR3Abstract BR3BR3D_RotateMeasurement Rotate the measurement in 2D space
Parameters:
Abstract BR3BR3D_RotateMeasurementPivotPoint Rotate the measurement in 2D space using a pivot point.
Parameters:
Abstract BR3BR3D_RotateMeasurements Rotate the measurements in 2D space using a pivot point.
Parameters:
Abstract BR3BR3D_RotateMeasurementsOnPlane Rotate the measurement in 2D space using a normal plane.
Parameters:
Abstract BR3BR3D_RubberbandSelectElements Do a rubberband selection on the elements.
Parameters:
Returns the number of selected IDS (which is also the size of the IDS buffer)
Abstract BR3BR3D_RubberbandSelectMeasurementPoints Use rubberband select on 3D measurements points. Only on visible intersected measurements.
Parameters:
Abstract BR3BR3D_RubberbandSelectMeasurements Use rubberband select on 3D measurements. Only on visible intersected measurements.
Parameters:
Abstract BR3BR3D_ScaleMeasurement Scale the measurement in 2D space
Parameters:
Abstract BR3BR3D_ScanSnapshotSessionCreate Create a scan snaphsot session. The user is expected to provide the region that is going to be used as the template for the scan process by specifying the region's extents in window coordinates(@see BR_GetRubberbandExtents). The values of that region will be used to extract the template image. Once a session is created, the renderer proceeds to capture all the snapshots in the scene that are going to be needed for the scan session. The renderer will block for this step.
In the current version of the library, only ONE scan snapshot session can be active at a time.
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_ScanSnapshotSessionDestroy A session should always be destroyed using this API call.
Parameters:
Abstract BR3BR3D_ScanSnapshotSessionGetTemplateImage Gets the width, height and RGBA data of the template image associated with the provided session.
It must be called after the session has been created.
Parameters:
Abstract BR3BR3D_ScanSnapshotSessionNextImage Return the snaphot of the next region
Parameters:
To get the world_position of a pixel: vec2 normalized_pixel_coord = pixel / resolution; // normalize the pixel coordinates vec4 pos(2.f * normalized_pixel_coord.x - 1.f, 2.f * (1.0f - normalized_pixel_coord.y) - 1.f, 0.f, 1.f); // convert from [0 1] to [-1 1]. Flip the Y axis if needed pos = world_matrix * pos; pos /= pos.w; pos contains the world coordinates of the pixel
Returns true if operation was successful.
Abstract BR3BR3D_ScanSnapshotSessionProgress Gets the progress of a previously started session
Parameters:
Abstract BR3Abstract BR3BR3D_SelectMeasurement Get the selected measurement.
Parameters:
Abstract BR3BR3D_Set2DDrawingBackground Sets the background color for the 2D drawings. This is a state operation.
Parameters:
Abstract BR3BR3D_Set2DDrawingDefaultDrawingType Sets the default color and line width for all drawing types that have not been set specifically (through BR3D_Set2DDrawingType).
Parameters:
Abstract BR3BR3D_Set2DDrawingFontColor Sets the font color for the 2D drawings. This is a state operation.
Parameters:
Abstract BR3BR3D_Set2DDrawingFontName Sets the font used for the 2D drawings. This is a state operation. The font must have been registered.
Parameters:
Abstract BR3BR3D_Set2DDrawingType Sets the color and line width for a particular IFC type
Parameters:
Abstract BR3BR3D_Set2DDrawingZoomOutPercentage Sets the percentage that the camera will be zoomed out for the 2D drawings, e.g., a zoom out value of 0.1 means that the camera will zoom out 10%. This is a state operation. This operation can be useful for printing text that does not overlap with the generated Drawing.
Parameters:
Abstract BR3BR3D_SetActiveMinimapCameraParameters Sets the color and size (in pixels) of the camera icon
Parameters:
Returns true if operation was successful.
Abstract BR3Abstract BR3BR3D_SetActiveMinimapOffscreenRendering Enables/disables offscreen rendering for the minimap. This can be useful if the minimap should be rendered on an external overlay window (for resize, etc)
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_SetActiveMinimapID Sets the opacity of the active minimap.
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_SetActiveMinimapWindowPosition Sets the viewport pixel positions of the active minimap. Any changes to these parameters force a new render of the associated 2D Drawings. This function MUST be called during the registration of a minimap, otherwise it will not be shown.
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_SetActiveMinimapWindowThicknessParameters Sets the stroke's color and thickness (in pixels) of the minimap window
Parameters:
Returns true if operation was successful.
Abstract BR3Abstract BR3Abstract BR3BR3D_SetAmbientColor BR3D_Sets the global ambient color (Default is 0.2, 0.2, 0.2)
Parameters:
Abstract BR3Abstract BR3Abstract BR3Abstract BR3BR3D_SetBackgroundColors Sets the background colors
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_SetBackgroundImage Sets the background image. Set it to 0 to disable the background image and show the color gradient
Parameters:
Abstract BR3BR3D_SetBillboardPresort Presort the billboards according to distance form camera for OIT (order independent transparency).
Parameters:
Abstract BR3Abstract BR3BR3D_SetCameraCubeDimensions Set the dimensions of the viewport displaying the cube.
Parameters:
Returns true if operation was successful.
Abstract BR3Abstract BR3Abstract BR3BR3D_SetCameraCubeVisible Sets the visibility of the camera cube.
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_SetCameraTransition Transition to the given camera cube position (Orbit camera only)
Returns true if operation was successful.
Abstract BR3BR3D_SetCameraTransitionArbitrary Transition to an arbitrary position/direction and up vector (Orbit camera only)
Returns true if operation was successful.
Abstract BR3Abstract BR3Abstract BR3BR3D_SetCurrentCameraAngularSpeed Set the camera's angular speed
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_SetCurrentCameraLinearSpeed Set the camera's linear speed
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_SetCurrentCameraPosition Sets the camera position to one of the predefined types
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_SetCurrentCameraPositionAngles Sets the camera position to the specified angles. 0,0 is equal to the BCP_LEFT looking at the center (direction -1,0,0). The azimuthal angle increases clockwise (BCP_LEFT, BCP_BACK, etc). The elevation angle is 0 at the XZ plane, -PI/2 at BCP_TOP* options and PI/2 at BCP_BOTTOM* options.
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_SetCurrentCameraState Set the current camera's state
Parameters:
Abstract BR3BR3D_SetCurrentCameraZoomBlendFactors Set the camera's zoom blend factors. For perspective cameras, this corresponds to the minimum/maximum speed factors used when the camera is very close/far to a target object. (Default is min: 1.0, max: 100000.0) For ortho cameras, this corresponds to the minimum/maximum scale factor that can be applied when zoomin in/out. The values relate directly to system units (e.g., mm) (Default is min: 1000, max: 1000000.0)
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_SetCurrentCameraZoomSpeed Set the camera's zoom speed
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_SetCuttingPlaneParameters Enable/Disable and sets the various parameters for the cutting plane
Parameters:
Abstract BR3BR3D_SetCuttingPlaneVisualizationParameters Sets the visualization parameters for the cutting planes
Parameters:
Abstract BR3BR3D_SetDynamicElementOutlines Set the geometric data of the dynamic element outlines
Parameters:
Returns true if the operation was succesfull.
Abstract BR3BR3D_SetElementOutlines Set the outlines of the element
Requirements: The model and element must already exists in the engine. Must only be called after AddModel, AddElement and SetElementVertices.
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_SetElementVertices Set the geometric data and inverse model matrix to an element to a model
Requirements: The model and element must already exists in the engine. Must only be called after AddModel and AddElement;
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_SetElementsColor Pass a list of IDs of the elements to be colorized alogn with the color in RGB format RGB is in [0 1] range
Requirements: Element IDs must already exists in the engine. Must only be called after AddModel, AddElement and SetElementVertices.
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_SetElementsHighlight Pass a list of IDs of the elements to be highlighted
Requirements: Element IDs must already exists in the engine. Must only be called after AddModel, AddElement and SetElementVertices.
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_SetElementsHybridState Set the state of a list of elements for the hybrid rendering mode
Requirements: Element IDs must already exists in the engine. Must only be called after AddModel, AddElement and SetElementVertices.
Parameters:
Returns true if operation was successful.
Abstract BR3Abstract BR3BR3D_SetElementsVisibility Set the visibility of a list of elements
Requirements: Element IDs must already exists in the engine. Must only be called after AddModel, AddElement and SetElementVertices.
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_SetEnhancedSilhouetteSSAOHideThreshold Sets the threshold to hide Enhanced Silhouette. When the normalized, by the scene radius, camera distance from the scene center is greater than a threshold, then Enhanced Silhouette is disabled.
Parameters:
Returns true if operation was successful.
Abstract BR3Abstract BR3BR3D_SetGlobalPointCloudPointSize Set the point size of the point cloud
Parameters:
Returns true if the operation was succesfull.
Abstract BR3BR3D_SetGlobalTransparencyValue Set the global transparency value for the transparent visualization option
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_SetGridExpansionFactor Set the expansion factor of the grid, e.g., how many units (meters, yards) the grid will be extruded after the bounding box (Default is 6)
Parameters:
Abstract BR3BR3D_SetGridLevelAttributes Sets various attributes for a particular resolution level of the grid
Parameters:
Abstract BR3BR3D_SetGridLevelColor Sets the color for a particular resolution level of the grid. Default values are:
Parameters:
Abstract BR3BR3D_SetGridUOM Set whether the grid is calculated in metric or imperial units of measurement Metric: Meter, Imperial: Yards
Parameters:
Returns true if operation was successful.
Abstract BR3Abstract BR3BR3D_SetGroundSurfaceShadowRecomputeState Set the recomputation state of the ground surface shadow technique.
Parameters: -enable, state Returns true if the operation was performed
Abstract BR3Abstract BR3Abstract BR3Abstract BR3Abstract BR3BR3D_SetMeasurementDrawOrder Set the draw order of the current measurement
Parameters:
Abstract BR3SetMeasurementFillColor Set the fill color of the measurement
Parameters:
Abstract BR3BR3D_SetMeasurementFillPattern Set the fill pattern of the measurement
Parameters:
Abstract BR3BR3D_SetMeasurementLineColor Set the line color of the measurement
Parameters:
Abstract BR3BR3D_SetMeasurementLineWidth Set the line width of the measurement
Parameters:
Abstract BR3SetMeasurementPointColor Set the point color of the measurement
Parameters:
Abstract BR3BR3D_SetMeasurementPointSize Set the point size of the measurement
Parameters:
Abstract BR3BR3D_SetMeasurementPreviewMode Set the preview mode of the measurement
Parameters:
Abstract BR3SetMeasurementVisualizationMode Set the visualization mode of the measurement
Parameters:
Abstract BR3BR3D_SetMeasurementXRayMode Set the xray mode of the measurement
Parameters:
Abstract BR3BR3D_SetElementsVisibility Set the visibility of a model
Requirements: Model should already exists in the engine. Must only be called after AddModel, AddElement and SetElementVertices.
Parameters:
Returns true if operation was successful.
Abstract BR3Abstract BR3BR3D_SetOutlineElementColorVisualization Set the mode for rendering the outlines with the element color or black.
Parameters: -enable, render with the element color or not Returns true if the operation was performed
Abstract BR3Abstract BR3Abstract BR3BR3D_SetPaperColor Set the paper color.
Parameters:
Abstract BR3BR3D_SetPaperMode Set the paper mode. It enables or disables the paper mode using a specified view and bbox.
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_SetPaperModeCustom Set the paper mode. It enables or disables the paper mode using a custom view and bbox.
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_SetPointCloudPointSize Set the point size of the point cloud
Parameters:
Returns true if the operation was succesfull.
Abstract BR3BR3D_SetPointCloudVisibility Set the visibility of the point cloud
Parameters:
Abstract BR3BR3D_SetSSAOHideThreshold Sets the threshold to hide SSAO. When the normalized, by the scene radius, camera distance from the scene center is greater than a threshold, then SSAO is disabled.
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_SetScreenSpaceSymbol Set the status of the screen space symbol.
Parameters: -x,y,z, symbol position -rgb, symbol color -symbol_type, symbol type. 0 - Rectangle, 1 - Triangle, 2 - Circle, 3 - 90 Degrees, 4 - Hourglass, 5 - Cross Circle, 6 - Cross, 7 - Edge -enable, enable the symbol rendering Returns true if the operation was performed
Abstract BR3BR3D_SetSelectiveOutlineRendering Sets the selective outline rendering state
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_SetSelectiveRenderingMode Set the selective rendering mode. With selective rendering, only a portion of the elements of the scene will be visible. 0-level : all scene elements are visible (slowest) 3-level : only a small part of the scene elements are visible (fastest)
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_SetSensorChannelData Set sensor channel data for channel 'channel_id' with a value range [low, high]
For BSV_SUM_NORMALIZATION the 'factor' is a scaling factor For BSV_LINEAR_FALLOFF the 'factor' is the exponent of the inverse power fallof For BSV_GAUSSIAN_NORMALIZATION the 'factor' is the standard deviation of each gaussian
Parameters:
Returns id of the channel if operation was successful. -1 if operation failed.
Abstract BR3Abstract BR3///////////////////////////////////////////////////////////////////////////////////////////////////// Settings3D API
BR3D_SetShadingOption Set the elements shading options
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_SetSunLightingLensFlare Sets sun lighting lens flare effect
Parameters:
Abstract BR3BR3D_SetSunLightingProperties Sets sun light properties. (Angles are in radians)
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_SetSunShadowingProperties Sets sun shadow properties. (Angles are in radians)
Parameters:
Returns true if operation was successful.
Abstract BR3BR3D_SetTextureElementActive Enables/disables the rendering of the Texture Element.
Parameters: texture_element_id, the Texture Element id active, a flag indicating whether the Texture Element will be rendered (Default is false)
Returns true if operation was successful.
Abstract BR3Abstract BR3Abstract BR3BR3D_SetTransformGizmoRotationOffset Sets the initial rotation offset of the 3D Transform Gizmo
Parameters:
Abstract BR3BR3D_SetTransformGizmoRotationOffsetVector Sets the initial rotation offset of the 3D Transform Gizmo using a vector
Parameters:
Abstract BR3Abstract BR3BR3D_SetTransformGizmoVisibilityState Sets the visibility state of the 3D Transform Gizmo
Parameters:
Abstract BR3Abstract BR3BR3D_StartComputingNormals Start the normal computation. It should be the first to be called.
Parameters:
Abstract BR3BR3D_StartPanning Sets the camera starting panning position.
Parameters:
Returns true if operation was successful.
Abstract BR3Abstract BR3Abstract BR3BR3D_TransformGizmoMouseClick Mouse click action for the 3D Transform Gizmo
Parameters:
Returns true if gizmo was clicked.
Abstract BR3Abstract BR3BR3D_UpdateTexture Update a texture layer with new image data
Parameters:
Returns the id of the texture or -1 if the operation was not successful.
Abstract BR3BR3D_VisualizeRubberband Visualize the rubberband
Parameters:
Returns true if operation was successful.
Abstract BR3Abstract BR3BR3D_ZoomToElements Zooms to a particular set of elements
Abstract BRFont_BRFont_AddTextToPos Add the current text on a specified position on the window. The positions are set relatively to the window. Origin (0, 0) is the top left corner of the window.
Parameters:
Abstract BRMD_Abstract BRMD_Abstract BRMD_Abstract BRMD_Abstract BRMD_Abstract BRMD_Abstract BRU_Abstract BRU_Abstract BRXRU_Abstract BRXRU_Abstract BRXRU_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BRXR_Abstract BR_///////////////////////////////////////////////////////////////////////////////////////////////////// Engine API
BR_Create Allocates memory for all the internal engine components. It must be the first function called.
Returns true if operation was successful.
Abstract BR_Abstract BR_Abstract BR_Abstract BR_Abstract BR_BR_GetBenchmarkingStatus Retrieves the current benchmarking status
Parameters:
Returns true if operation was successful.
Abstract BR_Abstract BR_BR_GetCompressedImageBuffer Get the Final Compressed RGB image buffer as an array of unsigned bytes. Buffer MUST be pre-allocated to: screen_width * screen_height / 2 . The callee is responsible for managing the memory of the image buffer (memory allocation and deallocation).
Parameters:
Returns true if operation was successful.
Abstract BR_BR_GetFPSstatus Retrieves the frames per second current visibility status
Parameters:
Returns true if operation was successful.
Abstract BR_Abstract BR_BR_GetHighlightColors Retrieves the coloring of the highlight
Parameters:
Returns true if operation was successful.
Abstract BR_Abstract BR_BR_GetImageBuffer Get the Final RGB image buffer as an array of unsigned bytes. Buffer MUST be pre-allocated to: screen_width * screen_height * 3. The callee is responsible for managing the memory of the image buffer (memory allocation and deallocation).
Parameters:
Returns true if operation was successful.
Abstract BR_Abstract BR_BR_GetMemorySizeEstimationMB Estimates the memory size in MB allocated by the internal engine's buffers. Note that this is can only serve as an estimation and does not reflect the "actual" memory size reserved by the GPU at any point.
Parameters
Returns true if operation was successful.
Abstract BR_BR_GetOffscreenRendering Retrieves whether the results are written to the system's framebuffer
Parameters
Returns true if operation was successful.
Abstract BR_Abstract BR_BR_GetRubberbandExtents Retrieves the extents of the last rubberband selection.
Parameters:
Abstract BR_Abstract BR_BR_GetRubberbandMode Retrieves the color of the rubberband for the associated rubberband mode.
Parameters:
Returns true if operation was successful.
Abstract BR_Abstract BR_Abstract BR_Abstract BR_Abstract BR_Abstract BR_Abstract BR_BR_KeyButtonEvent Key stroke event
Parameters:
Returns true if operation was successful. All keys are in string format (e.g. "f", "w"), special buttons in string format (e.g. alt, ctrl, enter, backspace, F1, F12, up, down)
Abstract BR_BR_LoggingAddText logs an external message of a particular type (Info, Warning, Error)
Parameters:
Abstract BR_BR_LoggingGetConsoleFilter retrieves the type of events that the log console displays
Parameters:
Abstract BR_BR_LoggingGetFileFilter retrieves the type of events that the log file stores
Parameters:
Abstract BR_Abstract BR_BR_LoggingSetConsoleFilter sets the type of events that the console will show by default, all messages are disabled
Parameters:
Abstract BR_BR_LoggingSetFileFilter sets the type of events that the log file will store by default, all messages are enabled
Parameters:
Abstract BR_///////////////////////////////////////////////////////////////////////////////////////////////////// Logging API
BR_LoggingSetFilename sets the filename that will be used to log any messages
Parameters:
Abstract BR_BR_LoggingSetStatus
Sets whether the renderer events will be stored in the log file and displayed in the console
log file is stored under Logs/
Parameters:
Abstract BR_BR_MouseButtonEvent Mouse Button Event
Parameters:
Returns true if operation was successful.
Abstract BR_Abstract BR_Abstract BR_BR_Move Move in 3D Space. The API tries to abstract the camera's move but each camera type behaves differently based on the desired behavior
Parameters:
Returns true if operation was successful.
Abstract BR_Abstract BR_BR_Resize Resize the buffers to the requested width and height
Parameters:
Returns true if operation was successful.
Abstract BR_BR_RotateStart Rotate in 3D Space. This is mainly required to set the world space coordinates of the anchor point. The API tries to abstract the camera's rotation but each camera type behaves differently based on the desired behavior
Parameters:
Abstract BR_BR_RotateStart Rotate in 3D Space. This is mainly required to set the world space coordinates of the anchor point. The API tries to abstract the camera's rotation but each camera type behaves differently based on the desired behavior
Parameters:
Abstract BR_BR_RotateStop Stop rotation in 3D Space. This is mainly required reset camera state. The API tries to abstract the camera's rotation but each camera type behaves differently based on the desired behavior
Parameters:
Returns true if operation was successful.
Abstract BR_BR_SetBackgroundColor Sets the background color (Default is 0.5, 0.5, 0.5)
Parameters:
Returns true if operation was successful.
Abstract BR_BR_SetBenchmarkingStatus Enables or disables internal benchmarking of the renderer
Parameters:
Returns true if operation was successful.
Abstract BR_BR_SetCompressedImageFormat Set the Compressed RGB image buffer format.
Parameters:
Returns true if operation was successful.
Abstract BR_BR_SetDataPath Sets the location where the renderer's external data are loaded from (shaders, textures, fonts, etc.)
Parameters
Returns true if operation was successful.
Abstract BR_BR_SetHighlightAlpha Set the alpha of the highlight
Parameters:
Returns true if operation was successful.
Abstract BR_BR_SetHighlightColors Set the coloring of the highlight
Parameters:
Returns true if operation was successful.
Abstract BR_Abstract BR_Abstract BR_BR_SetOffscreenRendering Sets whether the results are written to the system's framebuffer
Parameters
Returns true if operation was successful.
Abstract BR_Abstract BR_BR_SetRubberbandMode Set the selection mode of the rubberband. Default is Front (Visible).
Parameters:
Returns true if operation was successful.
Abstract BR_BR_SetRubberbandModeColor Set the color of the rubberband for the associated rubberband modes. Default is red (1,0,0,0.1) for front modes (BRM_VISIBLE) and green (0,1,0,0.1) for visible + hidden modes (BRM_ALL).
Parameters:
Returns true if operation was successful.
Abstract BR_BR_ShowFPS Enables/Disables the FPS text
Parameters:
Returns true if operation was successful.
Abstract BR_Abstract BR_Abstract _BR3Abstract _BRXR_Abstract _BR_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.
Asynchronously initializes the renderer.
Optional initializationFunction: ((renderer: LocalBIMRenderer) => 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.
Abstract isChecks 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.
BIM renderer that performs the render process in-browser