@realsee/five 6.7.2 → 6.8.0-alpha.1

package/docs_markdown/five/classes/PanoCircleMesh.md

@@ -0,0 +1,296 @@
+[**如视 Five SDK**](../../README.md)
+
+***
+
+[如视 Five SDK](../../modules.md) / [five](../README.md) / PanoCircleMesh
+
+# Class: PanoCircleMesh
+
+Defined in: lib/five/meshes/panoCircleMesh.ts:157
+
+地面提示点位接口
+
+点位状态
+ 1. 默认状态: 无任何操作的情况
+ 2. 高亮状态: 高亮，认为是合适的下一个点位，或者设备选中了某个点位
+ 3. 进度状态: 点位加载中，存在进度的情况
+ 4. 加载状态: 点位加载中，不存在进度的情况
+ 5. 不可用状态：点位不可用，存在点位，但是点位是个摆设
+ 6. 点击动画： 点位被选择，触发全景图切换
+ 7. 透明度改变： 一般会处理为近的点位透明度高，远的点位透明度低
+
+## Extends
+
+- `Object3D`
+
+## Implements
+
+- [`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md)
+
+## Constructors
+
+### Constructor
+
+> **new PanoCircleMesh**(`options`): `PanoCircleMesh`
+
+Defined in: lib/five/meshes/panoCircleMesh.ts:179
+
+#### Parameters
+
+##### options
+
+[`PanoCircleMeshOptions`](../interfaces/PanoCircleMeshOptions.md) = `{}`
+
+#### Returns
+
+`PanoCircleMesh`
+
+#### Overrides
+
+`THREE.Object3D.constructor`
+
+## Properties
+
+### current
+
+> **current**: `boolean`
+
+Defined in: lib/five/meshes/panoCircleMesh.ts:173
+
+当前高亮
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`current`](../interfaces/PanoCircleMeshInterface.md#current)
+
+***
+
+### disabled
+
+> **disabled**: `boolean`
+
+Defined in: lib/five/meshes/panoCircleMesh.ts:175
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`disabled`](../interfaces/PanoCircleMeshInterface.md#disabled)
+
+***
+
+### loading
+
+> **loading**: `boolean`
+
+Defined in: lib/five/meshes/panoCircleMesh.ts:174
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`loading`](../interfaces/PanoCircleMeshInterface.md#loading)
+
+***
+
+### needsRender
+
+> **needsRender**: `boolean`
+
+Defined in: lib/five/meshes/panoCircleMesh.ts:159
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`needsRender`](../interfaces/PanoCircleMeshInterface.md#needsrender)
+
+***
+
+### opacity
+
+> **opacity**: `number`
+
+Defined in: lib/five/meshes/panoCircleMesh.ts:172
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`opacity`](../interfaces/PanoCircleMeshInterface.md#opacity)
+
+***
+
+### progress
+
+> **progress**: `number`
+
+Defined in: lib/five/meshes/panoCircleMesh.ts:171
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`progress`](../interfaces/PanoCircleMeshInterface.md#progress)
+
+## Methods
+
+### dispose()
+
+> **dispose**(): `void`
+
+Defined in: lib/five/meshes/panoCircleMesh.ts:436
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`dispose`](../interfaces/PanoCircleMeshInterface.md#dispose)
+
+***
+
+### setCurrent()
+
+> **setCurrent**(`current`): `void`
+
+Defined in: lib/five/meshes/panoCircleMesh.ts:293
+
+是否当前高亮
+
+#### Parameters
+
+##### current
+
+`boolean`
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`setCurrent`](../interfaces/PanoCircleMeshInterface.md#setcurrent)
+
+***
+
+### setDisabled()
+
+> **setDisabled**(`disabled`): `void`
+
+Defined in: lib/five/meshes/panoCircleMesh.ts:311
+
+#### Parameters
+
+##### disabled
+
+`boolean`
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`setDisabled`](../interfaces/PanoCircleMeshInterface.md#setdisabled)
+
+***
+
+### setLoading()
+
+> **setLoading**(`loading`): `void`
+
+Defined in: lib/five/meshes/panoCircleMesh.ts:302
+
+#### Parameters
+
+##### loading
+
+`boolean`
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`setLoading`](../interfaces/PanoCircleMeshInterface.md#setloading)
+
+***
+
+### setOpacity()
+
+> **setOpacity**(`opacity`): `void`
+
+Defined in: lib/five/meshes/panoCircleMesh.ts:287
+
+#### Parameters
+
+##### opacity
+
+`number`
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`setOpacity`](../interfaces/PanoCircleMeshInterface.md#setopacity)
+
+***
+
+### setProgress()
+
+> **setProgress**(`progress`): `void`
+
+Defined in: lib/five/meshes/panoCircleMesh.ts:267
+
+#### Parameters
+
+##### progress
+
+`number`
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`setProgress`](../interfaces/PanoCircleMeshInterface.md#setprogress)
+
+***
+
+### tap()
+
+> **tap**(): `Promise`\<`void`\>
+
+Defined in: lib/five/meshes/panoCircleMesh.ts:320
+
+点击交互
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`tap`](../interfaces/PanoCircleMeshInterface.md#tap)
+
+***
+
+### updateTime()
+
+> **updateTime**(`time`, `deltaTime`): `void`
+
+Defined in: lib/five/meshes/panoCircleMesh.ts:336
+
+#### Parameters
+
+##### time
+
+`number`
+
+##### deltaTime
+
+`number`
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`updateTime`](../interfaces/PanoCircleMeshInterface.md#updatetime)

package/docs_markdown/five/classes/PanoCircleMeshCustom.md

@@ -0,0 +1,296 @@
+[**如视 Five SDK**](../../README.md)
+
+***
+
+[如视 Five SDK](../../modules.md) / [five](../README.md) / PanoCircleMeshCustom
+
+# Class: PanoCircleMeshCustom
+
+Defined in: lib/five/meshes/panoCircleMeshCustom.ts:194
+
+地面提示点位接口
+
+点位状态
+ 1. 默认状态: 无任何操作的情况
+ 2. 高亮状态: 高亮，认为是合适的下一个点位，或者设备选中了某个点位
+ 3. 进度状态: 点位加载中，存在进度的情况
+ 4. 加载状态: 点位加载中，不存在进度的情况
+ 5. 不可用状态：点位不可用，存在点位，但是点位是个摆设
+ 6. 点击动画： 点位被选择，触发全景图切换
+ 7. 透明度改变： 一般会处理为近的点位透明度高，远的点位透明度低
+
+## Extends
+
+- `Object3D`
+
+## Implements
+
+- [`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md)
+
+## Constructors
+
+### Constructor
+
+> **new PanoCircleMeshCustom**(`options`): `PanoCircleMeshCustom`
+
+Defined in: lib/five/meshes/panoCircleMeshCustom.ts:215
+
+#### Parameters
+
+##### options
+
+[`PanoCircleMeshCustomOptions`](../interfaces/PanoCircleMeshCustomOptions.md) = `{}`
+
+#### Returns
+
+`PanoCircleMeshCustom`
+
+#### Overrides
+
+`THREE.Object3D.constructor`
+
+## Properties
+
+### current
+
+> **current**: `boolean`
+
+Defined in: lib/five/meshes/panoCircleMeshCustom.ts:209
+
+当前高亮
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`current`](../interfaces/PanoCircleMeshInterface.md#current)
+
+***
+
+### disabled
+
+> **disabled**: `boolean`
+
+Defined in: lib/five/meshes/panoCircleMeshCustom.ts:211
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`disabled`](../interfaces/PanoCircleMeshInterface.md#disabled)
+
+***
+
+### loading
+
+> **loading**: `boolean`
+
+Defined in: lib/five/meshes/panoCircleMeshCustom.ts:210
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`loading`](../interfaces/PanoCircleMeshInterface.md#loading)
+
+***
+
+### needsRender
+
+> **needsRender**: `boolean`
+
+Defined in: lib/five/meshes/panoCircleMeshCustom.ts:196
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`needsRender`](../interfaces/PanoCircleMeshInterface.md#needsrender)
+
+***
+
+### opacity
+
+> **opacity**: `number`
+
+Defined in: lib/five/meshes/panoCircleMeshCustom.ts:208
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`opacity`](../interfaces/PanoCircleMeshInterface.md#opacity)
+
+***
+
+### progress
+
+> **progress**: `number`
+
+Defined in: lib/five/meshes/panoCircleMeshCustom.ts:207
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`progress`](../interfaces/PanoCircleMeshInterface.md#progress)
+
+## Methods
+
+### dispose()
+
+> **dispose**(): `void`
+
+Defined in: lib/five/meshes/panoCircleMeshCustom.ts:462
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`dispose`](../interfaces/PanoCircleMeshInterface.md#dispose)
+
+***
+
+### setCurrent()
+
+> **setCurrent**(`current`): `void`
+
+Defined in: lib/five/meshes/panoCircleMeshCustom.ts:349
+
+是否当前高亮
+
+#### Parameters
+
+##### current
+
+`boolean`
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`setCurrent`](../interfaces/PanoCircleMeshInterface.md#setcurrent)
+
+***
+
+### setDisabled()
+
+> **setDisabled**(`disabled`): `void`
+
+Defined in: lib/five/meshes/panoCircleMeshCustom.ts:367
+
+#### Parameters
+
+##### disabled
+
+`boolean`
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`setDisabled`](../interfaces/PanoCircleMeshInterface.md#setdisabled)
+
+***
+
+### setLoading()
+
+> **setLoading**(`loading`): `void`
+
+Defined in: lib/five/meshes/panoCircleMeshCustom.ts:358
+
+#### Parameters
+
+##### loading
+
+`boolean`
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`setLoading`](../interfaces/PanoCircleMeshInterface.md#setloading)
+
+***
+
+### setOpacity()
+
+> **setOpacity**(`opacity`): `void`
+
+Defined in: lib/five/meshes/panoCircleMeshCustom.ts:343
+
+#### Parameters
+
+##### opacity
+
+`number`
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`setOpacity`](../interfaces/PanoCircleMeshInterface.md#setopacity)
+
+***
+
+### setProgress()
+
+> **setProgress**(`progress`): `void`
+
+Defined in: lib/five/meshes/panoCircleMeshCustom.ts:323
+
+#### Parameters
+
+##### progress
+
+`number`
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`setProgress`](../interfaces/PanoCircleMeshInterface.md#setprogress)
+
+***
+
+### tap()
+
+> **tap**(): `Promise`\<`void`\>
+
+Defined in: lib/five/meshes/panoCircleMeshCustom.ts:376
+
+点击交互
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`tap`](../interfaces/PanoCircleMeshInterface.md#tap)
+
+***
+
+### updateTime()
+
+> **updateTime**(`time`, `deltaTime`): `void`
+
+Defined in: lib/five/meshes/panoCircleMeshCustom.ts:392
+
+#### Parameters
+
+##### time
+
+`number`
+
+##### deltaTime
+
+`number`
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`PanoCircleMeshInterface`](../interfaces/PanoCircleMeshInterface.md).[`updateTime`](../interfaces/PanoCircleMeshInterface.md#updatetime)