API Reference

Classes¶

Viewer ⇐ THREE.EventDispatcher

PropertyFilter

PropertySelector

AggregateFunctionsEnum

CameraTypesEnum

DataTypesEnum

EventsEnum

OperatorsEnum

Typedefs¶

ViewerConfiguration : Object

Configuation object used to initialise bimU.io Viewer.

Viewpoint : Object

BCF-compatible viewpoint object.

Camera : Object

BCF-compatible camera object.

ClippingPlane : Object

BCF-compatible clipping plane object.

XYZ : Object

BCF-compatible XYZ object.

TagOptions : Object

Display options for Tag.

Viewer ⇐ THREE.EventDispatcher¶

Kind: global class
Extends: THREE.EventDispatcher

• Viewer ⇐ THREE.EventDispatcher
  • new Viewer(configs)
  • .showDialog(title, body, closeButtonText, okButtonText, [okButtonCallback], [dismissible])
  • .closeDialog()
  • .showHelp()
  • .showElementInformation()
  • .initialize()
  • .setViewpoint(viewpointObject)
  • .getViewpoint() ⇒ Viewpoint
  • .setSectionBox(min, max)
  • .setSectionBoxMode(mode)
  • .setProjectionMode(mode, value)
  • .isPerspectiveMode() ⇒ boolean
  • .toggleSectionbox([isVisible])
  • .sectionAroundSelection()
  • .anyElementSelected(showWarning) ⇒ boolean
  • .alignToView(viewOrientation)
  • .zoomToFit()
  • .zoomToSelection()
  • .getBoundingBoxBySelection() ⇒ THREE.Box3
  • .zoomToObject(object3D)
  • .loadModel(modelConfigs, onProgress, onLoaded, onError)
  • .unselectAllElements()
  • .unhideAllElements()
  • .resetVisibility()
  • .setVisibility(elementIndices, isVisible, [invertOthers])
  • .hideSelectedElements()
  • .isolateSelectedElements()
  • .isPointInSectionBox(point)
  • .clearAllColorOverrides()
  • .getFileProperties(onSuccess, onError)
  • .getModelMetadata(onSuccess, onError)
  • .getElementDataByIndex(elementIndex, onSuccess, onError)
  • .toggleFullscreen([isFullScreen])
  • .readCoordinates()
  • .measureDistance()
  • .measureHeight()
  • .measureAngle()
  • .measureArea()
  • .clearAllMeasurements()
  • .setColor(elementIndices, color)
  • .setTexture(elementIndices, texture)
  • .addObject(object3D) ⇒ string
  • .removeObject(objectId)
  • .addTag(text, location, [options], [onClick]) ⇒ string
  • .removeTag(tagId)
  • .getGeometry(elementIndex) ⇒ THREE.BufferGeometry
  • .getBoundingBox(elementIndices) ⇒ THREE.Box3
  • .getLocation(elementIndex) ⇒ THREE.Vector3
  • .getElementIndicesBySelection() ⇒ Array.<number>
  • .addCustomButton(domElementId, icon, color, tooltip, callback)
  • .removeDomElement(domElementId)
  • .setBackgroundColor(color)
  • .toggleWireframeMode([isWireframe])
  • .getScreenshot(openInNewWindow) ⇒ string
  • .getElementDataByQuery(filterExpression, selectExpression, limit, onSuccess, onError)
  • .getElementDataByProperty(propertyFilters, propertySelectors, limit, onSuccess, onError)
  • .aggregateElementProperty(propertyFilters, propertyToAggregate, aggregateFunction, onSuccess, onError)
  • .dispose()

new Viewer(configs)¶

bimU.io Viewer main application. You should always create an instance of Viewer by passing the ViewerConfiguration object into the constructor.

Example

let viewerConfigs = {
    domElementId: "viewer",
    THREE: null,
    showFPS: true,
    showUI: false
};
let viewer = new bimU.Viewer(viewerConfigs);

viewer.showDialog(title, body, closeButtonText, okButtonText, [okButtonCallback], [dismissible])¶

Displays a modal dialog with custom UI.

Kind: instance method of Viewer

viewer.closeDialog()¶

Closes custom modal dialog.

Kind: instance method of Viewer

