Bimplus Renderer version : 0.

...

4.

...

8

Table of Contents

• ClashObject
  • clashElements
  • status
  • volume
  • createVisualObjects
• id
• clashingObjects
• clashFilter
• ContentLoader
  • api
  • viewport
  • errorHandler
  • canceled
  • resetState
  • loadProject
  • loadModel
  • loadModelLayers
  • loadNavigationMap
  • loadClashes
  • loadTopologyNode
  • loadObject
  • checkModelModified
  • checkModelsModified
  • checkAndRefreshProject
  • reloadClashesFromFilter
  • reloadClashes
  • reloadRevisionCompareObjects
  • cancel
• layerTemplatePromises
• viewport
• pickObject
• Highlight
• Highlight
• isInternalLayer
• NavigationMap
• ObjectContent
  • parseObjectTopologyResponse
• ObjectFactory
  • createVisualObject
  • createClashObject
  • createRevisionCompareObject
• ObjectsContainer
  • reset
  • initObjects
  • addObject
  • removeObject
  • removeObjects
  • deferredRemoveObjects
  • getObjectCount
  • getObject
  • getObjects
  • forEachObject
  • getObjectAt
  • getObjectRoot
  • getObjectParent
  • bubbleUp
  • traverseDown
  • getObjectsArray
  • objectLoop
  • findSubsetIdsObjects
  • addClashObject
  • getClashObject
  • getClashObjectCount
  • removeClashObject
  • clearClashObjects
  • forEachClashObject
  • addRevisionCompareObject
  • clearRevisionCompareObjects
  • getRevisionCompareObject
  • forEachRevisionCompareObject
• ProjectContent
  • addModel
  • getModel
  • getModels
  • findModel
  • forEachModel
  • getTopologyLeafNode
  • forEachTopologyLeafNode
  • parseProjectDetailsResponse
  • disposeClashObjectsByFilter
  • disposeObjects
  • disposeLayerGeometry
  • disposeClashObjects
  • disposeRevisionCompareObjects
  • parseClashFilterResponse
  • parseRevisionCompareResultResponse
  • parseProjectTopologyResponse
  • parseObjectTopologyResponse
  • parseGeometryTemplateChunks
  • unloadNode
  • unloadModel
  • getDisciplineNode
• ProjectLayer
  • getProject
  • getModel
  • setModel
  • isInternal
  • asLegacyDiscipline
  • getDisciplineNodes
  • setBackground
  • isBackground
  • setVisible
  • isVisible
  • setUserColor
  • getUserColor
  • setUserOpacity
  • getUserOpacity
• ProjectModel
  • getProject
  • addLayer
  • getLayer
  • getClashLayer
  • getRevisionCompareLayer
  • getLayerArray
  • forEachLayer
  • setCurrentRevision
  • getCurrentRevision
  • hasRevisions
  • addTopologyLeafNode
  • getTopologyLeafNodes
  • getTopologyLeafNode
  • forEachTopologyLeafNode
  • parseProjectTopologySubTree
  • clear
  • setVisible
• ProjectTopologyNode
  • isLayerGeometryLoaded
  • setLayerGeometryLoaded
  • setVisible
  • isVisible
  • setLayerVisible
  • isLayerVisible
  • getGeometryNode
  • getDisciplineNode
  • disposeLayerGeometry
  • getModel
  • setLayerUserColor
  • getLayerUserColor
  • setLayerUserOpacity
  • getLayerUserOpacity
• RevisionCompareObject
• Viewport3D
  • normFactor
  • minmaxbox
  • initRenderer
  • dispose
  • setContent
  • isMultiselectActive
  • showDivisionBoundingBox
  • hideDivisionBoundingBox
  • setDivisionVisible
  • centerBoundingSphere
  • calcObjectsBoundingbox
  • centerObjects
  • clipObjects
  • isolateObjects
  • addObjectsToWorkingSet
  • removeObjectsFromWorkingSet
  • addObjectsToSelectedSet
  • addObjectsToHiddenSet
  • addObjectsToColoredSet
  • disposeIsolatedSet
  • makeIsolatedSet
  • restoreSelectedObjects
  • hideIsolateObjects
  • resetHideIsolateObjects
  • hideObjects
  • getSelected3DObjectId
  • getAllSelected3DObjectIds
  • getObjectRevision
  • highlightObject
  • highlightObjects
  • disposePinObject
  • subscribeToSelectionModeChanges
  • setSelectionMode
  • unsetSelectionMode
  • setIsolationMode
  • resetIsolationMode
  • makeColoredSet
  • resetSelectionMode
  • checkSelectionMode
  • getRotationCenter
  • setRotationCenter
  • setCameraResetAxis
  • setSectionAxis
  • setViewportSize
  • resetViewport
  • restoreViewbox
  • resetCamera
  • setTargetToObject
  • calculateBoundingBox
  • toggleDisciplinesOpacity
  • toggleObjectNode
  • toggleObjectNodeOpacity
  • setDisciplineOpacity
  • updateStats
  • setLocalizationFnc
  • prototype
