Version 13.0.0

Released on 25 Jun 2024

Type Description
Major API changes due to removal of the "Spec"

Version 12.4.1

Released on 23 Apr 2024

Type Description
Improved readability of texture names which are based on Combeenation image assets (e.g. shown in inspector)
GLB export for scenes which include paintables

Version 12.4.0

Released on 19 Mar 2024

Type Description
Add possibility to disable parallel shader compilition via Spec (see useParallelShaderCompile flag in SceneJson)
Locked version of optional Babylon.js packages in order to fix development build errors in consuming code

Version 12.3.0

Released on 04 Mar 2024

Type Description
Support 3d model import with material types NodeMaterial, BackgroundMaterial, PBRSpecularGlossinessMaterial, PBRMetallicRoughnessMaterial
VariantInstanceManager.clone function leads to browser freeze

Version 12.2.1

Released on 09 Feb 2024

Type Description
Move viewer internal debug meshes into dedicated rendering utility scene

Version 12.2.0

Released on 08 Feb 2024

Type Description
Add function Viewer.hideWorldCoordinates as counterpart for Viewer.showWorldCoordinates

Version 12.1.2

Released on 31 Jan 2024

Type Description
Fix internal instanced mesh type checking in production builds

Version 12.1.1

Released on 31 Jan 2024

Type Description
Reconstruct original tags assignment for instanced meshes on loading, instead of syncing source mesh tags state

Version 12.1.0

Released on 29 Jan 2024

Type Description
Apply current skeleton influence for GLB export
Import and cloning of models with instanced meshes

Version 12.0.2

Released on 03 Jan 2024

Type Description
Improve apprearance of debug coordinate system from Viewer.showWorldCoordinates function

Version 12.0.1

Released on 11 Dec 2023

Type Description
Adjust Babylon.js Inspector dependencies configuration to decrease build size in certain environments

Version 12.0.0

Released on 05 Dec 2023

Type Description
Implement texture downscaling mode
Disable camera centering on double click
Activate engines adaptToDeviceRatio setting per default for better visual quality on certain devices
exportOptions parameter removed in exportGlb, exportGltfToFile & exportGlbToFile

Version 11.1.0

Released on 27 Nov 2023

Type Description
Support usage of Node Geometry Editor in Babylon.js Inspector
Fix negative scalings in Gltf export which leads to erroneous AR models on iOS devices

Version 11.0.0

Released on 08 Nov 2023

Type Description
Update from Babylon.js v5.27.1 to v6.27.1, see new features of Babylon.js 6

Version 10.0.0

Released on 19 Oct 2023

Type Description
Rework integration of Babylon.js Inspector

Version 9.3.0

Released on 21 Sep 2023

Type Description
Support usage of baked skeletons
Fix Event.TEXTURE_LOADING_END event not triggered if models with morph targets are loaded

Version 9.2.0

Released on 12 Sep 2023

Type Description
Bake morph targets in glb export for AR so that they can be displayed on iOS devices
Viewer scene breaks after GLB export for AR due to interaction with dummy export scene

Version 9.1.1

Released on 02 Jun 2023

Type Description
Crashing glb export with paintables based on SVGs with embedded assets (eg: fonts)

Version 9.1.0

Released on 23 May 2023

Type Description
Add option for limiting texture size in glb export (see IExportOptionsExtended.limitTextureSize)
Handling of invalid SVG in paintable parameter
Crashing glb export in iOS devices

Version 9.0.1

Released on 05 May 2023

Type Description
Handling of paintable parser errors when used in Combeenation viewer control
Avoid multiple material requests for the same material on different meshes

Version 9.0.0

Released on 02 May 2023

Type Description
Add materials as subject for tag manager
Add paintables as material parameter in tag manager
Add material sub parameter Parameter.COLOR, Parameter.METALLIC and Parameter.ROUGHNESS in tag manager
Remove support for legacy material sub parameter Parameter.MATERIAL_COLOR, Parameter.MATERIAL_METALLNESS and Parameter.MATERIAL_ROUGHNESS in tag manager
Geometry filter for glb export ignored TransformNodes and adapted mesh names from AR optimization
Tag manager race conditions which sometimes didn't apply parameter values correctly

Version 8.0.0

Released on 19 Apr 2023

Type Description
Changed options for IExportOptionsExtended which is used in exportGlb, exportGltfToFile & exportGlbToFile:
Removed createUniqueMeshNames from IExportOptionsExtended which is now part of the new optimizeForAR parameter of the export functions & added exchangeRefractionMaterials to IExportOptionsExtended.
The viewer now bakes transformations in gltf export functions when using the new optimizeForAR parameter to handle iOS negative scaling issue in augmented reality

Version 7.1.3

Released on 12 Apr 2023

Type Description
getAllViewerModules which is internally required for Combeenation's viewer control when passing the Viewer to its injectViewer method

Version 7.1.2

Released on 30 Mar 2023

