Class: PathAnimation
路径动画对象类
Details
设置模型动画姿态、设置模型姿态、设置是否关联相机、播放路径动画、暂停动画、恢复动画、停止动画、设置路径动画关联的模型、 设置路径动画关联对象的guid值、路径动画效果清除、设置是否以第三人称视角观察、设置模型的提示文本的文字内容、 设置模型的提示文本内容的样式、设置模型移动速度、设置是否循环播放、设置是否方向播放、设置相机俯仰角、获取对象的guid值、 获取路径动画关联对象的guid值、设置铭牌是否显示等
Hierarchy
Callable
↳
PathAnimation
Methods
setModelAnimationAction
▸ setModelAnimationAction(modelAnimationAcs
): Promise
<any
>
Details
设置模型动画姿态
Examples
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.setModelAction(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.setModelAction(modelAnimationAcs);
Parameters
Name | Type | Description |
---|---|---|
modelAnimationAcs | string [] | 模型姿态数组 |
Returns
Promise
<any
>
无
setModelAction
▸ setModelAction(modelAcs
): Promise
<any
>
Details
设置模型姿态
Examples
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);
Parameters
Name | Type | Description |
---|---|---|
modelAcs | string | 模型姿态 |
Returns
Promise
<any
>
无
setIsBindCamera
▸ setIsBindCamera(isBindCamera
): Promise
<any
>
Details
设置是否关联相机(接口名修改将弃用)
Examples
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);
Parameters
Name | Type | Description |
---|---|---|
isBindCamera | boolean | 是否关联相机 |
Returns
Promise
<any
>
无
isBindCamera
▸ isBindCamera(isBindCamera
): Promise
<any
>
Details
设置是否关联相机
Examples
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);
Parameters
Name | Type | Description |
---|---|---|
isBindCamera | boolean | 是否关联相机 |
Returns
Promise
<any
>
无
playPathAnimation
▸ playPathAnimation(time
): Promise
<any
>
Details
播放路径动画
Examples
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.playPathAnimation(30000);
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.playPathAnimation(30000);
Parameters
Name | Type | Description |
---|---|---|
time | number | 动画播放时长 |
Returns
Promise
<any
>
pausePathAnimation
▸ pausePathAnimation(): Promise
<any
>
Details
暂停动画
Examples
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();
Returns
Promise
<any
>
resumePathAnimation
▸ resumePathAnimation(): Promise
<any
>
Details
恢复动画
Examples
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();
Returns
Promise
<any
>
stopPathAnimation
▸ stopPathAnimation(): Promise
<any
>
Details
停止动画
Examples
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();
Returns
Promise
<any
>
setAnimationModel
▸ setAnimationModel(modelFile
): Promise
<any
>
Details
设置路径动画关联的模型
Examples
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");
Parameters
Name | Type | Description |
---|---|---|
modelFile | string | 动画模型文件 |
Returns
Promise
<any
>
changeAnimationModel
▸ changeAnimationModel(modelFile
): Promise
<any
>
Details
设置路径动画关联的模型
Examples
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");
Parameters
Name | Type | Description |
---|---|---|
modelFile | string | 动画模型文件 |
Returns
Promise
<any
>
setBindPathGuid
▸ setBindPathGuid(pathGuid
, isNeedChangeCamera?
): Promise
<any
>
Details
设置路径动画关联路径对象的guid值
Examples
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");
Parameters
Name | Type | Default value | Description |
---|---|---|---|
pathGuid | string | undefined | 路径对象guid值 |
isNeedChangeCamera | boolean | true | 是否需要改变相机位置; |
Returns
Promise
<any
>
pathAnimEffectClean
▸ pathAnimEffectClean(): Promise
<any
>
Details
路径动画效果清除
Examples
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();
Returns
Promise
<any
>
setTPP
▸ setTPP(isTPP
): Promise
<any
>
Details
设置是否以第三人称视角观察
Examples
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);
Parameters
Name | Type | Description |
---|---|---|
isTPP | boolean | 是否为第三人称 |
Returns
Promise
<any
>
isTPP
▸ isTPP(isTPP
): Promise
<any
>
Details
设置是否以第三人称视角观察
Examples
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);
Parameters
Name | Type | Description |
---|---|---|
isTPP | boolean | 是否为第三人称 |
Returns
Promise
<any
>
setTitleContent
▸ setTitleContent(title
): Promise
<any
>
Details
设置模型的提示文本的文字内容
Examples
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");
Parameters
Name | Type | Description |
---|---|---|
title | string | 文本内容 |
Returns
Promise
<any
>
无
setTitleContentStyle
▸ setTitleContentStyle(contentStyle
): undefined
| Promise
<any
>
Details
设置模型的提示文本内容的样式
Examples
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
var contentStyle = {
color: "0XFF000000", //字体颜色(选填)
fontFace: "宋体", //字体类型(选填)
outLineColor: "0XFFFF0000", //轮廓线颜色(选填)
outLineWidth: 3, //轮廓线宽度(选填)
rectBorderColor: "0xFFFF0000", //背景框颜色(选填)
rectBorderShow: false,//是否显示背景框(选填)
backGroundColor: '0xFF0000FF', //背景颜色(选填)
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: "0XFF000000", //字体颜色(选填)
fontFace: "宋体", //字体类型(选填)
outLineColor: "0XFFFF0000", //轮廓线颜色(选填)
outLineWidth: 3, //轮廓线宽度(选填)
rectBorderColor: "0xFFFF0000", //背景框颜色(选填)
rectBorderShow: false,//是否显示背景框(选填)
backGroundColor: '0xFF0000FF', //背景颜色(选填)
size: 10, //文字大小(选填)
titleTextPortrait: false //文字排列方式(横向或纵向)(选填)
};
await pathAnim.setTitleContentStyle(contentStyle);
Parameters
Name | Type | Description |
---|---|---|
contentStyle | any | json格式铭牌样式 格式为:{ contentStyle: { //样式设置 color: "0XFF000000", //字体颜色(选填) fontFace: "宋体", //字体类型(选填) outLineColor: "0XFFFF0000", //轮廓线颜色(选填) outLineWidth: 3, //轮廓线宽度(选填) rectBorderColor: "0xFFFF0000", //背景框颜色(选填) rectBorderShow: false,//是否显示背景框(选填) backGroundColor: '0xFF0000FF', //背景颜色(选填) size: 10, //文字大小(选填) titleTextPortrait: false //文字排列方式(横向或纵向)(选填) }; } |
Returns
undefined
| Promise
<any
>
无
setSpeed
▸ setSpeed(speed
): Promise
<any
>
Details
设置模型移动速度
Examples
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setSpeed(3);
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setSpeed(3);
Parameters
Name | Type | Description |
---|---|---|
speed | number | 移动速率 |
Returns
Promise
<any
>
无
setIsLoop
▸ setIsLoop(isLoop
): Promise
<any
>
Details
设置是否循环播放
Examples
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);
Parameters
Name | Type | Description |
---|---|---|
isLoop | boolean | 是否循环播放 |
Returns
Promise
<any
>
无
setIsReverse
▸ setIsReverse(isReverse
): Promise
<any
>
Details
设置是否反向播放
Examples
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);
Parameters
Name | Type | Description |
---|---|---|
isReverse | boolean | 是否反向播放 |
Returns
Promise
<any
>
无
isLoop
▸ isLoop(isLoop
): Promise
<any
>
Details
设置是否循环播放
Examples
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);
Parameters
Name | Type | Description |
---|---|---|
isLoop | boolean | 是否循环播放 |
Returns
Promise
<any
>
无
isReverse
▸ isReverse(isReverse
): Promise
<any
>
Details
设置是否反向播放
Examples
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);
Parameters
Name | Type | Description |
---|---|---|
isReverse | boolean | 是否反向播放 |
Returns
Promise
<any
>
无
setPitch
▸ setPitch(pitch
): Promise
<any
>
Details
设置相机俯仰角
Examples
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setPitch(43.8);
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
await pathAnim.setPitch(43.8);
Parameters
Name | Type | Description |
---|---|---|
pitch | number | 相机俯仰角 |
Returns
Promise
<any
>
无
getGuid
▸ getGuid(): Promise
<string
>
Details
获取路径动画对象的guid值
Examples
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();
Returns
Promise
<string
>
返回路径动画对象的guid值
getBindPathGuid
▸ getBindPathGuid(): Promise
<string
>
Details
获取路径动画关联路径对象的guid值
Examples
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();
Returns
Promise
<string
>
返回路径动画关联路径对象的guid值
setNameplateNodeShow
▸ setNameplateNodeShow(isShow
): Promise
<any
>
Details
设置铭牌是否显示
Examples
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);
Parameters
Name | Type | Description |
---|---|---|
isShow | boolean | 是否显示 |
Returns
Promise
<any
>
无
getModelNode
▸ getModelNode(): Node
Details
获取路径动画对象中的node对象
Example
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
pathAnim.getModelNode();
const pathAnimationManager = await cloud.getPathAnimationManager();
var pathAnims = await pathAnimationManager.getAllPathAnimation();
var pathAnim = pathAnims[0];
pathAnim.getModelNode();
Returns
返回路径动画对象中的node对象
setFixedCamera
▸ setFixedCamera(height
, distanc
): Promise
<any
>
设置路径动画对象与相机的固定位置
Examples
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);
Parameters
Name | Type | Description |
---|---|---|
height | number | 路径动画对象头顶向上的距离 |
distanc | number | 距离路径动画对象的距离 |
Returns
Promise
<any
>