Releases: CesiumGS/cesium-unreal
Cesium for Unreal v1.20.0 (Unreal Engine 4)
2022-12-02
This release includes support for Unreal Engine v4.26 and v4.27 for Windows, Linux, macOS, Android, and iOS. Please select the appropriate ZIP for your version. For Unreal Engine 5, please see Cesium for Unreal v1.20.0 (Unreal Engine 5).
This is the last release that will support Unreal Engine v4.26. Starting in the next release, in January 2023, UE 4.26 will no longer be supported. You may continue to use old versions of Cesium for Unreal in UE 4.26, but we recommend upgrading your UE version as soon as possible in order to continue receiving the latest updates.
Fixes 🔧
- Fixed a bug that caused Cesium3DTilesets to fail to disconnect from CesiumGeoreference notifications. It could cause problems when changing to a different georeference instance.
In addition to the above, this release updates cesium-native from v0.21.0 to v0.21.1. See the changelog for a complete list of changes in cesium-native.
Cesium for Unreal v1.19.0 (Unreal Engine 5)
2022-11-01
This release includes support for Unreal Engine v5.0 for Windows, Linux, macOS, Android, and iOS. For Unreal Engine 4, please see Cesium for Unreal v1.19.0 (Unreal Engine 4).
Breaking Changes 📣
- Removed some poorly named and unreliable functions on the
CesiumGeoreference
:ComputeEastNorthUp
,TransformRotatorEastNorthUpToUnreal
, andTransformRotatorUnrealToEastNorthUp
. These functions have been replaced with reliable "EastSouthUp" counterparts.
Additions 🎉
- Added asynchronous texture creation where supported by the graphics API. This offloads a frequent render thread bottleneck to background loading threads.
- Improved synchronous texture creation by eliminating a main-thread memcpy, for cases where asynchronous texture creation is not supported.
- Added throttling of the main-thread part of loading for glTFs.
- Added throttling for tile cache unloads on the main thread.
- Added a prototype developer feature enabling Unreal Insights tracing into Cesium Native. This helps us investigate end-to-end performance in a deeper and more precise manner.
Fixes 🔧
- Significantly reduced frame-rate dips during asynchronous tile loading by eliminating thread pool monopolization by Cesium tasks.
- Improved the tile destruction sequence by allowing it to defer being destroyed to future frames if it is waiting on asynchronous work to finish. Previously we would essentially block the main thread waiting for tiles to become ready for destruction.
In addition to the above, this release updates cesium-native from v0.20.0 to v0.21.0. See the changelog for a complete list of changes in cesium-native.
Cesium for Unreal v1.19.0 (Unreal Engine 4)
2022-11-01
This release includes support for Unreal Engine v4.26 and v4.27 for Windows, Linux, macOS, Android, and iOS. Please select the appropriate ZIP for your version. For Unreal Engine 5, please see Cesium for Unreal v1.19.0 (Unreal Engine 5).
Breaking Changes 📣
- Removed some poorly named and unreliable functions on the
CesiumGeoreference
:ComputeEastNorthUp
,TransformRotatorEastNorthUpToUnreal
, andTransformRotatorUnrealToEastNorthUp
. These functions have been replaced with reliable "EastSouthUp" counterparts.
Additions 🎉
- Added asynchronous texture creation where supported by the graphics API. This offloads a frequent render thread bottleneck to background loading threads.
- Improved synchronous texture creation by eliminating a main-thread memcpy, for cases where asynchronous texture creation is not supported.
- Added throttling of the main-thread part of loading for glTFs.
- Added throttling for tile cache unloads on the main thread.
- Added a prototype developer feature enabling Unreal Insights tracing into Cesium Native. This helps us investigate end-to-end performance in a deeper and more precise manner.
Fixes 🔧
- Significantly reduced frame-rate dips during asynchronous tile loading by eliminating thread pool monopolization by Cesium tasks.
- Improved the tile destruction sequence by allowing it to defer being destroyed to future frames if it is waiting on asynchronous work to finish. Previously we would essentially block the main thread waiting for tiles to become ready for destruction.
In addition to the above, this release updates cesium-native from v0.20.0 to v0.21.0. See the changelog for a complete list of changes in cesium-native.
Cesium for Unreal v1.18.0 (Unreal Engine 5)
2022-10-03
This release includes support for Unreal Engine v5.0 for Windows, Linux, macOS, Android, and iOS. For Unreal Engine 4, please see Cesium for Unreal v1.18.0 (Unreal Engine 4).
Additions 🎉
- Improved the dithered transition between levels-of-detail, making it faster and eliminating depth fighting.
- Added an option to
Cesium3DTileset
to change the tileset's mobility, rather than always using Static mobility. This allows users to make a tileset movable at runtime, if needed. ACesiumCreditSystem
now has a Blueprint-accessible property for theCreditsWidget
. This is useful to, for example, move the credits to an in-game billboard rather than a 2D overlay.
Fixes 🔧
- Fixed a bug where collision settings were only applied to the first primitive in a glTF.
- Fixed a bug where the Screen Credits Decorator prevented the Rich Text Block Image Decorator from working.
In addition to the above, this release updates cesium-native from v0.19.0 to v0.20.0. See the changelog for a complete list of changes in cesium-native.
Cesium for Unreal v1.18.0 (Unreal Engine 4)
2022-10-03
This release includes support for Unreal Engine v4.26 and v4.27 for Windows, Linux, macOS, Android, and iOS. Please select the appropriate ZIP for your version. For Unreal Engine 5, please see Cesium for Unreal v1.18.0 (Unreal Engine 5).
Additions 🎉
- Improved the dithered transition between levels-of-detail, making it faster and eliminating depth fighting.
- Added an option to
Cesium3DTileset
to change the tileset's mobility, rather than always using Static mobility. This allows users to make a tileset movable at runtime, if needed. ACesiumCreditSystem
now has a Blueprint-accessible property for theCreditsWidget
. This is useful to, for example, move the credits to an in-game billboard rather than a 2D overlay.
Fixes 🔧
- Fixed a bug where collision settings were only applied to the first primitive in a glTF.
- Fixed a bug where the Screen Credits Decorator prevented the Rich Text Block Image Decorator from working.
In addition to the above, this release updates cesium-native from v0.19.0 to v0.20.0. See the changelog for a complete list of changes in cesium-native.
Cesium for Unreal v1.17.0 (Unreal Engine 5)
v1.17.0 - 2022-09-01
This release includes support for Unreal Engine v5.0 for Windows, Linux, macOS, Android, and iOS. For Unreal Engine 4, please see Cesium for Unreal v1.17.0 (Unreal Engine 4).
Additions 🎉
- The translucent parts of 3D Tiles are now correctly rendered as translucent. In addition, a new
TranslucentMaterial
property onCesium3DTileset
allows a custom material to be used to render these translucent portions. - Added a
Rendering -> Use Lod Transitions
option onCesium3DTileset
to smoothly dither between levels-of-detail rather than switching abruptly. - Added support for loading WebP images inside glTFs and raster overlays. WebP textures can be provided directly in a glTF texture or in the
EXT_texture_webp
extension.
Fixes 🔧
- Fixed a bug that prevented fractional DPI scaling from being properly taken into account. Instead, it would scale by the next-smallest integer.
- Cesium for Unreal now only uses Editor viewports for tile selection if they are visible, real-time, and use a perspective projection. Previously, any viewport with a valid size was used, which could lead to tiles being loaded and rendered unnecessarily.
- Fixed a bug that caused tiles to disappear when the Editor viewport was in Orbit mode.
- Fixed a bug in the Globe Anchor Component that prevented changing/resetting the actor transform in the details panel.
- Reduced the size of physics meshes by only copying UV data if "Support UV from Hit Results" is enabled in the project settings.
- Fixed a bug - in Unreal Engine 5 only - where a LineTrace would occasionally fail to collide with tiles at certain levels-of-detail.
- Fixed a crash that could occur while running on a dedicated server, caused by attempting to add the credits widget to the viewport.
In addition to the above, this release updates cesium-native from v0.18.1 to v0.19.0. See the changelog for a complete list of changes in cesium-native.
Cesium for Unreal v1.17.0 (Unreal Engine 4)
v1.17.0 - 2022-09-01
This release includes support for Unreal Engine v4.26 and v4.27 for Windows, Linux, macOS, Android, and iOS. Please select the appropriate ZIP for your version. For Unreal Engine 5, please see Cesium for Unreal v1.17.0 (Unreal Engine 5).
Additions 🎉
- The translucent parts of 3D Tiles are now correctly rendered as translucent. In addition, a new
TranslucentMaterial
property onCesium3DTileset
allows a custom material to be used to render these translucent portions. - Added a
Rendering -> Use Lod Transitions
option onCesium3DTileset
to smoothly dither between levels-of-detail rather than switching abruptly. - Added support for loading WebP images inside glTFs and raster overlays. WebP textures can be provided directly in a glTF texture or in the
EXT_texture_webp
extension.
Fixes 🔧
- Fixed a bug that prevented fractional DPI scaling from being properly taken into account. Instead, it would scale by the next-smallest integer.
- Cesium for Unreal now only uses Editor viewports for tile selection if they are visible, real-time, and use a perspective projection. Previously, any viewport with a valid size was used, which could lead to tiles being loaded and rendered unnecessarily.
- Fixed a bug that caused tiles to disappear when the Editor viewport was in Orbit mode.
- Fixed a bug in the Globe Anchor Component that prevented changing/resetting the actor transform in the details panel.
- Reduced the size of physics meshes by only copying UV data if "Support UV from Hit Results" is enabled in the project settings.
- Fixed a bug - in Unreal Engine 5 only - where a LineTrace would occasionally fail to collide with tiles at certain levels-of-detail.
- Fixed a crash that could occur while running on a dedicated server, caused by attempting to add the credits widget to the viewport.
In addition to the above, this release updates cesium-native from v0.18.1 to v0.19.0. See the changelog for a complete list of changes in cesium-native.
Cesium for Unreal v1.16.2 (Unreal Engine 5)
v1.16.2 - 2022-08-04
This release includes support for Unreal Engine v5.0 for Windows, Linux, macOS, Android, and iOS. Please select the appropriate ZIP for your version. For Unreal Engine 4, please see Cesium for Unreal v1.16.2 (Unreal Engine 4).
Fixes 🔧
- Fixed a bug that caused a crash in Unreal Engine 4.26 when enabling the experimental tileset occlusion culling feature.
In addition to the above, this release updates cesium-native from v0.18.0 to v0.18.1. See the changelog for a complete list of changes in cesium-native.
Cesium for Unreal v1.16.2 (Unreal Engine 4)
v1.16.2 - 2022-08-04
This release includes support for Unreal Engine v4.26 and v4.27 for Windows, Linux, macOS, Android, and iOS. Please select the appropriate ZIP for your version. For Unreal Engine 5, please see Cesium for Unreal v1.16.2 (Unreal Engine 5).
Fixes 🔧
- Fixed a bug that caused a crash in Unreal Engine 4.26 when enabling the experimental tileset occlusion culling feature.
In addition to the above, this release updates cesium-native from v0.18.0 to v0.18.1. See the changelog for a complete list of changes in cesium-native.
Cesium for Unreal v1.16.1 (Unreal Engine 5)
v1.16.1 - 2022-08-01
This release includes support for Unreal Engine v5.0 for Windows, Linux, macOS, Android, and iOS. For Unreal Engine 4, please see Cesium for Unreal v1.16.1 (Unreal Engine 4).
Fixes 🔧
- Fixed a bug that could cause a crash when using thumbnail rendering, notably on the Project Settings panel in UE5.
- More fully disabled the occlusion culling system when the project-level feature flag is disabled.
v1.16.0 - 2022-08-01
Breaking Changes 📣
- Cesium for Unreal now automatically scales the selected 3D Tiles level-of-detail by the viewport client's
GetDPIScale
, meaning that devices with high-DPI displays will get less detail and higher performance than they did in previous versions. This can be disabled - and the previous behavior restored - by disabling the "Scale Level Of Detail By DPI" in Project Settings under Plugins -> Cesium, or by changing the "Apply Dpi Scaling" property on individual Tileset Actors.
Additions 🎉
- Added an experimental feature that uses Occlusion Culling to avoid refining tiles that are occluded by other content in the level. Currently this must be explicitly enabled from the Plugins -> Cesium section of Project Settings. We expect to enable it by default in a future release.
- Added options in
ACesium3DTileset
to control occlusion culling and turn it off if necessary. UCesiumGltfPrimitiveComponent
now has static mobility, allowing it to take advantage of several rendering optimizations only available for static objects.- Added an
OnTilesetLoaded
even that is invoked when the current tileset has finished loading. It is available from C++ and Blueprints. - Added a
GetLoadProgress
method that returns the current load percentage of the tileset. It is available from C++ and Blueprints. - Added Blueprint-accessible callback
OnFlightComplete
for when Dynamic Pawn completes flight. - Added Blueprint-accessible callback
OnFlightInterrupt
for when Dynamic Pawn's flying is interrupted.
Fixes 🔧
- When the Cesium ion access or login token is modified and stored in a config file that is under source code control, it will now be checked out before it is saved. Previously, token changes could be silently ignores with a source code control system that marks files read-only, such as Perforce.
- Fixed a bug that prevented credit images from appearing in UE5.
- Fixed a credit-related crash that occur when switching levels.
In addition to the above, this release updates cesium-native from v0.17.0 to v0.18.0. See the changelog for a complete list of changes in cesium-native.