From b29c8ea1c265cef921c95aac8c18ea11a6700561 Mon Sep 17 00:00:00 2001 From: Anne Gropler Date: Mon, 15 Jan 2024 09:50:46 +0100 Subject: [PATCH] add info about orientation default --- CHANGES.md | 1 + packages/engine/Source/DataSources/Entity.js | 5 +++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 1a442eb7b209..6e4db77aa400 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -24,6 +24,7 @@ - Fixed a bug where transforms that had been defined with the `KHR_texture_transform` extension had not been applied to Property Textures in `EXT_structural_metadata`. [#11708](https://github.com/CesiumGS/cesium/issues/11708) - Fixed improper scaling of ellipsoid inner radii in 3D mode. [#11656](https://github.com/CesiumGS/cesium/issues/11656) and [#10245](https://github.com/CesiumGS/cesium/issues/10245) - Fixed a bug where transforms that had been defined with the `KHR_texture_transform` extension had not been applied to Feature ID Textures in `EXT_mesh_features`. [#11731](https://github.com/CesiumGS/cesium/issues/11731) +- Fixed `Entity` documentation for `orientation` property. [#11762](https://github.com/CesiumGS/cesium/pull/11762) #### @cesium/widgets diff --git a/packages/engine/Source/DataSources/Entity.js b/packages/engine/Source/DataSources/Entity.js index 352417581782..e1ab69a85587 100644 --- a/packages/engine/Source/DataSources/Entity.js +++ b/packages/engine/Source/DataSources/Entity.js @@ -71,7 +71,7 @@ function createPropertyTypeDescriptor(name, Type) { * @property {boolean} [show] A boolean value indicating if the entity and its children are displayed. * @property {Property | string} [description] A string Property specifying an HTML description for this entity. * @property {PositionProperty | Cartesian3} [position] A Property specifying the entity position. - * @property {Property} [orientation] A Property specifying the entity orientation. + * @property {Property} [orientation=Transforms.eastNorthUpToFixedFrame(position)] A Property specifying the entity orientation in respect to Earth-fixed-Earth-centered (ECEF). If undefined, east-north-up at entity position is used. * @property {Property} [viewFrom] A suggested initial offset for viewing this object. * @property {Entity} [parent] A parent entity to associate with this entity. * @property {BillboardGraphics | BillboardGraphics.ConstructorOptions} [billboard] A billboard to associate with this entity. @@ -413,7 +413,8 @@ Object.defineProperties(Entity.prototype, { */ tileset: createPropertyTypeDescriptor("tileset", Cesium3DTilesetGraphics), /** - * Gets or sets the orientation. + * Gets or sets the orientation in respect to Earth-fixed-Earth-centered (ECEF). + * Defaults to east-north-up at entity position. * @memberof Entity.prototype * @type {Property|undefined} */