CHANGE_LOG.md

xeokit-sdk Change Log

Find releases on npm: @xeokit/xeokit-sdk

2.2.0

Unreleased

Features

• General
  • Add commonjs build. #773 (@amir-arad)
• AngleMeasurementsPlugin, DistanceMeasurementsPlugin
  • Events + More flexible API for Distance & Angle Measurement Plugins. #751 (@Kurtil
• CityJSONLoaderPlugin
  • Create CityJSONLoaderPlugin. #781 (@xeolabs)
• GLTFLoaderPlugin
  • Double precision support for GLTFLoaderPlugin performance mode. #761 (@xeolabs)
• WebIFCLoaderPlugin
  • Create WebIFCLoaderPlugin. #759 (@xeolabs)
• LASLoaderPlugin
  • Create LASLoaderPlugin. #776 (@xeolabs)
• Configs
  • Create singleton Configs class for managing global configurations. #758 (@xeolabs)
• stats
  • Expose rendering stats via API. #779 (@xeolabs)

Fixes

• Node
  • Fix: trigger redraw on update to Node#origin. #787 (@xeolabs)
• PerformanceModel
  • Fix PerformanceModel#origin. #785 (@xeolabs)
• SkyBox
  • Set SkyBox unclippable. #746 (@dengzer1001
• Mesh
  • Fix occlusion behaviour for billboarded Meshes. #788 (@xeolabs)

Optimizations

• PerformanceModel
  • Optimize PerformanceModel finalize. #771 (@xeolabs)
• XKTLoaderPlugin
  • Optimization: selectively batch instanced geometries. #769 (@xeolabs)

Breaking Changes

• FastNavPlugin
  • Improved FastNavPlugin. #774 (@xeolabs)

Deprecations

• API change: rename "rtcCenter" as "origin". #752 (@xeolabs)

2.0.7

Oct 8, 2021

• XKTLoaderPlugin
  • Fix: fs Module not found. #745 (@xeolabs)

2.0.6

Oct 7, 2021

• NavCubePlugin
  • Make NavCubePlugin robust for custom Camera projection. #742 (@xeolabs)
• Viewer
  • Option to configure HTML element on which to listen for KB events. #741 (@xeolabs)

2.0.1

Oct 1, 2021

• XML3DLoaderPlugin
  • Fix XML3DLoaderPlugin error logging for unsupported 3DXML version. #661 (@xeolabs)

2.0.0

Sep 22, 2021

Multi language support, full-precision measurement, renderer features for more model types, various fixes.

• Release notes

Features

• General
  • Localization. #671 (@xeolabs)
  • Remove src directory from npm distribution. #688 (@xeolabs)
• AngleMeasurementPlugin
  • Full-precision angle measurement. #691 (@xeolabs)
• CameraControlPlugin
  • Extend CameraControl to fire "rightClick" event on long-touch. #716 (@xeolabs)
• DistanceMeasurementPlugin
  • Full-precision distance measurement. #692 (@xeolabs)
• FastNavPlugin
  • Make FastNavPlugin ignore simple click input. #697 (@xeolabs)
• Input
  • Make keyboard handlers listen to scene inputs instead of document events #707 (@Kurtil)
• PerformanceModel
  • Full-precision triangle picking for PerformanceModel. #690 (@xeolabs)
  • Support PerformanceModel point cloud intensities. #683 (@xeolabs)
  • PerformanceModel normals optional. #684 (@xeolabs)
• PropertySet, Property
  • Support property sets in XKT and metadata. #712 (@xeolabs)
• SkyBox
• Enhance Skybox effect - keep SkyBox in background. #720 (@whucj)
• SpriteMarker
  • New component: SpriteMarker. #727 (@xeolabs)
• XKTLoaderPlugin
  • Support XKT v9. #685 (@xeolabs)
  • Extend XKTLoaderPlugin to auto-generate default MetaModels. #658 (@xeolabs)

