Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Deck of Cards
idsdk3DModel
Card
defaulttrue
labelUI Control
titleInterface for rendering & displaying a 3D model of any size
 
Card
labelController & Methods
titleThe modules to be loaded for using this interface

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

 

Info

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

Card
labelTemplate & View
titleThe template that has to be loaded

Template: main.hbs

View: viewport3dView

...

Deck of Cards
idsdkAttachmentsList
Card
defaulttrue
labelUI Control
titleInterface to create,update,delete & display the list of attachments
 
Card
labelController & Methods
titleThe modules to be loaded for using this interface

Controller: attachmentsListController

Methods:

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)

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

 

deleteAttachment(Object attachment): Deletes the specified attachment from the current object in local cache & db and returns a deferred object

findAll(String object_id): Loads object attachments from local db or make AJAX request to server and returns a deferred object 

Card
labelTemplate & View
titleThe template that has to be loaded

Template: attachmentList.hbs

View: attachmentsListView

...

Deck of Cards
idsdkCommentsList
Card
defaulttrue
labelUI Control
titleInterface to create,update,delete & display the list of comments
 
Card
labelController & Methods
titleThe modules to be loaded for using this interface

Controller: commentController, commentsListController

Methods: No public methods:

find(): Loads the comment info from local db or make the AJAX request to the server

Card
labelTemplate & View
titleThe template that has to be loaded

Template: commentsList.hbs

View: commentsListView

 

...

Anchor
hyperlinks
hyperlinks

...