Type Description
Support providing viewer package as full distribution build (needed for Combeenation 3d viewer control)
Exclude meshes with infinite distance (skybox) from Viewer.autofocusActiveCamera function
New TagManager.getAllTags
Viewer is printing some subtle info about all registered variant instances to the console when bootstrapping
Viewer.autofocusActiveCamera & GLB export functions now also support TagManagerSubjects to be given with the exclude options
When cloning variant instances, nodes of elements are renamed a bit different then before
Handling of boolean tag parameter values when passed as strings
Parameter values where sometimes re-applied when same value was given multiple times to the tag manager

Version 7.1.1

Released on 15 Mar 2023

Type Description
Race conditions when applying tag manager parameter values while bootstrapping

Version 7.1.0

Released on 06 Mar 2023

Type Description
createMaterialFromCbnAssets and getOrCreateMaterial functions became asynchronous, due to viewer usage in Combeenation asset environment

Version 7.0.0

Released on 23 Feb 2023

Type Description
Introduce Tag Manager as new framework for altering node data
Remove scene as parameter of setMaterial
Change default value of SceneJsons cloneMaterialsOnMutation from true to false
Viewer.bootstrap requires a set of initial tag and node parameter values
Change naming algorithm for nodes of variant instances and clones
Change default value of Viewer.autofocusActiveCamera radius factor back to 1.5 to get some padding when zooming on the model
Unhandled exception in setMaterial function

The new default value false of SceneJson.cloneMaterialsOnMutation might changes the behavior and look of your 3d model when working with material parameters. Test carefully when updating to this release.

The adapted node naming strategy will most likely break your application, if nodes are accessed directly via Babylon.js API (eg: scene.getMeshByName)

Version 6.5.0

Released on 23 Jan 2023

Type Description
Expose SpecStorage to public API to support manual re-booting of viewer
Firing mesh enable observers too late so that material application looks weird in some cases
Unhandled exception in material post load observer

Version 6.4.0

Released on 19 Jan 2023

Type Description
Defer applying materials until material shader is compiled to avoid meshes from appearing transparent when setting materials the first time
Replace dots (.) with slashes (/) when auto-generating the Spec to avoid special handling of dotted path variants
Fix triggering material application if mesh visibility state is changed by parent node

Version 6.3.0

Released on 09 Jan 2023

Type Description
Defer applying materials until all its textures are loaded to avoid meshes from appearing transparent during texture loading

Version 6.2.1

Released on 03 Jan 2023

Type Description
Variant instances were not shown initially when visible parameter and lazy flag were both set to true
Rework Viewer.autofocusActiveCamera function to avoid timing issues with deferred material loading

Version 6.2.0

Released on 22 Dec 2022

Type Description
Add option for creating Spec automatically, using Viewer.generateSpec

Version 6.1.0

Released on 3 Nov 2022

Type Description
Option for creating unique mesh names when exporting GLB/GLTF files via GltfExportManager, which is required for certain AR engines
Events Event.TEXTURE_LOADING_START & Event.TEXTURE_LOADING_END which can be used e.g. to show a load load mask whenever a texture is loading in the background

Version 6.0.0

Released on 14 Oct 2022

Type Description
Update build process, using webpack 5 (see Update Guide for more details)
Update from Babylon.js v5.21.0 to v5.27.0

Version 5.1.3

Released on 5 Oct 2022

Type Description
Materials set via element parameter were sometimes not applied when there are multiple instances of the same variant

Version 5.1.2

Released on 29 Sep 2022

Type Description
Material textures were erroneously eager loaded when element was hidden via value of named parameter

Version 5.1.1

Released on 27 Sep 2022

Type Description
Support for babylon files & PbrMaterials loaded from Combeenation assets
Update from Babylon.js v5.6.0 to v5.21.0

Version 5.0.3

Released on 8 Sep 2022

Type Description
Provide Photo Domes and further environment options in the Spec
Exporting GLBs sometimes threw an unhandled exception

Version 5.0.2

Released on 27 Jun 2022

Type Description
Provide Babylon.js Inspector from CDN to decrease bundle size

Version 5.0.1

Released on 9 Jun 2022

Type Description
Basis for Augmented Reality (AR) due to newly introduced GLTF Export Manager
Add option for excluding certain meshes from Viewer.autofocusActiveCamera
Update to Babylon.js version 5
Multiple creation of lazy loaded variants
Console warning about shortestWay flag in animation framework GSAP

See details page for more in-depth descriptions.

Version 4.3.0

Released on 22 Mar 2022

Type Description
Integrate Babylon.js Inspector in development builds via Viewer.enableDebugLayer
Possibility to keep original materials on mutation
Adjust naming of cloned materials
Invalid fallback material for Paintable meshes
AnimationDefinition typing not defined in consumer projects

See details page for more in-depth descriptions.

Version 4.2.0

Released on 21 Feb 2022