Fixes

• AxisGizmoPlugin
  • Fix AxisGizmoPlugin#destroy(). #704 (@xeolabs)
• NavCubePlugin
  • Fix perpendicularity of camera eye, look, up for NavCube. #687 (@xeolabs)
  • Fix view-fit distance for NavCube. #703 (@xeolabs)
• PerformanceModel
  • Fix coordinate quantization for zero-width boundaries. #709 (@xeolabs)
• Scene
  • Ignore logarithmicDepthBufferEnabled for ortho projection. #677 (@xeolabs)
• SectionPlane, FastNavPlugin
  • Fix SectionPlanes crash with FastNavPlugin on Windows/FF/Chrome. #678 (@xeolabs)
• Spinner
  • Clean spinner destroy. #673 (@xeolabs)
• Viewer
  • Fix Safari user agent detector in SAO. #681 (@juho-ylikyla)

1.9.0

May 14, 2021

Simpler and faster model loading, better code bundling, Safari/iOS robustness, SAO tweaks, rendering fixes.

• General
  • Build into library using Rollup. #638 (@incureforce, @xeolabs)
  • Serve library via JSDelivr CDN. #639 (@xeolabs)
• AmbientLight
  • Don't use intensity when using AmbientLight for WebGL clear color. #650 (@xeolabs)
• DistanceMeasurementPlugin
  • Distance measurement axes scale bugfix. #648 (@robin-pham)
• FastNavPlugin
  • Fix FastNavPlugin snapshot overlay alignment. #628 (@xeolabs)
• SAO
  • Disable SAO for Safari. #632 (@xeolabs)
  • Improve depth/SAO shader accuracy #633 (@xeolabs)
• PerformanceModel
  • Fix transparency bug revealed by IfcOpenShell simple_wall.ifc model. #641 (@xeolabs)
• XKTLoaderPlugin
  • Support XKT V8. #655 (@xeolabs)

Breaking changes

• AxisGizmoPlugin
  • AxisGizmoPlugin breaking change: require external canvas. #630 (@xeolabs)

1.8.2

April 22, 2021

Patches

• CameraControl
  • Fix sticky CameraControl rotation after dragging with left & right mouse buttons. #623 (@xeolabs)
  • Fix jumping around behavior with CameraControl middle mouse button. #571 (@xeolabs)
• FastNavPlugin
  • Ability to configure which quality rendering effects are enabled by FastNavPlugin. #625 (@xeolabs)
  • Fix FastNavPlugin fade for Firefox. #624 (@xeolabs)

1.8.0

April 21, 2021

Rendering, performance and QA improvements.

• General
  • Automatic visual tests. #501 (@xeolabs)
  • Improve examples UX. #617 (@xeolabs)
• AnnotationsPlugin
  • Add AnnotationsPlugin "annotationCreated" and "annotationDestroyed" events. #597 (@xeolabs)
• CameraControl
  • Fix CameraControl double-click. #602 (@xeolabs)
  • Touch picking support. #608 (@xeolabs)
• FastNavPlugin
  • FastNavPlugin - disables SAO and PBR while camera moving. #601 (@xeolabs)
• Mesh
  • Fix ambient lighting for PBR, Phong and Lambert shaders. #609 (@xeolabs)
• PointLight
  • Fix PointLight shading direction. #612 (@xeolabs)
• PointsMaterial
  • Set PointsMaterial#roundPoints true by default. #613 (@xeolabs)
• SAO
  • Make SAO automatically work for all far clipping plane distances #598. #598 (@xeolabs)
  • Fix halo artifacts in SAO blur. #594 (@xeolabs)
  • Fix PerformanceModel SAO shader breakage with logarithmic depth buffer. #592 (@xeolabs)
• SectionPlane, SectionPlanesPlugin
  • Show backfaces on solid meshes when sliced by SectionPlanes. #600 (@xeolabs)
