@nnepoch/dtc-sdk 3.0.0

package/docs/api/api/classes/ModelTransform.md

@@ -0,0 +1,579 @@
+[@nnepoch/dtc-sdk](../../index.md) / [api](../index.md) / ModelTransform
+
+# Class: ModelTransform
+
+模型对象变换 API，涵盖旋转、缩放、移动操作。
+
+## Agent Title
+
+模型变换
+
+## Agent Capabilities
+
+模型轨迹移动, 暂停/继续/结束移动, 恢复位置, 模型旋转, 绕目标旋转, 恢复旋转, 模型缩放, 停止缩放, 恢复缩放
+
+## Extends
+
+- `BaseApi`
+
+## Methods
+
+### startMoveByNodes()
+
+> **startMoveByNodes**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+设置模型对象的移动轨迹。
+默认值：`speed=1`、`linear=-1`（引擎默认）、`isLookAtTarget=false`、`needDirection=true`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ModelTransformStartMoveRequest`](../../types/interfaces/ModelTransformStartMoveRequest.md) | 移动轨迹参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+var node = [
+{"x":109.06024958153341, y: 34.215840195184015, z: -3.4762240643423716,"ePSGType":"4326"},
+{x: 109.06048095352413, y: 34.21573993612359, z: -3.474684804328557, ePSGType: '4326'},
+{x: 109.06051305981796, y: 34.215672246109996, z: -3.4765398803586356, ePSGType: '4326'}]; 
+ dtcEngine.ModelTransform.startMoveByNodes(
+   {parentId: '', id: 'Cube4', nodes:node, speed: 6, linear: dtcEngine.Enums.ModelTransformType.Linear, isLookAtTarget: false,needDirection:false },
+   (result) => { console.log(result); }
+ );
+```
+
+***
+
+### pauseMove()
+
+> **pauseMove**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+暂停模型对象的移动。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ModelTransformNodeRequest`](../../types/interfaces/ModelTransformNodeRequest.md) | 节点标识参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.ModelTransform.pauseMove({ parentId: 'test', id: 'myRobot' }, (result) => { console.log(result); });
+```
+
+***
+
+### resumeMove()
+
+> **resumeMove**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+继续模型对象的移动。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ModelTransformNodeRequest`](../../types/interfaces/ModelTransformNodeRequest.md) | 节点标识参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.ModelTransform.resumeMove({ parentId: 'test', id: 'Camera01' }, (result) => { console.log(result); });
+```
+
+***
+
+### endMove()
+
+> **endMove**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+结束轨迹移动。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ModelTransformNodeRequest`](../../types/interfaces/ModelTransformNodeRequest.md) | 节点标识参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.ModelTransform.endMove({ parentId: 'test', id: 'Camera01' }, (result) => { console.log(result); });
+```
+
+***
+
+### restoreMove()
+
+> **restoreMove**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+重置对象到原来的位置。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ModelTransformRestoreRequest`](../../types/interfaces/ModelTransformRestoreRequest.md) | 恢复位置参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.ModelTransform.restoreMove({ parentId: 'test', ids: ['Camera01', 'Camera02'] }, (result) => { console.log(result); });
+```
+
+***
+
+### rotate()
+
+> **rotate**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+指定轴旋转模型角度到。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ModelTransformRotateRequest`](../../types/interfaces/ModelTransformRotateRequest.md) | 旋转参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+ dtcEngine.ModelTransform.rotate(
+   { parentId: 'test', id: 'myBus', rotate: new dtcEngine.Type.Vector3(30, 180, 120) },
+   (result) => { console.log(result); }
+ );
+```
+
+***
+
+### endRotate()
+
+> **endRotate**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+结束旋转。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ModelTransformNodeRequest`](../../types/interfaces/ModelTransformNodeRequest.md) | 节点标识参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.ModelTransform.endRotate({ parentId: 'test', id: 'myBus' }, (result) => { console.log(result); });
+```
+
+***
+
+### continuedRotate()
+
+> **continuedRotate**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+持续不断的绕自身旋转。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ModelTransformRotateRequest`](../../types/interfaces/ModelTransformRotateRequest.md) | 旋转参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.ModelTransform.continuedRotate(
+  { parentId: 'test', id: 'Camera01', rotate: new dtcEngine.Type.Vector3(30, 180, 120) },
+  (result) => { console.log(result); }
+);
+```
+
+***
+
+### rotateByTarget()
+
+> **rotateByTarget**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+围绕某个对象做旋转。
+默认值：`axisX=0`、`axisY=0`、`axisZ=0`、`angle=0`、`isPersistence=false`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ModelTransformRotateByTargetRequest`](../../types/interfaces/ModelTransformRotateByTargetRequest.md) | 目标旋转参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.ModelTransform.rotateByTarget(
+  {
+    parentId: 'test',
+    id: 'Camera01',
+    targetID: 'target',
+    point: new dtcEngine.Type.Vector3(1, 2, 3),
+    axisX: 1, axisY: 0, axisZ: 0, angle: 10,
+    isPersistence: true
+  },
+  (result) => { console.log(result); }
+);
+```
+
+***
+
+### restoreRotate()
+
+> **restoreRotate**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+重置恢复场景多个对象的旋转。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ModelTransformRestoreRequest`](../../types/interfaces/ModelTransformRestoreRequest.md) | 恢复旋转参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.ModelTransform.restoreRotate({ parentId: 'test', ids: ['Camera01', 'Camera02'] }, (result) => { console.log(result); });
+```
+
+***
+
+### setScale()
+
+> **setScale**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+设置模型对象的缩放。
+默认值：`duration=0.5`。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ModelTransformScaleRequest`](../../types/interfaces/ModelTransformScaleRequest.md) | 缩放参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+ dtcEngine.ModelTransform.setScale(
+   { parentId: 'test', id: 'Camera01', scale: new dtcEngine.Type.Vector3(0.5, 0.5, 0.5), duration: 3 },
+   (result) => { console.log(result); }
+);
+```
+
+***
+
+### endScale()
+
+> **endScale**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+停止模型对象的缩放。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ModelTransformNodeRequest`](../../types/interfaces/ModelTransformNodeRequest.md) | 节点标识参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.ModelTransform.endScale({ parentId: '', id: 'Cube4' }, (result) => { console.log(result); });
+```
+
+***
+
+### restoreScale()
+
+> **restoreScale**(`payload`, `callback?`): `Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+重置模型的缩放，恢复到开始状态。
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | [`ModelTransformRestoreRequest`](../../types/interfaces/ModelTransformRestoreRequest.md) | 恢复缩放参数。 |
+| `callback?` | [`ApiCallback`](../../types/type-aliases/ApiCallback.md)\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\> | 可选回调函数。 |
+
+#### Returns
+
+`Promise`\<[`ApiResponseEnvelope`](../../types/interfaces/ApiResponseEnvelope.md)\<`unknown`\>\>
+
+Promise 形式的接口响应。
+
+#### Agent Side Effects
+
+write
+
+#### Agent Preconditions
+
+DTCEngine 已完成鉴权并建立 WebRTC 连接
+
+#### Agent Risk Level
+
+low
+
+#### Agent Example
+
+#### Example
+
+```ts
+dtcEngine.ModelTransform.restoreScale({parentId: '', ids: ['Camera01', 'Camera02'] }, (result) => { console.log(result); });
+```