Skip to content

Commit ce648e8

Browse files
committed
Update API.md
1 parent 50533f9 commit ce648e8

1 file changed

Lines changed: 55 additions & 4 deletions

File tree

src/three/plugins/API.md

Lines changed: 55 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -125,13 +125,30 @@ after modifying properties such as `colorMode`, `displayBoxBounds`, or
125125
so changes can be reflected.
126126

127127

128+
## ImageFormatPlugin
129+
130+
Base plugin class for tiled image sources with a consistent size and resolution per
131+
tile. Subclasses provide a concrete `imageSource` and override `getUrl` and
132+
`createBoundingVolume` as needed.
133+
134+
135+
### .constructor
136+
137+
```js
138+
constructor(
139+
{
140+
imageSource = null: Object,
141+
center = false: boolean,
142+
useRecommendedSettings = true: boolean,
143+
}
144+
)
145+
```
146+
128147
## DeepZoomImagePlugin
129148
149+
_extends [`ImageFormatPlugin`](#imageformatplugin)_
150+
130151
Plugin that renders a Deep Zoom Image (DZI) as a 3D Tiles-compatible tiled texture.
131-
Only a single embedded "Image" is supported. Pass the `.dzi` XML file URL as the
132-
`TilesRenderer` URL.
133-
See the [Deep Zoom specification](https://learn.microsoft.com/en-us/previous-versions/windows/silverlight/dotnet-windows-silverlight/cc645077(v=vs.95))
134-
and [OpenSeadragon](https://openseadragon.github.io).
135152
136153
137154
### .constructor
@@ -146,6 +163,26 @@ constructor(
146163
)
147164
```
148165

166+
## EllipsoidProjectionTilesPlugin
167+
168+
_extends [`ImageFormatPlugin`](#imageformatplugin)_
169+
170+
Extension of `ImageFormatPlugin` that projects tiled images onto ellipsoidal
171+
(globe-surface) geometry in addition to the default planar layout. Set
172+
`options.shape = 'ellipsoid'` to enable globe projection.
173+
174+
175+
### .constructor
176+
177+
```js
178+
constructor(
179+
{
180+
shape = 'planar': string,
181+
endCaps = true: boolean,
182+
}
183+
)
184+
```
185+
149186
## GLTFCesiumRTCExtension
150187
151188
GLTF loader plugin that applies the [CESIUM_RTC](https://github.com/KhronosGroup/glTF/blob/main/extensions/1.0/Vendor/CESIUM_RTC/README.md)
@@ -330,6 +367,8 @@ Disposes all textures used by this instance.
330367

331368
## OBBRegion
332369

370+
_extends [`BaseRegion`](#baseregion)_
371+
333372
An oriented bounding-box load region. Only tiles that intersect `obb` are loaded.
334373

335374

@@ -368,6 +407,8 @@ constructor(
368407

369408
## RayRegion
370409

410+
_extends [`BaseRegion`](#baseregion)_
411+
371412
A ray-based load region. Only tiles that intersect `ray` are loaded.
372413

373414

@@ -428,6 +469,8 @@ with X facing west and Z facing north.
428469

429470
## SphereRegion
430471

472+
_extends [`BaseRegion`](#baseregion)_
473+
431474
A spherical load region. Only tiles that intersect `sphere` are loaded.
432475

433476

@@ -659,6 +702,8 @@ constructor(
659702

660703
## TMSTilesPlugin
661704

705+
_extends [`EllipsoidProjectionTilesPlugin`](#ellipsoidprojectiontilesplugin)_
706+
662707
Plugin that renders TMS (Tile Map Service) image tiles projected onto 3D tile geometry.
663708
See the [TMS specification](https://wiki.osgeo.org/wiki/Tile_Map_Service_Specification).
664709

@@ -741,6 +786,8 @@ constructor( manager: LoadingManager )
741786

742787
## WMSTilesPlugin
743788

789+
_extends [`EllipsoidProjectionTilesPlugin`](#ellipsoidprojectiontilesplugin)_
790+
744791
Plugin that renders WMS (Web Map Service) image tiles projected onto 3D tile geometry.
745792

746793

@@ -892,6 +939,8 @@ This method:
892939
893940
## WMTSTilesPlugin
894941
942+
_extends [`EllipsoidProjectionTilesPlugin`](#ellipsoidprojectiontilesplugin)_
943+
895944
Plugin that renders WMTS (Web Map Tile Service) image tiles projected onto 3D tile
896945
geometry. Pass a parsed capabilities object from `WMTSCapabilitiesLoader` or provide
897946
a URL template directly.
@@ -913,6 +962,8 @@ constructor(
913962

914963
## XYZTilesPlugin
915964

965+
_extends [`EllipsoidProjectionTilesPlugin`](#ellipsoidprojectiontilesplugin)_
966+
916967
Plugin that renders XYZ/Slippy-map image tiles (e.g. OpenStreetMap) projected onto
917968
3D tile geometry. See the [Slippy map tilenames specification](https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames).
918969

0 commit comments

Comments
 (0)