• Scene
  • Improve default lighting. #605 (@xeolabs)
  • Option to include gizmos in canvas snapshots. #606 (@xeolabs)
• XKTLoaderPlugin, PerformanceModel
  • Fix missing backfaces. #596 (@xeolabs)
  • Improved edge coloring. #595 (@xeolabs)
  • Make XKTLoaderPlugin load most colors from model by default. #604 (@xeolabs)
  • Fix disappearing loading spinner for XKTLoaderPlugin. #603 (@xeolabs)
  • Fix picking for PerformanceModel with instanced "points" geometry. #619 (@xeolabs)

1.7.1

March 18, 2021

Faster rendering, XKT, STL and OBJ loading enhancements, lighting and camera control fixes.

• BIMServerPlugin
  • Remove BIMServer support. #547 (@xeolabs)
• CameraControl
  • Fix dollying exception for ortho and frustum projections. #547 (@xeolabs)
  • Fix canvas position for touch events on canvas with margins. #588 (@xeolabs)
  • Enable CameraControl follow pointer mode by default. #585 (@xeolabs)
• DirLight, PointLight
  • Fix lighting for PerformanceModel with instanced geometry. #545 (@xeolabs)
  • Minimal default lights for better performance. #543 (@xeolabs)
• DistanceMeasurementsPlugin
  • Fix disappearing DistanceMeasurement length label. #583 (@xeolabs)
• Scene
  • Fix surface picking option to not pick surface normal. #550 (@xeolabs)
• OBJLoaderPlugin
  • Extend OBJLoaderPlugin to support double-precision geometry. #580 (@xeolabs)
• STLLoaderPlugin
  • Extend STLLoaderPlugin to support double-precision geometry. #579 (@xeolabs)
  • Extend STLLoaderPlugin to load via optional, custom data source object. #578 (@xeolabs)
  • Extend STLLoaderPlugin to handle data directly, not only loaded from file. #572 (@xeolabs)
• TreeViewPlugin
  • Make TreeViewPlugin robust for invalid metadata. #572 (@xeolabs)
• XKTLoaderPlugin, PerformanceModel
  • Ability to cancel XKT model loading. #565 (@xeolabs)
  • Configurable max geometry batching size for PerformanceModel and XKTLoaderPlugin. #559 (@xeolabs)
  • Optimize PerformanceModel shaders. #542 (@xeolabs)
  • Support point clouds and line segments in PerformanceModel. #569 (@xeolabs)
  • Extend XKTLoaderPlugin to load XKT 1.0.0. #586 (@xeolabs)
  • Make XKTLoaderPlugin robust for empty arrays in XKT. #587 (@xeolabs)

1.6.0

January 19, 2021

• CameraControl
  • Smart Pivot. #533 (@xeolabs, @amoki)
  • Additional Camera properties to support un-projection. #530 (@xeolabs)
  • Pan/Rotate: mousemove event listen on document instead of canvas. #527 (@Kurtil)
  • Remove default CameraControl cursor style. #522 (@Kurtil)
• SectionPlanesPlugin
  • Make SectionPlanesPlugin overviewCanvasId optional. #524 (@Kurtil)
• TreeViewPlugin
  • Don't group TreeViewPlugin "types" hierarchies by IfcBuilding parents. #539 (@xeolabs)
• Viewer
  • Logarithmic depth buffer. #254 (@xeolabs)

Breaking changes

• Viewer
  • Option to enable or disable Entity#offset. #514 (@xeolabs)

1.5.3

December 23, 2020

• CameraControl
  • Orbit Camera#look when click-dragging on empty canvas in "orbit" mode. #503 (@xeolabs)
  • Apply followPointer when pointer over empty canvas. #502 (@xeolabs)
  • Apply followPointer in orthographic mode. #242 (@xeolabs)
  • Touch-pivot about Camera#look by default in orbit mode. #510 (@xeolabs)
  • Don't show CameraControl pivot position while panning. #509 (@xeolabs)
  • Fix unwanted "picked*" events from pinch-to-zoom on touch devices. #438 (@xeolabs)
