Home > @modelo.io/api

api package

Classes

ClassDescription
BarChartA 3D bar chart.
CameraManipulatorThe camera manipulator associates the input, e.g, mouse to the view camera. This tool is added to viewer implicitly when mouse is enabled.
HeatMapGenerate a heatmap texture from a point distribution and color map.
HeightMapGenerate a height map from a point distribution and color map.
Keyboard
MagnifyGlassThis tool allows users to zoom into specific region defined by a rectanglar on the screen.
MeasureThe base class of all Modelo.View.Tool.MeasureXXX.
MeasureAngleA used to measure the angles on the model surface.
MeasureAreaA tool use to measure the area on model surface. Users can reset the current measurement by clicking the mouse right button. Users can press "Esc/Enter" to stop the current measurement.
MeasureLineA tool to measure the distance between two points. Users can reset the current measurement by clicking the mouse right button. Users can press "Esc/Enter" to stop the current measurement.
MeasureLineFanA tool the measure distance between a fixed point to other points on the model surface. Users can reset the current measurement by clicking the mouse right button. Users can press "Esc/Enter" to stop the current measurement.
MeasureLinesA tool to measure the total length of several un-connected lines. Users can reset the current measurement by clicking the mouse right button. Users can press "Esc/Enter" to stop the current measurement.
MeasureLineStripA tool to measure the total length of several un-connected lines. Users can reset the current measurement by clicking the mouse right button. Users can press "Esc/Enter" to stop the current measurement.
MetaBallRender a texture with meta-balls for a bunch of points over the XY plane.
Mouse
PawnPawn is a small object that can be inserted into scene dynamically.
PawnBillboardA billboard pawn that always faces camera.
Scene3DScene3D describes the contents in the scene and provides a number of ways to change them.A Scene3D object is created internally when Viewer3D is initialized. It can be obtained by call Viewer3D.getScene().
SectionThis tool can cut the scene in any directions and reveal the internal part of the scene.
SelectElementsSelect one or more elements by mouse clicking.
Text3DText3D is a 3d text that can be inserted into scene dynamically.
Text3DBillboardText3DBillboard is billboard text that can be inserted into scene dynamically.
TrailRender paths defined by a connected line segments. The path rendering has animation which trace the path from the beginning to the end.
ViewerThe viewer is the abstract base class of all viewers. It provides some basic functionalities and common interfaces.
Viewer360A viewer that displays a 3D panorama.
Viewer3DA Viewer3D object takes in an HTML5 DOM and draw 3D models over this DOM. It captures the input methods, e.g., mouse, keyboard whenever they are enabled, and other browser events, e.g., resize and take correspoinding actions.
Viewer3DCompareA viewer that shows two 3D model side by side and highlights the differences.
Viewer3DDarkA special viewer that will override the model's appearance with a programmed dark style.
VisualizeThe base class of Modelo.Scene3D.Visualize.XXX.
VolumeCreate a volume rendering. It takes in a 2D texture representing the density in XY plane. The volume is construct by extruding the XY plane in Z axis.

Enumerations

EnumerationDescription
AssetStatus
AssetType
BIMTreeNodeTypeValid types of BIM tree node
ElementType
IssuePriority
IssueStatus
ModelStatus
ModelType
SelectionType
StateThe runtime state of canvas.
TaskCommentType
TaskPriority
WechatMessageType

Functions

FunctionDescription
activate(viewer, commentId)Make a model comment in current viewer to be the current comment. It will change the current view angle to the one when comment was created.this function is only available after a 3D viewer loaded.
create(viewer, modelId, extData)Create a model comment with model id and extData.this function is only available after a 3D viewer loaded.
init(newConfig)Initialize and configure Modelo API.
isSupportWebGL(doc)Check if the current platform supports WebGL 1.0.
isSupportWebGL2(doc)Check if the current platform supports WebGL 2.0.

Interfaces

InterfaceDescription
BIMCategoryType information of a BIM category node
BIMElementType information of a BIM Element node
BIMFamilyType information of a BIM family node
BIMLevelType information of a BIM level node
BIMModelType information of a BIM model(doc) node
BIMNodeTypeType information of a BIM node
BIMPropertyType information of a BIM property
BIMTreeType information of a BIM tree
BIMTypeType information of a BIM type node
Viewer3DConfigThe initialization configuration for Viewer3D.

Namespaces

NamespaceDescription
AddCombinedModel
AddModelComment
AddModelSelectionSet
AddSliceModel
Asset
BatchDeleteProperties
BatchGetProperties
BatchUpdateProperty
BIM
Comment
DeleteAsset
DeleteModel
DeleteModelComment
DeleteModelSelectionSet
Generate3Dpdf
Get3Dpdfurl
GetAsset
GetAssetFolder
GetElementProperties
GetModel
GetModelComment
GetModelComments
GetModelFiles
GetModelFolder
GetModelSelectionSets
InitElementProperty
Model
ModelInfo
ThreeDScene
UpdateAsset
UpdateElementProperty
UpdateModel
UpdateModelComment
UpdateModelSelectionSet
UploadAsset
UploadAssetSuccess
UploadModel
UploadModelSuccess
ViewThis namespace contains all the UI related functionalities, including the viewers, inputs and tools.

Variables

VariableDescription
_default

Type Aliases

Type AliasDescription
AssetData
BIMCategoriesType information of BIM categories object
BIMElementsType information of BIM elements object
BIMFamiliesType information of BIM families object
BIMLevelsType information of BIM levels object
BIMModelsType information of BIM models(docs) object
BIMTypesType information of BIM types object
Id
Maybe
ModelData
ModeloAPIConfigThe initialization information of API. It requires "endpoint", the URL of the backend server, e.g., https://build-portal.modeloapp.com for Modelo public cloud service, and "appToken", the secret token to access the backend data. The token can be found on build's admin page. Check out the programming guide for more details about the app token.
ProgressFn
SelectionSetType information of a selection set