Three.js Blocks

Home
Documentation
Examples
Tools

NavMeshGridHelper

@three-blocks/pro
new NavMeshGridHelper(navMeshGrid : NavMeshGrid, options : Object)
Extends
THREE.Object3D

Create a navmesh grid helper.

Constructor Parameters
navMeshGridNavMeshGrid
The navmesh grid to visualize.
optionsoptionalObject
Configuration options.
Default is {}.
  • showPolygonsoptionalboolean
    Show polygon surfaces.
    Default is true.
  • showEdgesoptionalboolean
    Show polygon edges.
    Default is true.
  • showPortalsoptionalboolean
    Show portal edges (connections).
    Default is false.
  • polygonColoroptionalnumber
    Polygon fill color.
    Default is 0x00ff88.
  • edgeColoroptionalnumber
    Edge line color.
    Default is 0x0088ff.
  • portalColoroptionalnumber
    Portal edge color.
    Default is 0xff8800.
  • opacityoptionalnumber
    Polygon opacity.
    Default is 0.3.
  • yOffsetoptionalnumber
    Y offset above surfaces.
    Default is 0.05.
  • updateIntervaloptionalnumber
    Update interval in ms.
    Default is 1000.

Properties

.navMeshGrid : NavMeshGrid

Reference to the navmesh grid.

.showPolygons : boolean

Whether to show polygon surfaces.

.showEdges : boolean

Whether to show polygon edges.

.showPortals : boolean

Whether to show portal edges.

.polygonColor : number

Polygon fill color.

.edgeColor : number

Edge line color.

.portalColor : number

Portal edge color.

.opacity : number

Polygon opacity.

.yOffset : number

Y offset for visualization elements.

.updateInterval : number

Update interval in milliseconds.

.isNavMeshGridHelper : boolean

Three.js-style type flag.

Methods

update#

update()

Update visualization - call each frame or periodically.

refresh#

refresh()

Force refresh the visualization.

dispose#

dispose()

Dispose of the helper and release resources.