@realsee/five 6.7.2 → 6.8.0-alpha.1

package/docs_markdown/five/classes/ModelScene.md

@@ -0,0 +1,495 @@
+[**如视 Five SDK**](../../README.md)
+
+***
+
+[如视 Five SDK](../../modules.md) / [five](../README.md) / ModelScene
+
+# Class: ModelScene
+
+Defined in: lib/five/model/model-scene.ts:102
+
+## Extends
+
+- `Scene`
+
+## Constructors
+
+### Constructor
+
+> **new ModelScene**(`options`): `ModelScene`
+
+Defined in: lib/five/model/model-scene.ts:151
+
+#### Parameters
+
+##### options
+
+###### fiveId
+
+`string`
+
+#### Returns
+
+`ModelScene`
+
+## Properties
+
+### autoRefine
+
+> **autoRefine**: `boolean` = `true`
+
+Defined in: lib/five/model/model-scene.ts:125
+
+自动细化
+
+***
+
+### boundingBox
+
+> **boundingBox**: `Box3`
+
+Defined in: lib/five/model/model-scene.ts:128
+
+包围盒
+
+***
+
+### boundingMesh
+
+> **boundingMesh**: [`BoundingMesh`](BoundingMesh.md)
+
+Defined in: lib/five/model/model-scene.ts:131
+
+包围盒 Mesh
+
+***
+
+### fiveId
+
+> **fiveId**: `string`
+
+Defined in: lib/five/model/model-scene.ts:121
+
+***
+
+### loaded
+
+> **loaded**: `boolean` = `false`
+
+Defined in: lib/five/model/model-scene.ts:134
+
+加载完成
+
+***
+
+### models
+
+> `readonly` **models**: [`Models`](../type-aliases/Models.md)
+
+Defined in: lib/five/model/model-scene.ts:146
+
+模型列表
+
+***
+
+### needsRender
+
+> **needsRender**: `boolean` = `true`
+
+Defined in: lib/five/model/model-scene.ts:122
+
+***
+
+### parameter
+
+> **parameter**: [`Parameter`](Parameter.md)
+
+Defined in: lib/five/model/model-scene.ts:143
+
+参数
+
+***
+
+### refined
+
+> **refined**: `boolean` = `false`
+
+Defined in: lib/five/model/model-scene.ts:137
+
+细化完成
+
+***
+
+### refineProgress
+
+> **refineProgress**: \[`number`, `number`\]
+
+Defined in: lib/five/model/model-scene.ts:140
+
+细化进度
+
+## Accessors
+
+### bounding
+
+#### Get Signature
+
+> **get** **bounding**(): `Box3`
+
+Defined in: lib/five/model/model-scene.ts:474
+
+##### Deprecated
+
+Use `.boundingBox` instead
+
+##### Returns
+
+`Box3`
+
+***
+
+### empty
+
+#### Get Signature
+
+> **get** **empty**(): `boolean`
+
+Defined in: lib/five/model/model-scene.ts:322
+
+##### Returns
+
+`boolean`
+
+## Methods
+
+### addEventListener()
+
+#### Call Signature
+
+> **addEventListener**(`type`, `listener`): `void`
+
+Defined in: lib/five/model/model-scene.ts:108
+
+##### Parameters
+
+###### type
+
+`"model.create"`
+
+###### listener
+
+(`event`) => `void`
+
+##### Returns
+
+`void`
+
+#### Call Signature
+
+> **addEventListener**(`type`, `listener`): `void`
+
+Defined in: lib/five/model/model-scene.ts:109
+
+##### Parameters
+
+###### type
+
+`"model.dispose"`
+
+###### listener
+
+(`event`) => `void`
+
+##### Returns
+
+`void`
+
+#### Call Signature
+
+> **addEventListener**(`type`, `listener`): `void`
+
+Defined in: lib/five/model/model-scene.ts:110
+
+##### Parameters
+
+###### type
+
+`string`
+
+###### listener
+
+(`event`) => `void`
+
+##### Returns
+
+`void`
+
+***
+
+### dispatchEvent()
+
+#### Call Signature
+
+> **dispatchEvent**(`event`): `void`
+
+Defined in: lib/five/model/model-scene.ts:104
+
+##### Parameters
+
+###### event
+
+###### model
+
+[`Model`](Model.md)
+
+###### type
+
+`"model.create"`
+
+##### Returns
+
+`void`
+
+#### Call Signature
+
+> **dispatchEvent**(`event`): `void`
+
+Defined in: lib/five/model/model-scene.ts:105
+
+##### Parameters
+
+###### event
+
+###### model
+
+[`Model`](Model.md)
+
+###### type
+
+`"model.dispose"`
+
+##### Returns
+
+`void`
+
+#### Call Signature
+
+> **dispatchEvent**(`event`): `void`
+
+Defined in: lib/five/model/model-scene.ts:106
+
+##### Parameters
+
+###### event
+
+###### type
+
+`string`
+
+##### Returns
+
+`void`
+
+***
+
+### dispose()
+
+> **dispose**(): `void`
+
+Defined in: lib/five/model/model-scene.ts:505
+
+#### Returns
+
+`void`
+
+***
+
+### ~~getMaterial()~~
+
+> **getMaterial**(): [`ParameterValue`](../interfaces/ParameterValue.md)
+
+Defined in: lib/five/model/model-scene.ts:490
+
+#### Returns
+
+[`ParameterValue`](../interfaces/ParameterValue.md)
+
+#### Deprecated
+
+Use `.parameter.get` instead
+
+***
+
+### intersectRaycaster()
+
+> **intersectRaycaster**(`raycaster`, `target?`): [`Intersection`](../interfaces/Intersection.md)[]
+
+Defined in: lib/five/model/model-scene.ts:332
+
+计算模型射线碰撞检测
+
+#### Parameters
+
+##### raycaster
+
+`Raycaster`
+
+THREE 射线对象
+
+##### target?
+
+[`Intersection`](../interfaces/Intersection.md)[]
+
+返回碰撞点
+
+#### Returns
+
+[`Intersection`](../interfaces/Intersection.md)[]
+
+返回碰撞点
+
+***
+
+### removeEventListener()
+
+#### Call Signature
+
+> **removeEventListener**(`type`, `listener`): `void`
+
+Defined in: lib/five/model/model-scene.ts:112
+
+##### Parameters
+
+###### type
+
+`"model.create"`
+
+###### listener
+
+(`event`) => `void`
+
+##### Returns
+
+`void`
+
+#### Call Signature
+
+> **removeEventListener**(`type`, `listener`): `void`
+
+Defined in: lib/five/model/model-scene.ts:113
+
+##### Parameters
+
+###### type
+
+`"model.dispose"`
+
+###### listener
+
+(`event`) => `void`
+
+##### Returns
+
+`void`
+
+#### Call Signature
+
+> **removeEventListener**(`type`, `listener`): `void`
+
+Defined in: lib/five/model/model-scene.ts:114
+
+##### Parameters
+
+###### type
+
+`string`
+
+###### listener
+
+(`event`) => `void`
+
+##### Returns
+
+`void`
+
+***
+
+### ~~resetBrightness()~~
+
+> **resetBrightness**(): `void`
+
+Defined in: lib/five/model/model-scene.ts:498
+
+#### Returns
+
+`void`
+
+#### Deprecated
+
+Use `.parameter.reset('brightness')` instead
+
+***
+
+### ~~setMaterial()~~
+
+> **setMaterial**(`parameter`): `void`
+
+Defined in: lib/five/model/model-scene.ts:482
+
+#### Parameters
+
+##### parameter
+
+`Partial`\<[`ParameterValue`](../interfaces/ParameterValue.md)\>
+
+#### Returns
+
+`void`
+
+#### Deprecated
+
+Use `.parameter.set` instead
+
+***
+
+### setModels()
+
+> **setModels**(`works`, `options`): [`Model`](Model.md)[]
+
+Defined in: lib/five/model/model-scene.ts:230
+
+#### Parameters
+
+##### works
+
+[`Works`](../type-aliases/Works.md)
+
+##### options
+
+[`ModelOptions`](../interfaces/ModelOptions.md)
+
+#### Returns
+
+[`Model`](Model.md)[]
+
+***
+
+### update()
+
+> **update**(`renderer`, `camera`): `boolean`
+
+Defined in: lib/five/model/model-scene.ts:351
+
+#### Parameters
+
+##### renderer
+
+`WebGLRenderer`
+
+##### camera
+
+[`Camera`](Camera.md)
+
+#### Returns
+
+`boolean`

