Class RecastJSPlugin

RecastJS navigation plugin

Hierarchy

RecastJSPlugin

Implements

INavigationEnginePlugin

Constructors

constructor

new RecastJSPlugin(recastInjection?: any): RecastJSPlugin

- Defined in .temp/docdirectory/doc.d.ts:85089
Initializes the recastJS plugin

Parameters
- Optional recastInjection: any
  
  can be used to inject your own recast reference
Returns RecastJSPlugin

Properties

bjsRECAST Search playground for bjsRECAST

bjsRECAST: any

Reference to the Recast library

name Search playground for name

name: string

plugin name

navMesh Search playground for navMesh

navMesh: any

the first navmesh created. We might extend this to support multiple navmeshes

Accessors

timeFactor

get timeFactor(): number
set timeFactor(value: number): void

- Defined in .temp/docdirectory/doc.d.ts:85130
Get the time factor used for crowd agent update

Returns number
the time factor
- Defined in .temp/docdirectory/doc.d.ts:85125
Time factor applied when updating crowd agents (default 1). A value of 0 will pause crowd updates.

Parameters
- value: number
  
  the time factor applied at update
Returns void

Methods

addBoxObstacle Search playground for addBoxObstacle

addBoxObstacle(position: Vector3, extent: Vector3, angle: number): IObstacle

Implementation of INavigationEnginePlugin.addBoxObstacle
- Defined in .temp/docdirectory/doc.d.ts:85245
Creates an oriented box obstacle and add it to the navigation

Parameters
- position: Vector3
  
  world position
- extent: Vector3
  
  box size
- angle: number
  
  angle in radians of the box orientation on Y axis
Returns IObstacle
the obstacle freshly created

addCylinderObstacle Search playground for addCylinderObstacle

addCylinderObstacle(position: Vector3, radius: number, height: number): IObstacle

Implementation of INavigationEnginePlugin.addCylinderObstacle
- Defined in .temp/docdirectory/doc.d.ts:85237
Creates a cylinder obstacle and add it to the navigation

Parameters
- position: Vector3
  
  world position
- radius: number
  
  cylinder radius
- height: number
  
  cylinder height
Returns IObstacle
the obstacle freshly created

buildFromNavmeshData Search playground for buildFromNavmeshData

buildFromNavmeshData(data: Uint8Array): void

Implementation of INavigationEnginePlugin.buildFromNavmeshData
- Defined in .temp/docdirectory/doc.d.ts:85215
build the navmesh from a previously saved state using getNavmeshData

Parameters
- data: Uint8Array
  
  the Uint8Array returned by getNavmeshData
Returns void

computePath Search playground for computePath

computePath(start: Vector3, end: Vector3): Vector3[]

Implementation of INavigationEnginePlugin.computePath
- Defined in .temp/docdirectory/doc.d.ts:85190
Compute a navigation path from start to end. Returns an empty array if no path can be computed

Parameters
- start: Vector3
  
  world position
- end: Vector3
  
  world position
Returns Vector3[]
array containing world position composing the path

createCrowd Search playground for createCrowd

createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd

Implementation of INavigationEnginePlugin.createCrowd
- Defined in .temp/docdirectory/doc.d.ts:85198
Create a new Crowd so you can add agents

Parameters
- maxAgents: number
  
  the maximum agent count in the crowd
- maxAgentRadius: number
  
  the maximum radius an agent can have
- scene: Scene
  
  to attach the crowd to
Returns ICrowd
the crowd you can add agents to

createDebugNavMesh Search playground for createDebugNavMesh

createDebugNavMesh(scene: Scene): Mesh

Implementation of INavigationEnginePlugin.createDebugNavMesh
- Defined in .temp/docdirectory/doc.d.ts:85143
Create a navigation mesh debug mesh

Parameters
- scene: Scene
  
  is where the mesh will be added
Returns Mesh
debug display mesh

createNavMesh Search playground for createNavMesh

createNavMesh(meshes: Mesh[], parameters: INavMeshParameters, completion?: ((navmeshData: Uint8Array) => void)): void

Implementation of INavigationEnginePlugin.createNavMesh
- Defined in .temp/docdirectory/doc.d.ts:85137
Creates a navigation mesh

Parameters
- meshes: Mesh[]
  
  array of all the geometry used to compute the navigation mesh
- parameters: INavMeshParameters
  
  bunch of parameters used to filter geometry
- Optional completion: ((navmeshData: Uint8Array) => void)
  
  callback when data is available from the worker. Not used without a worker
  - - (navmeshData: Uint8Array): void
    - Parameters
      - navmeshData: Uint8Array
      Returns void
Returns void

dispose Search playground for dispose

dispose(): void

Implementation of INavigationEnginePlugin.dispose
- Defined in .temp/docdirectory/doc.d.ts:85229
Disposes

Returns void

getClosestPoint Search playground for getClosestPoint

getClosestPoint(position: Vector3): Vector3