viewer.showHelp()¶

Displays user instructions in a modal dialog.

Kind: instance method of Viewer

viewer.showElementInformation()¶

Displays selected element properties in a modal dialog.

Kind: instance method of Viewer

viewer.initialize()¶

Initializes bimU.io Viewer. This function must be called before using any other functions.

Kind: instance method of Viewer

viewer.setViewpoint(viewpointObject)¶

Sets camera viewpoint and clipping planes.

Kind: instance method of Viewer
See: BCF Documentation

viewer.getViewpoint() ⇒ Viewpoint¶

Gets camera viewpoint and clipping planes.

Kind: instance method of Viewer
Returns: Viewpoint - The BCF compatible viewpoint definition. See Viewpoint.
See: BCF Documentation

viewer.setSectionBox(min, max)¶

Sets the section box orthogonally.

Kind: instance method of Viewer

viewer.setSectionBoxMode(mode)¶

Sets the transformation mode of the section box.

Kind: instance method of Viewer

viewer.setProjectionMode(mode, value)¶

Changes camera parameters directly.

Kind: instance method of Viewer

viewer.isPerspectiveMode() ⇒ boolean¶

Checks camera type.

Kind: instance method of Viewer
Returns: boolean - Whether current camera is a perspective one.

viewer.toggleSectionbox([isVisible])¶

Toggles section box visibility.

Kind: instance method of Viewer

viewer.sectionAroundSelection()¶

Creates a section box around current selection.

Kind: instance method of Viewer

viewer.anyElementSelected(showWarning) ⇒ boolean¶

Checks if there's any element selected.

Kind: instance method of Viewer
Returns: boolean - Whether at least one element selected.

viewer.alignToView(viewOrientation)¶

Aligns current camera to an orthogonal view.

Kind: instance method of Viewer

viewer.zoomToFit()¶

Zooms model extent to fit current viewport.

Kind: instance method of Viewer

viewer.zoomToSelection()¶

Moves camera to focus on current selection.

Kind: instance method of Viewer

viewer.getBoundingBoxBySelection() ⇒ THREE.Box3¶

Returns a bounding box of selected elements.

Kind: instance method of Viewer
Returns: THREE.Box3 - Represents an axis-aligned bounding box (AABB) in 3D space.

viewer.zoomToObject(object3D)¶

Moves camera to focus on a particular 3D object.

Kind: instance method of Viewer

viewer.loadModel(modelConfigs, onProgress, onLoaded, onError)¶

Loads model from bimU.io server.

Kind: instance method of Viewer

viewer.unselectAllElements()¶

Unselects all selected elements.

Kind: instance method of Viewer

viewer.unhideAllElements()¶

Makes all hidden elements visible.

Kind: instance method of Viewer

viewer.resetVisibility()¶

Unhides all elements and clears all section planes.

Kind: instance method of Viewer

viewer.setVisibility(elementIndices, isVisible, [invertOthers])¶

Makes elements hidden or visible.

Kind: instance method of Viewer

viewer.hideSelectedElements()¶

Makes all selected elements invisible.

Kind: instance method of Viewer

viewer.isolateSelectedElements()¶

Hides all unselected elements.

Kind: instance method of Viewer

viewer.isPointInSectionBox(point)¶

Checks whether a 3D point is within the current section box.

Kind: instance method of Viewer

viewer.clearAllColorOverrides()¶

Removes color overrides from all elements.

Kind: instance method of Viewer

viewer.getFileProperties(onSuccess, onError)¶

Retrieves file properties from bimU.io server.

Kind: instance method of Viewer

viewer.getModelMetadata(onSuccess, onError)¶

Retrieves model metadata from bimU.io server.

Kind: instance method of Viewer

viewer.getElementDataByIndex(elementIndex, onSuccess, onError)¶

Retrieves model element data (Revit parameters, Navisworks properties, etc.) from bimU.io server.

Kind: instance method of Viewer

viewer.toggleFullscreen([isFullScreen])¶

Activates or exits full screen mode.

Kind: instance method of Viewer

viewer.readCoordinates()¶

Starts user interaction to read XYZ coordinates.

Kind: instance method of Viewer

viewer.measureDistance()¶

Starts user interaction to measure distance point by point.

