Bimplus Renderer version : 0.0.11

Table of Contents

 

DimensionLine

DimensionLine class constructor.

Creates an instance of a 3D dimension line consisting of start and end symbol, connection line and the corresponding dimension label

Parameters

 

updateGeometry

Update the dimension line geometry and labeling

Parameters

 

updateLabel

Updates the dimension label screen position

Parameters

 

setVisible

Set the dimension line visibility

Parameters

 

addToScene

Add the dimension label representations to the given sceene

Parameters

 

removeFromScene

Remove the dimension label representations from the given sceene

Parameters

 

DimensionLine

NEMETSCHEK BIM Plus Viewer. Base 3D viewport class.

Meta

 

updateGeometry

Update the dimension line geometry and labeling

Parameters

 

updateLabel

Updates the dimension label screen position

Parameters

 

setVisible

Set the dimension line visibility

Parameters

 

addToScene

Add the dimension label representations to the given sceene

Parameters

 

removeFromScene

Remove the dimension label representations from the given sceene

Parameters

 

GPUPicker

Helper class for GPU Picking

Parameters

 

pickObject

Pick object using GPU acceleration.

 

Highlight

Highlight class constructor.

Creates an instance of the highlight class which encapsulates the highlighting for vertices, faces and edges

Parameters

 

updateCursorPosition

Calulates projected cursor position

Parameters

 

MeshPartSearcher

MeshPartSearcher class constructor.

Creates an instance of the MeshPartSearcher class which encapsulates the functionality for finding faces, edges and vertices of a given mesh at given screen coordiantes

 

Viewport3D

Viewport class constructor. Created as native Javascript class because of local 3D context, which will be lost, if the class instantiated as Ember Object / Controller class. Used in the viewport3d (main view) and object 3d (object details view) classes.

Parameters

 

normFactor

Normalization factor for recalculating vertices coordinates to get rid of rendering artifacts

 

minmaxbox

Bounding box of the drawing. {x, y, z} -- center point of the box (camera look at) {w, d, h} -- width, depth and height of the box

 

initRenderer

Initialize renderer. A part of init() method

Parameters

 

initCamera

Initialize camera

Parameters

 

initControls

Initialize viewport controls.

Parameters

 

addAxisHelper

Axis helper. Used for debugging.

Parameters

 

draw

Render viewport if rendering enabled and update statistic in the debug mode.

 

moveDivisionBoundingBox

Move the boundingbox of a given division

Parameters

 

resetDivisionBoundingBox

Reset the boundingbox of a given division

Parameters

 

showDivisionBoundingBox

show the boundingbox of a given division

Parameters

 

hideDivisionBoundingBox

hide the boundingbox of a given division

Parameters

 

setDivisionVisible

Set visibilty for given divisions and adjust scene viewbox accordingly

Parameters

 

getSelected3DObjectId

Get id of 3D object currently selected in the viewport. Check all three object types: simple object, grouped geometry and clash objects.

Returns String id object id

 

getAllSelected3DObjectIds

Get list of all selected object ids

Parameters

Returns any

 

getAllSelected3DObjectIdsNodesRevisions

Get list of all selected object ids together with their node id's

Parameters

Returns any

 

getObjectRevision

Get object revision. Check all three object types: simple object, grouped geometry and clash objects.

Parameters

Returns any

 

getObjectRGBById

Get RGB of object by id

Parameters

 

highlightObject

Highlight object by id. Used in object navigator and in object details view for highlighting object in 3D viewport when respective object selected in the topology or in the grid.

Parameters

 

togglehighlightObjectChildren

togglehighlightObjectChildren

Parameters

 

disposeObjectSet

Dispose object set. Dispose buffer geometry of all object on given set when set must be destroyed or recreated.

Parameters

Returns Viewport3D this viewport 3D class

 

disposePins

Dispose pins. Dispose geometry of all given pins and free memory.

Parameters

 

disposePinObject

Dispose single pin object. Used in pinListController to remove particular pin object from isolated set.

Parameters

 

removeObjectFromSet

Remove single object from object set. Dispose object geometry, restore it on node mesh, remove object fron object set and repaint object if needed.

Parameters

 

moveObjectToSet

Move object from one to another set. Check if the object is part of grouped geometry. If so, move all related objects to target set.

Parameters

Returns Viewport3D this Viewport3D class

 

setSelectionMode

Set selection mode. Set selection mode array according to viewport settings:

Parameters

Returns Viewport3D Viewport3D class

 

unsetSelectionMode

Unset selection mode. Unset particular selection mode and prepare environments to updated mode.

