5. Bimplus Web SDK Reference

Bimplus Web SDK

Bimplus provides a javascript SDK for accessing & manipulating building information stored in the Bimplus platform. The SDK provides a rich set of web-interface tools to view any part or aspect of the 3D model of the given building, showing or hiding specific layers, such as Disciplines or Collisions and other details. It also provides user controls for creating and managing Bimplus projects, collaborating with team/project members, issue tracking etc.

• Build your own web application for managing building projects from any location, simply from your preferred device using a browser supporting openGL(Chrome, Firefox, IE>10)
• Build a web tool for managing building projects on the Bimplus platform (www.bimplus.net)
• View a 3D model of any size
• The SDK uses REST based Bimplus API for accessing, creating, modifying and deleting different levels of information in a building model on the Bimplus platform (Bimplus API)
• The SDK is a javascript based library and Bimplus web explorer(https://www.bimplus.net/out/webviewer) is built using this library

Features

The SDK offers various controllers for

• Rendering & visualizing 3D Models/Objects of any size
• Displaying Topologies (objects in a hierarchical tree structure)
• Project related controllers
• Object highlighting
• Setting object transparency
• Sectioning
• Client & Server side(ETag) caching for performance improvement
• Issue Tracking
• Performing CRUD operations on Attachments in projects/objects/issues
• Performing CRUD operations on Comments in Issues
• Performing CRUD operations on Pins (for visualizing issues)
• Slideshows & Slides
• Hyperlinks

Downloading & using the SDK

The source code for the SDK is located under https://github.com/Bimplus/Web-SDK. Please go through the "Getting Started" & "Using the SDK" sections of README.MD text.

Web SDK Reference

• 3DModel Renderer
• Attachments
• Comments
• Hyperlinks
• Issues
• IssueList
• Object Properties
• Spots
• Projects
• Slideshow Service
• Hyperlink Service

3D Model Renderer 

This control is used for rendering & displaying a 3D model of any size. This is the main view which displays the model.

 

Controller: viewport3d, viewport3dController

Methods: No public methods

Please note that viewport3dController acts like a proxy to the viewport3d and hence all the public methods are available under viewport3d.

Template: main.hbs

View: viewport3dView

Attachments

This control is used for uploading & displaying the attachments (attachment control is already included for objects, issues & slideshows)

 

Controller: attachmentsListController

Methods: No public methods

Template: attachmentList.hbs

View: attachmentsListView

Comments

This control is used for working with the comments (comments control is already included for objects, issues & slideshows)

 

Controller: commentController, commentsListController

Methods: No public methods

Template: commentsList.hbs

View: commentsListView

Hyperlinks

This control is used for working with the hyperlinks (hyperlinks control is already included for objects, issues & slideshows)

 

Controller: hyperlinksListController

Methods: No public methods

Template: hyperlinksList.hbs

View: hyperlinksListView

Issues

This control is used for working with issues inside a project. Please use Pins/Spot control for visualizing spots/pins(could be a problem) related to an issue (if the issue includes geometrical information)

 

Controller: issueController

Methods: No public methods

Template: issue.hbs

View: issueView

Issue List

This control is used for displaying a list of issues inside a project.

 

Controller: issuesListController

Methods: No public methods

Template: issuesList.hbs

View: issuesListView

Object Properties 

This control is used for displaying object's properties. It includes comments, attachments & hyperlinks controls.

Spots / Pins

This control is used for visualizing spots/pins(could be a problem) related to an issue (if the issue includes geometrical information)

Projects

This control is used for displaying project information. A project consists of one or more models and each model contains one or more disciplines/layers in it. Each model & discipline could be switched on/off and the transparency of the disciplines could also be switched on/off. 

Project List

This control is used for displaying a list of projects inside a team.

Slideshows

This control is used for working with a particular slideshow inside a project.

Slideshow List

This control is used for displaying a list of slideshows inside a project.

Slides

This control is used for working with a particular slide belonging to a slideshow.

Slide List

This control is used for displaying a list of slides belonging to a slideshow.

Teams

This control is used for displaying the list of teams.

Topology

This control is used for displaying the topology structure of a model.

User

This control is used for displaying user information & his application settings (context menus)