Turn off built-in context menus:

this.bim3d.contextMenus.setFilter(['hideSelected', 'hideSimilar', 'showAll']);

Add custom context menus

You can add a custom context menu based on user selected object's asset type:

var assetType = this.bim3d.getSelectedObjectAssetType(); var primaryKey = this.bim3d.getSelectedObjectPrimaryKey(); this.bim3d.contextMenus.setShowListener(function(menus){ if(primaryKey && assetType === 'rm'){ primaryKey = primaryKey.split(';'); menus.push(null); menus.push({label:'Show Room Contents', id:'showroomcontents_rm', actions:[function() { var url = 'ab-revit-overlay-rm.axvw?fieldName=rm.bl_id&fieldValue='+primaryKey[0]+'&fieldName2=rm.fl_id&fieldValue2='+primaryKey[1] +'&fieldName3=rm.rm_id&fieldValue3='+primaryKey[2]; View.openDialog(url, '', false, {width : 600, height : 650}); }]}); } });

Create 3D Navigator Object

/**
* Constructor for 3D navigator.
* @param: divId, div object id to hold 3D drawing.
* @param: config, for future usage.
*/
constructor: function(divId, config)
//create an new object
var bim3d = new Ab.bim3d.Navigator('bim3d');

Load a drawing

/**
* Loads published 3D drawing.
* @param: fileName, its value comes from either database afm_dwgs.draw_name or assembling by publish naming convention like {bl_id}-shell. It must be in lower-case and no file extension included.
* @param: isFirst, if it's the first-time loading call for a specified model or building. If true, the navigator will calculate the best layout and orientation for the drawing and delete any cached 3D data.
* @param: callback, call back function with loaded scenes object as parameter.
*/
load: function(fileName, isFirst, callback){

/**
*following code example will load three published 3D files one by one.
*/

//load the shell of NB building
this.bim3d.load('nb-shell', true, function(scenes){
//load shell first to layout the drawing in best fitting and orientation, but hide its categories
scope.bim3d.showCategories(['Roofs','Walls','Curtain Panels', 'Doors'], null, false, false, false, scenes);
//load the core of NB building
scope.bim3d.load('nb-core', false, function(scenes){
//load core but hide its categories
scope.bim3d.showCategories(['Floors','Stairs','Railings','Ceilings'], null, false, false, false, scenes);
//load the level 1 of NB building and show its categories
scope.bim3d.load('nb-level 1', false, null);
});
});

Single mouse click

With mouse is over 3D object, a single-click will make the object selected and highlighted in red.

/**
* single click event listener callback function parameters.
*
*@param: id, 3d object id.
*@param: category, object's category code.
*@param: level, object's level.
*@param: assetType, object asset type like 'rm'.
*@param: primaryKeys, object primary key values like 'HQ;18;105'.
*@param: userData, object's published data.
*/
this.bim3d.setObjectClickEventListener(function(id, category, level, assetType, primaryKeys , userData){
primaryKeys = primaryKeys.split(';'); //Array like [HQ, 18, 105
//use primaryKeys as restriction to do drill-down
});
//turn off single click
this.bim3d.setObjectClickable(false);

Double mouse click

With mouse double click over 3D object, the object or its similar ones will be hidden.

//set up double click event listener
this.bim3d.setObjectHideEventListener(function(obj){...});
//turn off double click
this.bim3d.setObjectDoubleClickable(false);

Highlight

/**
* Gets highlight colors from database and highlights corresponding asset objects.

* @param: asset, asset type like rm, eq and so on.
* @param: viewName, axvw file name.
* @param: dataSourceId, highlight dataSource id.
* @param: restriction, Ab.view.Restriction.
* @param: parameters, dataSource parameters.
*/
thematicHighlight: function(asset, viewName, dataSourceId, restriction, parameters)

var restriction = new Ab.view.Restriction();
restriction.addClause('rm.bl_id', scope.selectedFloorRow['rm.bl_id'] );
//highlight objects
this.bim3d.thematicHighlight('rm', 'ab-ex-bim-3d-rm-example-navigator.axvw', scope.currentHighlightDS, toJSON(restriction), null);

/** * Clears highlight.
* @param needRendering: if rendering the drawing.
*/
clearHighlight: function(needRendering)

this.bim3d.clearHighlight(true);

Label

/**
* Adds labels to specified objects by their category.
* @param: categoryCode, category code.
* @param: labels, Object like {'HQ;18;105': 'displayed label' ...}.
* @param: callback. call back function to be invoked after labeling is completed.
*/
addLabels: function(categoryCode, labels, callback)

//since labeling could take a while, add spinning progress indicator
this.bim3d.startSpinning();

//get label records from the label dataSource object
var records = View.dataSources.get(this.currentLabelDS).getRecords(restriction);
var record, labels={};
for(var i=0, ln=records.length; i<ln; i++){
record = records[i];
var value='';
for(var j=0, jn=fieldNames.length; j<lj; j++){
value += record.getValue(fieldNames[j]);
if(j !== jn - 1){
//multiple lines
value += '\n';
}
}
labels[record.getValue('rm.bl_id') +';'+ record.getValue('rm.fl_id') +';'+ record.getValue('rm.rm_id')] = value;
}
//add the labels to the 3D objects
this.bim3d.addLabels('Rooms', labels, function(){
//after labeling is done, stop the spinning
scope.bim3d.stopSpinning();
});

/**
* Clears displayed labels.
*/
clearLabels: function()

//clear labels
this.bim3d.clearLabels();

Isolate

Isolates 3D objects so that they can be reviewable and click-selectable even they are inside 3D structure.

/**
* Isolates objects by their categories.
*
* @param: categories, Array of category codes.
*/
isolate: function(categories)
this.bim3d.isolate(['Rooms']);

/**
* Isolates objects by their material name.
*
* @param: materialName, 3D object material name.
*/
isolateByMaterial: function(materialName)

//isolates highlighted objects
this.bim3d.isolateByMaterial('ab-highlight'); //isolates selected object
this.bim3d.isolateByMaterial('ab-selection');

/**
* Clears isolated objects.
*
* @param: callback, call back function.
*/|
clearIsolated: function(callback)
this.bim3d.clearIsolated();

Select

/**
* Selects an object by its id.
*
* @param id: 3D object id.
* @param colorCode: rgb color value.
* @param callback: call back function - pass object uuid.
*/
select: function(id, colorCode, callback)

//use primary key to get 3D object and then call API to do selection or zooming
this.bim3d.getObjectByPrimaryKey(pkValue, function(object){
//select
scope.bim3d.select(object.id);
scope.bim3d.render();
//scope.bim3d.zoomIn(object);
});

//gets the asset type of the selected object like 'rm' or 'eq'
var assetType = this.bim3d.getSelectedObjectAssetType();
//gets the asset primary key value of the selected object like 'HQ;18;105'
var pkValue = this.bim3d.getSelectedObjectPrimaryKey();

/**
* Clears selection.
*/
clearSelection: function()

this.bim3d.clearSelection();

Category

/**
* Shows specified Categories.
*
* @param: categoryCodes Array of category codes.
* @param: levels Array like ['LEVEL 1','LEVEL 2'].
* @param: show true/false.
* @param: showExcluded true/false.
* @param: forcedRendering true/false.
* @param: scenes Array of scene objects. */
showCategories: function(categoryCodes, levels, show, showExcluded, forcedRendering, scenes)

//hides shell by its categories
this.bim3d.showCategories(['Roofs','Walls','Curtain Panels', 'Doors'], null, false, false, false, scenes);

Dynamically update category panel

When loading a new model or building, sample code below fetches category data from corresponding afm_enterprise_graphics records.

API rebuildContent(modelName) updates Category panel's contents dynamically. When modelName is not null, its value appears in Category panel's top bar.

//when loading a new model or building, dynamically get category data from corresponding afm_enterprise_graphics records var superCategories = []; var exteriorSuperCategories = []; var site = this.getModelRecordInfoByFileName(bl_id, 'site'); if(site){ exteriorSuperCategories.push({title:'Site', name: 'Site', codes:site.categories, json:site.filename, functions: site.functions}); } var shell = this.getModelRecordInfoByFileName(bl_id, 'shell'); if(shell){ exteriorSuperCategories.push({title:'Shell', name: 'Shell', codes:shell.categories, json:shell.filename, functions: shell.functions}); } core = this.getModelRecordInfoByFileName(bl_id, 'core'); if(core){ exteriorSuperCategories.push({title:'Core', name: 'Core', codes:core.categories, json:'null', functions: core.functions}); } if(exteriorSuperCategories.length > 0){ superCategories.push({title:'Exterior/Core', name:'Exterior', superCategories: exteriorSuperCategories }); } var disciplinesSuperCategories = []; var hvac = this.getModelRecordInfoByFileName(bl_id, 'hvac'); if(hvac){ disciplinesSuperCategories.push({title:'HVAC', name: 'HVAC', codes:hvac.categories, json:hvac.filename}); } var plumbing = this.getModelRecordInfoByFileName(bl_id, 'plumbing'); if(plumbing){ disciplinesSuperCategories.push({title:'Plumbing', name: 'Plumbing', codes:plumbing.categories, json:plumbing.filename}); } if(disciplinesSuperCategories.length > 0){ superCategories.push({title:'Disciplines', name:'Disciplines', superCategories: disciplinesSuperCategories}); } var floorElementsSuperCategories = [{title:'Interior Walls', name: 'Interior Walls', codes: interiorWallCategory, functions:['Interior'], dual:'true', json:'null'}, {title:'Curtain Panels', name: 'Curtain Panels', codes:curtainPanelCategrory, functions:['Interior'], dual:'true', json:'null'}, {title:'Doors', name:'Doors', codes:doorCategrory, functions:['Interior'], dual:'true', json:'null'}]; if(core){ floorElementsSuperCategories.push({title:'Floors', name: 'Floors', dual:'true', codes:['-2000032'], functions:['Interior'], json:'null'}); floorElementsSuperCategories.push({title:'Ceilings', name: 'Ceilings', dual:'true', codes:['-2000038'], functions:['Interior'], json:'null'}); } var lighting = this.getModelRecordInfoByFileName(bl_id, 'lighting'); if(lighting){ floorElementsSuperCategories.push({title:'Lighting', name:'Lighting', codes:lighting.categories, dual:'false', functions:lighting.functions, json:lighting.filename}); } superCategories.push({title:'Floor Elements', name:'Floor', superCategories: floorElementsSuperCategories}); superCategories.push({title:'Assets', name:'Assets', superCategories:[{title:'Rooms', name: 'Rooms', codes:['-2000160'], functions:['Interior'],json:''}, {title:'Equipment', name: 'Equipment', codes: ['-2008085','-2008079', '-2001350','-2001160' ], functions:['Interior'], json:''}, {title:'Furniture', name: 'Furniture', codes: ['-2000080', '-2001100'], functions:['Interior'], json:''}]}); //update category panel with new data this.bim3d.setSuperCategories(superCategories); //if passed bl_id is not null, its value will be displayed on category panel's top bar this.bim3d.categoriesPanel.rebuildContent(bl_id);

Level

/**
* Shows specified level.
*
* @param: levelCode, level code from afm_dwgs.model_level record value.
* @param: excludedCategories, Array like ['Rooms','Equipment'].
* @param: show, true/false.
* @param: forcedRendering, true/false. */
showLevel: function(levelCode, excludedCategories, show, forcedRendering) //gets all hidden categories from categories panel
var excludedCategories = scope.bim3d.categoriesPanel.getAllCategoryCodes(false)
//shows level 1 of NB building with exception of excludedCategories
this.bim3d.showLevel('nb-level 1', excludedCategories, true, true);

Zoom

/**
* Zooms in.
*
* @param object, 3D Object.
*/
zoomIn: function(object) //use primary key value to find targeted 3D object and zoom in.
this.bim3d.getObjectByPrimaryKey(pkValue, function(object){
//zoom in
scope.bim3d.zoomIn(object);
});

/**
* Zooms out.
*
* @param object, 3D Object.
*/
zoomOut: function(object)

//use primary key value to find targeted 3D object and zoom out.
this.bim3d.getObjectByPrimaryKey(pkValue, function(object){
//zoom out
scope.bim3d.zoomOut(object);
});

Print

/**
* Gets current 3D screen image in 64-based string format,
*/
getImageBytes: function() //print 3D image in PPT
var slides = [];
var image = this.bim3d.getImageBytes();
slides.push({'title': 'Equipment 3D','images':[image]});

var jobId = Workflow.startJob('AbSystemAdministration-generatePaginatedReport-generatePpt', slides, {});
View.openJobProgressBar("Please wait...", jobId, null, function(status) {
var url = status.jobFile.url;
//window.location = url;
window.open(url);
});