AbstractGets the list of companion renderers.
Gets the base path for assets.
The base path for assets.
Gets the base path for the BimCT additional functions server.
The base path for the BimCT server.
Checks if the touch widget is available.
Whether the touch widget is available.
Gets the touch widget.
The touch widget.
Checks if the left toolbar is available.
Whether the left toolbar is available.
Checks if the home toolbar is available.
Whether the home toolbar is available.
Checks if the toolbar is available.
Whether the toolbar is available.
Checks if the context menu is available.
Whether the context menu is available.
Checks if the split elements UI is available.
Whether the split elements UI is available.
Checks if the settings window is available.
Whether the settings window is available.
Checks if the time changer window is available.
Whether the time changer window is available.
Checks if the comparison viewer is available.
Gets the comparison viewer.
Checks if the comparison viewer is available.
Gets the instance of the minimap viewer.
The instance of the minimap viewer.
Checks if the share window is available.
Whether the share window is available.
Checks if the WebXR window is available.
Whether the WebXR window is available.
Gets the WebXR window.
The WebXR window.
Checks if the snapshot window is available.
Whether the snapshot window is available.
Gets if export to map window is available.
Whether the export to map window is available.
Gets the export to map window.
The export to map window.
Checks if the views manager is available.
Whether the views manager is available.
Checks if the message window is available.
Whether the message window is available.
Gets the animations.
The animations.
Gets whether picking 2D elements is allowed.
Whether picking 2D elements is allowed.
Sets whether picking 2D elements is allowed.
Whether to allow picking 2D elements.
Gets the div element.
The div element.
Keeps tracking of loaded models and elements. See [[SceneState]].
The scene state.
Gets the display format.
Gets the terrain manager.
The terrain manager.
Returns the alignment cofiguration handler of the BimCT scene models.
AbstractpickGets the pick lines state.
The pick lines state.
Gets the GUI actions locked event.
The GUI actions locked event.
Gets the solar position changed event.
The the solar position changed event.
Gets the selection change event.
The selection change event.
Gets the map position change event.
The map position change event.
Gets the pin dehighlighted event.
The pin dehighlighted event.
Gets the mouse right clicked event.
The mouse right clicked event.
Gets the model loaded event, called after a sceneView is also loaded
The model loaded event.
Gets the model added event, called directly after model is loaded into GPU. (no scenes after that)
the model added event
Gets the pick lines updated event.
The pick lines updated event.
Gets the measurements selected event.
The measurements selected event.
Gets the measurements updated event.
The measurements updated event.
Gets the measurements deleted event.
The measurements deleted event.
Gets the measurements point push back event.
The measurements point push back event.
Gets whether the renderer is rotating or panning.
Whether the renderer is rotating or panning.
Sets whether the renderer is rotating or panning.
Whether the renderer is rotating or panning.
Checks if the selection label is enabled.
Whether the selection label is enabled.
Gets the cutting elements manager.
The cutting elements manager.
Sets the shading mode of the renderer.
The shading mode to set.
Gets whether snapping is enabled.
Whether snapping is enabled.
Gets the settings changed event.
The settings changed event.
Gets the camera change event.
The camera state change event.
Gets the resized event.
The resized event.
Gets the language changed event.
The language changed event.
Gets the resized event.
The resized event.
Registers a companion renderer.
The renderer to register.
Unregisters a companion renderer.
The renderer to unregister.
Unregisters all companion renderers.
Changes the language of the renderer.
The language to change to.
Converts screen coordinates to world position.
The x-coordinate on the screen.
The y-coordinate on the screen.
A promise that resolves to the world position.
Converts screen coordinates to world position without taking depth into account.
The x-coordinate on the screen.
The y-coordinate on the screen.
A promise that resolves to the world position.
Converts 3D world position to real earth coordinates, using the current scene wgs84 center coordinate as a reference. If you have another reference other than the scene center, you can use [[cartesianToWGS84]] directly.
The world coordinates.
OptionalsceneBoundingBox: BoundingBox3DOptional bounding box of the scene to use as reference. If not provided, the scene bounding box will be used.
Optionalalignment: WGS84AlignmentA promise that resolves to the earth coordinates.
Converts earth coordinates to 3D world space position, using the current scene wgs84 center coordinate as a reference. If you have another reference other than the scene center, you can use [[wgs84ToCartesian]] directly.
The earth coordinates.
OptionalsceneBoundingBox: BoundingBox3DOptional bounding box of the scene to use as reference. If not provided, the scene bounding box will be used.
Optionalalignment: WGS84AlignmentOptional alignment information for the scene. If not provided, the scene alignment will be used better to provide it if you have it already calculated for performance reasons.
A promise that resolves to the world space position.
Locks or unlocks GUI actions.
Whether to lock or unlock GUI actions.
Checks if GUI actions are locked.
Whether GUI actions are locked.
Checks if a key is pressed.
The key code to check.
Whether the key is pressed.
Checks if roll over is enabled.
Whether roll over is enabled.
Reverts the previous roll over.
Whether to reset the roll over.
Performs roll over at the specified coordinates.
The x-coordinate.
The y-coordinate.
Marks that a mouse action event has been made.
Marks the rendering pipeline for a redraw. Call this if ECO RENDERING IS ON and not on Game Mode to update the render loop before your actions
Whether to reload the state.
Gets the skymap IDs.
A map of skymap IDs.
Removes the skymap.
Loads a skymap by its ID.
The ID of the skymap.
Whether to show the loading screen.
A promise that resolves to a boolean indicating success or failure.
Loads a skymap from URLs.
The URL of the skymap.
The URL of the clouds.
Sets SSAO (Screen Space Ambient Occlusion) enabled or disabled.
Whether to enable or disable SSAO.
Sets ground shadow enabled or disabled.
Whether to enable or disable ground shadow.
Sets the scene date and time.
The date and time to set.
OptionalshowDateTimePopup: booleanWhether to show the date and time popup.
Refreshes the position of the clouds.
Sets sun light enabled or disabled.
Whether to enable or disable sun light.
Sets sun flare enabled or disabled.
Whether to enable or disable sun flare.
Sets the pixel size of point clouds.
The pixel size.
Sets the grid enabled or disabled.
Whether to enable or disable the grid.
Sets the measurement system.
The measurement system to set.
AbstractisChecks if the VR session is started.
Whether the VR session is started.
Dispatches the context menu event.
The pointer event.
Dispatches the state changed event.
Clears the selection.
Checks if the properties window is showing.
Whether the properties window is showing.
Hides the properties window.
Checks if the design tree window is showing.
Whether the design tree window is showing.
Hides the design tree window.
Checks if the views window is showing.
Whether the views window is showing.
Shows the views window.
Hides the views window.
Checks if the filter elements window is showing.
Whether the filter elements window is showing.
Hides the filter elements window.
Checks if the settings window is showing.
Whether the settings window is showing.
Checks if the share window is showing.
Whether the share window is showing.
Checks if the WebXR window is showing.
Whether the WebXR window is showing.
Checks if the snapshot window is showing.
Whether the snapshot window is showing.
Checks if the map export window is showing.
Whether the map export window is showing.
Checks if any views windows are showing.
Whether any views windows are showing.
Checks if the message window is showing.
Whether the message window is showing.
Hides the settings window.
Hides the share window.
Hides the WebXR window.
Hides the snapshot window.
Hides the map export window.
Hides all views windows.
Hides the message window.
Shows a message box.
The message to display.
The title of the message box.
The options for the message box.
The icon for the message box.
A promise that resolves to the result of the message box.
Shows an input text message box.
The message to display.
The title of the message box.
The default value of the input.
The icon for the message box.
A promise that resolves to the input text.
Shows an input number message box.
The message to display.
The title of the message box.
The default value of the input.
The icon for the message box.
A promise that resolves to the input number.
Shows an input number message box.
The message to display.
The title of the message box.
The default value of the input in millimeters
The icon for the message box.
A promise that resolves to the input number in millimeters
Hides all windows.
Checks if the context menu is showing.
Whether the context menu is showing.
Hides the menus.
Whether the context menu was hidden.
Hides the context menu.
Whether the context menu was hidden.
When set to true, the pick mode and setSelectionType change will clear measurements. By default, this is true.
Whether the pick mode change clears measurements.
Sets the pick mode.
The pick mode to set.
Whether to dispatch the state changed event.
Checks if picking elements is enabled.
Whether picking elements is enabled.
Checks if picking faces is enabled.
Whether picking faces is enabled.
Checks if picking faces or elements is enabled.
Whether picking faces or elements is enabled.
Checks if picking measurements is enabled.
Whether picking measurements is enabled.
Checks if picking lines is enabled.
Whether picking lines is enabled.
Checks if picking isometric is enabled.
Whether picking isometric is enabled.
Recomputes the snapping points.
A promise that resolves to a boolean indicating success or failure.
Recomputes the camera movement settings.
Starts occlusion culling.
Stops occlusion culling.
Gets the bounding box of the scene.
A promise that resolves to the bounding box of the scene.
Gets the geolocated center of the scene at ground level.
OptionalsceneBoundingBox: BoundingBox3Dthe scene bounding box to use, if not provided it will be fetched
A promise that resolves to the WGS84 coordinates of the center point at ground level.
Gets the bounding box of the scene.
whether to use altitude from minimap viewer
OptionalsceneBoundingBox: BoundingBox3Dthe scene bounding box to use, if not provided it will be fetched
A promise that resolves to the bounding box of the scene.
Returns the visible region of the scene in 2D Visualuzer mode only
A promise that resolves to the bounding box of the visible region in 3D scene coordinates.
Gets the bounding box of visible elements.
A promise that resolves to the bounding box of visible elements.
Gets the bounding box of a model.
The ID of the model.
Whether to force recalculation of the bounding box.
A promise that resolves to the bounding box of the model.
Calculates the geolocated bounding box in WGS84 coordinates from the Ground Level center.
The 3D bounding box to be converted.
OptionalsceneBoundingBox: BoundingBox3DOptional scene bounding box to use for center calculation if not provided it will be fetched.
OptionaluseAltitude: booleanA new WGS84BoundingBox object representing the geolocated bounding box.
Sets the visibility of a bounding box.
The bounding box to set visibility for.
Whether to set the bounding box visible or not.
The color of the bounding box.
Checks if the bounding box is visible.
Whether the bounding box is visible.
Redraws the bounding box if it is visible.
Gets the bounding box of elements.
The internal IDs of the elements.
A promise that resolves to the bounding box of the elements.
Gets the bounding box of faces.
The internal IDs of the faces.
A promise that resolves to the bounding box of the faces.
Rotates the 2D camera to the specified position.
The position to rotate the camera to.
A promise that resolves to a boolean indicating success or failure.
Sets the 2D visualizer on or off.
Whether to set the 2D visualizer on or off.
Whether to animate the transition.
Checks if the element is a 3D element.
The renderer ID of the element.
A promise that resolves to a boolean indicating if the element is a 3D element.
Picks element IDs within the specified rectangle.
The x-coordinate of the top-left corner of the rectangle.
The y-coordinate of the top-left corner of the rectangle.
The width of the rectangle.
The height of the rectangle.
A promise that resolves to an array of picked element IDs.
Picks element IDs within the specified rubberband rectangle.
The x-coordinate of the start point.
The y-coordinate of the start point.
The x-coordinate of the end point.
The y-coordinate of the end point.
A promise that resolves to an array of picked element IDs.
Picks measurement IDs within the specified rubberband rectangle.
The x-coordinate of the start point.
The y-coordinate of the start point.
The x-coordinate of the end point.
The y-coordinate of the end point.
A promise that resolves to an array of picked measurement IDs.
Picks face IDs within the specified rubberband rectangle.
The x-coordinate of the start point.
The y-coordinate of the start point.
The x-coordinate of the end point.
The y-coordinate of the end point.
A promise that resolves to an array of picked face IDs.
Picks the normal vector at the specified coordinates.
The x-coordinate.
The y-coordinate.
A promise that resolves to the normal vector.
Picks the face ID at the specified coordinates.
The x-coordinate.
The y-coordinate.
Whether to prefer 2D paper face.
A promise that resolves to the picked face ID.
Gets the elements selection mode.
A promise that resolves to the elements selection mode.
Picks face IDs within the specified rectangle.
The x-coordinate of the top-left corner of the rectangle.
The y-coordinate of the top-left corner of the rectangle.
The width of the rectangle.
The height of the rectangle.
Whether to prefer 2D paper face.
A promise that resolves to an array of picked face IDs.
Sets whether the selection label is enabled.
Whether to enable the selection label.
Updates the selection label.
Updates the selection from the highlight.
Updates the selection by internal IDs.
The internal IDs to update the selection with.
Whether to highlight the selection.
Manually update the selection.
The local element nodes to update the selection with.
Whether to use internal IDs for selection.
Updates the selection by element IDs.
The element IDs to update the selection with.
Updates the selection by global IDs.
The global IDs to update the selection with.
Shows all elements.
Whether to show 3D elements.
Whether to show 2D elements.
Gets the highlighted internal IDs. May include Split Internal IDs that are not directly mappable to elements.
A promise that resolves to an array of highlighted internal IDs.
Resets the hybrid mode.
Whether to clear the highlights.
Sets elements to hybrid opaque state.
The internal IDs of the elements.
The hybrid opaque state.
Whether to clear the highlights.
Colorizes elements by internal IDs.
The internal IDs of the elements.
The red component of the color.
The green component of the color.
The blue component of the color.
Whether to dehighlight after colorizing.
Decolorizes elements by internal IDs.
The internal IDs of the elements.
Colorizes the selected elements.
The red component of the color.
The green component of the color.
The blue component of the color.
Decolorizes the selected elements.
Whether to ensure the decolorized elements are shown (sets shading mode to solid colors if needed).
Decolorizes all elements.
Whether to ensure the decolorized elements are shown (sets shading mode to solid colors if needed).
Gets the visible internal IDs.
Whether to include static elements.
Whether to include dynamic elements.
A promise that resolves to an array of visible internal IDs.
Selects and highlights all elements on the scene.
Selects and highlights the elements by element ID.
The element IDs as defined on the metadata file.
Selects and highlights the elements by engine internal IDs.
The internal IDs (different on every scene loading).
Selects and highlights the elements using an ElementInfo structure.
The elements to select and highlight.
Selects and highlights visible elements on the scene according to static or dynamic type.
Whether to include static elements.
Whether to include dynamic elements.
Whether to return only hybrid opaque elements.
A promise that resolves to a boolean indicating success or failure.
Selects and highlights the elements on the scene according to model name.
The name of the model.
A promise that resolves to a boolean indicating success or failure.
Selects and highlights the elements on the scene according to the class name. Names for all file types are similar to Ifc Standard without the Ifc prefix.
The class name.
A promise that resolves to a boolean indicating success or failure.
Selects and highlights the elements on the scene according to the layer name defined in the file.
The layer name.
A promise that resolves to a boolean indicating success or failure.
Selects and highlights the elements on the scene according to the material name defined in the file.
The material name.
A promise that resolves to a boolean indicating success or failure.
Selects and highlights the elements on the scene according to the type defined in the file. Note: For Revit, this is usually the family name.
The type name.
A promise that resolves to a boolean indicating success or failure.
Selects and highlights the elements on the scene according to the storey defined in the file.
The storey name.
A promise that resolves to a boolean indicating success or failure.
Selects and highlights the elements on the scene according to the membership defined in the file.
The membership name or global ID.
A promise that resolves to a boolean indicating success or failure.
Selects and highlights the elements on the scene according to filters.
The filters to apply.
A promise that resolves to a boolean indicating success or failure.
Selects and highlights the elements sharing the same property.
The property to filter by.
The group of the property.
A promise that resolves to a boolean indicating success or failure.
Hides the selected elements.
Hides elements by global ID.
The global IDs of the elements to hide.
Hides elements by internal ID.
The internal IDs of the elements to hide.
Whether to recompute snapping points.
Hides elements by element ID.
The element IDs of the elements to hide.
Whether to recompute snapping points.
Shows elements by global ID.
The global IDs of the elements to show.
Shows elements by element ID.
The element IDs of the elements to show.
Isolates the selected elements.
Isolates the specified elements by their internal IDs.
The internal IDs of the elements to isolate.
Sets the visibility of elements by internal IDs.
The internal IDs of the elements.
Whether to set the elements visible or not.
Checks if an element is visible.
The internal ID of the element.
A promise that resolves to a boolean indicating if the element is visible.
Sets the key for the renderer.
The key to set.
Zooms to elements by global IDs.
The global IDs of the elements.
Zooms to elements by element IDs.
The element IDs of the elements.
Zooms to the selected elements.
A promise that resolves to a boolean indicating success or failure.
Zooms to the selection.
A promise that resolves to a boolean indicating success or failure.
Looks at the specified bounding box.
The bounding box to look at.
Whether to animate the transition.
A promise that resolves to a boolean indicating success or failure.
Resets the camera to the home position.
Checks if the game mode is on.
Whether the game mode is on.
Sets the camera type.
The camera type to set.
Whether panning is preferred.
Gets the selection type.
The selection type.
Resets the 3D camera to the specified position.
The position to reset the camera to.
Whether to animate the transition.
Starts length measurement.
Whether the measurement is negative.
Starts isometric measurement.
Whether the measurement is negative.
Starts area measurement.
Whether the measurement is negative.
Starts count measurement.
OptionalautoCount: booleanStarts auto count measurement.
Get the Measurement Options that are used while creating measurements.
measurementOptions
Clears the Measurement Options that are used while creating measurements. The default options will be used
Clears the measurements.
Clears the pins.
Focuses the renderer.
Refreshes the cutting plane label.
The index of the cutting plane.
Clears the cutting planes.
Activates a cutting plane.
The index of the cutting plane.
Deactivates a cutting plane.
The index of the cutting plane.
Checks if a cutting plane is enabled.
Whether a cutting plane is enabled.
Checks if a cutting plane is active.
The index of the cutting plane.
Whether the cutting plane is active.
Gets the image data.
Whether to flip the image upside down.
A promise that resolves to the image data.
Gets the gzipped image data.
A promise that resolves to the gzipped image data.
AbstractinitInitializes the renderer.
OptionalinitializationFunction: (renderer: BaseRenderer) => voidThe initialization function.
Checks if the renderer is initialized.
Whether the renderer is initialized.
Destroys the renderer.
Unloads all models in the scene.
Unloads a model by its ID.
The ID of the model.
Whether to dispatch the model removed event.
Refreshes the camera cube.
Sets the camera cube visible or not.
Whether to set the camera cube visible or not.
Checks if the camera cube is visible.
Whether the camera cube is visible.
Sets the camera compass visible or not.
Whether to set the camera compass visible or not.
Checks if the camera compass is visible.
Whether the camera compass is visible.
Zooms to elements by internal IDs.
The internal IDs of the elements.
Whether to animate the transition.
A promise that resolves to a boolean indicating success or failure.
Zooms to the extents of the scene, 2D mode only
A promise that resolves to a boolean indicating success or failure.
Checks if elements are showing.
The internal IDs of the elements.
A promise that resolves to a boolean indicating if the elements are showing.
Takes a snapshot image and maintains aspect ratio.
Optionalwidth: numberThe requested width.
Optionalheight: numberThe requested height.
A promise that resolves to a URI that contains the image to download or use.
Takes a snapshot image and gets the URL to access it
Optionalwidth: numberThe requested width.
Optionalheight: numberThe requested height.
A promise that resolves to a URI that contains the image to download or use.
Retrieves the current state of dynamic elements.
A promise that resolves to a DynamicElementsState object.
Sets the state of dynamic elements.
The state to set.
Gets the state of clipping regions.
A promise that resolves to a ClippingRegionsState object.
Sets the state of clipping regions.
The state to set.
Gets the state of the camera. The state number array includes:
A promise that resolves to a CameraState object.
Sets the state of the camera. The state number array includes:
The state to set.
Whether to animate the transition (will not animate if minimap is showing)
Whether to dispatch the state changed event default is true
AbstractcheckChecks if Virtual Reality is supported.
A promise that resolves to a boolean indicating if VR is supported.
Gets the visibility state.
A promise that resolves to a VisibilityState object.
Sets the visibility state.
The state to set.
Whether to recompute snapping points.
Gets the colorization state.
OptionalfilterIds: Set<bigint>A promise that resolves to a ColorizationState object.
Sets the markup state.
The state to set.
Whether to enable edit mode.
Gets the sensors state.
A promise that resolves to a SensorsState object.
Sets the sensors state.
The state to set.
Sets the colorization state.
The state to set.
Gets the viewer settings state.
Whether to include geo position and time.
A promise that resolves to a ViewerSettingsState object.
Sets the viewer settings state.
The state to set.
Gets the highlighted state.
A promise that resolves to a HighlightedState object.
Sets the highlighted state.
The state to set.
Gets the measurements state.
A promise that resolves to a MeasurementState object.
Sets the measurements state.
The state to set.
Gets the cutting planes state.
A promise that resolves to a CuttingPlanesState object.
Gets the splitted elements state.
Sets the splitted elements state.
The state to set.
Sets the cutting planes state.
The state to set.
Gets the scene view.
Whether to include the settings state.
OptionalincludePinsState: booleanWhether to include the pins state.
OptionalincudeSensorsState: booleanWhether to include the sensors state.
OptionalincludeDynamicElementsState: booleanWhether to include the dynamic elements state.
A promise that resolves to a SceneView object.
Sets the scene view.
The scene view to set.
Whether to transition to the view (will not transition if minimap is showing).
Whether to enable markup editing.
Whether to show the loading splashscreen.
Checks if the renderer is a mobile renderer.
Whether the renderer is a mobile renderer.
AbstractBR_BR_GetInputState Retrieves the state of the input manager. It sets how the events are consumed.
Parameters:
Returns true if operation was successful.
AbstractBR_BR_GetRendererMode Retrieves the active renderer (2D or 3D)
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_ClearSelectedIDs Forces a clear of the current selection
Returns true if operation was successful.
AbstractBR3AbstractBR3AbstractBR3AbstractBR3BR3D_GetAllTextureElementIDs Retrieves the ids of the registered Texture Elements.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_SetLineFadeOut Set the state of outline and line pattern fade out
Parameters:
AbstractBR3BR3D_GetCameraCubeDimensions Retrieves the dimensions of the viewport displaying the cube.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_SetTransformGizmoPosition Sets the position of the 3D Transform Gizmo in world space units.
Parameters:
AbstractBR3BR3D_GetTransformGizmoPosition Returns the position of the 3D Transform Gizmo in world space units. Parameters:
AbstractBR3BR3D_GetTransformGizmoTransformState Returns the transfomation state of the 3D Transform Gizmo Parameters:
AbstractBR3BR3D_SetTransformGizmoVisibilityState Sets the visibility state of the 3D Transform Gizmo
Parameters:
AbstractBR3BR3D_GetTransformGizmoVisibilityState Returns the visibility state of the 3D Transform Gizmo
Returns the visibility state of the gizmo
AbstractBR3BR3D_SetTransformGizmoHoverColor Sets the hover color of the 3D Transform Gizmo
Parameters:
AbstractBR3BR3D_GetTransformGizmoHoverColor Gets the hover color of the 3D Transform Gizmo
Parameters:
AbstractBR3BR3D_SetTransformGizmoRotationOffset Sets the initial rotation offset of the 3D Transform Gizmo
Parameters:
AbstractBR3BR3D_GetTransformGizmoRotationOffset Gets the initial rotation offset of the 3D Transform Gizmo
Parameters:
AbstractBR3BR3D_SetTransformGizmoRotationOffsetVector Sets the initial rotation offset of the 3D Transform Gizmo using a vector
Parameters:
AbstractBR3BR3D_TransformGizmoMouseMove Mouse move action for the 3D Transform Gizmo
Parameters:
Returns true if gizmo was hovered.
AbstractBR3BR3D_TransformGizmoMouseClick Mouse click action for the 3D Transform Gizmo
Parameters:
Returns true if gizmo was clicked.
AbstractBR3BR3D_SetTransformGizmoScreenSize Sets the screen size of the 3D Transform Gizmo
Parameters:
AbstractBR3BR3D_GetTransformGizmoScreenSize Returns the screen size of the 3D Transform Gizmo
Returns the screen size of the gizmo
AbstractBR3BR3D_IsCameraCompassClicked Retrieves a flag indicating whether the given mouse click event has clicked the camera cube, along with the selected camera cube position
Parameters:
AbstractBR3BR3D_StartCameraCompassDrag Call after a mouse lick (down) callback to signal start of "grabbing" of the compass widget
Parameters:
AbstractBR3BR3D_IsCameraCompassDragging Is the compass widget currently being dragged
Parameters:
AbstractBR3BR3D_IsCameraCompassVisible Is the compass widget currently visible
Parameters:
AbstractBR3AbstractBR3AbstractBR3AbstractBR3AbstractBR3BR3D_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.
AbstractBR3BR3D_GetGlobalTransparencyValue Retrieves the global transparency value for the transparent visualization option
Parameters:
Returns true if operation was successful.
AbstractBR3AbstractBR3BR3D_SetIgnoreTransparentElementsOnHybridMode Ignore transparent elements during selection for Hybrid mode
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_SetGlobalColorizedTransparencyValue Set the global colorized transparency value for the transparent visualization option
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_GetGlobalColorizedTransparencyValue Retrieves the global colorized transparency value for the transparent visualization option
Returns an object with alpha value in [0 1] range and output status.
AbstractBR3///////////////////////////////////////////////////////////////////////////////////////////////////// Hidden Line API BR3D_HiddenLineSetColor Set geometry fill color for the Hidden Line rendering mode
Parameters:
AbstractBR_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)
AbstractBR_BR_SetInputState Set the state of the input manager. It sets how the events are consumed.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_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
AbstractBR3BR3D_GetCuttingPlaneVisualizationParameters Set the outline elements color when BR3D_GetOutlineElementColorVisualization is false
Parameters:
AbstractBR3BR3D_GetCuttingPlaneVisualizationParameters Get the outline elements color when BR3D_GetOutlineElementColorVisualization is false Parameters:
AbstractBR3AbstractBR3BR3D_SetMeasurementPreviewMode Set the preview mode of the measurement
Parameters:
AbstractBR3AbstractBR3BR3D_SetCurrentCameraLinearSpeed Set the camera's linear speed
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_Get2DDrawingData Retrieves the rgb data of a 2D drawing
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_GetClosestPoint Get the closest segment id and distance, on the measurement based on the given position.
Parameters:
AbstractBR3AbstractBR3BR3D_Set2DDrawingDefaultDrawingType Sets the default color and line width for all drawing types that have not been set specifically (through BR3D_Set2DDrawingType).
Parameters:
AbstractBR3BR3D_Generate2DDrawingID Registers a 2D Drawing of dimensions (width, height).
Parameters:
Returns true if operation was successful.
AbstractBR_///////////////////////////////////////////////////////////////////////////////////////////////////// Logging API
BR_LoggingSetFilename sets the filename that will be used to log any messages
Parameters:
AbstractBR_BR_ShowFPS Enables/Disables the FPS text
Parameters:
Returns true if operation was successful.
AbstractBR3///////////////////////////////////////////////////////////////////////////////////////////////////// Drawing3D API
BR3D_Generate2DDrawingID Registers a 2D Drawing of dimensions (width, height).
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_GetArea Retrieves the measurement area. To be performed the measurement should be closed.
Parameters:
AbstractBR3AbstractBR3BR3D_RotateMeasurement Rotate the measurement in 2D space
Parameters:
AbstractBR3BR3D_RotateMeasurements Rotate the measurements in 2D space using a pivot point.
Parameters:
AbstractBR3AbstractBR3BR3D_RotateMeasurementsOnPlane Rotate the measurement in 2D space using a normal plane.
Parameters:
AbstractBR3AbstractBR3BR3D_HiddenLineGetColor Get geometry fill color for the Hidden Line rendering mode
Parameters:
AbstractBR3BR3D_SelectMeasurement Get the selected measurement.
Parameters:
AbstractBR3AbstractBR3BR3D_SelectCuttingPlane Select a cutting plane.
Parameters:
AbstractBR3GetMeasurementPointColor Retrieves the point color of the measurement
Parameters:
AbstractBR3BR3D_SetDynamicElementOutlines Set the geometric data of the dynamic element outlines
Parameters:
Returns true if the operation was succesfull.
AbstractBR3BR3D_GetTotalLength Retrieves the length of the measurement.
Parameters:
AbstractBR3AbstractBR3BR3D_DeleteMeasurementPoint Removes a point from the measurement. It also collapses the neighboring segments into a line.
Parameters:
AbstractBR3AbstractBR3BR3D_GetCameraCubeVisible Retrieves the visibility of the camera cube.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_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.
AbstractBR3Reset2DDrawingTypes Resets all color customizations to the engine's original state
Returns true if operation was successful.
AbstractBR3BR3D_SetAmbientColor BR3D_Sets the global ambient color (Default is 0.2, 0.2, 0.2)
Parameters:
AbstractBR_BR_SetOffscreenRendering Sets whether the results are written to the system's framebuffer
Parameters
Returns true if operation was successful.
AbstractBR3BR3D_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.
AbstractBR3AbstractBR3BR3D_GetGridVisibilityStatus Retrieves the visibility status of the grid color
Parameters:
AbstractBR3BR3D_GetAll2DDrawingIDs Retrieves the ids of the registered Minimaps.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_DestroyMinimap Destroys a minimap.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_GetAll2DDrawingIDs Retrieves the ids of the registered 2D Drawings.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_IsMeasurementClosed Check if the measurement is closed.
Parameters:
AbstractBR3AbstractBR3BR3D_GetEnhancedSilhouetteHideThreshold Retrieves the Enhanced Silhouette hide threshold
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_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.
AbstractBR3BR3D_SetOutlineThickness Set the thickness of the outlines (shaded mode)
Parameters:
AbstractBR3BR3D_SetLinePatternThickness Set the thickness of line patterns
Parameters:
AbstractBR3BR3D_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:
AbstractBR3AbstractBR3BR3D_GetCurrentCameraZoomSpeed Retrieves the camera's zoom speed
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_SetCurrentCameraAngularSpeed Set the camera's angular speed
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_RubberbandSelectMeasurements Use rubberband select on 3D measurements. Only on visible intersected measurements.
Parameters:
AbstractBR3AbstractBR_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.
AbstractBR3BR3D_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.
AbstractBR3GetTextureElementActive 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.
AbstractBR_BR_GetBenchmarkingStatus Retrieves the current benchmarking status
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_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.
AbstractBR_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:
AbstractBR3BR3D_SetMeasurementLineWidth Set the line width of the measurement
Parameters:
AbstractBR3AbstractBR3BR3D_SetMeasurementPointSize Set the point size of the measurement
Parameters:
AbstractBR3AbstractBR3BR3D_GetGlobalIDFromElementsID Retrieves the ids of the given globalIDs
Parameters:
AbstractBR3BR3D_GetOutlineThickness Get the thickness of the outlines (outline mode)
Returns the thickness value in pixels
AbstractBR3BR3D_GetLinePatternThickness Get the thickness of line patterns
Returns the thickness value in pixels
AbstractBR3BR3D_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.
AbstractBR3AbstractBR3BR3D_GetFacesArea Retrieves the area of the requested faces (only static element)
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_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.
AbstractBR3BR3D_SetBackfaceCulling Set the state of backface culling
Parameters:
AbstractBR3Get2DDrawingCameraUVW 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.
AbstractBR3BR3D_SetGlobalTransparencyValue Set the global transparency value for the transparent visualization option
Parameters:
Returns true if operation was successful.
AbstractBR_BR_MouseButtonEvent Mouse Button Event
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_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:
AbstractBR3BR3D_QuickMeasurement See 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:
AbstractBR3BR3D_GetCurrentCameraType Retrieves the current camera type (orbit mode or game mode).
Parameters:
Returns true if operation was successful.
AbstractBR3Parameters: texture_element_id, the Texture Element id
Returns true if operation was successful.
AbstractBR3BR3D_SetCameraTransitionArbitrary Transition to an arbitrary position/direction and up vector (Orbit camera only)
Returns true if operation was successful.
AbstractBR3BR3D_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:
AbstractBR3BR3D_ComputeClosestPointAndOutlineStructure Compute the closest point and outline acceleration structure (GL ES 3.0 only)
Parameters: Returns true if operation was successful.
AbstractBR3AbstractBR3///////////////////////////////////////////////////////////////////////////////////////////////////// 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.
AbstractBR3BR3D_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.
AbstractBR3BR3D_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.
AbstractBR3BR3D_RemoveMeasurement Removes the 3D measurement and deletes the data.
Parameters:
AbstractBR3BR3D_GetElementsArea Retrieves the area of the requested elements (both static and dynamic on GL43)
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_GetElementPerimeter Retrieves the selected perimeter of the element in millimeter (only static element)
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_Get2DDrawingDimensions Retrieves the dimensions for a 2D drawing
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_GetLineFadeOut Get the state of outline and line pattern fade out
Returns the state of fade out.
AbstractBR3BR3D_GetMeasurementFillPattern Retrieves the fill pattern of the measurement
Parameters:
AbstractBR3BR3D_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:
AbstractBR3BR3D_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
AbstractBR3AbstractBR3BR3D_GetAmbientColor Retrieves the global ambient color
Parameters:
AbstractBR3BR3D_InsertMeasurementPoint Insert a point at a given position and breaks the given segment into two new segments connected with the new point.
Parameters:
AbstractBR3AbstractBR3BR3D_RemoveDynamicElement Remove the dynamic element
Parameters:
Returns true if the operation was succesfull.
AbstractBR3BR3D_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.
AbstractBR3BR3D_RemovePointCloud remove a point cloud
Parameters:
Returns true if the operation was successful.
AbstractBR3BR3D_SetPointCloudVisibility Set the visibility of the point cloud
Parameters:
AbstractBR3BR3D_GetPointCloudVisibility Get the visibility of the point cloud
Parameters:
Returns the visibility of the point cloud.
AbstractBR3BR3D_SetPointCloudPointSize Set the point size of the point cloud
Parameters:
Returns true if the operation was succesfull.
AbstractBR3BR3D_GetPointCloudPointSize Get the point size of the point cloud
Parameters:
Returns the point size of the point cloud. Returns -1 if not successful
AbstractBR3BR3D_SetGlobalPointCloudPointSize Set the point size of the point cloud
Parameters:
Returns true if the operation was succesfull.
AbstractBR3BR3D_GetGlobalPointCloudPointSize Get the point size of the point cloud
Parameters:
Returns the point size of the point cloud. Returns -1 if not successful
AbstractBR3BR3D_GetPointCloudBoundingBox Retrieves the bounding box of the requested point cloud
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_GetCuttingPlaneVisualizationParameters Get the visualization parameters of the cutting plane
Parameters:
AbstractBR3BR3D_Get2DDrawingTypeInfo Retrieves the color and line width that have been set for a particular IFC type
Parameters:
AbstractBR3BR3D_SetActiveMinimapCameraParameters Sets the color and size (in pixels) of the camera icon
Parameters:
Returns true if operation was successful.
AbstractBR_BR_Resize Resize the buffers to the requested width and height
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_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:
AbstractBR_BR_GetHighlightColors Retrieves the coloring of the highlight
Parameters:
Returns true if operation was successful.
AbstractBR_BR_SetHighlightAlpha Set the alpha of the highlight
Parameters:
Returns true if operation was successful.
AbstractBR_BR_GetHighlightAlpha Get the alpha of the highlight
Parameters:
Returns true if operation was successful.
AbstractBR_BR_GetHighlightXRayMode Get the XRay highlight mode
Parameters:
Returns true if operation was successful. boolean BR_SetHighlightXRayMode(int mode);
AbstractBR3BR3D_GetCurrentCameraLinearSpeed Retrieves the camera's linear speed
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_GetCameraState Retrieves the camera state for the requested camera
Parameters:
AbstractBR3BR3D_GetElementsVolume Retrieves the volume of the requested elements (both static and dynamic on GL43)
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_EndComputingNormals Ends the computation of the normals
Parameters:
AbstractBR3BR3D_GetGroundSurfaceShadowState Get the state of the ground surface shadow technique.
Parameters: -enable, state Returns true if the operation was performed
AbstractBR3BR3D_GetGroundSurfaceShadowRecomputeState Get the recomputation state of the ground surface shadow technique.
Parameters: -enable, state Returns true if the operation was performed
AbstractBR3BR3D_IsElementVisible Set the visibility of a list of elements
Abstract_AbstractBR_BR_LoggingGetStatus Retrieves whether the logger is enabled/disabled
Parameters:
AbstractBR3SetMeasurementVisualizationMode Set the visualization mode of the measurement
Parameters:
AbstractBR3AbstractBR3BR3D_GetElementsIDs Retrieves the ids of the given globalIDs
Parameters:
AbstractBR3BR3D_GetActiveMinimapID Retrieves the id of the active minimap.
Parameters:
Returns true if operation was successful.
AbstractBR_BR_MouseWheelMotion Mouse Wheel Motion Event
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_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.
AbstractBR3BR3D_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.
AbstractBR3BR3D_SetCuttingPlaneVisualizationParameters Sets the visualization parameters for the cutting planes
Parameters:
AbstractBR_BR_MouseMotion Mouse move event
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_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.
AbstractBR3BR3D_SetSelectiveOutlineRendering Sets the selective outline rendering state
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_GetGridUOM Retrieves the grid's metric units Metric: Meter, Imperial: Yards
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_GetClosestSegment Get the closest segment id and distance, on the measurement based on the given position.
Parameters:
AbstractBR3AbstractBR_BR_GetFPSstatus Retrieves the frames per second current visibility status
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_SetCameraTransition Transition to the given camera cube position (Orbit camera only)
Returns true if operation was successful.
AbstractBR3BR3D_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.
AbstractBR3///////////////////////////////////////////////////////////////////////////////////////////////////// Camera3D API
BR3D_ResetCameras Reset the position and properties of the cameras based on the loaded model
Returns true if operation was successful.
AbstractBR3BR3D_GetElementPixelCenter Retrieves the pixel center of a particular element
Parameters:
AbstractBR3BR3D_GetMeasurement3DPreviewColor Get the preview color of the measurements
Parameters:
AbstractBR3AbstractBR3BR3D_GetMeasurement3DDataSize Get the size of the generated measurement byte buffer
Parameters:
AbstractBR3AbstractBR3BR3D_GetSceneBoundingBox Retrieves the bounding box of the entire scene
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_GetElementsBoundingBox Retrieves the bounding box of a list of elements (both static and dynamic on GL43)
Parameters:
Returns true if operation was successful.
AbstractBRMD_AbstractBR3BR3D_GetPointAdjacentPointIDs Get the adjacent point ids from the given point id connected with segments through the point id.
Parameters:
AbstractBR3AbstractBR3BR3D_CheckMeasurementPolygon Check the polygon for self intersection. It also works on Measurements with holes.
Parameters:
AbstractBR3AbstractBR3BR3D_GetMeasurementLineWidth Retrieves the line width of the measurement
Parameters:
AbstractBR3AbstractBR3BR3D_GetMeasurementPointSize Retrieves the point size of the measurement
Parameters:
AbstractBR3AbstractBR3BR3D_SetActiveMinimapID Sets a minimap as active for rendering
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_AntiAliasingSetMode Set 3D renderer anti aliasing mode
Parameters:
AbstractBR3BR3D_SetOutlineThickness Set the thickness of the outlines (outline mode)
Parameters:
AbstractBR3BR3D_QuickCorner Find the nearest intersection point in 2D raster/pixel space based on the current cursor position.
Parameters:
AbstractBR3AbstractBR3BR3D_CreateCutter Only one cutter can be created at each time
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_IsPlaneCutter Check if the cutter is a plane cutter.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_CloseCutter Close the cutter and create a new model with 'model_id' and name 'name'. The new model will contain the difference and intersection of the selected elements.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_RemoveCutter Clear the memory and resources of the previously created cutter.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_SetCutterElements Set the elements IDs that are associated with this cutter. For plane cutters, these IDs are also used to create the shape of the plane. Cutting is performed element-wise.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_SetCutterNormal Set the normal of the plane or polygon of the cutter.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_SetCutterPosition Set the position of the cutter. Only makes sense for plane cutters.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_GetElementParentInfo Get parent element and model id after using cutters. For non-cutter elements, only the model id is returned and -1 for element_parent_id.
Parameters:
Returns true if operation was successful.
AbstractBR3AbstractBR3AbstractBR3AbstractBR3AbstractBR3BR3D_PushBackCutterPoint Append a point on the cutter and create a line.
Parameters:
Returns true if operation was successful.
AbstractBR3AbstractBR3BR3D_ScaleCutter Scale the cutter in 2D space.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_MoveCutter Move the cutter in a given direction.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_RotateCutter Rotate the cutter in 2D space.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_SetCutterDrawOrder Set the draw order of the cutter.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_GetCutterDrawOrder Get the draw order of the cutter.
Parameters:
Returns the draw order of the cutter.
AbstractBR3BR3D_SetCutterLineColor Set the line color of the cutter.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_GetCutterLineColor Get the line color of the cutter.
Parameters:
Returns the line color of the cutter.
AbstractBR3BR3D_SetCutterPointColor Set the point color of the cutter.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_GetCutterPointColor Get the point color of the cutter.
Parameters:
Returns the point color of the cutter.
AbstractBR3BR3D_GetCutterPointCount Return the number of points defining a polygonal cutter.
Parameters:
Returns the number of points.
AbstractBR3BR3D_GetCutterPoints Return the actual points of the underlying measurement used for the cutter.
Parameters:
Returns the points in x0, y0, z0, x1, y1, z1, ... format.
AbstractBR3BR3D_GetCutterNormal Return the normal of the cutter.
Parameters:
Returns the normal direction coordinates.
AbstractBR3BR3D_GetCutterPosition Return the position of the cutter. Only relevant for plane cutters.
Parameters:
Returns the position coordinates.
AbstractBR3BR3D_GetActiveMinimapOpacity Retrieves the opacity of the active minimap.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_GetGridLevelAttributes Retrieves various attributes for a particular resolution level of the grid
Parameters:
AbstractBR3BR3D_SetCurrentCamera Set the camera type (orbit mode or game mode).
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_RemoveModel Remove a model of the given name and ID from the scenegraph
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_GetElementsSelectionMode Get the element selection mode
Parameters:
Returns the current selection mode
AbstractBR3AbstractBR3AbstractBR3BR3D_AddShapeText Create a textual shape that is attached to an element ID. It works only for BCT_TOP view and Fixed plane camera
The id of the element
The x position of the text
The y position of the text
The z position of the text
The span of the text on the Horizontal axis (x)
The span of the text on the Horizontal axis (y)
The span of the text on the Horizontal axis (z)
The span of the text on the Vertical axis (x)
The span of the text on the Vertical axis (y)
The span of the text on the Vertical axis (z)
The id of the generated shape.
AbstractBR3BR3D_UpdateShapeText2 Update the position and span of the textual shape.
AbstractBR3BR3D_RemoveShapeText Removes the textual shape.
The id of the shape
True if the operation was successful.
AbstractBR3BR3D_UpdateShapeText Update the texture of the textual shape.
The id of the shape
The level of detail of the image
RGBA data of the image (Uint8Array)
The width of the image in pixels
The height of the image in pixels
True if the operation was successful.
AbstractBR3BR3D_SetUpdateShapeTextCallback Sets a callback for updating the textures.
A function for updating the shape's textures.
AbstractRemoveRemoveUpdateShapeTextCallback Removes the callback for updating the textures.
AbstractBR3BR3D_UpdateShapeTextFullscreenImage Update the fullscreen image.
RGBA data of the image (Uint8Array)
The width of the image in pixels
The height of the image in pixels
True if the operation was successful.
AbstractBR3BR3D_SetUpdateShapeTextImageCallback Sets a callback for updating the textures.
A function for updating the shape's textures. The first argument is an array of shape IDs, the second is the number of shapes.
AbstractBR3BR3D_SetShapeTextVisibility Sets the visibility of the single texture shape text technique.
The visibility flag.
A promise that resolves when the operation is complete.
AbstractBR_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.
AbstractBR3BR3D_GetNumTextureElements Retrieves the number of registered Texture Elements
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_Get2DDrawingFontColor Retrieves the font color for the 2D drawings.
Parameters:
AbstractBR_BR_SetRubberbandMode Set the selection mode of the rubberband. Default is Front (Visible).
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_StartComputingNormals Start the normal computation. It should be the first to be called.
Parameters:
AbstractBR3BR3D_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.
AbstractBR3AbstractBR_BR_GetRubberbandMode Retrieves the selection mode of the rubberband.
Parameters:
Returns true if operation was successful.
AbstractBR3AbstractBR3AbstractBR_BR_SetHighlightColors Set the coloring of the highlight
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_IsCameraTransitioning Check if the camera is transitioning
Returns camera transition state.
AbstractisAbstractBR3BR3D_GetGlobalClosestSegment Get the closest measurement id, segment id and distance, from the given position.
Parameters:
AbstractBR3AbstractBR3BR3D_ClearElementsHighLight Set highlight status of all elements to false
Returns true if operation was successful.
AbstractBR_BR_LoggingGetConsoleFilter retrieves the type of events that the log console displays
Parameters:
AbstractBR3BR3D_GetCuttingPlaneParameters Get the various parameters of the cutting plane
Parameters:
AbstractBR_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.
AbstractBR_///////////////////////////////////////////////////////////////////////////////////////////////////// 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.
AbstractBR3BR3D_GetFacesBoundingBox Retrieves the bounding box of the requested faces (only static element)
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_RubberbandSelectElements Do a rubberband selection on the elements.
Parameters:
Returns the number of selected IDS (which is also the size of the IDS buffer)
AbstractBR3BR3D_GetBackgroundColor Retrieves the color for a particular resolution level of the grid
Parameters:
AbstractBR3BR3D_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.
AbstractBR3BR3D_SetPaperColor Set the paper color.
Parameters:
AbstractBR3BR3D_GetPaperColor Get the paper color
Parameters:
AbstractBR3BR3D_GetLengthFromPixelSize Returns the world space size from pixel size at a given position. Works in perspective cameras
Parameters:
AbstractBR_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.
AbstractBR3BR3D_GetMeasurement3DDataSize Get the size of the generated measurement byte buffer
Parameters:
AbstractBR3BR3D_GetElementArea Retrieves the selected area of the element (only static element)
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_GetPointPosition Get position of a point id
Parameters:
AbstractBR3AbstractBR3BR3D_IsPointControlPoint Get is_control_point of a point id
Parameters:
AbstractBR3AbstractBR3BR3D_AddTexture
Parameters:
Returns the id of the texture or -1 if the operation was not successful.
AbstractBR3BR3D_UpdateTexture Update a texture layer with new image data
Parameters:
Returns the id of the texture or -1 if the operation was not successful.
AbstractBR3Parameters: texture_element_id, the Texture Element id
Returns true if operation was successful.
AbstractBR3BR3D_GetMeasurementLineColor Retrieves the line color of the measurement
Parameters:
AbstractBR3BR3D_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.
AbstractBR3BR3D_GetCurrentCameraState Retrieves the current camera's state
Parameters:
AbstractBR3BR3D_GetCameraTargetToGroundPlane Get the distance from the camera position to the ground plane on camera direction
AbstractBR_BR_SetBenchmarkingStatus Enables or disables internal benchmarking of the renderer
Parameters:
Returns true if operation was successful.
AbstractBR_Parameters:
Returns true if operation was successful.
AbstractBR_BR_Init2D This function initializes the internal structure of the 2D rendering engine, fonts, the main techniques, compiles shaders, etc.
Returns true if operation was successful.
AbstractBR3BR3D_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.
AbstractBR_BR_GetRubberbandExtents Retrieves the extents of the last rubberband selection.
Parameters:
AbstractBR_BR_Render Render the data to the screen
Returns true if operation was successful.
AbstractBR3BR3D_Set2DDrawingFontName Sets the font used for the 2D drawings. This is a state operation. The font must have been registered.
Parameters:
AbstractBR3BR3D_PushBackMeasurementPoint Append a point on the measurement and create a line
Parameters:
AbstractBR3BR3D_RevertMeasurementPointIdsGenBack Reverts the generation segment and point IDs back minus one value
Parameters:
AbstractBR3AbstractBR3BR3D_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.
AbstractBR3BR3D_SetGroundSurfaceShadowState Set the state of the ground surface shadow technique.
Parameters: -enable, state Returns true if the operation was performed
AbstractBR3BR3D_SetGroundSurfaceShadowRecomputeState Set the recomputation state of the ground surface shadow technique.
Parameters: -enable, state Returns true if the operation was performed
AbstractBR3BR3D_QuickEdgePoint Find the nearest intersection point in 2D raster/pixel space based on the current cursor position.
Parameters:
AbstractBR_BR_Init3D This function initializes the internal structure of the 3D rendering engine, fonts, the scenegraph, compiles shaders, etc.
Returns true if operation was successful.
AbstractBR_BR_GetOffscreenRendering Retrieves whether the results are written to the system's framebuffer
Parameters
Returns true if operation was successful.
AbstractBR3BR3D_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.
AbstractBR3BR3D_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)
AbstractBR3BR3D_LoadMeasurement3DData Load a measurement from a byte buffer
Parameters:
AbstractBR3AbstractBR3GetMeasurementFillColor Retrieves the fill color of the measurement
Parameters:
AbstractBR3AbstractBR3BR3D_GetSSAOHideThreshold Retrieves the SSAO hide threshold
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_GetCurrentCameraZoomBlendFactors Retrieves the camera's zoom blend factors
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_GetNum2DDrawings Retrieves the number of the registered 2D Drawings
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_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.
AbstractBR3BR3D_GetSelectiveRenderingMode Retrieves the selective rendering mode
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_GetMeasurementDrawOrder Retrieves the draw order of the current measurement
Parameters:
AbstractBR3BR3D_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.
AbstractBR3BR3D_Set2DDrawingBackground Sets the background color for the 2D drawings. This is a state operation.
Parameters:
AbstractBR3BR3D_GetNumMinimaps Retrieves the number of the registered Minimaps
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_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.
AbstractBR3BR3D_SetModelVertices Set the vertices of the model REQUIRED: for adding INDEXED elements to a model
Parameters:
Returns true if operation was successful.
AbstractBR3AbstractBR3BR3D_AddElementIndexed Add an element to the engine using data from the BR3D_SetModelVertices
Parameters:
Returns the element ID if operation was successful.
AbstractBR3BR3D_ExcludeFromSceneBoundingBox Exclude/Include an element from the scene bounding box calculation
Parameters:
the element ID
true to exclude, false to include
Returns true if operation was successful.
AbstractBR3BR3D_SetElementOutlinesIndexed Add outlines to an element
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_SetModelLinePatternVertices Add model line pattern vertex data
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_AddElementLinePatternVerticesIndexed Add the element line pattern range from the BR3D_SetModelLinePatternVertices. It is used to compute the bbox of the line pattern
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_CloseMeasurement Close the measurement in order to create a closed polygon. It is necessary in order to compute other functions (e.g. GetArea())
Parameters:
AbstractBR3AbstractBR3BR3D_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.
AbstractBR3AbstractBR3AbstractBR3BR3D_SetCurrentCameraZoomSpeed Set the camera's zoom speed
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_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.
AbstractBR3BR3D_Remove2DDrawing Removes an existing 2D Drawing
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_ChangeDynamicElementColor Chnage the color data of the dynamic element
Parameters:
Returns true if the operation was succesfull.
AbstractBR3BR3D_GetShadingOption Retrieves the elements shading options
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_GetCursorWorldSpacePosition3D Get the world space position of the cursor.
Parameters
Returns true if operation was successful.
AbstractBR3AbstractBR3AbstractBR3BR3D_ZoomToElements Zooms to a particular set of elements
AbstractBR3BR3D_RubberbandSelectMeasurementPoints Use rubberband select on 3D measurements points. Only on visible intersected measurements.
Parameters:
AbstractBR3AbstractBR3BR3D_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:
AbstractBR3AbstractBR3BR3D_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:
AbstractBR3AbstractBR3BR3D_GetSegmentPointIDs Get the point ids of the given segment.
Parameters:
AbstractBR3AbstractBR3BR3D_GetGlobalClosestPoint Get the closest measurement id, point id and distance from the given position.
Parameters:
AbstractBR3AbstractBR3BR3D_ChangeDynamicElement Changes the geometric data of the dynamic element.
Parameters:
Returns true if the operation was successful.
AbstractBR3BR3D_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.
AbstractBR3BR3D_SetGridVisibilityStatus Sets the visibility status of the grid (Default is enabled)
Parameters:
AbstractBR3BR3D_SetMeasurementLineColor Set the line color of the measurement
Parameters:
AbstractBR3BR3D_Set2DDrawingFontColor Sets the font color for the 2D drawings. This is a state operation.
Parameters:
AbstractBR_BR_LoggingAddText logs an external message of a particular type (Info, Warning, Error)
Parameters:
AbstractBR3AbstractBR3AbstractBR3BR3D_SetGridLevelAttributes Sets various attributes for a particular resolution level of the grid
Parameters:
AbstractBR3BR3D_SetCameraCubeVisible Sets the visibility of the camera cube.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_GetActiveMinimapCameraParameters Retrieves the color and size (in pixels) of the camera icon
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_MoveMeasurement Move the measurement at a given direction
Parameters:
AbstractBR3BR3D_MoveMeasurements Move the measurements at a given direction
Parameters:
AbstractBR3AbstractBR3BR3D_SetActiveMinimapWindowThicknessParameters Sets the stroke's color and thickness (in pixels) of the minimap window
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_ScaleMeasurement Scale the measurement in 2D space
Parameters:
AbstractBR3BR3D_MirrorMeasurement Mirror the measurement in 2D space
Parameters:
AbstractBR3AbstractBR3BR3D_MirrorMeasurementPivotPoint Mirror the measurement in 2D space
Parameters:
AbstractBR3AbstractBR3BR3D_MirrorMeasurements Mirror the measurements in 2D space
Parameters:
AbstractBR3AbstractBR3BR3D_MirrorMeasurementsOnPlane Mirror the measurements in 2D space
Parameters:
AbstractBR3AbstractBR3BR3D_GetMeasurementsBoundingBox Get the Bounding Box of the Measurements
Parameters:
AbstractBR3AbstractBR_BR_SetCompressedImageFormat Set the Compressed RGB image buffer format.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_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.
AbstractBR3BR3D_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.
AbstractBR3BR3D_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.
AbstractBR3BR3D_GetCurrentCameraProjectionType Retrieves the camera's angular speed
Parameters:
Returns true if operation was successful.
AbstractBR_BR_Update Updates engine states based on the elapsed time
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_IsCameraCubeClicked Retrieves a flag indicating whether the given mouse click event has clicked the camera cube, along with the selected camera cube position
Parameters:
AbstractBR3BR3D_CameraCubeHover Highlights the camera cube mode to be selected
Parameters:
AbstractBR3AbstractBR3BR3D_GetAmbientOcclusionQuality Retrieves the ambient quality
Parameters:
AbstractBR3BR3D_MergeFaceAndElementID Merges the face and element id
Parameters:
AbstractBR_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:
AbstractBR3BR3D_SetMeasurementDrawOrder Set the draw order of the current measurement
Parameters:
AbstractBR3BR3D_GetShadingOption Get the state of backface culling
Returns the state of backface culling.
AbstractBR3BR3D_SetMeasurement3DPreviewColor Set the preview color of the measurements
Parameters:
AbstractBR3AbstractBR_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.
AbstractBR3BR3D_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.
AbstractBR3BR3D_GetSelectiveOutlineRendering Retrieves the selective outline rendering state
Parameters:
Returns true if operation was successful.
AbstractBR3///////////////////////////////////////////////////////////////////////////////////////////////////// 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.
AbstractBR3BR3D_GetOutlineThickness Get the thickness of the outlines (shaded mode)
Returns the thickness value in pixels
AbstractBR3BR3D_ClearMeasurement Clears the point and segment data from a measurement
Parameters:
AbstractBR3AbstractBR_BR_GetBackgroundColor Retrieves the background color
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_MoveMeasurementPointWithSnapping Move the point of the measurement at the given location.
Parameters:
AbstractBR3AbstractBR3BR3D_MoveMeasurementPointOverPlaneWithSnapping Move the point of the measurement over plane at the given location.
Parameters:
AbstractBR3AbstractBR3BR3D_SetMeasurementFillPattern Set the fill pattern of the measurement
Parameters:
AbstractBR3AbstractBR3BR3D_GetLastSegmentLength Retrieves the length of the last added segment on the measurement.
Parameters:
AbstractBR3AbstractBR3BR3D_GetSegmentLength Retrieves the length of the requested segment on the measurement.
Parameters:
AbstractBR3AbstractBR3BR3D_Get2DDrawingDefaultDrawingTypeInfo Retrieves the default color and line width for all drawing types that have not been set specifically (through BR3D_Set2DDrawingType).
Parameters:
AbstractBR3BR3D_GetCursorFromWorldSpacePosition3D Get the cursor position from a world space position.
Parameters
Returns true if operation was successful.
AbstractBR3AbstractBR3BR3D_RotateMeasurementPivotPoint Rotate the measurement in 2D space using a pivot point.
Parameters:
AbstractBR3AbstractBR3BR3D_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.
AbstractBR3BR3D_SetActiveMinimapID Sets the opacity of the active minimap.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_SetCurrentCameraPosition Sets the camera position to one of the predefined types
Parameters:
Returns true if operation was successful.
AbstractBRBRFont_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:
AbstractBR3GetMeasurementVisualizationMode Retrieves the visualization mode of the measurement
Parameters:
AbstractBR3AbstractBR3BR3D_GetActiveMinimapWindowThicknessParameters Retrieves the stroke's color and thickness (in pixels) of the minimap window
Parameters:
Returns true if operation was successful.
AbstractBR_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.
AbstractBR3BR3D_Get2DDrawingZoomOutPercentage Retrieves the percentage that the camera is zoomed out for the 2D drawings
Parameters:
AbstractBR3BR3D_AntiAliasingGetMode Get 3D renderer anti aliasing mode
Parameters:
AbstractBR3BR3D_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.
AbstractBR3AbstractBR3BR3D_SetCurrentCameraState Set the current camera's state
Parameters:
AbstractBR3BR3D_SetOrthoCameraStatePart Set only the ortho part of the current camera from floats 20 to 35 use this in conjuction with arbitray transitions of camera
AbstractBR3BR3D_Get2DDrawingBackground Retrieves the background color for the 2D drawings.
Parameters:
AbstractBR3AbstractBR3BR3D_VisualizeRubberband Visualize the rubberband
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_MoveMeasurementSegment Move the measurement segment at a given direction
Parameters:
AbstractBR3AbstractBR3BR3D_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.
AbstractBR3BR3D_GetElementsHighLightedIDs Retrieves the current list of highlighted IDs
Parameters:
Returns true if operation was successful.
AbstractBR_BR_Destroy Destroy the engine and clean up the memory.
AbstractBR_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.
AbstractBR3BR3D_Set2DDrawingType Sets the color and line width for a particular IFC type
Parameters:
AbstractBR3///////////////////////////////////////////////////////////////////////////////////////////////////// Settings3D API
BR3D_SetShadingOption Set the elements shading options
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_ConvertFromDXToOpenGL Convert the interleaved vertex with normals vertex array and index array from DX format to OpenGL
Parameters:
AbstractBR_BR_GetRubberbandMode Retrieves the color of the rubberband for the associated rubberband mode.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_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.
AbstractBR3BR3D_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.
AbstractBR3AbstractBR_BR_SetBackgroundColor Sets the background color (Default is 0.5, 0.5, 0.5)
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_SetBackgroundColors Sets the background colors
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_SetBackgroundImage Sets the background image. Set it to 0 to disable the background image and show the color gradient
Parameters:
AbstractBR3BR3D_GetBackgroundImage Gets the background image texture handle.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_SetSunLightingLensFlare Sets sun lighting lens flare effect
Parameters:
AbstractBR3BR3D_GetSunLightingLensFlare Get sun lighting lens flare effect status
Returns true if lens flare effect is enabled.
AbstractBR3BR3D_GetSunLightingLensFlareSunOnly Is the sun flare effect enable only for the sun corona
Returns true if lens flare effect is enabled.
AbstractBR3BR3D_IsSunVisible Get sun visible. This information has a one (1) frame delay
Returns true if the sun is visible and within viewport.
AbstractBR3BR3D_SetSunLightingProperties Sets sun light properties. (Angles are in radians)
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_SetSunShadowingProperties Sets sun shadow properties. (Angles are in radians)
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_GetSunLightingProperties Gets sun light properties
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_MoveMeasurementPoint Move the point of the measurement at the given location.
Parameters:
AbstractBR3AbstractBR_BR_LoggingGetFileFilter retrieves the type of events that the log file stores
Parameters:
AbstractBR3BR3D_GetGridExpansionFactor Retrieves the the expansion factor of the grid
Parameters:
AbstractBR3BR3D_ClearSelectedMeasurements3DPointIDs Clear the selected measurement and point IDS.
Returns true if operation was successful.
AbstractBR3AbstractBR3SetMeasurementFillColor Set the fill color of the measurement
Parameters:
AbstractBR3AbstractBR_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:
AbstractBR3BR3D_SetCameraCubeDimensions Set the dimensions of the viewport displaying the cube.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_SetCameraCubeHoverColor Set the camera cube highlight color
Parameters:
AbstractBR3BR3D_SetCameraCubeRenderOnlyRotationArrows Set the camera cube render mode to render only rotation arrows
Parameters:
AbstractBR_Settings API
BR_SetRendererMode Set the active renderer (2D or 3D)
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_SetAmbientOcclusionQuality BR3D_Sets the ambient occlusion quality.
Parameters:
AbstractBR3BR3D_RemoveElement Remove the element from the model
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_SetCuttingPlaneParameters Enable/Disable and sets the various parameters for the cutting plane
Parameters:
AbstractBR3BR3D_GetMeasurementPreviewMode Get the preview mode of the measurement
Parameters:
AbstractBR3BR3D_SetGridLevelColor Sets the color for a particular resolution level of the grid. Default values are:
Parameters:
AbstractBR3SetMeasurementPointColor Set the point color of the measurement
Parameters:
AbstractBR3BR3D_StartPanning Sets the camera starting panning position.
Parameters:
Returns true if operation was successful.
AbstractBR3BR3D_ClearSelectedMeasurements3DIDs Clear the selected IDS.
Returns true if operation was successful.
AbstractBR3AbstractBR_BR_LoggingSetConsoleFilter sets the type of events that the console will show by default, all messages are disabled
Parameters:
AbstractBR3BR3D_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.
AbstractBR3BR3D_ChangeDynamicElementBillboardTexture Set the billboard texture of the dynamic element. The caller is responsible for lifetime management of the texture.
Parameters:
AbstractBR3BR3D_ChangeDynamicElementBillboardActive Set whether the dynamic element should be shown as a billboard
Parameters:
Returns true if the operation was succesfull.
AbstractBR3BR3D_SetBillboardPresort Presort the billboards according to distance form camera for OIT (order independent transparency).
Parameters:
AbstractBR3BR3D_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.
AbstractBR_BR_LoggingSetFileFilter sets the type of events that the log file will store by default, all messages are enabled
Parameters:
AbstractBR_Abstract_AbstractBR3BR3D_GetFaceFirstNormal Retrieves the normal of the first triangle with the given elementFaceID
Parameters:
AbstractBR3BR3D_GetClosestNormalToPoint Retrieves the normal of the specified element ID that is closed to the given point
Parameters:
AbstractBR3BR3D_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
AbstractBR3BR3D_StopPanning Unsets the camera starting panning position.
Returns true if operation was successful.
AbstractBR3AbstractBR3BR3D_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.
AbstractBR3BR3D_SetGlobalMeasurementXRayMode Set the global xray mode
Parameters:
AbstractBR3BR3D_GetGlobalMeasurementXRayMode Get the global xray mode
Parameters:
AbstractBR3BR3D_SetMeasurementXRayMode Set the xray mode of the measurement
Parameters:
AbstractBR3AbstractBR3BR3D_GetMeasurementXRayMode Get the xray mode of the measurement
Parameters:
AbstractBR3BR3D_AddSensorChannel Add sensor channel with a value range [low, high]
Parameters:
Returns id of the channel if operation was successful. -1 if operation failed.
AbstractBR3BR3D_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.
AbstractBR3BR3D_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.
AbstractBR3AbstractBR3AbstractBR3AbstractBR3AbstractBR3AbstractBR3AbstractBR3AbstractBR3AbstractBR3AbstractBRXR_AbstractBRXRU_AbstractBRXR_AbstractBRXR_AbstractBRXR_AbstractBRXR_AbstractBRXR_Abstract_AbstractBRXR_AbstractBRXR_AbstractBRXR_AbstractBRXR_AbstractBRXR_AbstractBRXR_AbstractBRXR_AbstractBRXR_AbstractBRXR_AbstractBRXR_AbstractBRXR_AbstractBRXR_AbstractBRXR_AbstractBRXR_AbstractBRXR_AbstractBRXR_AbstractBRXR_AbstractBRXR_AbstractBRXRU_AbstractBRXRU_AbstractBRXR_AbstractBRXR_AbstractBRXR_AbstractBRXR_AbstractBR3BR3D_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.
AbstractBR3BR3D_ScanSnapshotSessionDestroy A session should always be destroyed using this API call.
Parameters:
AbstractBR3BR3D_ScanSnapshotSessionProgress Gets the progress of a previously started session
Parameters:
AbstractBR3BR3D_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.
AbstractBR3BR3D_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:
AbstractBR_AbstractBRMD_AbstractBRMD_AbstractBRMD_AbstractBRMD_AbstractBRMD_AbstractBRMD_AbstractBRMD_AbstractBRU_AbstractBRU_AbstractBR_AbstractBR_AbstractBR_AbstractBR_AbstractBR_AbstractBGK_AbstractBGK_AbstractBGK_AbstractBGK_AbstractBGK_AbstractBGK_AbstractBGK_AbstractBGK_AbstractBGK_AbstractBGK_AbstractBGK_AbstractBGK_AbstractBGK_AbstractBGK_AbstractBGK_AbstractBGK_AbstractBGK_AbstractBGK_AbstractBGK_AbstractBGK_AbstractBGK_AbstractBGK_AbstractBGK_AbstractBGK_AbstractBR3AbstractBR3AbstractBR3AbstractBR3AbstractBRLOADER_
The
BaseRendererclass is an abstract class that extends theBIMRendererclass. It provides a base implementation for rendering BIM (Building Information Modeling) data.