• Entity
  • Fix Entity#offset for PerformanceModel instancing. #505 (@xeolabs)
• PerformanceModel
  • Fix PerformanceModel batched geometry opaque fill on Android 10. #507 (@xeolabs)
• StoreyViewsPlugin
  • Fix memory leak in StoreyViewsPlugin#destroy(). #499 (@xeolabs)

1.5.22

December 10, 2020

• BCFViewpointsPlugin
  • Simplify BCFViewpointsPlugin#getViewpoint(). #497 (@amoki)

1.5.21

December 9, 2020

• SectionPlane, SectionPlanesPlugin
  • Fix size of SectionPlane editing control (2). #480 (@xeolabs)

1.5.2

December 9, 2020

• CameraControl
  • Fix CameraControl zoom for ortho mode when followPointer false. #484 (@xeolabs)
  • Prevent middle mouse button from rotating the camera. #492 (@xeolabs)
  • Fix CameraControl pivot marker centering for custom size. #471 (@xeolabs)
• Entity
  • Improve rendering of translucent objects. #489 (@xeolabs)
• Entity, EdgeMaterial, EmphasisMaterial
  • Fix rendering of translucent edges. #490 (@xeolabs)
• SectionPlane, SectionPlanesPlugin
  • Fix SectionPlane slicing for transformed PerformanceModels. #494 (@xeolabs)
  • Fix SectionPlanesPlugin overview for orthographic projection. #145 (@xeolabs)
  • Fix size of SectionPlane editing control. #480 (@xeolabs)
• XKTLoaderPlugin, BCFViewpointsPlugin
  • Ability to load multiple copies of same IFC model without object ID clashes. #485 (@xeolabs)

1.5.14

November 25, 2020

• SectionPlane, SectionPlanesPlugin
  • Fix SectionPlane failure to clip certain objects. #481 (@xeolabs)

1.5.13

November 23, 2020

• SectionPlane, SectionPlanesPlugin
  • Fix rotation bug in SectionPlanesPlugin editing control. #479 (@xeolabs)

1.5.12

November 18, 2020

• SectionPlane, SectionPlanesPlugin
  • Fix case for which SectionPlane does not clip everything. #474 (@xeolabs)
• CameraControl
  • CameraControl picking robustness. #473 (@xeolabs)

1.5.11

November 13, 2020

• CameraControl
  • A better way to dolly CameraControl through objects. #472 (@xeolabs)

1.5.1

November 13, 2020

• CameraControl
  • Fix disappearing models after pivot from downward-looking direction. #289 (@xeolabs)
  • Fix disappearing models when CameraControl zooming in orbit mode. #468 (@xeolabs)
  • Improve CameraControl dollying through objects. #469 (@xeolabs)
  • Fix CameraControl first-person rotation and dolly for touch devices. #470 (@xeolabs)

1.5.0

November 10, 2020

• CameraControl
  • Improve CameraControl#followPointer behaviour for ortho projection. #462 (@xeolabs)
  • Fix CameraControl#dragRotationRate sensitivity. #466 (@xeolabs)

1.4.9

November 1, 2020

• Scene
  • Add Scene#getAABB() full-precision coordinate support. #457 (@xeolabs)

1.4.8

October 20, 2020

• PerformanceModel, Mesh, XKTLoaderPlugin
  • Support full-precision model geometry. #456 (@xeolabs)

1.4.7

October 28, 2020

• BCFViewpointsPlugin
  • Fix BCFViewpointsPlugin visibility update for composite elements. #452 (@xeolabs)
  • Don't return empty non-mandatory nodes. #454 (@xeolabs)
• TreeViewPlugin
  • Fix TreeViewPlugin node checked states. #455 (@xeolabs)
• Picking
  • Fix PickResult#worldPos for arbitrary ray picking. #447 (@xeolabs)