Kind: instance method of Viewer

viewer.measureHeight()¶

Starts user interaction to measure height by three points.

Kind: instance method of Viewer

viewer.measureAngle()¶

Starts user interaction to measure angles by a triangle formed by three points.

Kind: instance method of Viewer

viewer.measureArea()¶

Starts user interaction to measure area by a polygon.

Kind: instance method of Viewer

viewer.clearAllMeasurements()¶

Removes all current measurements shown in the viewer.

Kind: instance method of Viewer

viewer.setColor(elementIndices, color)¶

Overrides element color.

Kind: instance method of Viewer

viewer.setTexture(elementIndices, texture)¶

WORK IN PROGRESS. Adds texture to elements.

Kind: instance method of Viewer

viewer.addObject(object3D) ⇒ string¶

Adds an arbitrary 3D object to the viewer.

Kind: instance method of Viewer
Returns: string - UUID of created Object3D.

viewer.removeObject(objectId)¶

Removes an existing 3D object from the viewer.

Kind: instance method of Viewer

viewer.addTag(text, location, [options], [onClick]) ⇒ string¶

This method adds a 3D sprite to a particular location.

Kind: instance method of Viewer
Returns: string - UUID of created Object3D.

viewer.removeTag(tagId)¶

Removes an existing tag from the viewer.

Kind: instance method of Viewer

viewer.getGeometry(elementIndex) ⇒ THREE.BufferGeometry¶

Returns primitive geometry of a particular model element.

Kind: instance method of Viewer
Returns: THREE.BufferGeometry - Three.js BufferGeometry object.

viewer.getBoundingBox(elementIndices) ⇒ THREE.Box3¶

Returns the bounding box of particular model elements or the entire model if the parameter is not set.

Kind: instance method of Viewer
Returns: THREE.Box3 - Represents an axis-aligned bounding box (AABB) in 3D space.

viewer.getLocation(elementIndex) ⇒ THREE.Vector3¶

Returns the center point of a particular model element.

Kind: instance method of Viewer
Returns: THREE.Vector3 - Three.js Vector3 object.

viewer.getElementIndicesBySelection() ⇒ Array.<number>¶

Returns indices of selected elements.

Kind: instance method of Viewer
Returns: Array.<number> - An array of element indices.

viewer.addCustomButton(domElementId, icon, color, tooltip, callback)¶

Creates a custom button on the user interface of the viewer.

Kind: instance method of Viewer

viewer.removeDomElement(domElementId)¶

Removes an existing DOM element by its ID.

Kind: instance method of Viewer

viewer.setBackgroundColor(color)¶

Sets background color of the viewer canvas.

Kind: instance method of Viewer

viewer.toggleWireframeMode([isWireframe])¶

Turns on or off wireframe mode.

Kind: instance method of Viewer

viewer.getScreenshot(openInNewWindow) ⇒ string¶

Returns screenshot of the viewer canvas.

Kind: instance method of Viewer
Returns: string - A DOMString containing a data URI containing a representation of the screenshot.

viewer.getElementDataByQuery(filterExpression, selectExpression, limit, onSuccess, onError)¶

Retrieves element data from bimU.io server based on a custom query expression.

Kind: instance method of Viewer

viewer.getElementDataByProperty(propertyFilters, propertySelectors, limit, onSuccess, onError)¶

Retrieves element data by predefined property filters and selectors.

Kind: instance method of Viewer

viewer.aggregateElementProperty(propertyFilters, propertyToAggregate, aggregateFunction, onSuccess, onError)¶

Retrieves element data by predefined property filters and selectors.

Kind: instance method of Viewer

viewer.dispose()¶

Destroys this Viewer instance and releases all resources.

Kind: instance method of Viewer

PropertyFilter¶

Kind: global class

• PropertyFilter
  • new PropertyFilter(groupName, propertyName, propertyValue)
  • .operator : OperatorsEnum
  • .groupName : string
  • .propertyName : string
  • .propertyValue : string | Array.<string> | number | Array.<number>
  • .getExpressionString() ⇒ string

new PropertyFilter(groupName, propertyName, propertyValue)¶

This class is used to find elements by a property that satisfies the specified condition. It is similar to the SQL WHERE clause.

