@realsee/five 6.7.2 → 6.8.0-alpha.1

package/docs_markdown/five/classes/Tile3D.md

@@ -0,0 +1,1287 @@
+[**如视 Five SDK**](../../README.md)
+
+***
+
+[如视 Five SDK](../../modules.md) / [five](../README.md) / Tile3D
+
+# Class: Tile3D
+
+Defined in: lib/five/model/tile3d/index.ts:112
+
+## Extends
+
+- `Object3D`
+
+## Extended by
+
+- [`ViewLayer`](../interfaces/ViewLayer.md)
+
+## Constructors
+
+### Constructor
+
+> **new Tile3D**(`tilesetHeader`, `options`): `Tile3D`
+
+Defined in: lib/five/model/tile3d/index.ts:152
+
+#### Parameters
+
+##### tilesetHeader
+
+[`TilesetHeader`](../interfaces/TilesetHeader.md)
+
+##### options
+
+[`Tile3DOptions`](../interfaces/Tile3DOptions.md)
+
+#### Returns
+
+`Tile3D`
+
+#### Overrides
+
+`THREE.Object3D.constructor`
+
+## Properties
+
+### autoRefine
+
+> **autoRefine**: `boolean`
+
+Defined in: lib/five/model/tile3d/index.ts:139
+
+***
+
+### boundingBox
+
+> **boundingBox**: `Box3`
+
+Defined in: lib/five/model/tile3d/index.ts:138
+
+***
+
+### coordinateSystem
+
+> **coordinateSystem**: [`TileCoordinateSystem`](../interfaces/TileCoordinateSystem.md)
+
+Defined in: lib/five/model/tile3d/index.ts:134
+
+***
+
+### error?
+
+> `optional` **error**: `Error`
+
+Defined in: lib/five/model/tile3d/index.ts:119
+
+meta 信息加载错误
+
+***
+
+### fetcher
+
+> **fetcher**: [`Fetcher`](Fetcher.md)
+
+Defined in: lib/five/model/tile3d/index.ts:130
+
+***
+
+### frameNumber
+
+> **frameNumber**: `number`
+
+Defined in: lib/five/model/tile3d/index.ts:124
+
+更新帧次数
+
+***
+
+### groundHeight
+
+> **groundHeight**: `number`
+
+Defined in: lib/five/model/tile3d/index.ts:133
+
+***
+
+### light
+
+> **light**: `boolean`
+
+Defined in: lib/five/model/tile3d/index.ts:128
+
+***
+
+### loaded
+
+> **loaded**: `boolean`
+
+Defined in: lib/five/model/tile3d/index.ts:142
+
+***
+
+### onError()?
+
+> `optional` **onError**: (`error`) => `void`
+
+Defined in: lib/five/model/tile3d/index.ts:121
+
+meta 信息加载错误
+
+#### Parameters
+
+##### error
+
+`Error`
+
+#### Returns
+
+`void`
+
+***
+
+### parameter
+
+> **parameter**: [`Parameter`](Parameter.md)
+
+Defined in: lib/five/model/tile3d/index.ts:126
+
+***
+
+### parent
+
+> **parent**: [`Model`](Model.md)
+
+Defined in: lib/five/model/tile3d/index.ts:116
+
+Object's parent in the scene graph.
+
+#### Overrides
+
+`THREE.Object3D.parent`
+
+***
+
+### refined
+
+> **refined**: `boolean`
+
+Defined in: lib/five/model/tile3d/index.ts:140
+
+***
+
+### refineProgress
+
+> **refineProgress**: \[`number`, `number`\]
+
+Defined in: lib/five/model/tile3d/index.ts:141
+
+***
+
+### search
+
+> **search**: `string`
+
+Defined in: lib/five/model/tile3d/index.ts:131
+
+***
+
+### tileset
+
+> **tileset**: [`Tileset`](Tileset.md)
+
+Defined in: lib/five/model/tile3d/index.ts:136
+
+***
+
+### type
+
+> **type**: `"point_cloud"` \| `"mesh"`
+
+Defined in: lib/five/model/tile3d/index.ts:114
+
+#### Overrides
+
+`THREE.Object3D.type`
+
+***
+
+### upAxis
+
+> **upAxis**: `string`
+
+Defined in: lib/five/model/tile3d/index.ts:129
+
+## Accessors
+
+### coordinates
+
+#### Get Signature
+
+> **get** **coordinates**(): `string`
+
+Defined in: lib/five/model/tile3d/index.ts:834
+
+##### Deprecated
+
+使用 localToLla(new THREE.Vector()) 替代
+
+##### Returns
+
+`string`
+
+***
+
+### loadSiblings
+
+#### Get Signature
+
+> **get** **loadSiblings**(): `boolean`
+
+Defined in: lib/five/model/tile3d/index.ts:1008
+
+##### Deprecated
+
+use `.parameter.loadSiblings` `.parameter.set('loadSiblings', loadSiblings)` instend
+
+##### Returns
+
+`boolean`
+
+#### Set Signature
+
+> **set** **loadSiblings**(`value`): `void`
+
+Defined in: lib/five/model/tile3d/index.ts:1018
+
+##### Parameters
+
+###### value
+
+`boolean`
+
+##### Returns
+
+`void`
+
+***
+
+### maxGeometricError
+
+#### Get Signature
+
+> **get** **maxGeometricError**(): `number`
+
+Defined in: lib/five/model/tile3d/index.ts:936
+
+##### Deprecated
+
+use `.parameter.maxGeometricError` `.parameter.set('maxGeometricError', maxGeometricError)` instend
+
+##### Returns
+
+`number`
+
+#### Set Signature
+
+> **set** **maxGeometricError**(`value`): `void`
+
+Defined in: lib/five/model/tile3d/index.ts:946
+
+##### Parameters
+
+###### value
+
+`number`
+
+##### Returns
+
+`void`
+
+***
+
+### maxLevelOfDetail
+
+#### Get Signature
+
+> **get** **maxLevelOfDetail**(): `number`
+
+Defined in: lib/five/model/tile3d/index.ts:900
+
+##### Deprecated
+
+use `.parameter.maxLevelOfDetail` `.parameter.set('maxLevelOfDetail', maxLevelOfDetail)` instend
+
+##### Returns
+
+`number`
+
+#### Set Signature
+
+> **set** **maxLevelOfDetail**(`value`): `void`
+
+Defined in: lib/five/model/tile3d/index.ts:910
+
+##### Parameters
+
+###### value
+
+`number`
+
+##### Returns
+
+`void`
+
+***
+
+### maxMemoryUsage
+
+#### Get Signature
+
+> **get** **maxMemoryUsage**(): `number`
+
+Defined in: lib/five/model/tile3d/index.ts:1026
+
+##### Deprecated
+
+use `.parameter.maxMemoryUsage` `.parameter.set('maxMemoryUsage', maxMemoryUsage)` instend
+
+##### Returns
+
+`number`
+
+#### Set Signature
+
+> **set** **maxMemoryUsage**(`value`): `void`
+
+Defined in: lib/five/model/tile3d/index.ts:1036
+
+##### Parameters
+
+###### value
+
+`number`
+
+##### Returns
+
+`void`
+
+***
+
+### maxRequests
+
+#### Get Signature
+
+> **get** **maxRequests**(): `number`
+
+Defined in: lib/five/model/tile3d/index.ts:1044
+
+##### Deprecated
+
+use `.parameter.maxRequests` `.parameter.set('maxRequests', maxRequests)` instend
+
+##### Returns
+
+`number`
+
+#### Set Signature
+
+> **set** **maxRequests**(`value`): `void`
+
+Defined in: lib/five/model/tile3d/index.ts:1054
+
+##### Parameters
+
+###### value
+
+`number`
+
+##### Returns
+
+`void`
+
+***
+
+### maxScreenSpaceError
+
+#### Get Signature
+
+> **get** **maxScreenSpaceError**(): `number`
+
+Defined in: lib/five/model/tile3d/index.ts:1080
+
+##### Deprecated
+
+use `.parameter.maxScreenSpaceError` `.parameter.set('maxScreenSpaceError', maxScreenSpaceError)` instend
+
+##### Returns
+
+`number`
+
+#### Set Signature
+
+> **set** **maxScreenSpaceError**(`value`): `void`
+
+Defined in: lib/five/model/tile3d/index.ts:1090
+
+##### Parameters
+
+###### value
+
+`number`
+
+##### Returns
+
+`void`
+
+***
+
+### minGeometricError
+
+#### Get Signature
+
+> **get** **minGeometricError**(): `number`
+
+Defined in: lib/five/model/tile3d/index.ts:918
+
+##### Deprecated
+
+use `.parameter.minGeometricError` `.parameter.set('minGeometricError', minGeometricError)` instend
+
+##### Returns
+
+`number`
+
+#### Set Signature
+
+> **set** **minGeometricError**(`value`): `void`
+
+Defined in: lib/five/model/tile3d/index.ts:928
+
+##### Parameters
+
+###### value
+
+`number`
+
+##### Returns
+
+`void`
+
+***
+
+### minLevelOfDetail
+
+#### Get Signature
+
+> **get** **minLevelOfDetail**(): `number`
+
+Defined in: lib/five/model/tile3d/index.ts:882
+
+##### Deprecated
+
+use `.parameter.minLevelOfDetail` `.parameter.set('minLevelOfDetail', minLevelOfDetail)` instend
+
+##### Returns
+
+`number`
+
+#### Set Signature
+
+> **set** **minLevelOfDetail**(`value`): `void`
+
+Defined in: lib/five/model/tile3d/index.ts:892
+
+##### Parameters
+
+###### value
+
+`number`
+
+##### Returns
+
+`void`
+
+***
+
+### model
+
+#### Get Signature
+
+> **get** **model**(): [`Model`](Model.md)
+
+Defined in: lib/five/model/tile3d/index.ts:752
+
+##### Deprecated
+
+use this.parent instead.
+
+##### Returns
+
+[`Model`](Model.md)
+
+***
+
+### mostDetail
+
+#### Get Signature
+
+> **get** **mostDetail**(): `boolean`
+
+Defined in: lib/five/model/tile3d/index.ts:990
+
+##### Deprecated
+
+use `.parameter.mostDetail` `.parameter.set('mostDetail', mostDetail)` instend
+
+##### Returns
+
+`boolean`
+
+#### Set Signature
+
+> **set** **mostDetail**(`value`): `void`
+
+Defined in: lib/five/model/tile3d/index.ts:1000
+
+##### Parameters
+
+###### value
+
+`boolean`
+
+##### Returns
+
+`void`
+
+***
+
+### panoramaMinGeometricError
+
+#### Get Signature
+
+> **get** **panoramaMinGeometricError**(): `number`
+
+Defined in: lib/five/model/tile3d/index.ts:954
+
+##### Deprecated
+
+use `.parameter.panoramaMinGeometricError` `.parameter.set('panoramaMinGeometricError', panoramaMinGeometricError)` instend
+
+##### Returns
+
+`number`
+
+#### Set Signature
+
+> **set** **panoramaMinGeometricError**(`value`): `void`
+
+Defined in: lib/five/model/tile3d/index.ts:964
+
+##### Parameters
+
+###### value
+
+`number`
+
+##### Returns
+
+`void`
+
+***
+
+### requestOrder
+
+#### Get Signature
+
+> **get** **requestOrder**(): [`TileRequestOrder`](../type-aliases/TileRequestOrder.md)
+
+Defined in: lib/five/model/tile3d/index.ts:1062
+
+##### Deprecated
+
+use `.parameter.requestOrder` `.parameter.set('requestOrder', requestOrder)` instend
+
+##### Returns
+
+[`TileRequestOrder`](../type-aliases/TileRequestOrder.md)
+
+#### Set Signature
+
+> **set** **requestOrder**(`value`): `void`
+
+Defined in: lib/five/model/tile3d/index.ts:1072
+
+##### Parameters
+
+###### value
+
+[`TileRequestOrder`](../type-aliases/TileRequestOrder.md)
+
+##### Returns
+
+`void`
+
+***
+
+### scene
+
+#### Get Signature
+
+> **get** **scene**(): `this`
+
+Defined in: lib/five/model/tile3d/index.ts:760
+
+##### Deprecated
+
+it's self
+
+##### Returns
+
+`this`
+
+***
+
+### skipLevelOfDetail
+
+#### Get Signature
+
+> **get** **skipLevelOfDetail**(): `boolean`
+
+Defined in: lib/five/model/tile3d/index.ts:972
+
+##### Deprecated
+
+use `.parameter.skipLevelOfDetail` `.parameter.set('skipLevelOfDetail', skipLevelOfDetail)` instend
+
+##### Returns
+
+`boolean`
+
+#### Set Signature
+
+> **set** **skipLevelOfDetail**(`value`): `void`
+
+Defined in: lib/five/model/tile3d/index.ts:982
+
+##### Parameters
+
+###### value
+
+`boolean`
+
+##### Returns
+
+`void`
+
+***
+
+### tiles
+
+#### Get Signature
+
+> **get** **tiles**(): [`Tile`](Tile.md)[]
+
+Defined in: lib/five/model/tile3d/index.ts:227
+
+##### Returns
+
+[`Tile`](Tile.md)[]
+
+***
+
+### trajectories
+
+#### Get Signature
+
+> **get** **trajectories**(): [`Trajectory`](Trajectory.md)[]
+
+Defined in: lib/five/model/tile3d/index.ts:231
+
+##### Returns
+
+[`Trajectory`](Trajectory.md)[]
+
+***
+
+### viewerRequestVolume
+
+#### Get Signature
+
+> **get** **viewerRequestVolume**(): [`BoundingVolume`](../interfaces/BoundingVolume.md)
+
+Defined in: lib/five/model/tile3d/index.ts:219
+
+##### Returns
+
+[`BoundingVolume`](../interfaces/BoundingVolume.md)
+
+#### Set Signature
+
+> **set** **viewerRequestVolume**(`value`): `void`
+
+Defined in: lib/five/model/tile3d/index.ts:223
+
+##### Parameters
+
+###### value
+
+[`BoundingVolume`](../interfaces/BoundingVolume.md)
+
+##### Returns
+
+`void`
+
+***
+
+### viewLayer
+
+#### Get Signature
+
+> **get** **viewLayer**(): `this`
+
+Defined in: lib/five/model/tile3d/index.ts:768
+
+##### Deprecated
+
+it's self
+
+##### Returns
+
+`this`
+
+## Methods
+
+### ~~coordinatesToWorldPoint()~~
+
+> **coordinatesToWorldPoint**(`coordinates`): `Vector3`
+
+Defined in: lib/five/model/tile3d/index.ts:855
+
+#### Parameters
+
+##### coordinates
+
+###### altitude
+
+`number`
+
+###### latitude
+
+`number`
+
+###### longitude
+
+`number`
+
+#### Returns
+
+`Vector3`
+
+#### Deprecated
+
+使用 llaToWorld 替代
+
+***
+
+### dispose()
+
+> **dispose**(): `void`
+
+Defined in: lib/five/model/tile3d/index.ts:721
+
+#### Returns
+
+`void`
+
+***
+
+### ecefToEnu()
+
+> **ecefToEnu**(`vector`): `Vector3`
+
+Defined in: lib/five/model/tile3d/index.ts:786
+
+#### Parameters
+
+##### vector
+
+`Vector3`
+
+#### Returns
+
+`Vector3`
+
+***
+
+### ecefToLocal()
+
+> **ecefToLocal**(`vector`): `Vector3`
+
+Defined in: lib/five/model/tile3d/index.ts:794
+
+#### Parameters
+
+##### vector
+
+`Vector3`
+
+#### Returns
+
+`Vector3`
+
+***
+
+### ecefToWorld()
+
+> **ecefToWorld**(`vector`): `Vector3`
+
+Defined in: lib/five/model/tile3d/index.ts:818
+
+#### Parameters
+
+##### vector
+
+`Vector3`
+
+#### Returns
+
+`Vector3`
+
+***
+
+### enuToEcef()
+
+> **enuToEcef**(`vector`): `Vector3`
+
+Defined in: lib/five/model/tile3d/index.ts:782
+
+#### Parameters
+
+##### vector
+
+`Vector3`
+
+#### Returns
+
+`Vector3`
+
+***
+
+### enuToLocal()
+
+> **enuToLocal**(`vector`): `Vector3`
+
+Defined in: lib/five/model/tile3d/index.ts:778
+
+#### Parameters
+
+##### vector
+
+`Vector3`
+
+#### Returns
+
+`Vector3`
+
+***
+
+### enuToWorld()
+
+> **enuToWorld**(`vector`): `Vector3`
+
+Defined in: lib/five/model/tile3d/index.ts:810
+
+#### Parameters
+
+##### vector
+
+`Vector3`
+
+#### Returns
+
+`Vector3`
+
+***
+
+### getRecommendProps()
+
+> **getRecommendProps**(`options`): `object`
+
+Defined in: lib/five/model/tile3d/index.ts:235
+
+#### Parameters
+
+##### options
+
+###### powerPreference?
+
+`"high"` \| `"default"`
+
+#### Returns
+
+`object`
+
+##### maxScreenSpaceError
+
+> **maxScreenSpaceError**: `number`
+
+##### pointMinPixel
+
+> **pointMinPixel**: `number`
+
+##### pointScale
+
+> **pointScale**: `number`
+
+***
+
+### ~~getTransformMatrix4()~~
+
+> **getTransformMatrix4**(`target`): `Matrix4`
+
+Defined in: lib/five/model/tile3d/index.ts:844
+
+#### Parameters
+
+##### target
+
+`Matrix4` = `...`
+
+#### Returns
+
+`Matrix4`
+
+#### Deprecated
+
+使用 coordinateSystem 替代
+
+***
+
+### intersectRaycaster()
+
+> **intersectRaycaster**(`raycaster`, `target?`): [`Intersection`](../interfaces/Intersection.md)[]
+
+Defined in: lib/five/model/tile3d/index.ts:307
+
+#### Parameters
+
+##### raycaster
+
+`Raycaster`
+
+##### target?
+
+[`Intersection`](../interfaces/Intersection.md)[]
+
+#### Returns
+
+[`Intersection`](../interfaces/Intersection.md)[]
+
+***
+
+### llaToLocal()
+
+> **llaToLocal**(`vector`): `Vector3`
+
+Defined in: lib/five/model/tile3d/index.ts:802
+
+#### Parameters
+
+##### vector
+
+`Vector3`
+
+#### Returns
+
+`Vector3`
+
+***
+
+### llaToWorld()
+
+> **llaToWorld**(`vector`): `Vector3`
+
+Defined in: lib/five/model/tile3d/index.ts:826
+
+#### Parameters
+
+##### vector
+
+`Vector3`
+
+#### Returns
+
+`Vector3`
+
+***
+
+### loadAllTilesets()
+
+> **loadAllTilesets**(): `Promise`\<`void`\>
+
+Defined in: lib/five/model/tile3d/index.ts:273
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### loadContent()
+
+> **loadContent**(`tile`): `Promise`\<`void`\>
+
+Defined in: lib/five/model/tile3d/index.ts:243
+
+#### Parameters
+
+##### tile
+
+[`Tile`](Tile.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### loadTrajectory()
+
+> **loadTrajectory**(`trajectory`): `Promise`\<`void`\>
+
+Defined in: lib/five/model/tile3d/index.ts:290
+
+#### Parameters
+
+##### trajectory
+
+[`Trajectory`](Trajectory.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### localToEcef()
+
+> **localToEcef**(`vector`): `Vector3`
+
+Defined in: lib/five/model/tile3d/index.ts:790
+
+#### Parameters
+
+##### vector
+
+`Vector3`
+
+#### Returns
+
+`Vector3`
+
+***
+
+### localToEnu()
+
+> **localToEnu**(`vector`): `Vector3`
+
+Defined in: lib/five/model/tile3d/index.ts:774
+
+#### Parameters
+
+##### vector
+
+`Vector3`
+
+#### Returns
+
+`Vector3`
+
+***
+
+### localToLla()
+
+> **localToLla**(`vector`): `Vector3`
+
+Defined in: lib/five/model/tile3d/index.ts:798
+
+#### Parameters
+
+##### vector
+
+`Vector3`
+
+#### Returns
+
+`Vector3`
+
+***
+
+### ~~resetBrightness()~~
+
+> **resetBrightness**(): `void`
+
+Defined in: lib/five/model/tile3d/index.ts:874
+
+#### Returns
+
+`void`
+
+#### Deprecated
+
+Use `.parameter.reset('brightness')` instead
+
+***
+
+### unloadContent()
+
+> **unloadContent**(`tile`): `Promise`\<`void`\>
+
+Defined in: lib/five/model/tile3d/index.ts:268
+
+#### Parameters
+
+##### tile
+
+[`Tile`](Tile.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### unloadTrajectory()
+
+> **unloadTrajectory**(`trajectory`): `Promise`\<`void`\>
+
+Defined in: lib/five/model/tile3d/index.ts:302
+
+#### Parameters
+
+##### trajectory
+
+[`Trajectory`](Trajectory.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### update()
+
+> **update**(`renderer`, `camera`, `modelScene`, `model`): `boolean`
+
+Defined in: lib/five/model/tile3d/index.ts:379
+
+#### Parameters
+
+##### renderer
+
+`WebGLRenderer`
+
+##### camera
+
+[`Camera`](Camera.md)
+
+##### modelScene
+
+[`ModelScene`](ModelScene.md)
+
+##### model
+
+[`Model`](Model.md)
+
+#### Returns
+
+`boolean`
+
+***
+
+### ~~worldPointToCoordinates()~~
+
+> **worldPointToCoordinates**(`point`): `object`
+
+Defined in: lib/five/model/tile3d/index.ts:864
+
+#### Parameters
+
+##### point
+
+`Vector3`
+
+#### Returns
+
+`object`
+
+##### ~~altitude~~
+
+> **altitude**: `number`
+
+##### ~~latitude~~
+
+> **latitude**: `number`
+
+##### ~~longitude~~
+
+> **longitude**: `number`
+
+#### Deprecated
+
+使用 llaToWorld 替代
+
+***
+
+### worldToEcef()
+
+> **worldToEcef**(`vector`): `Vector3`
+
+Defined in: lib/five/model/tile3d/index.ts:814
+
+#### Parameters
+
+##### vector
+
+`Vector3`
+
+#### Returns
+
+`Vector3`
+
+***
+
+### worldToEnu()
+
+> **worldToEnu**(`vector`): `Vector3`
+
+Defined in: lib/five/model/tile3d/index.ts:806
+
+#### Parameters
+
+##### vector
+
+`Vector3`
+
+#### Returns
+
+`Vector3`
+
+***
+
+### worldToLla()
+
+> **worldToLla**(`vector`): `Vector3`
+
+Defined in: lib/five/model/tile3d/index.ts:822
+
+#### Parameters
+
+##### vector
+
+`Vector3`
+
+#### Returns
+
+`Vector3`