Implementation of INavigationEnginePlugin.getClosestPoint
- Defined in .temp/docdirectory/doc.d.ts:85149
Get a navigation mesh constrained position, closest to the parameter position

Parameters
- position: Vector3
  
  world position
Returns Vector3
the closest point to position constrained by the navigation mesh

getClosestPointToRef Search playground for getClosestPointToRef

getClosestPointToRef(position: Vector3, result: Vector3): void

Implementation of INavigationEnginePlugin.getClosestPointToRef
- Defined in .temp/docdirectory/doc.d.ts:85155
Get a navigation mesh constrained position, closest to the parameter position

Parameters
- position: Vector3
  
  world position
- result: Vector3
  
  output the closest point to position constrained by the navigation mesh
Returns void

getDefaultQueryExtent Search playground for getDefaultQueryExtent

getDefaultQueryExtent(): Vector3

Implementation of INavigationEnginePlugin.getDefaultQueryExtent
- Defined in .temp/docdirectory/doc.d.ts:85210
Get the Bounding box extent specified by setDefaultQueryExtent

Returns Vector3
the box extent values

getDefaultQueryExtentToRef Search playground for getDefaultQueryExtentToRef

getDefaultQueryExtentToRef(result: Vector3): void

Implementation of INavigationEnginePlugin.getDefaultQueryExtentToRef
- Defined in .temp/docdirectory/doc.d.ts:85225
Get the Bounding box extent result specified by setDefaultQueryExtent

Parameters
- result: Vector3
  
  output the box extent values
Returns void

getMaximumSubStepCount Search playground for getMaximumSubStepCount

getMaximumSubStepCount(): number

Implementation of INavigationEnginePlugin.getMaximumSubStepCount
- Defined in .temp/docdirectory/doc.d.ts:85120
Get the maximum number of iterations per navigation tick update

Returns number
the maximum number of iterations

getNavmeshData Search playground for getNavmeshData

getNavmeshData(): Uint8Array

Implementation of INavigationEnginePlugin.getNavmeshData
- Defined in .temp/docdirectory/doc.d.ts:85220
returns the navmesh data that can be used later. The navmesh must be built before retrieving the data

Returns Uint8Array
data the Uint8Array that can be saved and reused

getRandomPointAround Search playground for getRandomPointAround

getRandomPointAround(position: Vector3, maxRadius: number): Vector3

Implementation of INavigationEnginePlugin.getRandomPointAround
- Defined in .temp/docdirectory/doc.d.ts:85162
Get a navigation mesh constrained position, within a particular radius

Parameters
- position: Vector3
  
  world position
- maxRadius: number
  
  the maximum distance to the constrained world position
Returns Vector3
the closest point to position constrained by the navigation mesh

getRandomPointAroundToRef Search playground for getRandomPointAroundToRef

getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void

Implementation of INavigationEnginePlugin.getRandomPointAroundToRef
- Defined in .temp/docdirectory/doc.d.ts:85169
Get a navigation mesh constrained position, within a particular radius

Parameters
- position: Vector3
  
  world position
- maxRadius: number
  
  the maximum distance to the constrained world position
- result: Vector3
  
  output the closest point to position constrained by the navigation mesh
Returns void

getTimeStep Search playground for getTimeStep

getTimeStep(): number

Implementation of INavigationEnginePlugin.getTimeStep
- Defined in .temp/docdirectory/doc.d.ts:85107
Get the time step of the navigation tick update.

Returns number
the current time step

isSupported Search playground for isSupported

isSupported(): boolean

Implementation of INavigationEnginePlugin.isSupported
- Defined in .temp/docdirectory/doc.d.ts:85255
If this plugin is supported

Returns boolean
true if plugin is supported

moveAlong Search playground for moveAlong

moveAlong(position: Vector3, destination: Vector3): Vector3

Implementation of INavigationEnginePlugin.moveAlong
- Defined in .temp/docdirectory/doc.d.ts:85176
Compute the final position from a segment made of destination-position

Parameters
- position: Vector3
  
  world position
- destination: Vector3
  
  world position
Returns Vector3
the resulting point along the navmesh

moveAlongToRef Search playground for moveAlongToRef

moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void

Implementation of INavigationEnginePlugin.moveAlongToRef
- Defined in .temp/docdirectory/doc.d.ts:85183
Compute the final position from a segment made of destination-position

Parameters
- position: Vector3
  
  world position
- destination: Vector3
  
  world position
- result: Vector3
  
  output the resulting point along the navmesh
Returns void

removeObstacle Search playground for removeObstacle

removeObstacle(obstacle: IObstacle): void

Implementation of INavigationEnginePlugin.removeObstacle
- Defined in .temp/docdirectory/doc.d.ts:85250
Removes an obstacle created by addCylinderObstacle or addBoxObstacle

Parameters
- obstacle: IObstacle
  
  obstacle to remove from the navigation
Returns void