Example

// Filter out elements that have a property called "Top Constrant" in a "Constraints" group and its value is equal to "Level 1".
let propertyFilter1 = new bimU.PropertyFilter("Constraints", "Top Constrant", "Level 1");
// Filter out elements that have a property called "Height" in a "Dimension" group and its value is greater than 12.34.
let propertyFilter2 = new bimU.PropertyFilter("Dimension", "Height", 12.34);
// Default operator is EQUAL_TO.
propertyFilter2.operator = bimU.OperatorsEnum.GREATER_THAN;

propertyFilter.operator : OperatorsEnum¶

An operator that determines how the property value is compared. Default is bimU.OperatorsEnum.EQUAL_TO.

Kind: instance property of PropertyFilter

propertyFilter.groupName : string¶

Property group name

Kind: instance property of PropertyFilter

propertyFilter.propertyName : string¶

Property name.

Kind: instance property of PropertyFilter

propertyFilter.propertyValue : string | Array.<string> | number | Array.<number>¶

Property value. Use Array along with IN, NOT_IN, or BETWEEN operators.

Kind: instance property of PropertyFilter

propertyFilter.getExpressionString() ⇒ string¶

This method returns a SQL equivalent expression for the underlying filter.

Kind: instance method of PropertyFilter
Returns: string - SQL filter expression.

PropertySelector¶

Kind: global class

• PropertySelector
  • new PropertySelector(groupName, propertyName)
  • .dataType : DataTypesEnum
  • .groupName : string
  • .propertyName : string
  • .alias : string
  • .getExpressionString() ⇒ string

new PropertySelector(groupName, propertyName)¶

This class is used to specify or restrict properties to return. It is similar to the SQL SELECT clause.

Example

// Return a property called "Top Offset" in a "Constraints" group.
let propertySelector1 = new bimU.PropertySelector("Constraints", "Top Offset");
// Default data type is STRING.
propertySelector1.type = bimU.DataTypesEnum.FLOAT;
// Return a property called "Mark" in a "Text" group.
let propertySelector2 = new bimU.PropertySelector("Text", "Mark");
// Rename the property name to "Wall Mark" when data is returned.
propertySelector2.alias = "Wall Mark";

propertySelector.dataType : DataTypesEnum¶

Data type casting/conversion. Default is bimU.DataTypesEnum.STRING.

Kind: instance property of PropertySelector

propertySelector.groupName : string¶

Property group name

Kind: instance property of PropertySelector

propertySelector.propertyName : string¶

Property name.

Kind: instance property of PropertySelector

propertySelector.alias : string¶

Alias for renaming the property name. It is similar to the SQL AS command. Default is the same as the property name.

Kind: instance property of PropertySelector

propertySelector.getExpressionString() ⇒ string¶

This method returns a SQL equivalent expression for the underlying selector.

Kind: instance method of PropertySelector
Returns: string - SQL select expression.

AggregateFunctionsEnum¶

Kind: global class
Read only: true
Properties

new AggregateFunctionsEnum()¶

Enum for aggregate functions that perform a calculation on property values and return a single value.

CameraTypesEnum¶

Kind: global class
Read only: true
Properties

new CameraTypesEnum()¶

Enum for camera types.

DataTypesEnum¶

Kind: global class
Read only: true
Properties

new DataTypesEnum()¶

Enum for SQL compatible data types.

EventsEnum¶

Kind: global class
Read only: true
Properties

new EventsEnum()¶

Enum for events.

OperatorsEnum¶

Kind: global class
Read only: true
Properties

new OperatorsEnum()¶

Enum for comparison and pattern matching operators.

ViewerConfiguration : Object¶

Configuation object used to initialise bimU.io Viewer.

Kind: global typedef
Properties

Viewpoint : Object¶

BCF-compatible viewpoint object.

Kind: global typedef
Properties

Camera : Object¶

BCF-compatible camera object.

Kind: global typedef
Properties

ClippingPlane : Object¶

BCF-compatible clipping plane object.

Kind: global typedef
Properties

XYZ : Object¶

BCF-compatible XYZ object.

Kind: global typedef
Properties

TagOptions : Object¶

Display options for Tag.

Kind: global typedef
Properties