Skip to main content
Version: v5.3

IafViewer Overview

Introduction to IafViewer​

The IafViewer React component allows you to explore and manipulate 2D and 3D models using a powerful set of viewing tools and visual assists. For example, you can use the IaFViewer to view a BIM model in 3D space and interact with that model using a variety of tools.

Different IafViewer viewing modes are available which support a wide range of industry standards for 2D and 3D models of buildings and facilities.

Note: The Model Navigator page in the Reference app, is built using the IafViewer component. Refer to the section on the Reference app for more information.

For load-time and browser-cost tips when configuring the viewer from your app, see IafViewer Performance Tips.

IafViewer at a glance​

The IafViewer combines several viewing modes, layout options, and platform integrations behind one set of props and callbacks that your application configures. Enhanced Viewing Modes expand the viewer to support diverse rendering technologies and hybrid visualization experiences.

Figure: Enhanced Viewing Modes

Click a block to enlarge that region. Click the backdrop, press Esc, or × to return to the full diagram.

IafViewer ArcGIS×

Click outside, press Esc, or × to return to the full diagram

IafViewer Unreal Engine×

Click outside, press Esc, or × to return to the full diagram

IafViewer Photosphere×

Click outside, press Esc, or × to return to the full diagram

IafViewer APS×

Click outside, press Esc, or × to return to the full diagram

IafViewer GIS (Mapbox)×

Click outside, press Esc, or × to return to the full diagram

IafViewer View3D×

Click outside, press Esc, or × to return to the full diagram

IafViewer View2D×

Click outside, press Esc, or × to return to the full diagram

Display Modes & Layouts×

Click outside, press Esc, or × to return to the full diagram

Integration Aspects×

Click outside, press Esc, or × to return to the full diagram

Session & composition×

Click outside, press Esc, or × to return to the full diagram

Core views×

Click outside, press Esc, or × to return to the full diagram

Mapbox GIS×

Click outside, press Esc, or × to return to the full diagram

EVM modes×

Click outside, press Esc, or × to return to the full diagram

Shell & chrome×

Click outside, press Esc, or × to return to the full diagram

Element & scene state×

Click outside, press Esc, or × to return to the full diagram

Authoring & assists×

Click outside, press Esc, or × to return to the full diagram

App integration×

Click outside, press Esc, or × to return to the full diagram

Note: Third-party toolkits (ArcGIS, Unreal Engine, Photosphere/Pannellum, Mapbox, and Autodesk Viewer) provide extensive features and APIs. The diagram shows the key capabilities that IafViewer integrates. To use other toolkit features through IafViewer, refer to that toolkit's documentation.

The figure groups IafViewer into these cards. Each viewing mode is inspired by and derived from an established viewer or toolkit, then aligned to work with the other IafViewer EVM modes and the IafViewer property and callback framework.

GroupCardWhat it covers
Enhanced viewing modesIafViewer ArcGISDerived from the Esri ArcGIS JS API (SceneView). 3D scenes, layers / graphics / slice, commands and callbacks, and an optional overview view
Enhanced viewing modesIafViewer Unreal EngineDerived from Epic Games' Unreal Engine with Pixel Streaming. High-fidelity streaming, server and app config, commands and onUeReady, immersive reviews
Enhanced viewing modesIafViewer PhotosphereDerived from the Pannellum panorama viewer. 360° panoramic tours, scenes and hotspots, virtual site navigation, eventHandler events
Enhanced viewing modesIafViewer APSDerived from Autodesk's APS Viewer (LMV). Autodesk-hosted designs, URN model sets, callbacks and helper APIs, outlines on MapBox
Core viewsIafViewer GIS (Mapbox)Derived from Mapbox GL. Geographic context, federated modes and clusters, elevation and markers, camera sync with View3D
Core viewsIafViewer View3DDerived from HOOPS WebViewer, served by Graphics Service. 3D model rendering, composition and disciplines, camera / walk / focus, rendering modes including Glass
Core viewsIafViewer View2DDerived from HOOPS WebViewer, served by Graphics Service. Drawings and floor plans, sheet and schematic views, layout and display modes, synced with View3D
Layout & integrationDisplay Modes & LayoutsWhere each mode's window appears (DEFAULT, SPLIT, FULLSCREEN, or FIXED), with alignment, toolbar, launcher, order, margin, and opacity options. You can also run several IafViewer instances side by side, for example to compare models. For an example layout, see EVM instances.
Layout & integrationIntegration Aspects Item, File, AI, and Workflow services, plus property-based scene management, cross-mode communication, and event handling
Property StoreSession & compositionmodel · modelComposition: model and version, federation type, clusters and quality, disciplines, persistence
Property StoreCore viewsview3d · view2d: layout and display, camera, rendering modes, 2D sheets and plans, view-ready callbacks
Property StoreMapbox GISgis: map session, federated modes, elevation and markers, cluster load mode, GIS callbacks
Property StoreEVM modesarcgis · ue · photosphere · aps: mode config, layout and display, command / eventHandler, ready callbacks and aps.callbacks
Property StoreShell & chromeToolbar, side panel, focus and nav cube, tooltips and notifications
Property StoreElement & scene stateSelection and isolate, hidden elements and spaces, color groups, cutting planes, selection callbacks
Property StoreAuthoring & assistsMarkups, measurements, scripted animations, graphics overlays
Property StoreApp integrationSettings and units, permissions and cache, internationalization (i18n), lifecycle callbacks, toolbar config callbacks

