路径动画对象 PathAnimation
路径动画对象操作是用于控制云渲染路径动画对象操作的工具, 该工具的主要功能包括:
- 设置模型动画姿态
- 设置模型姿态
- 设置是否关联相机
- 播放路径动画
- 暂停动画
- 恢复动画
- 停止动画
- 设置路径动画关联的模型
- 设置路径动画关联对象的guid值
- 路径动画效果清除
- 设置是否以第三人称视角观察
- 设置模型的提示文本的文字内容
- 设置模型的提示文本内容的样式
- 设置模型移动速度
- 设置是否循环播放
- 设置是否方向播放
- 设置相机俯仰角
- 获取对象的guid值
- 获取路径动画关联对象的guid值
- 设置铭牌是否显示
- 设置路径动画对象与相机的固定位置
我们将提供详细的使用指南和功能说明,帮助用户更好地使用该工具。
设置模型动画姿态 | setModelAnimationAction
- 说明:设置模型动画姿态
我们可以调用 PathAnimation
上面的 setModelAnimationAction
方法来设置模型动画姿态。
- 参数说明
Name | Type | Description |
---|---|---|
modelAnimationAcs | string[] | 模型姿态数组 |
注意
模型姿态的取值根据具体模型有所不同,例如:阿凡达模型的模型姿态有,'Walk', 'Run', 'Climb', 'WalkCrouch', 'Stand', 'Jump', 'Fly'等。
调用示例:
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
//例如阿凡达模型姿态:'Walk', 'Run', 'Climb', 'WalkCrouch', 'Stand', 'Jump', 'Fly'等
var modelAnimationAcs = ["Walk", "Run", "Walk"];
await pathAnim.setModelAnimationAction(modelAnimationAcs);
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
//例如阿凡达模型姿态:'Walk', 'Run', 'Climb', 'WalkCrouch', 'Stand', 'Jump', 'Fly'等
var modelAnimationAcs = ["Walk", "Run", "Walk"];
await pathAnim.setModelAnimationAction(modelAnimationAcs);
设置模型姿态 | setModelAction
- 说明:设置模型姿态
我们可以调用 PathAnimation
上面的 setModelAction
方法来设置模型姿态。
- 参数说明
Name | Type | Description |
---|---|---|
modelAcs | string | 模型姿态 |
注意
模型姿态的取值根据具体模型有所不同,例如:阿凡达模型的模型姿态有,'Walk', 'Run', 'Climb', 'WalkCrouch', 'Stand', 'Jump', 'Fly'等。
调用示例:
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
//例如阿凡达模型姿态:'Walk', 'Run', 'Climb', 'WalkCrouch', 'Stand', 'Jump', 'Fly'等
var modeAcs = "Walk";
await pathAnim.setModelAction(modeAcs);
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
//例如阿凡达模型姿态:'Walk', 'Run', 'Climb', 'WalkCrouch', 'Stand', 'Jump', 'Fly'等
var modeAcs = "Walk";
await pathAnim.setModelAction(modeAcs);
设置是否关联相机 | isBindCamera
- 说明:设置是否关联相机
我们可以调用 PathAnimation
上面的 isBindCamera
方法来设置是否关联相机。
- 参数说明
Name | Type | Description |
---|---|---|
isBindCamera | Boolean | 是否关联相机 |
调用示例:
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.isBindCamera(false);
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.isBindCamera(false);
设置是否关联相机(接口名修改将弃用) | setIsBindCamera
- 说明:设置是否关联相机
我们可以调用 PathAnimation
上面的 setIsBindCamera
方法来设置是否关联相机。
- 参数说明
Name | Type | Description |
---|---|---|
isBindCamera | Boolean | 是否关联相机 |
调用示例:
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setIsBindCamera(false);
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setIsBindCamera(false);
播放路径动画 | playPathAnimation
- 说明:播放路径动画
我们可以调用 PathAnimation
上面的 playPathAnimation
方法来播放路径动画。
- 参数说明
Name | Type | Description |
---|---|---|
time | number | 动画播放时长 |
调用示例:
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.playPathAnimation(50000);
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.playPathAnimation(50000);
暂停动画 | pausePathAnimation
- 说明:暂停动画
我们可以调用 PathAnimation
上面的 pausePathAnimation
方法来暂停动画。
调用示例:
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.pausePathAnimation();
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.pausePathAnimation();
恢复动画 | resumePathAnimation
- 说明:恢复动画
我们可以调用 PathAnimation
上面的 resumePathAnimation
方法来设置路径颜色。
调用示例:
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.resumePathAnimation();
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.resumePathAnimation();
停止动画 | stopPathAnimation
- 说明:停止动画
我们可以调用 PathAnimation
上面的 stopPathAnimation
方法来停止动画。
调用示例:
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.stopPathAnimation();
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.stopPathAnimation();
设置路径动画关联的模型 | changeAnimationModel
- 说明:设置路径动画关联的模型
我们可以调用 PathAnimation
上面的 changeAnimationModel
方法来设置路径动画关联的模型。
- 参数说明
Name | Type | Description |
---|---|---|
modelFile | string | 动画模型文件 |
调用示例:
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.changeAnimationModel("avatar_woman.wlkx");
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.changeAnimationModel("avatar_woman.wlkx");
设置路径动画关联的模型 | setAnimationModel
- 说明:设置路径动画关联的模型
我们可以调用 PathAnimation
上面的 setAnimationModel
方法来设置路径动画关联的模型。
- 参数说明
Name | Type | Description |
---|---|---|
modelFile | string | 动画模型文件 |
调用示例:
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setAnimationModel("avatar_woman.wlkx");
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setAnimationModel("avatar_woman.wlkx");
设置路径动画关联对象的guid值 | setBindPathGuid
- 说明:设置路径动画关联对象的guid值
我们可以调用 PathAnimation
上面的 setBindPathGuid
方法来设置路径动画关联对象的guid值。
- 参数说明
Name | Type | Description |
---|---|---|
pathGuid | string | 路径对象guid值 |
调用示例:
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setBindPathGuid("E24FAB463E5746FE98F100918D4B32E3");
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setBindPathGuid("E24FAB463E5746FE98F100918D4B32E3");
路径动画效果清除 | pathAnimEffectClean
- 说明:路径动画效果清除
我们可以调用 PathAnimation
上面的 pathAnimEffectClean
方法来清除路径动画效果。
调用示例:
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.pathAnimEffectClean();
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.pathAnimEffectClean();
设置是否以第三人称视角观察 | isTPP
- 说明:设置是否以第三人称视角观察
我们可以调用 PathAnimation
上面的 isTPP
方法来设置是否以第三人称视角观察。
- 参数说明
Name | Type | Description |
---|---|---|
isTPP | Boolean | 是否为第三人称 |
调用示例:
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.isTPP(false);
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.isTPP(false);
设置是否以第三人称视角观察 | setTPP
- 说明:设置是否以第三人称视角观察
我们可以调用 PathAnimation
上面的 setTPP
方法来设置是否以第三人称视角观察。
- 参数说明
Name | Type | Description |
---|---|---|
isTPP | Boolean | 是否为第三人称 |
调用示例:
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setTPP(false);
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setTPP(false);
设置模型的提示文本的文字内容 | setTitleContent
- 说明:设置模型的提示文本的文字内容
我们可以调用 PathAnimation
上面的 setTitleContent
方法来设置模型的提示文本的文字内容。
- 参数说明
Name | Type | Description |
---|---|---|
title | string | 文本内容 |
调用示例:
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setTitleContent("pathAnimation");
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setTitleContent("pathAnimation");
设置模型的提示文本内容的样式 | setTitleContentStyle
- 说明:设置模型的提示文本内容的样式
我们可以调用 PathAnimation
上面的 setTitleContentStyle
方法来设置模型的提示文本内容的样式。
- 参数说明
Name | Type | Description |
---|---|---|
contentStyle | any | json格式铭牌样式 格式为:{ |
contentStyle: { //样式设置
color: "0XFF000000", //字体颜色(选填)
fontFace: "宋体", //字体类型(选填)
outLineColor: "0XFFFF0000", //轮廓线颜色(选填)
outLineWidth: 3, //轮廓线宽度(选填)
rectBorderColor: "0xFFFF0000", //背景框颜色(选填)
rectBorderShow: false,//是否显示背景框(选填)
backGroundColor: '0xFF0000FF', //背景颜色(选填)
size: 10, //文字大小(选填)
titleTextPortrait: false //文字排列方式(横向或纵向)(选填)
};}|
调用示例:
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
var contentStyle = {
color: 4294967040,
fontFace: "宋体",
outLineColor: 4294901760,
outLineWidth: 3,
rectBorderColor: 4294901760,
backGroundColor: '0xFF0000FF',
rectBorderShow: false,
size: 10,
titleTextPortrait: false
};
await pathAnim.setTitleContentStyle(contentStyle);
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
var contentStyle = {
color: 4294967040,
fontFace: "宋体",
outLineColor: 4294901760,
outLineWidth: 3,
rectBorderColor: 4294901760,
backGroundColor: '0xFF0000FF',
rectBorderShow: false,
size: 10,
titleTextPortrait: false
};
await pathAnim.setTitleContentStyle(contentStyle);
设置模型移动速度 | setSpeed
- 说明:设置模型移动速度
我们可以调用 PathAnimation
上面的 setSpeed
方法来设置模型移动速度。
- 参数说明
Name | Type | Description |
---|---|---|
speed | number | 移动速率 |
调用示例:
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setSpeed(4);
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setSpeed(4);
设置是否循环播放 | isLoop
- 说明:设置是否循环播放
我们可以调用 PathAnimation
上面的 isLoop
方法来设置是否循环播放。
- 参数说明
Name | Type | Description |
---|---|---|
isLoop | Boolean | 是否循环播放 |
调用示例:
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.isLoop(false);
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.isLoop(false);
设置是否循环播放 | setIsLoop
- 说明:设置是否循环播放
我们可以调用 PathAnimation
上面的 setIsLoop
方法来设置是否循环播放。
- 参数说明
Name | Type | Description |
---|---|---|
isLoop | Boolean | 是否循环播放 |
调用示例:
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setIsLoop(false);
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setIsLoop(false);
设置是否反向播放 | isReverse
- 说明:设置是否反向播放
我们可以调用 PathAnimation
上面的 isReverse
方法来设置是否反向播放。
- 参数说明
Name | Type | Description |
---|---|---|
isReverse | Boolean | 是否反向播放 |
调用示例:
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.isReverse(false);
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.isReverse(false);
设置是否反向播放 | setIsReverse
- 说明:设置是否反向播放
我们可以调用 PathAnimation
上面的 setIsReverse
方法来设置是否反向播放。
- 参数说明
Name | Type | Description |
---|---|---|
isReverse | Boolean | 是否反向播放 |
调用示例:
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setIsReverse(false);
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setIsReverse(false);
设置相机俯仰角 | setPitch
- 说明:设置相机俯仰角
我们可以调用 PathAnimation
上面的 setPitch
方法来设置相机俯仰角。
- 参数说明
Name | Type | Description |
---|---|---|
pitch | number | 相机俯仰角 |
调用示例:
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setPitch(60.0);
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setPitch(60.0);
获取路径动画对象的guid值 | getGuid
- 说明:获取路径动画对象的guid值
我们可以调用 PathAnimation
上面的 getGuid
方法来获取路径动画对象的guid值。
调用示例:
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.getGuid();
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.getGuid();
获取路径动画关联路径对象的guid值 | getBindPathGuid
- 说明:获取路径动画关联路径对象的guid值
我们可以调用 PathAnimation
上面的 getBindPathGuid
方法来获取路径动画关联路径对象的guid值。
调用示例:
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.getBindPathGuid();
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.getBindPathGuid();
设置铭牌是否显示 | setNameplateNodeShow
- 说明:设置铭牌是否显示
我们可以调用 PathAnimation
上面的 setNameplateNodeShow
方法来设置铭牌是否显示。
- 参数说明
Name | Type | Description |
---|---|---|
isShow | Boolean | 是否显示 |
调用示例:
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setNameplateNodeShow(false);
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setNameplateNodeShow(false);
设置路径动画对象与相机的固定位置 | setFixedCamera
- 说明:设置路径动画对象与相机的固定位置
我们可以调用 AvatarManager
上面的 setFixedCamera
方法来设置路径动画对象与相机的固定位置。
- 参数说明
Name | Type | Description |
---|---|---|
height | number | 路径动画对象头顶向上的距离 |
distanc | number | 距离路径动画对象的距离 |
优化相机位置
height单位m 正为上 负为下;distanc,取值范围-100-100,单位为m ,默认为为5,正为后,负为前。
调用示例:
let pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setFixedCamera(12,-15);
let pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setFixedCamera(12,-15);