Parameters

Returns Viewport3D Viewport3D class

 

resetSelectionMode

Reset selection mode. Reset selection, dispose isolated mesh, remove sectioning and selection, show hidden objects and reset selection mode to default.

Returns Viewport3D Viewport3D class

 

checkSelectionMode

Check selection mode. Check if selection mode present in the modes array.

Parameters

Returns boolean

 

setCameraResetAxis

Set camera reset axis. Set axis, which will be used on camera reset. Used to show different model views like front, top, side, perspective.

Parameters

 

setSectionAxis

Set section axis. Set axis (x, y, z) which will be used in section view, recreate visible section plane object, update environment variables.

Parameters

 

setViewportSize

Set viewport size. Reset viewport size according to the container size. Used when any viewport size updates are made, f. e. on main window resize or DOM layout change.

 

resetViewport

Reset viewport. Dispose model and reset viewport setting to default. Used when new model must be loaded.

 

restoreViewbox

Restore viewbox. Restore viewbox size to saved size and reinitialize camera.

 

resetCamera

Reset camera. Recalculate scene and camera parameters and set them according to default or given model bounding box, make camera fly effect to defined position.

Parameters

 

setSlideScene

Set slide scene. Setup scene according to scene object -- load visible disciplines and topology nodes, set viewport parameters, object sets, camera position, visible disciplines, topology nodes, etc.

Parameters

Returns any

 

cameraFlyTo

Camera fly action. Make camera movement from current to the target position within 100 ms. Time can be adjusted by setting s (step) parameter.

Parameters

Returns any

 

setTargetToObject

Set controls target (rotation center) to object's center.

Parameters

 

calculateBoundingBox

Calculate bounding box of the object. Applied to simple object (one geometry) and complex geometry with cjild / related -- including all children objects.

Parameters

 

addLights

Add lights to scene.

Parameters

 

toggleDisciplinesOpacity

Toggle disciplines opacity. Make all disciplines transparent or restore initial discipline opacity. Used in isolated mode.

Parameters

Returns Viewport3D reference to Viewport3D class instance

 

disposeObjects

Dispose objects. Make recursive loop on object tree, remove all children and dispose geometry if exists. If node or discipline id (or both) is / are given, they will be taken into account.

Parameters

 

toggleObjectNode

Toggle object node (visibility). Used in object details view. Make all node children visible / invisible according to parent visibility.

Parameters

 

toggleObjectNodeOpacity

Toggle object node (opacity). Used in object details view. Make all node children visible / invisible according to parent visibility.

Parameters

 

displayCollisionElement

Toggle collision element

Parameters

 

displayRevisionCompareElement

Toggle revision compare element

Parameters

 

filterRevisionCompareElements

hides all revision compare elements which are not of the given revNr

Parameters

 

displayRevisionCompareOriginalElements

hides all revision compare elements which are not of the given revNr

Parameters

 

setDisciplineOpacity

Set discipline opacity. Check if node exists and set its transparency to given or default value.

Parameters

 

showPins

Show pins. Render pins geometries for given pin set and move pin objects to working set.

Parameters

Returns Viewport3D Viewport3D class

 

hidePins

Hide pins. Quit visible pins mode, dispose pins geometry.

Returns Viewport3D Viewport3D class

 

getPinObject

Get pin object. Create promise, enable add pin mode -- next mouse click will define object and position on the object, where pin will be placed. The add pin mode will be active, till some object has been selected or mode cancel.

Returns Object get pin object promise

 

cancelAddPin

Cancel add pin. Quit add pin mode. Reject add pin object promise and return to default picking mode.

 

getSlideThumbnail

Get slide thumbnail. Resize viewport to defined thumbnail size, render thumbnail and return url to it.

Returns String url string

 

getSlideParams

Get slide parameters. Collect all current viewport settings and save them in scene parameters object.

Returns Object slide parameters object

 

showRelatedObject

Show related object. Fly camera to the object, referenced by pin.

Parameters

Returns Object camera fly promise

 

highlightPin

Highlight pin. Paint pin into active color.

Parameters

 

updateStats

Update status info widow. Show debug information in the debug window if debug mode active.

 

prototype

Define Viewport3D prototype and common properties and methods for all instances.

 

MeasureInteractor

Measure interactor, used to create dimension lines

Parameters

 

ViewportInteractor

Base class for user interactions with scene

Parameters

 

RenderableObject

Meta

 

OrbitControls

Parameters

Meta

released under MIT License (MIT)

 

calcNDCScreenPos

Calculates the projection of 3D point onto the near plane in NDC coordinates

Parameters