App developers configure IafViewerDBM through the Property Store prop groups. For how the groups relate, see How prop groups fit together.

For a guide to each viewing mode, see IafViewer Enhanced Viewing Modes.

For common deployment patterns when configuring IafViewer from an application, see Integration Patterns.

Building blocks — EVM - UE, ArcGIS, Photosphere, APS​

Applications configure ArcGIS, Unreal Engine, Photosphere, and APS through IafViewerDBM properties and callbacks. IafViewer mediates; each mode uses its own external runtime (ArcGIS portal, UE pixel stream, panorama URLs, or the Autodesk Viewer)—not Platform Services as the command channel.

Figure: UE, ArcGIS, Photosphere & APS EVM communication framework

Click a block to enlarge that region. Click the backdrop, press Esc, or × to return to the full diagram.

1. Application (consumer)×
1. Application (consumer), details

Click outside, press Esc, or × to return to the full diagram

2. IafViewer (mediator)×
2. IafViewer (mediator), details

Click outside, press Esc, or × to return to the full diagram

IafViewer ArcGIS×
IafViewer ArcGIS, details

Click outside, press Esc, or × to return to the full diagram

IafViewer Unreal Engine×
IafViewer Unreal Engine, details

Click outside, press Esc, or × to return to the full diagram

IafViewer Photosphere×
IafViewer Photosphere, details

Click outside, press Esc, or × to return to the full diagram

IafViewer APS×
IafViewer APS, details

Click outside, press Esc, or × to return to the full diagram

How the app drives each mode×
How the app drives each mode, details

Click outside, press Esc, or × to return to the full diagram

Events back to the application×
Events back to the application, details

Click outside, press Esc, or × to return to the full diagram

Note: Graphics, Item, File, and Permissions services power View3D, View2D, and Mapbox GIS model loading. They aren't the command or callback channel for ArcGIS, Unreal Engine, Photosphere, or APS. APS uses GraphicsService only for the optional APS REST proxy. Your application can still call APIs separately to resolve assets or config before setting IafViewer props.

Mode detail: IafViewer ArcGIS, IafViewer Unreal Engine, IafViewer Photosphere, IafViewer APS.

Building blocks — EVM - View3D, View2D, GIS (Mapbox)​

These diagrams cover how an application composes View3D, View2D, and Mapbox GIS for federated workspaces: modelComposition decides which models load; IafViewer mediates; Graphics Service powers 3D/2D and Mapbox powers the map. APS joins the figure through modelComposition.clusteredModels: clusters with evmMode: 'aps' appear on the map as outlines, and any APS cluster turns gis.initial.enableOverlay off. For more information, see APS models on Mapbox.

GIS is configured through the top-level gis prop on IafViewerDBM — not nested under view3d.

Figure: Building blocks - Geo-referenced federated projects

Click a block to enlarge that region. Click the backdrop, press Esc, or × to return to the full diagram.

1. Application (consumer)×
1. Application (consumer), details

Click outside, press Esc, or × to return to the full diagram

2. IafViewer (mediator)×
2. IafViewer (mediator), details

Click outside, press Esc, or × to return to the full diagram

IafViewer View3D×
IafViewer View3D, details

Click outside, press Esc, or × to return to the full diagram

IafViewer View2D×
IafViewer View2D, details

Click outside, press Esc, or × to return to the full diagram

IafViewer GIS (Mapbox)×
IafViewer GIS (Mapbox), details

Click outside, press Esc, or × to return to the full diagram

IafViewer APS×
IafViewer APS, details

Click outside, press Esc, or × to return to the full diagram

modelComposition — feeds which models load×
modelComposition — feeds which models load, details

Click outside, press Esc, or × to return to the full diagram

Note: Graphics Service supplies View3D and View2D model graphics. Mapbox is the GIS map runtime (token and geo placement). ArcGIS, Unreal Engine, Photosphere, and APS use their own external runtimes and don't use Graphics Service as a command bus.

Mapbox (GIS) and View3D work together, with synchronized navigation and geo-referenced BIM/PK models.

Figure: Building Blocks - Mapbox and View3D synchronization framework

Click a block to enlarge that region. Click the backdrop, press Esc, or × to return to the full diagram.

IafViewer GIS (Mapbox)×
IafViewer GIS (Mapbox), details

Click outside, press Esc, or × to return to the full diagram

IafViewer View3D×
IafViewer View3D, details

Click outside, press Esc, or × to return to the full diagram

IafViewer GIS (Mapbox) features×
IafViewer GIS (Mapbox) features, details

Click outside, press Esc, or × to return to the full diagram

IafViewer View3D features×
IafViewer View3D features, details

Click outside, press Esc, or × to return to the full diagram

Auto-synchronized operations×
Auto-synchronized operations, details

Click outside, press Esc, or × to return to the full diagram

Geo-referencing×
Geo-referencing, details

Click outside, press Esc, or × to return to the full diagram

Federated modes×
Federated modes, details

Click outside, press Esc, or × to return to the full diagram

Flow diagrams for federation type, multi-model GIS, and GIS ↔ View3D camera sync live on the pages that own those topics: Federated View3D Buildings on Gis(Mapbox), IafViewer GIS (Mapbox), Model composition.