setDefaultQueryExtent Search playground for setDefaultQueryExtent

setDefaultQueryExtent(extent: Vector3): void

Implementation of INavigationEnginePlugin.setDefaultQueryExtent
- Defined in .temp/docdirectory/doc.d.ts:85205
Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...) The queries will try to find a solution within those bounds default is (1,1,1)

Parameters
- extent: Vector3
  
  x,y,z value that define the extent around the queries point of reference
Returns void

setMaximumSubStepCount Search playground for setMaximumSubStepCount

setMaximumSubStepCount(newStepCount?: number): void

Implementation of INavigationEnginePlugin.setMaximumSubStepCount
- Defined in .temp/docdirectory/doc.d.ts:85115
If delta time in navigation tick update is greater than the time step a number of sub iterations are done. If more iterations are need to reach deltatime they will be discarded. A value of 0 will set to no maximum and update will use as many substeps as needed

Parameters
- Optional newStepCount: number
  
  the maximum number of iterations
Returns void

setTimeStep Search playground for setTimeStep

setTimeStep(newTimeStep?: number): void

Implementation of INavigationEnginePlugin.setTimeStep
- Defined in .temp/docdirectory/doc.d.ts:85102
Set the time step of the navigation tick update. Default is 1/60. A value of 0 will disable fixed time update

Parameters
- Optional newTimeStep: number
  
  the new timestep to apply to this world.
Returns void

setWorkerURL Search playground for setWorkerURL

setWorkerURL(workerURL: string): boolean

- Defined in .temp/docdirectory/doc.d.ts:85095
Set worker URL to be used when generating a new navmesh

Parameters
- workerURL: string
  
  url string
Returns boolean
boolean indicating if worker is created

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional recastInjection: any

Returns RecastJSPlugin

Properties

bjsRECASTSearch playground for bjsRECAST

nameSearch playground for name

navMeshSearch playground for navMesh

Accessors

timeFactor

Returns number

Parameters

value: number

Returns void

Methods

addBoxObstacleSearch playground for addBoxObstacle

Parameters

position: Vector3

extent: Vector3

angle: number

Returns IObstacle

addCylinderObstacleSearch playground for addCylinderObstacle

Parameters

position: Vector3

radius: number

height: number

Returns IObstacle

buildFromNavmeshDataSearch playground for buildFromNavmeshData

Parameters

data: Uint8Array

Returns void

computePathSearch playground for computePath

Parameters

start: Vector3

end: Vector3

Returns Vector3[]

createCrowdSearch playground for createCrowd

Parameters

maxAgents: number

maxAgentRadius: number

scene: Scene

Returns ICrowd

createDebugNavMeshSearch playground for createDebugNavMesh

Parameters

scene: Scene

Returns Mesh

createNavMeshSearch playground for createNavMesh

Parameters

meshes: Mesh[]

parameters: INavMeshParameters

Optional completion: ((navmeshData: Uint8Array) => void)

Parameters

navmeshData: Uint8Array

Returns void

Returns void

disposeSearch playground for dispose

Returns void

getClosestPointSearch playground for getClosestPoint

Parameters

position: Vector3

Returns Vector3

getClosestPointToRefSearch playground for getClosestPointToRef

Parameters

position: Vector3

result: Vector3

Returns void

getDefaultQueryExtentSearch playground for getDefaultQueryExtent

Returns Vector3

getDefaultQueryExtentToRefSearch playground for getDefaultQueryExtentToRef

Parameters

result: Vector3

Returns void

bjsRECAST Search playground for bjsRECAST

name Search playground for name

navMesh Search playground for navMesh

addBoxObstacle Search playground for addBoxObstacle

addCylinderObstacle Search playground for addCylinderObstacle

buildFromNavmeshData Search playground for buildFromNavmeshData

computePath Search playground for computePath

createCrowd Search playground for createCrowd

createDebugNavMesh Search playground for createDebugNavMesh

createNavMesh Search playground for createNavMesh

dispose Search playground for dispose

getClosestPoint Search playground for getClosestPoint

getClosestPointToRef Search playground for getClosestPointToRef

getDefaultQueryExtent Search playground for getDefaultQueryExtent

getDefaultQueryExtentToRef Search playground for getDefaultQueryExtentToRef

getMaximumSubStepCount Search playground for getMaximumSubStepCount

getNavmeshData Search playground for getNavmeshData

getRandomPointAround Search playground for getRandomPointAround

getRandomPointAroundToRef Search playground for getRandomPointAroundToRef

getTimeStep Search playground for getTimeStep

isSupported Search playground for isSupported

moveAlong Search playground for moveAlong

moveAlongToRef Search playground for moveAlongToRef

removeObstacle Search playground for removeObstacle

setDefaultQueryExtent Search playground for setDefaultQueryExtent

setMaximumSubStepCount Search playground for setMaximumSubStepCount

setTimeStep Search playground for setTimeStep

setWorkerURL Search playground for setWorkerURL