From 913f08996b908110d0edb63508d9de985bfcd9c8 Mon Sep 17 00:00:00 2001 From: Jonathan Lurie Date: Wed, 25 Sep 2024 17:01:12 +0200 Subject: [PATCH] doc --- readme.md | 6 +++--- src/SceneLayer.ts | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/readme.md b/readme.md index d7a53b7..870178b 100644 --- a/readme.md +++ b/readme.md @@ -164,7 +164,7 @@ enum SourceOrientation { Y_UP = 2, /** - * The mesh was originaly created in a 3D space that uses the z axis as the up direction + * The mesh was originaly created in a 3D space that uses the Z axis as the up direction */ Z_UP = 3, }; @@ -263,14 +263,14 @@ Adds a ThreeJS mesh/Group/Object3D, given a mesh ID (will throw if not unique) a * visible: `true` - `.modifyMesh(id: string, options: MeshOptions)` -Modify the settings of a mesh (scale, lntLat, etc.) +Modify the settings of a mesh (scale, lntLat, etc.) ℹ️ Only the settings provided in the option object will be updated, the others will be left as they already are. - `.cloneMesh(sourceId: string, id: string, options: MeshOptions)` Clones a mesh that has a given ID (`sourceId`) and create another one with a new ID (`id`). The provided options will overwrite the settings of the source mesh. - `.addPointLight(id: string, options: PointLightOptions = {})` -Adds a point light with a unique ID (will throw if not unique) and some options. +Adds a point light with a unique ID (will throw if not unique) and some options. ℹ️ By default, the light will have some settings (if not overwritten by the options): * lngLat: `[0, 0]` (null island) * altitude: `2_000_000` meters diff --git a/src/SceneLayer.ts b/src/SceneLayer.ts index 59c76d3..f9149a0 100644 --- a/src/SceneLayer.ts +++ b/src/SceneLayer.ts @@ -56,7 +56,7 @@ export enum SourceOrientation { Y_UP = 2, /** - * The mesh was originaly created in a 3D space that uses the z axis as the up direction + * The mesh was originaly created in a 3D space that uses the Z axis as the up direction */ Z_UP = 3, };