@realsee/five 6.7.2 → 6.8.0-alpha.1

package/docs_markdown/five/classes/AnimationFrameLoop.md

@@ -0,0 +1,195 @@
+[**如视 Five SDK**](../../README.md)
+
+***
+
+[如视 Five SDK](../../modules.md) / [five](../README.md) / AnimationFrameLoop
+
+# Class: AnimationFrameLoop
+
+Defined in: lib/five/utils/animationFrameLoop.ts:58
+
+## Constructors
+
+### Constructor
+
+> **new AnimationFrameLoop**(): `AnimationFrameLoop`
+
+Defined in: lib/five/utils/animationFrameLoop.ts:79
+
+#### Returns
+
+`AnimationFrameLoop`
+
+## Accessors
+
+### shared
+
+#### Get Signature
+
+> **get** `static` **shared**(): `AnimationFrameLoop`
+
+Defined in: lib/five/utils/animationFrameLoop.ts:68
+
+##### Returns
+
+`AnimationFrameLoop`
+
+## Methods
+
+### add()
+
+> **add**(`callback`, `once`, `delay`, `order`): () => `void`
+
+Defined in: lib/five/utils/animationFrameLoop.ts:206
+
+添加到动画循环
+
+#### Parameters
+
+##### callback
+
+(`time`, `deltaTime`, ...`requestAnimationFrameArgs`) => `void`
+
+动画循环回调
+
+##### once
+
+`boolean` = `false`
+
+是否只回调一次
+
+##### delay
+
+`number` = `0`
+
+延迟多少个动画循环回调
+
+##### order
+
+`number` = `DEFAULT_ORDER`
+
+优先级，数字越小越早被调用
+
+#### Returns
+
+移除动画循环函数
+
+> (): `void`
+
+##### Returns
+
+`void`
+
+***
+
+### clear()
+
+> **clear**(): `void`
+
+Defined in: lib/five/utils/animationFrameLoop.ts:226
+
+#### Returns
+
+`void`
+
+***
+
+### getContext()
+
+> **getContext**\<`T`\>(): `T`
+
+Defined in: lib/five/utils/animationFrameLoop.ts:147
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`AnimationFrameContext`](../interfaces/AnimationFrameContext.md)\<`any`[], `any`\> = [`AnimationFrameContext`](../interfaces/AnimationFrameContext.md)\<`any`[], `any`\>
+
+#### Returns
+
+`T`
+
+***
+
+### getLoopType()
+
+> **getLoopType**(): [`AnimationFrameLoopType`](../type-aliases/AnimationFrameLoopType.md)
+
+Defined in: lib/five/utils/animationFrameLoop.ts:159
+
+#### Returns
+
+[`AnimationFrameLoopType`](../type-aliases/AnimationFrameLoopType.md)
+
+***
+
+### setContext()
+
+> **setContext**(`context`): `void`
+
+Defined in: lib/five/utils/animationFrameLoop.ts:139
+
+#### Parameters
+
+##### context
+
+[`AnimationFrameContext`](../interfaces/AnimationFrameContext.md)\<`any`[], `any`\>
+
+#### Returns
+
+`void`
+
+***
+
+### setLoopType()
+
+> **setLoopType**(`type`): `void`
+
+Defined in: lib/five/utils/animationFrameLoop.ts:151
+
+#### Parameters
+
+##### type
+
+[`AnimationFrameLoopType`](../type-aliases/AnimationFrameLoopType.md)
+
+#### Returns
+
+`void`
+
+***
+
+### start()
+
+> **start**(): `void`
+
+Defined in: lib/five/utils/animationFrameLoop.ts:126
+
+#### Returns
+
+`void`
+
+***
+
+### stop()
+
+> **stop**(): `void`
+
+Defined in: lib/five/utils/animationFrameLoop.ts:134
+
+#### Returns
+
+`void`
+
+***
+
+### getFrameTime()
+
+> `static` **getFrameTime**(): `number`
+
+Defined in: lib/five/utils/animationFrameLoop.ts:75
+
+#### Returns
+
+`number`

package/docs_markdown/five/classes/BoundingMesh.md

@@ -0,0 +1,75 @@
+[**如视 Five SDK**](../../README.md)
+
+***
+
+[如视 Five SDK](../../modules.md) / [five](../README.md) / BoundingMesh
+
+# Class: BoundingMesh
+
+Defined in: lib/five/meshes/boundingMesh.ts:19
+
+## Extends
+
+- [`PBMMesh`](PBMMesh.md)
+
+## Constructors
+
+### Constructor
+
+> **new BoundingMesh**(`options`): `BoundingMesh`
+
+Defined in: lib/five/meshes/boundingMesh.ts:21
+
+#### Parameters
+
+##### options
+
+###### name?
+
+`string`
+
+#### Returns
+
+`BoundingMesh`
+
+#### Overrides
+
+[`PBMMesh`](PBMMesh.md).[`constructor`](PBMMesh.md#constructor)
+
+## Methods
+
+### dispose()
+
+> **dispose**(): `void`
+
+Defined in: lib/five/meshes/boundingMesh.ts:125
+
+#### Returns
+
+`void`
+
+***
+
+### update()
+
+> **update**(`renderer`, `camera`, `modelScene`): `boolean`
+
+Defined in: lib/five/meshes/boundingMesh.ts:43
+
+#### Parameters
+
+##### renderer
+
+`WebGLRenderer`
+
+##### camera
+
+[`Camera`](Camera.md)
+
+##### modelScene
+
+[`ModelScene`](ModelScene.md)
+
+#### Returns
+
+`boolean`