Documentation

# Native plugins

The BIMDataViewer is shipped with native plugins that allow basic interaction with ifcs/models. To enabled/disabled/configure them, use their name with the corresponding configuration on the plugins section of the makeBIMDataViewer configuration object.

Example:

const viewer = makeBIMDataViewer({
  plugins: {
    viewer3d: {
      navCube: false,
    },
    split: true,
    "structure-properties": {
      merge: true,
    },
  },
});

Some plugins have instance API that can be used to interact with them:

Example:

$viewer.globalContext
  .getPlugins("structure-properties")
  .forEach((plugin) => plugin.reloadTrees());

# BCF

  • name: bcf

The BCF plugin allows to interact with the BIMData BCF API by default. It is possible to change the target API using its configuration.

# Configuration

Name Type Description Default Version
headers object Additionnal headers to send to the BCF API {} 1.2.0
apiUrl string The BCF API URL. BIMData API URL 1.2.0
projectId object Override the project ID viewer's project id 1.2.0
fetchUsers async function Define another method to fetch user list (used in assigned_to field) null 1.3.0
mergeUsers boolean Set if users fetched with fetchUsers must be merged with users on BIMData API or should override the list true 1.3.0
fetchCurrentUser async function Change the method to retrive BCF current-user. Defaults to BCF standard method. Must be return the same object than standard current-user route. Emitted BCF Topics and Comments will use the id of the current user null 1.4.0
showAllAnnotations boolean If true, all annotations for all BCF in list will be shown false 1.5.0

# Fullscreen

  • name: fullscreen

A plugin as button that allows to request fullscreen on the window it lays in.

# Projection

  • name: projection

A plugin as button that sends projection type information on the localContext.hub when user change it through the UI. It requires the viewer3d plugin.

  • name: search

A plugin as button that allows to search object by uuids or names.

# Section

  • name: section

A plugin as button that allows to create section planes in the viewer3d plugin. As mentionned, it requires the viewer3d plugin to work properly.

# Window selector

  • name: windowSelector

This plugin is displayed on windows if no plugins are present on them. It displays the available windows registered on the viewer.

# Split

  • name: split

Disabled by default, the split plugin add the ability to split the ifc according to the selection, through a command on the context menu.

# Structure

  • name: structure

The structure plugin displays the tree structures of the IFCs.

# Instance API

Name Description
reload(): void Reload the trees of the loaded IFCs.

# Structure and properties

  • name: structure-properties

This plugin is actually two plugins merged together. The structure plugin that displays the tree structures of the IFCs. The properties plugin that displays the properties of the selected objects.

# Configuration

Name Type Description
merge boolean Default to false. Add the merge ifcs option on the structure.
export boolean Default to false. Add the export ifcs option on the structure.
editProperties boolean Default to false. Allows editing properties.

# Instance API

Name Description
reloadTrees(): void Reload the trees of the loaded IFCs.

# Viewer 3D

  • name: viewer3d

This plugin display the 3D representation of the IFC.

# Configuration

Name Type Description
pivotMarker boolean Default to true. Add a pivot marker of the rotation center when pivoting.
navCube boolean Default to true. Add the navCube to facilitate the 3D navigation.
edges boolean Default to true. Add model edges.
enableOffsets boolean Default to False. Allow model objects to be translated. This increase GPU memory usage

# Events

Name Payload Description
annotation-click annotation (opens new window) Emitted when an annotation marker is clicked.
3d-model-loaded { ifc, model, plugin } Emitted when a 3D model is loaded.

# Window split

  • name: window-split

This plugin is displayed if there is only one window and the header is dsplayed flying. It is displayed as button on the top-right of the window, and add the possibility to split the current window by half, and add the new window where the user want (top, bottom, right or left).

← mount →