1.4.6

October 13, 2020

• SectionPlane, SectionPlanesPlugin
  • When flipping SectionPlanes, also flip the editing control. #439 (@xeolabs)
• BCFViewpointsPlugin
  • Fix setViewpoint colors. #444 (@amoki)

1.4.5

October 2, 2020

• Annotation, AnnotationsPlugin
  • Workaround for iOS14 bug affecting WebGL framebuffers. #439 (@xeolabs)

1.4.4

September 30, 2020

• ObjectsMemento
  • Support null Entity#colorize values in ObjectsMemento#saveobjects. #437 (@xeolabs)

1.4.3

September 28, 2020

• ContextMenu
  • Remove ellipsis from ContextMenu items with sub-menus. #435 (@xeolabs)

1.4.2

September 25, 2020

• Picking
  • Fix Scene#setObjectsPickable. #434 (@xeolabs)

1.4.1

September 10, 2020

• CameraControl
  • Optimize CameraControl proximity-dependent dolly speed. #429 (@xeolabs)
• ContextMenu
  • Add ContextMenu "shown" and "hidden" events. #425 (@xeolabs)
  • Add ContextMenu "hideOnMouseDown" option. #430 (@xeolabs)
• Viewer
  • Ability to disable Viewer anti-aliasing. #427 (@xeolabs)

1.3.91

August 24, 2020

• ContextMenu
  • Fix ContextMenu getEnabled() callbacks. #419 (@xeolabs)

1.3.9

August 24, 2020

• CameraControl
  • Improve CameraControl touch dolly/pan. #415 (@amoki)
• ContextMenu
  • Multi-level ContextMenu. #418 (@xeolabs)
• SectionPlane, SectionPlanesPlugin
  • Ability to flip direction of a SectionPlane. #417 (@xeolabs)

1.3.8

August 14, 2020

• BIMServerLoaderPlugin
  • Support BIMServer 1.5.182. #287 (@dimone-kun)
• CameraControl
  • Picking optimizations and fixes. #404 (@xeolabs)
  • Fix CameraControl dolly/rotate interference. #349 (@xeolabs)
  • Set CameraControl rotationInertia zero by default. #411 (@xeolabs)
  • Fix CameraControl "picked" event. #412 (@xeolabs)
• Entity
  • Fix Rendering glitch on Chrome/FF/Android. #402 (@xeolabs)
  • Fix shading breakage for Phong, metallic and specular materials. #410 (@xeolabs)

1.3.7

August 7, 2020

• CameraControl
  • Customizable CameraControl key mappings. #395 (@xeolabs)
  • Add CameraControl#touchDollyRate and simplify touch code. #392 (@amoki)
  • Prevent CameraControl touch rotation in plan view mode. #396 (@xeolabs)
  • Fix CameraControl followPointer for pinch-dollying on touch devices. #397 (@xeolabs)
  • CameraControl one-finger panning in planView mode on touch devices. #398 (@xeolabs)
• GLTFLoaderPlugin
  • Fix edgeThreshold config for GLTFLoaderPlugin and PerformanceModel. #385 (@xeolabs)
• Entity
  • Fix broken emphasis fill effect. #394 (@xeolabs)

1.3.6

July 16, 2020

• ImagePlane
  • Embed images in section planes and ground planes. #378 (@xeolabs)
• Scene
  • Fix doublePickedNothing event arguments. #365 (@xeolabs)
• Annotation
  • Create example of creating annotation at center of clicked object. #374 (@xeolabs)
• buildPlaneGeometry()
  • Flip buildPlaneGeometry() UVs horizontally. 7c8bfe5 (@xeolabs)
• Mesh
  • Fix Mesh emissive mapping. #379 (@xeolabs)
• Canvas
  • Fix blend alpha function for non-transparent canvas. #381 (@xeolabs)

1.3.53

July 4, 2020

