Skip to content

Commit 3fbab26

Browse files
committed
makeOBBFromRegion docs
1 parent 5aa1d04 commit 3fbab26

File tree

6 files changed

+24
-3
lines changed

6 files changed

+24
-3
lines changed
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# EllipsoidTangentPlane
2+
3+
TBA
4+
5+
Function to convert a geospatial region to an oriented bounding box using ellipsoid math. Computes an `OrientedBoundingBox` that bounds a region on the surface of the WGS84 ellipsoid. There are no guarantees about the orientation of the bounding box.
6+
7+
Parameters:
8+
9+
- `region: number[]` - The cartographic region (west, south, east, north, minimum height, maximum height) on the surface of the ellipsoid.
10+
11+
Returns:
12+
13+
- `OrientedBoundingBox` - The modified result parameter or a new OrientedBoundingBox instance if none was provided.
32.2 KB
Loading

docs/modules/geospatial/api-reference/make-obb-from-region.md

Whitespace-only changes.

docs/table-of-contents.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@
113113
"items": [
114114
"modules/geospatial/README",
115115
"modules/geospatial/api-reference/ellipsoid",
116+
"modules/geospatial/api-reference/ellipsoid-tangent-plane",
116117
"modules/geospatial/api-reference/helpers"
117118
]
118119
},

docs/whats-new.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,14 @@ Goal: Stronger type guarantees for math classes via the new sized array types.
5555

5656
Release Date: TBD, maybe Q1, 2024.
5757

58-
Goal: Minor functionality additions, as required.
58+
Goals:
59+
60+
- Functionality additions to improve 3D Tiles support in loaders.gl.
61+
62+
**`@math.gl/geopspatial`**
63+
64+
- `makeOBBFromRegion()` - New function that creates a cartesian oriented bounding box from a geospatial region.
65+
- `EllipsoidTangentPlane` - New helper class for doing math on the ellipsoid surface.
5966

6067
## v4.1
6168

modules/geospatial/src/make-obb-from-region.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ const VECTOR3_UNIT_Z = new Vector3(0, 0, 1);
4949
* Computes an OrientedBoundingBox that bounds a region on the surface of the WGS84 ellipsoid.
5050
* There are no guarantees about the orientation of the bounding box.
5151
*
52-
* @param {number[]} region The cartographic region ([west, south, east, north, minimum height, maximum height])
52+
* @param region The cartographic region ([west, south, east, north, minimum height, maximum height])
5353
* on the surface of the ellipsoid.
54-
* @returns {OrientedBoundingBox} The modified result parameter or a new OrientedBoundingBox instance if none was provided.
54+
* @returns The modified result parameter or a new OrientedBoundingBox instance if none was provided.
5555
*/
5656
// eslint-disable-next-line max-statements
5757
export function makeOBBfromRegion(region: number[]): OrientedBoundingBox {

0 commit comments

Comments
 (0)