xeokit / SDK Examples

These examples demonstrate various features of the xeokit SDK, that you can use to build your own custom applications for viewing models in the Browser. For an idea of what you can build with xeokit, also check out some live examples of xeokit's bundled BIMViewer.

We reorganized these SDK examples in v2.4. Find the old examples index here.

Viewing Models

Viewing Building Models

Using the xeokit SDK to view building models loaded from IFC, glTF and XKT.

Viewing City Models

Using the xeokit SDK to view city models loaded from glTF, CityJSON, CityGML and XKT.

Viewing LiDAR Scans

Using the xeokit SDK to view LiDAR scans loaded from LAS, LAZ, glTF and XKT.

Viewing CAD Models

Using the xeokit SDK to view CAD models loaded from 3DXML, glTF, STL and XKT.

Navigating Models

Components for navigating models: TreeView, NavCube, ContextMenu, AxisGizmo, CameraControl, CameraPathAnimation etc.

Bookmarking Model Views

Saving and loading bookmarks, including how to exchange Building Collaboration Viewpoints (BCF) with other BIM software.

Capturing Snapshots

How to capture JPEG and PNG snapshots of a xeokit SDK viewer.

Customizing the Viewer

Configuring language translations, customizing the loading spinner, enabling ambient shadows, enabling the logarathmic depth buffer, and more.

Accelerating Performance

How to make the xeokit SDK viewer work at peak performance, using view frustum culling, LoD culling, resolution scaling and more.

Interacting with Objects

Measuring Objects

Measuring angles and distances on models.

Slicing Objects

Slicing models with interactive section planes to reveal internal structures.

Picking Objects

How to pick objects in a xeokit Viewer, interactively or programmatically.

Emphasising Objects

Changing the appearance of selected objects: colorizing, highlighting and X-raying.

Labelling Objects

Pinning fully-customizable HTML labels to the surfaces of model objects.

3D Zoning

Create 3D zones, measure base, area, volume and assign colours objects.

2D Overlay

Display a 2D overlay (e.g. a floor plan) within the 3D model

Programming Scene Content

SceneModel Examples

Low-level programming examples and tests for xeokit's high-performance model representation. Use these to build custom model loaders. Also useful to debug model viewing issues.

Scene Graph Examples

Creating custom scene elements using xeokit's scene graph; materials, transforms, geometries, billboards, sprites and more. Use these to build custom viewer gizmos.