• MeasureInteractor
• ViewportInteractor
• RenderableObject
• OrbitControls
• LegacyJSONLoader
• calcNDCScreenPos
• ViewportContent
• VisualObject
  • init
  • clone
  • setFromVisualObject
  • addRelation
  • hasRelation
  • getRelations
  • addChild
  • removeChild
  • addChildGeometry
  • removeChildGeometry
  • isDisciplineNodeVisible
  • getDisciplineNode
  • getDisciplineNodeMesh
  • getMesh
  • getMeshGeometry
  • getVertexAttributeArray
  • getPositionArray
  • setVertexAttributeArray
  • getNumberOfFaces
  • getStartIndex
  • hide
  • show
  • setIsolation
  • getIsolation
  • setForceObjectColor
  • getForceObjectColor
  • setBackground
  • getBackground
  • resetObjectFlags
  • paint
  • setPaintColor
  • resetPaintColor
  • hasOwnGeometry
  • getBoundingBox

...

• api Object Instance of the WebSdk Api wrapper. Used to make the http requests
• viewport Viewport3D Instance of the viewport where the data should be loaded to

api

Reference to WebSDK Api wrapper

viewport

Reference to the viewport instance to load into

errorHandler

Error handler callback

...

• project ProjectContent Parent project
• layers Array<ProjectLayer> Array of layers which shall be loaded

...

loadNavigationMap

Load clashes for the given projectcontent into the navigation map

Parameters

• project ProjectContent ProjectprojectId

loadTopologyNode

• modelRevisions
• visibleLayers Array<String> Array of layers which shall be loaded
• visibleTypes Array<String> Array of object types which should be shown
• project ProjectContent Parent project

loadClashes

Load clashes for the given project

Parameters

• project ProjectContent Project

loadTopologyNode

Load geometry and Load geometry and all necessary information for a given

...

• project ProjectContent Project
• node ProjectTopologyNode Topology leaf node
• layers Array<ProjectLayer> Array of layers
• loadTemplates Boolean Load required templates from server on/off (optional, default true)
• loadObjectTree Boolean Load node's obejct tree on/off (optional, default true)
• objectsFilter Boolean Additional filter to remove objects (optional, default undefined)
• objectTreeFilter (optional, default undefined)

loadObject

This is used to load all data including geometry into an ObjectContent instance. This is used for the preview rendering in the properties panel.

...

• objectId String Object Id
• revNr Number Revision number (optional, default 1)
• checkClashVisibilityCallback Function Callback to calculate the clash elements visibility defined in the clash module

...

checkModelModified

Makes head requests request to server to check if models have been modified

Parameters

• model ProjectModel Model to check for modification

checkModelsModified

Makes head requests to server to check if models have been modified

Parameters

• models Array<ProjectModel> Array models Array<ProjectModel> Array of models to check for mofication

...

Cancel the loading process

layerTemplatePromises

Reference to WebSDK Api wrapper

...

Reference to the viewport instance to load into

pickObject

Pick object using GPU acceleration.

...

Parameters

• id String Layer Id

NavigationMap

NavigationMap constructor.

Parameters

• settings
• api
• domElementId

ObjectContent

Parameters

• viewport Viewport3D Viewport instance

...

Remove a VisualObject instance from the container

Parameters

For performance reasons it is possible to set the deferredRemoval flag. This speeds up the oparation a lot but an after removing all objects a call to deferredRemoveObjects has to be made.

Parameters

• obj VisualObject Object to obj VisualObject Object to remove
• removeChildlessParent Boolean Remove also parent if object is the last child (optional, default true)
• removeChildren Boolean Remove all children from the container (optional, default false)
• deferredRemoval Boolean If this flag is set, the obejcts won't be removed from the array but substituted with null (optional, default false)

removeObjects

...

• objects Array<VisualObject> Array of objects to remove
• removeChildlessParent Boolean Remove also parent if object is the last child (optional, default true)

getObjectCount

deferredRemoveObjects

Remove all null values from the objects array - this is the preprocessing step after removeObject with deferredRemoval enabled

getObjectCount

Returns the count Returns the count of VisualObject instances inside the container

...

Parameters

• nodeId String Node id

forEachTopologyLeafNode

Run function for each topology leaf node

Parameters

• func Function Function to run

parseProjectDetailsResponse

...

• r Object Response
• revision Number Active revision
• objectFilter

parseGeometryTemplateChunks

...

Parameters

• id String Node id

forEachTopologyLeafNode

Loop through all attached topology leaf nodes and call the given function

...

• layer ProjectLayer Layer for which to dispose the geometry

getModel

Get the node's parent model

setLayerUserColor

Set layer user color - use null to reset it

Parameters

• layer ProjectLayer Layer for which to set the user color
• value Array RGB color array

getLayerUserColor

Get layer user color - returns null if no user color is set

Parameters

• layer ProjectLayer Layer for which to get the user color

setLayerUserOpacity

Set layer user opacity - use null to reset it

Parameters

• layer ProjectLayer Layer for which to set the user opycity
• value Array Opacity value (0..1)

getLayerUserOpacity

Get layer user opacity - returns null if no user opacity is set

Parameters

• layer ProjectLayer Layer for which to get the user opacity

RevisionCompareObject

This class represents the Revision comparison object which holds the information of the actual compared objects

...