• PerformanceModel
  • Fix PerformanceModel for uncompressed mesh/geometry positions. #370 (@xeolabs)
• CameraControl
  • Add pan rate config for touch. #363 (@juho-ylikyla)
  • Fix "Not initializing lastX and lastY leads to NaN". #357 (@Kurtil)
• ViewCullPlugin
  • Fix ViewCullPlugin: fix ObjectCullStates memory leak. #322 (@xeolabs)
• XKTLoaderPlugin
  • Fix XKTLoaderPlugin: MetaModel not destroyed with PerformanceModel. #360 (@xeolabs)

1.3.52

June 14, 2020

• PerformanceModel
  • Restore missing PerformanceModel#entityList. #320 (@xeolabs)

1.3.51

June 18, 2020

• ViewCullPlugin
  • View Culling. #322, #555 (@xeolabs)

1.3.5

June 17, 2020

• Entity
  • Dynamically movable Entity types. #208, #535 (@xeolabs)

1.3.43

June 16, 2020

• CameraControl
  • Don't fire "hover" events while right mouse button down. #335, 6accb69 (@xeolabs)

1.3.42

June 15, 2020

• XKTLoaderPlugin
  • Concurrent model loading. #347, #348 (@xeolabs)

1.3.41

June 15, 2020

• StoreyViewsPlugin
  • Fix flickering glitch with createStoreyMap(). #303, e4d6236 (@xeolabs)

1.3.4

June 15, 2020

• BCFViewpointsPlugin
  • Fix clipping planes and realWorldOffset #339, 6b2d070 (@amoki)
  • Save & load object colors and opacities #328, #345 0dd5efd (@amoki)
• CameraControl
  • Fix wrong entity on doublePick. #333, f1d5761 (@xeolabs)
  • Fix overly-sensitive touch rotation and dolly. #313, b98ddbb (@xeolabs)
  • Fix memory leak. 5436074 (@xeolabs)
• ContextMenu
  • Dynamic item titles #338, 8576910 (@xeolabs)
• Scene
  • Add Scene#opacityObjects #343, 37dc831 (@xeolabs)

1.3.3

June 8, 2020

• ContextMenu
  • Ignore clicks on disabled items. #331, 20e857f (@xeolabs)
  • Added ContextMenu#shown. 4f719ef (@xeolabs)
• CameraControl
  • Don't consume keyboard events on canvas. #337, 6c9c831 (@xeolabs)
  • Don't fire "hover" events while mouse down. #335, 5986a29 (@xeolabs)
  • Only fire "picked" on left click. #336, 4e6b103 (@xeolabs)
• BCFViewpointsPlugin
  • Fix clipping planes with yUp models and add option to reverse planes. #323 (@amoki)

1.3.2

June 8, 2020

• NavCubePlugin
  • Ignore right-click. 91badf2 (@xeolabs)

1.3.1

June 8, 2020

• MetaModel
  • Add creation/version/authoring properties. 6c154c7 (@xeolabs)

1.3.0

June 5, 2020

• Fix alpha blending for X-Ray. #318, 145ca17 (@xeolabs)
• Fix missing objects in large .XKT models. #315, 1b42a8 (@lasselaakkonen), (@xeolabs)
• Add PerformanceModel#entityList. #320, 184443d (@xeolabs)
• Fix CameraFlightAnimation; make it stop running animations when destroyed. #317, 42ebe1f (@xeolabs)
• Enhance CameraControl; add dollyMinSpeed and dollyProximityThreshold. baea53e (@xeolabs)

1.2.1

May 29, 2020

• PerformanceModel
  • Fix initializing BatchingLayer.colorsBuf. #314, 0f60018 (@xeolabs)

1.1.0

May 25, 2020

• IFCObjectDefaults
  • Fix types with no props not falling back on "DEFAULT". #276, b3e6ce3 (@xeolabs)
• CameraControl
  • Dolly rate proportional to target distance. #311, 0fe3c46 (@xeolabs)