package/docs_markdown/five/classes/Motion.md

@@ -0,0 +1,235 @@
+[**如视 Five SDK**](../../README.md)
+
+***
+
+[如视 Five SDK](../../modules.md) / [five](../README.md) / Motion
+
+# Class: Motion\<K\>
+
+Defined in: lib/five/utils/motion.ts:76
+
+## Type Parameters
+
+### K
+
+`K` *extends* `string`
+
+## Constructors
+
+### Constructor
+
+> **new Motion**\<`K`\>(`initalValue`): `Motion`\<`K`\>
+
+Defined in: lib/five/utils/motion.ts:89
+
+#### Parameters
+
+##### initalValue
+
+[`MotionInitalValue`](../type-aliases/MotionInitalValue.md)\<`K`\>
+
+#### Returns
+
+`Motion`\<`K`\>
+
+## Properties
+
+### config
+
+> **config**: [`MotionConfig`](../type-aliases/MotionConfig.md)\<`K`\>
+
+Defined in: lib/five/utils/motion.ts:78
+
+***
+
+### duration
+
+> **duration**: `number`
+
+Defined in: lib/five/utils/motion.ts:85
+
+***
+
+### ended
+
+> **ended**: `boolean`
+
+Defined in: lib/five/utils/motion.ts:81
+
+***
+
+### keyframes
+
+> **keyframes**: [`MotionKeyframe`](../interfaces/MotionKeyframe.md)\<`K`\>[]
+
+Defined in: lib/five/utils/motion.ts:86
+
+***
+
+### progress
+
+> **progress**: `number`
+
+Defined in: lib/five/utils/motion.ts:80
+
+***
+
+### startTime
+
+> **startTime**: `number`
+
+Defined in: lib/five/utils/motion.ts:83
+
+***
+
+### startVelocity
+
+> **startVelocity**: `number`
+
+Defined in: lib/five/utils/motion.ts:84
+
+***
+
+### value
+
+> **value**: [`MotionValue`](../type-aliases/MotionValue.md)\<`K`\>
+
+Defined in: lib/five/utils/motion.ts:79
+
+## Methods
+
+### dispose()
+
+> **dispose**(): `void`
+
+Defined in: lib/five/utils/motion.ts:241
+
+#### Returns
+
+`void`
+
+***
+
+### getKeyFrameSegment()
+
+> **getKeyFrameSegment**(`time`): \[[`MotionKeyframe`](../interfaces/MotionKeyframe.md)\<`K`\>, [`MotionKeyframe`](../interfaces/MotionKeyframe.md)\<`K`\>\]
+
+Defined in: lib/five/utils/motion.ts:168
+
+#### Parameters
+
+##### time
+
+`number`
+
+#### Returns
+
+\[[`MotionKeyframe`](../interfaces/MotionKeyframe.md)\<`K`\>, [`MotionKeyframe`](../interfaces/MotionKeyframe.md)\<`K`\>\]
+
+***
+
+### getProgressVelocity()
+
+> **getProgressVelocity**(`time`): `number`
+
+Defined in: lib/five/utils/motion.ts:146
+
+#### Parameters
+
+##### time
+
+`number`
+
+#### Returns
+
+`number`
+
+***
+
+### getTargetKeyframe()
+
+> **getTargetKeyframe**(): [`MotionKeyframe`](../interfaces/MotionKeyframe.md)\<`K`\>
+
+Defined in: lib/five/utils/motion.ts:178
+
+#### Returns
+
+[`MotionKeyframe`](../interfaces/MotionKeyframe.md)\<`K`\>
+
+***
+
+### set()
+
+> **set**(`value`, `duration`, `startProgressVelocity`, `time?`): `Promise`\<`void`\>
+
+Defined in: lib/five/utils/motion.ts:182
+
+#### Parameters
+
+##### value
+
+`Partial`\<[`MotionValue`](../type-aliases/MotionValue.md)\<`K`\>\>
+
+##### duration
+
+`number`
+
+##### startProgressVelocity
+
+`number` = `0`
+
+##### time?
+
+`number`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### setKeyframes()
+
+> **setKeyframes**(`keyframes`, `duration`, `startProgressVelocity`, `time?`): `Promise`\<`void`\>
+
+Defined in: lib/five/utils/motion.ts:206
+
+#### Parameters
+
+##### keyframes
+
+[`MotionKeyframe`](../interfaces/MotionKeyframe.md)\<`K`\>[]
+
+##### duration
+
+`number`
+
+##### startProgressVelocity
+
+`number` = `0`
+
+##### time?
+
+`number`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### update()
+
+> **update**(`time`): `boolean`
+
+Defined in: lib/five/utils/motion.ts:154
+
+#### Parameters
+
+##### time
+
+`number`
+
+#### Returns
+
+`boolean`