1. 曲线动画效果配置类

位于：BOS3D.Plugins.Animation.CurveAnimationConfig

1.1. 实例化

let curveAnimationConfig = new BOS3D.Plugins.Animation.CurveAnimationConfig();

1.2. 属性

1.2.1. curves

/**
 * 曲线对象的数组,应为BOS3D.Geometry.MeshLine或其子类.例如BOS3D.Geometry.SplineCurve
 * @property {Array}  curves
 */

1.2.2. type

/**
 * 曲线动画类型，“trail”为轨迹，“flow”为流动，默认为“trail”
 * @property {String}  type
 */

1.2.3. time

/**
 * 曲线动画完成一个动画周期所用时间，单位为毫秒（time和speed选填一项，若都填写则默认time有效）
 * @property {Number}  time
 */

1.2.4. speed

/**
 * 曲线动画速度,默认为10000，（time和speed选填一项，若都填写则默认time有效）
 * @property {Number} 动画速度，每秒前进的距离，距离单位与场景设置单位一致
 */

1.2.5. viewer

/**
 * Viewer对象
 * @property {Object}  viewer
 */

1.2.6. loop

/**
 * 曲线动画是否循环，默认为false
 * @property {Boolean}  loop
 */

2. 曲线动画效果类

位于：BOS3D.Plugins.Animation.CurveAnimation

2.1. 实例化

// 构造曲线动画的配置项
let curveAnimationConfig = new BOS3D.Plugins.Animation.CurveAnimationConfig();
// 配置Viewer对象、曲线对象、动画时间、动画循环、动画类型等参数
curveAnimationConfig.viewer = viewer3D;
curveAnimationConfig.curves = path;
curveAnimationConfig.time = 5000;
curveAnimationConfig.loop = true;
// curveAnimationConfig.type = "flow";
curveAnimationConfig.type = "trail";
// 构造曲线动画对象
let curveAnimation = new BOS3D.Plugins.Animation.CurveAnimation(curveAnimationConfig);
// 播放动画
curveAnimation.play();

2.2. 属性

2.3. 方法

2.3.1. getId

获取曲线动画 ID

调用方式：

/**
 * 获取曲线动画ID
 * @function getId
 * @returns {String} 曲线动画ID
 */
curveAnimation.getId();

2.3.2. getLoop

获取曲线动画是否循环

调用方式：

/**
 * 获取曲线动画是否循环
 * @function getLoop
 * @returns {Boolean} 曲线动画是否循环
 */
curveAnimation.getLoop();

2.3.3. setLoop

设置曲线动画是否循环

调用方式：

/**
 * 设置曲线动画是否循环
 * @function setLoop
 * @param {Boolean} loop 曲线动画是否循环
 * @return {void}
 */
curveAnimation.setLoop(true);

2.3.4. getCurves

获取曲线动画的曲线对象

调用方式：

/**
 * 获取曲线动画的曲线对象
 * @function getCurves
 * @returns {Array} 曲线对象的数组
 */
curveAnimation.getCurves();

2.3.5. getTime

获取曲线动画时间

调用方式：

/**
 * 获取曲线动画时间
 * @function getTime
 * @returns {Number} 动画时间，单位为毫秒
 */
curveAnimation.getTime();

2.3.6. setTime

设置曲线动画时间

调用方式：

/**
 * 设置曲线动画时间
 * @function setTime
 * @param {Number} time 动画时间，单位为毫秒
 * @return {void}
 */
curveAnimation.setTime(1000);

2.3.7. getSpeed

获取曲线动画速度

调用方式：

/**
 * 获取曲线动画速度
 * @function getSpeed
 * @returns {Number} 动画速度
 */
curveAnimation.getSpeed();

2.3.8. setSpeed

设置曲线动画速度

调用方式：

/**
 * 设置曲线动画速度
 * @function setSpeed
 *  @param {Number} speed 动画速度，每秒前进的距离，距离单位与场景设置单位一致
 *  @return {void}
 */
curveAnimation.setSpeed(1000);

2.3.9. getType

获取曲线动画类型

调用方式：

/**
 * 获取曲线动画类型
 * @function getType
 * @returns {String} 曲线动画类型
 */
curveAnimation.getType();

2.3.10. setType

设置曲线动画类型

调用方式：

/**
 * 设置曲线动画类型
 * @function setType
 * @param {String} type 动画类型，“trail”为轨迹，“flow”为流动，默认为“trail”
 * @return {void}
 */
curveAnimation.setType("trail");

2.3.11. play

播放动画

调用方式：

/**
 * 播放动画
 * @function play
 * @return {void}
 */
curveAnimation.play();

2.3.12. pause

暂停动画

调用方式：

/**
 * 暂停动画
 * @function pause
 * @return {void}
 */
curveAnimation.pause();

2.3.13. stop

停止动画

调用方式：

/**
 * 停止动画
 * @function stop
 * @return {void}
 */
curveAnimation.stop();