5. Bimplus Web SDK Reference

Controller: viewport3d, viewport3dController

Methods:

initViewport(): Initialize 3D viewport

select3DObject: Object properties and 3D preview will be shown in the object view if exists (This is a ember action helper which could be called from template or with sendAction() method)

getSelected3DObject(): Returns the currently selected 3D object id(String) in the viewport

stopLoadNode(): Stop node loading and processing on custom request

showPins(Array pins): Show specified pins in the 3D viewport and highlight the related objects

hidePins(): Hide pins in the 3D viewport and reset selected objects

cancelAddPin(): Cancels the addition of a pin

getPinObject(): Selects object in the 3D view to assign pin to

showRelatedObject(Object pin): Highlight the pin related object

setSlideScene(Object pin): Sets the scene according to the slide data

getObjectUnderMouse(): Returns the object(Object) which is under the mouse pointer

reset(): Resets the 3D view by deleting the node tree, geometry, objects and resetting the viewport. Used when new project will be loaded

setupScene(Object scene): Setup scene for particular slide in the slideshow. Set camera, selection mode, object picking mode, UI, etc. It returns Promise object

toggleNode(node, discipline): Toggles node visibility

setDisciplineOpacity(Object discipline, Object opacity): Sets the transparency of discipline

resetSize(): Sets the size of the viewport according to the container dimension

resetCamera(): Resets camera and controls to the initial values

setSectionAxis(String section_axis(i.e x, y, z)): Select axis for sectioning operation

setCameraResetAxis(String section_axis(i.e x, y, z)): Reset the sectioned axis

checkSelectionMode(): Checks the selection mode

setSelectionMode(): Sets the selection mode

unsetSelectionMode(): Unsets the selection mode in 3D viewport

find(Object node, Object discipline): Load objects with geometry

Template: main.hbs

View: viewport3dView

Controller: attachmentsListController

Methods:

addAttachment(Object form_data): Add an attachment to the current object. It returns a deferred object

deleteAttachment(Object attachment): Deletes the specified attachment and returns a deferred object

findAll(String object_id): Loads object attachments and returns a deferred object

Here is a list of Ember action helper methods which could be called from template or with sendAction() method 

createAttachment(): Create a new attachment object 

showNewAttachment(): Show DOM element for new attachment creation 

cancelNewAttachment(): Cancels the new attachment creation mode 

deleteIssueAttachment(Object attachment): Deletes the specified attachment from the current issue object 

downloadIssueAttachment(Object attachment): Download the specified attachment 

hideAttachmentPreview(): Hides the attachment preview of DOM object(div)

Template: attachmentList.hbs

View: attachmentsListView

Controller: commentController, commentsListController

Methods:

commentController

find(): Loads the comment info

commentsListController

addComment(): Adds comment to the current object and returns a deferred object

updateComment(Object comment): Updates the specified comment.

deleteComment(Object comment): Deletes the specified comment from the current object and returns a deferred object

findAll(String issue_id): Loads issue's comments

Here is a list of Ember action helper methods which could be called from template or with sendAction() method 

editMode(): Sets the edit mode for writable fields 

cancel(): Sets the read mode for writable fields 

createComment(): Creates a new comment 

updateIssueComment(Object comment): Updates the specified comment 

showNewComment(String DOM_Object_id): Show input view for new comment 

cancelNewComment(String DOM_Object_id): Cancel new comment creation mode 

deleteComment(Object comment): Deletes the specified comment

Template: commentsList.hbs

View: commentsListView

Controller: hyperlinksListController

Methods:

addHyperlink(): Adds hyperlink to an issue and returns a deferred object

updateHyperlink(object hyperlink): Update the hyperlink

deleteHyperlink(object hyperlink): Deletes hyperlink from the database and returns a deferred object

findAll(String issue_id): Load hyperlinks of an issue

Here is a list of Ember action helper methods which could be called from template or with sendAction() method 

cancel(object hyperlink): Sets the read only mode for that particular hyperlink

createHyperlink(): Creates a new hyperlink

showNewHyperlink(String DOM_Object_Id): Show input form for new hyperlink

cancelNewHyperlink(String DOM_Object_Id): Cancels hyperlink creation and go to preview mode

deleteHyperlink(object hyperlink): Deletes the selected hyperlink

Template: hyperlinksList.hbs

View: hyperlinksListView

Controller: issueController

Methods:

addIssue(): Creates a new issue

updateIssue(object issue): Updates the selected issue

deleteIssue(object issue): Deletes the issue

find(String issue_id): Loads issue info

Here is a list of Ember action helper methods which could be called from template or with sendAction() method 

editMode(): Sets the edit mode for writable fields of the selected hyperlink

cancel(): Sets the read only mode for the selected hyperlink

addIssue(object issue): Creates a new issue

deleteIssue(object issue): Deletes the selected issue

updateIssue(object issue): Updates the selected issue

Template: issue.hbs

View: issueView

Controller: issuesListController

Methods: No public methods

Template: issuesList.hbs

View: issuesListView

Controller: object3dController

Methods:

initViewport(): Initialize 3D viewport object

showDetails(String object_id): Show object details

highlightNode(String object_id, Object parent_node_object): Highlight currently selected node in the object structure tree view

toggleObjectViewportNode(Object node): Show/hide branch in the node tree view

highlightViewportObject(Object object): Highlight the selected object in the tree view of the 3D viewport

Here is a list of Ember action helper methods which could be called from template or with sendAction() method

toggleObjectNodeVisibility(Object node): Show / hide the selected object in tree view of the 3D viewport

toggleObjectNodeExpand(Object node): Show / hide the branch in the node tree view of the 3D viewport

highlightObject(Object node): Highlight the selected node and object in the 3D viewport

highlightObjectNode(): Hightlight node/branch in the tree view according to the selected object of the 3D viewport

reset(): Resets the object view

find(String object_guid): Gets the object details and returns a deferred object

findGeometry(String object_id, String model_id): Gets the object geometry and returns the deferred object

Template: object3d.hbs

View: object3dView

Controller: pinsListController

Methods:

cancelAddPin(): Quits the pin add mode

showPins(): Show all pins

addPin(String issue_id, Object related_object): Add the pin object to the specified issue and returns a deferred object

deletePin(Object pin): Deletes the pin

findAll(String issue_id): Loads the pins that belong to an issue

Here is a list of Ember action helper methods which could be called from template or with sendAction() method

showPins(): Show all pins

addPin(): Adds the new pin to issue

addIssuePin(): Adds the new issue along with its pin

cancelAddPin(): Quits the pin add mode

showRelatedObject(Object object): Shows the specified object in 3D viewport

Template: pinsList.hbs

View: pinsListView

Controller: projectController

Methods:

findMembers(String project_id): Find the project members

find(Object project or String project_id): Loads the project details

Template: project.hbs, project-details.hbs, mod-layers.hbs(For setting layer transparency & visibility)

View: projectView

Controller: projectListController

Methods:

setLastOpened(String project_id): Move the specified project to the top of the project list

findAll(): Loads the project list

Template: projectList.hbs

View: projectlistView

Controller: slideshowController

Methods:

addSlideshow(): Creates a new slideshow and returns a deffered object

updateSlideshow(): Updates the specified slide

deleteSlideshow(Object slideshow): Deletes the specified slideshow

find(String slideshow_id): Loads the specified slideshow info

Here is a list of Ember action helper methods which could be called from template or with sendAction() method 

editMode(): Makes the writable fields editable

cancel(): Back to the read only mode

addSlideshow(Object slideshow): Creates a new slideshow

deleteSlideshow(Object slideshow): Deletes the specified slideshow

updateSlideshow(Object slideshow): Updates the specified slide

play(): Plays the slideshow

stop(): Stops the slideshow from playing

pause(): Pauses the slideshow

forward(): Shows the next slide

backward(): Shows the previous slide

Template: slideshow.hbs

View: slideshowView

Controller: slideshowListController

Methods:

reset(): Resets the slideshow list

Here is a list of Ember action helper methods which could be called from template or with sendAction() method 

createSlideshow(): Creates a new slideshow

slideshowPlayMode(String play_mode_name): Sets the play mode of the slideshow

addSlide(String slide_id): Adds a new slide to the current slideshow

findAll(String/Object model): Loads the slideshow list that belong to a model

Template: slideshowsList.hbs

View: slideshowsListView

Controller: slideController

Methods:

getScene():Gets the scene parameters object from the slide

addSlide(String slideshow_id): Creates a new slide and add it to the slideshow

updateSlide(Object slide): Updates the speficified slide

deleteSlide(Object slide): Deletes the specified slide

find(String slide_id): Loads the slide info and returns a deferred object

Here is a list of Ember action helper methods which could be called from template or with sendAction() method 

editMode(): Makes the writable fields editable

cancel(): Back to the read only mode

addSlide(Object slide): Creates a new slide

deleteSlide(Object slide): Deletes the specified slide

updateSlide(Object slide): Updates the speficified slide

Template: slide.hbs

View: slideView

Controller: slidesListController

Methods:

findAll(String Slideshow_id): Loads all the slides belonging to a slideshow

Template: slidesList.hbs

View: slidesListView

Controller: teamsController

Methods:

selectTeam(Object team): Selects the specified team

setTeamByName(String team_name, Object model): Select team by team owner name

find(): Loads the project list

Template: teams.hbs

View: teamsView

Controller: topologyController

Methods:

toggleDisciplineVisibility(Object discipline): Toggles the layer/discipline visibility

toggleNodeVisibility(Object node): Toggles the visibility of the specified node object and its child elements

toggleNodeExpand(Object node): Expand/collapse the specified node in the tree view

find(String node_id): Loads the project topology

findObject(): Loads the object topology

Template: topology.hbs

View: topologyView

Controller: userController, usermenuController

Methods:

userController

find(): Loads user info

usermenuController

init(): Initialize UI strings

gotoUsermenuLink(): Open portal deeplink in the same or new window

Template: menu.hbs

View: userView, usermenuView