Skip to main content
Version: v4.6

ReferenceApp release notes

ReferenceApp 4.2#

The ReferenceApp version 4.2 introduces the following features:

Mapbox for IafViewer GIS#

In the IafViewer, you can view your building model on a GIS map, using Mapbox.

Automated Mapbox temp token generation for IafViewer GIS view#

  • The admin user can aquire a Mapbox license and store the Mapbox secret token as an encrypted parameter in the Item Service via a UI form on the Manage Model page
  • Non-admin users can enable GIS without direct access to the secret token. An orchestrator using a permission profile runs to access the secret token and requests a temporary token from Mapbox so that the map loads for the user

For more information, such as architectural diagrams and code walkthroughs to set up automatic Mapbox temp tokens, see Mapbox temp tokens for IafViewer GIS.

ReferenceApp 4.1#

The ReferenceApp version 4.1 introduces the following enhancements:

Multi-model support#

The Reference App now supports the ability to upload and manage more than one model and to change between models.

  • Set up a project with multiple models;
    • UI 1-click: Upload two pre-set models by checking the Multi-model support checkbox during project setup
    • VS code extension: Upload up to five of your own bimpks files
  • Change models from the Models pane, either on the Model Elements page or the Model Navigator drawer
  • Upload, import, and map a new model from the the Model Manager on the Admin/Manage Models page
  • Manage multiple models with the features that existed for single model support:
    • Upload new bimpk version
    • Import bimpk as model
    • Remap
    • Upload new type map
    • Delete model

For more information, see Multi-model support.

Improvements to the IaFViewer#

The IaFViewer has been significantly improved with the addition of new functionality as follows:

  • Performance: The performance of the IaFViewer has been improved with the introduction of caching for model composition. This feature enables users from different disciplines to save and retain their model composition user interface preferences, such as depth, layer settings, and linked model descriptions, when loading their projects. Previously, users had to manually reconfigure those settings each time they loaded a project. With this new caching feature, each user's custom configuration is automatically applied every time a project is loaded, which streamlines the workflow and improves overall productivity.

  • Grid Helpers: The new Grid Helper feature displays visual reference grids on a 3D model. This visual tool assists with more effective navigating, aligning, and analyzing of 3D models.

  • Improved sprite handling: Sprites are .PNG or .JPG files which can be added to 3D models. Now you can specify the exact size of these sprites in model display units (such as meters or feet). For example, you can add a sprite of a door to a 3D building model and can specify the exact height of the door.

ReferenceApp 4.0#

The ReferenceApp version 4.0 introduces the following main enhancement:

Improvements to the IaFViewer#

The IaFViewer has been significantly improved with the addition of new functionality as follows:

  • Animation: With the updated animation framework, you can now add layers of animation over 2D drawings which can animate model elements, graphics, and sprites. This is a very useful tool for displaying animations of system workflows. This new feature supports the use of animation scripts which allow you to use a range of graphical elements in your animations. The new workflow feature also supports multiple animations including animated GIFs and animating properties such as scale, rotation, and opacity.

  • Annotations: New annotation tools have been added in the Annotations and measurement pane. This feature allows you to add annotations to a 3D model in the form of text callouts, lines, and polygon graphics. You also import and export annotations.

  • Enhancements for developers: There is a new feature which allows developers to use model composition to set default visibility for the different disciplines of a Building Information Model (BIM) such as mechanical, electrical and plumbing systems.

ReferenceApp 3.1 patch#

  • Added .npmrc file for streamlined npm installs. Set up your dtplatform environment variables for the ReferenceApp's .npmrc file. If you have already developed on the platform, you may have already set these variables. If not, follow the information in NPM package install.
  • Status updates show on screen for telemetry and MQTT channel creation, cancellation and other events to provide a better understanding of the ongoing processes
  • Reduction of HTTP requests for model elements query script when searching by category and type in the model elements

ReferenceApp 3.1#

The ReferenceApp version 3.1 introduces the following enhancements:

Improved model composition#

Model composition features have been enhanced. Now, every 2D or 3D model file is composed of an array of linked files. This means only parts of the model have to be loaded as required, not one complete model file. A performance-optimized algorithm allows for improved selection speed and avoids unnecessary rendering.

For more information, refer to this page in the IafViewer: Model composition.

Improved ReferenceApp Files page#

The ReferenceApp Files page includes the following improvements:

  • Navigate a project's folders and files using the folder navigation tree or by clicking through folders in the folder view
  • Create, delete and update folders and files
  • Search, filter, and sort a project's files and folders based on multiple properties such as creation date, last updated date, user, and size.
  • View and edit file and folder object properties as well as add tags
  • View text and Microsoft Office files in the IafDocViewer

For more information, refer to Files page.

OMAPI demo option#

For the Object Model API demo, a new option - Validate Element has been added in the drop-down menu. This function is called through OMAPI to demonstrate how to call a script using fetch through OMAPI.

For more information, refer to Running OMAPI scripts.

findWithRelatedGraph demo#

For the findWithRelatedGraph query, you now have two new query options:

  • Path Discovery - Demonstrates finding the connection path between mechanical equipment within a named user collection. Allows users to retrieve the path from one piece of equipment to a defined hop depth.
  • Path Building - Demonstrates querying related items in separate collections for an HVAC system. Allows users to construct a request to query nodes up the end of the specified path.

For more information, refer to findWithRelatedGraph queries.

Upgraded software library#

The ReferenceApp has been upgraded to use dtplatform 4.3 packages and has also been upgraded to React 18 and MUI version 5.

VS code extension project setup#

ReferenceApp 3.1 includes a script specifically for manually setting up a project using the VS code extension. This process involves creating a new project, adding the VS code setup script, running each of its scripts manually and inputting the required config files. This provides a deeper insight into the steps required to set up a project. Use the VS code extension project setup guide to go through the process and view the progress in the console logs.

ReferenceApp 3.0#

Stream processing for model imports#

Stream processing enables the smooth loading of large projects as big as a city model. For more information, see Stream processing for model import.

Telemetry channel support#

ReferenceApp 2.0#

The following version 2.0 concepts have been introduced to the ReferenceApp with documentation covering the user interface and its underlying code:

ReferenceApp 1.0#

Use the ReferenceApp to examine a template app's user interface and its underlying code with reference to documenation that demonstrates the link between specific user interface actions and the functions and data flow within the code that make the actions possible.