plugin-pathfinding

路径寻找，依赖是 RecastJS

样例

安装

npm install @soonspacejs/plugin-pathfinding
# or
yarn add @soonspacejs/plugin-pathfinding

使用方法

import SoonSpace from 'soonspacejs';
import PathfindingPlugin from '@soonspacejs/plugin-pathfinding';
import { init } from '@recast-navigation/core';

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

// 初始化 RecastJS
await init();

const pathfinding = ssp.registerPlugin(PathfindingPlugin, 'pathfinding');
consolo.log(pathfinding);

属性

navMesh

导航 Mesh 区域

定义

import { NavMesh } from '@recast-navigation/core';

NavMesh | null;

crowd

人群管理

定义

import { Crowd } from '@recast-navigation/core';

Crowd | null;

debugDrawer

导航 Mesh 辅助对象

定义

import { DebugDrawer } from '@recast-navigation/three';

DebugDrawer | null;

crowdHelper

人群辅助对象

定义

import { CrowdHelper } from '@recast-navigation/three';

CrowdHelper | null;

方法

createSoloNavMesh

创建 NavMesh，创建成功后会设置 navMesh 属性

定义

createSoloNavMesh(objects: Object3D[], config?: Partial<SoloNavMeshGeneratorConfig>): NavMesh | null

用法

const [model] = ssp.getObjectByName('xx');
pathfindingPlugin.createSoloNavMesh([model], {
  cs: 0.2,
  ch: 0.2,
});

参数

objects

• 描述: 用于计算 navigation-mesh 的场景对象
• 必填:
• 类型: Object3D[]

config

• 描述: 配置项
• 必填:
• 类型: Partial<SoloNavMeshGeneratorConfig>

SoloNavMeshGeneratorConfig

请参考 SoloNavMeshGeneratorConfig

disposeSoloNavMesh

卸载 Nav Mesh 的数据

定义

disposeSoloNavMesh(): void

用法

pathfinding.disposeSoloNavMesh();

提示

再次调用 createSoloNavMesh 之前，必须先调用 disposeSoloNavMesh 卸载数据。

createCrowd

创建 Crowd，创建成功后会设置 crowd 属性

定义

function createCrowd(params: CrowdParams): Crowd | null;

用法

pathfindingPlugin.createCrowd({
  maxAgents: 500,
  maxAgentRadius: 10,
});

参数

params

• 描述: Crowd 参数
• 必填:
• 类型: CrowdParams

disposeCrowd

卸载 Crowd 的数据

定义

function disposeCrowd(): void;

用法

pathfinding.disposeCrowd();

提示

再次调用 createCrowd 之前，必须先调用 disposeCrowd 卸载数据。

createDebugDrawer

创建 DebugDrawer，创建成功后会设置 debugDrawer 属性

定义

function createDebugDrawer(): DebugDrawer | null;

用法

pathfinding.createDebugDrawer();

disposeDebugDrawer

卸载 DebugDrawer 的数据

定义

function disposeDebugDrawer(): void;

用法

pathfinding.disposeDebugDrawer();

提示

再次调用 createDebugDrawer 之前，必须先调用 disposeDebugDrawer 卸载数据。

createCrowdHelper

创建 CrowdHelper，创建成功后会设置 crowdHelper 属性

定义

function createCrowdHelper(params?: CrowdHelperParams): CrowdHelper | null;

用法

pathfinding.createCrowdHelper({
  agentMaterial: new THREE.MeshStandardMaterial({ color: 0x00ff00 }),
});

参数

params

• 描述: CrowdHelper 参数
• 必填:
• 类型: CrowdHelperParams

disposeCrowdHelper

卸载 CrowdHelper 的数据

定义

function disposeCrowdHelper(): void;

用法

pathfinding.disposeCrowdHelper();

提示

再次调用 createCrowdHelper 之前，必须先调用 disposeCrowdHelper 卸载数据。

dispose

卸载所有数据

定义

dispose(): void;

用法

pathfinding.dispose();