plugin-patrol-controls

路径巡检控制器。

样例

安装

npm install @soonspacejs/plugin-patrol-controls -S
# or
yarn add @soonspacejs/plugin-patrol-controls -S

使用方法

import SoonSpace from 'soonspacejs';
import PatrolControlsPlugin from '@soonspacejs/plugin-patrol-controls';

const ssp = new SoonSpace({
  el: '#view',
  options: {},
  events: {},
});

const patrolControls = ssp.registerPlugin(PatrolControlsPlugin, 'patrolControls');
consolo.log(patrolControls);

方法

start

开始巡检。

定义

type ProgressParams = {
  patrolled: number;
  total: number;
  percent: number;
}

interface StartOptions = {
    eyeHeight?: number | undefined;
    naviSpeed?: number | undefined;
    rotateSpeed?: number | undefined;
    flyToStartPoint?: boolean | undefined;
    onUpdate?: ( realTimePosition: Position, nextNode: Node, toNextNodeDistance: number ) => void;
    onProgress?: ((params: ProgressParams) => void) | undefined;
    onEnd?: ((endPosition: Position) => void) | undefined;
}

function start(path: Topology, options: StartOptions) => void

用法

patrolControls.start(
  // path
  shortestPath.
  // options
  {
    naviSpeed: 1,
    rotateSpeed: 1,
    eyeHeight: 100,
    flyToStartPoint: true,
    onUpdate: (realTimePosition) => {
      console.log(realTimePosition)
    },
    onProgress: ({ percent }) => {
      console.log('巡检进度', percent)
    },
    onEnd: (endPosition) => {
      console.log('巡检结束！', endPosition)
    }
  }
)

参数

path

• 描述: 用于自动巡检的路径
• 必填:
• 类型: Topology

options

• 描述: 可配置项
• 必填:
• 类型: StartOptions

StartOptions

属性	描述	类型	必填	默认值
naviSpeed	巡检时导航速度	number		1
rotateSpeed	视角旋转速度	number		1
eyeHeight	眼睛高度	number		100
flyToStartPoint	是否飞向起始点位置	boolean		true
onUpdate	巡检时实时更新回调函数	onUpdate: ( realTimePosition: Position, nextNode: Node, toNextNodeDistance: number ) => void;
onProgress	巡检进度回调	(params: ProgressParams) => void
onEnd	巡检结束回调函数	(endPosition: Position) => void

setProgress

v2.6.1

设置巡检进度

定义

/**
 * @param percent 0 - 1（不包含 1）
 */
function setProgress(percent: number): void;

用法

patrolControls.setProgress(0.5);

setOptions

动态设置巡检参数

定义

type ResetOptions = Pick<StartOptions, 'eyeHeight' | 'naviSpeed' | 'rotateSpeed'>;

function setOptions(options: ResetOptions): void;

用法

patrolControls.setOptions({
  naviSpeed: 1,
  rotateSpeed: 1,
  eyeHeight: 100,
});

stop

结束巡检。

用法

patrolControls.stop();

pause

暂停巡检。

用法

patrolControls.pause();

resume

继续巡检。

用法

patrolControls.resume();