Type Description
Viewer.autofocusActiveCamera now automatically adjusts camera clipping plane so that very small models don't get clipped when zooming in
Added alpha, beta and animation properties for AutofocusSettings

Version 4.1.0

Released on 7 Feb 2022

Type Description
Parameter.SCALING parameter is now applied relative to initial mesh scaling and in world coordinates
Viewer.moveActiveCameraTo doesn't work if animation definition is missing
"shortestWay" flag in AnimationDefinition doesn't work if alpha value is 0

There are breaking changes concerning the interpretation of transformation parameters (Parameter.ROTATION, Parameter.SCALING) between V3.1.2 - V4.0.0 and also V4.0.0 - V4.1.0, which will most likely change the way that your 3d model is shown in the viewer. This was required for fixing certain transformation bugs and to ensure consistency throughout these parameters. The updated transformation behaviour is described in the Transformation Parameters Docs.

Version 4.0.0

Released on 24 Jan 2022

Type Description
Parameter.ROTATION parameter is now applied relative to initial mesh rotation
Introduced lights & shadow configuration in Spec
Support font formats woff, ttf & otf for Paintables, beside the already supported format woff2
Added best practice example for changing custom material properties
Include further material extensions in viewer by default:
KHR_texture_basisu, KHR_materials_clearcoat, KHR_materials_sheen, KHR_materials_ior, KHR_materials_pbrSpecularGlossiness, KHR_materials_specular, KHR_materials_translucency, KHR_materials_transmission, KHR_materials_unlit, KHR_materials_variants
Camera avoids movements beyond 360° when moving to target position (see new flag shortestWay in AnimationDefinition)
Evaluation of visible meshes in Viewer.autofocusActiveCamera function
Blurry text paintables on transparent background
Text paintables which could not be drawn on certain IOS devices

Version 3.1.2

Released on 13 Jan 2022

Type Description
Update to latest Babylon.js version 4.2.1 to fix bug with shadows.
See this forums post for more details

Version 3.1.0

Released on 20 Oct 2021

Type Description
Fixed Element.getNode function, as it got broken with the latest performance improvements

Version 3.0.0

Released on 7 Oct 2021

Type Description
Performance improvements for bootstrapping process which is especially effective for specs/3d models with a very high number of elements and meshes. E.g. bootstrapping time of an example 3d model with a total of ~ 2600 meshes has been reduced from 70 seconds to 3 - 4 seconds.

Version 2.3.0

Released on 25 Aug 2021

Type Description
Viewer.reset has been fixed as it threw an unhandled exception in earlier versions

Version 2.2.0

Released on 18 Mai 2021

Type Description
Support for *.babylon files in addition to *.glb

Version 2.1.2

Released on 12 Mai 2021

Type Description
Fix issue which sometimes lead to multiple variant instances being shown when using with the exclusive flag

Version 2.1.1

Released on 5 Mai 2021

Type Description
Export EventEmitter class from viewer

Version 2.1.0

Released on 27 Apr 2021

Type Description
Basic support for GLBs with instanced meshes / linked duplicates
New convenience functions Viewer.getNode, Viewer.getMesh, VariantInstance.getElement, VariantInstance.getNode, VariantInstance.getMesh, VariantInstance.commitParameter, VariantInstance.commitParameters, Variant.getNode, Variant.getMesh & Element.getMesh for easier access to nodes & meshes

See details page for more in-depth descriptions.

Version 2.0.0

Released on 16 Mar 2021

Type Description
"Paintables" which allow graphics (like SVG) to be drawn on the 3d model
Convenience function Viewer.autofocusActiveCamera which automatically sets some sensible defaults for the current camera position & camera control properties like panning sensitivity etc.
Better documentation & simplified usage of events & parameters exposed by the Viewer
Some functions have been changed from "sync" to "asnyc" behavior

See details page for more in-depth descriptions.

Starting with this release, we'll be following SemVer more strictly. The main change is that we'll be incrementing the major version (e.g. 1.2.2 -> 2.0.0) every time a breaking change comes with the new version whereas until now we only incremented the minor version (e.g. 1.2.2 -> 1.3.0) on breaking changes and reserved major version bumps for releases with "big changes".

Version 1.2.2

Released on 12 Mar 2021

Type Description
Scene.clearColor is now set to transparent by default
Better explanation for some important types in docs.
E.g. see properties of StructureJson.

Version 1.2.1

Released on 2 Feb 2021

Type Description
Update to styles of release notes in docs

Version 1.2.0

Released on 2 Feb 2021

This release brings many simplifications and contains significant breaking changes:

Type Description
Update to latest Babylon.js version 4.2.0
Simplifications for type imports
Automatic conversion of colors to linear space
Spec driven camera positioning and animation API

See details page for more in-depth descriptions.

Version 1.1.2

Released on 25 Nov 2020

This release brings some simplifications for the specification syntax and contains breaking changes.

Type Description
Simplified definition for assets
Simplified definition for elements

See details page for more in-depth descriptions.

Generated using TypeDoc