Manual Reference Source

References

summary
public

F init(config: Object)

Initialize and configure Modelo API.

Auth

summary
public

F signIn(applicationToken: string, onSuccess: function(): void, onFail: function(errMsg: string): void)

Sign in Modelo with applicationToken.

public

F signOut(onSuccess: function(): void, onFail: function(errMsg: string): void)

Sign out Modelo and expire the session token obtained in signIn.

BIM

summary
public

F queryBIMTree(modelId: string, onSuccess: function(bimTree: BIMTree): void, onFail: function(errMsg: string): void)

Query the bim tree of the model

public

F queryElementBIM(modelId: string, elementId: number, onSuccess: function(properties: BIMProperty[]), onFail: function(errMsg: string): void)

Query the bim data of element

public

F updateElementBIM(modelId: string, elementId: number, property: {name: string, groupKey: number, strValue: ?string, numValue: ?number}, onSuccess: function(): void, onFail: function(errMsg: string): void)

Update one of the element properties with element id and model id

public
public
public
public
public
public
public
public
public
public
public
public
public

T BIMTreeNodeType: 'level' | 'category' | 'family' | 'type' | 'element'

public
public

Model

summary
public

F activateComment(comment: Object, viewer: Object)

Activiate the comment in the current viewer.

public

F createComment(modelId: string, subject: string, text: string, userData: string, onSuccess: function(commentId: number): void, onFail: function(errMsg: string): void, viewer: Object)

Create a comment with or without rendering information.

public

F deleteComment(commentId: number, onSuccess: function(commentId: number): void, onFail: function(errMsg: string): void, viewer: Object)

Delete a comment by given ID.

public

F getComments(modelId: string, onSuccess: function(comments: Comment): void, onFail: function(errMsg: string): void, viewer: Object)

Get information of the model with given id.

public

F updateComment(commentId: number, subject: string, text: string, onSuccess: function(commentId: string): void, onFail: function(errMsg: string): void)

Update the data of a comment.

public

F merge(name: string, modelIds: string[], onSuccess: function(modelId: string): void, onFail: function(errMsg: string): void)

Merge several models together into one model.

public

F query(modelId: string, onSuccess: function(model: Model): void, onFail: function(errMsg: string): void)

Get information of the model with given id.

public

F remove(modelId: string, onSuccess: function(modelId: string): void, onFail: function(errMsg: string): void)

Remove a model from its project and folder.

public

F update(modelId: string, name: string, onSuccess: function(modelId: string): void, onFail: function(errMsg: string): void)

Update the information of a model including name, folder id.

public

F upload(file: File, onSuccess: function(modelId: string): void, onProgress: function(percentage: number): void, onFail: function(errMsg: string): void)

Upload a model.

public
public

View

summary
public
public

C Viewer

public

A Viewer3D object takes in a HTML5

DOM and draw 3D models over this DOM.

public
public

View/input

summary
public
public

C Mouse

View/tool

summary
public
public
public
public

The base class for mersure tools.

public

A used to measure the angles on the model surface.

public

A tool use to measure the area on model surface.

public

A tool to measure the distance between two points.

public

A tool the measure distance between a fixed point to other points on the model surface.

public

A tool to measure the total length of several un-connected lines.

public

A tool to measure the total length of several un-connected lines.

public
public
public

C Tool

Tool is an abstract base class for all the tools in Modelo3d

Directories