Class InfiniteGridRenderer

Infinite ground grid renderer for xeokit V3.

Integrated into RenderManager and rendered once per frame via render(viewRenderState) when enabled is true.

Features:

  • Draws a flat grid on world plane y = 0
  • Uses one camera-centered quad
  • Minor/major lines and world axes generated in the fragment shader
  • Derivative-based antialiasing with fwidth
  • Accepts an externally managed WebGL2RenderingContext

Notes:

  • Does not manage framebuffers, viewport, clearing, or camera updates
  • Call init() once, then render(viewRenderState) each frame when enabled
  • Preserves/restores the GL state it changes internally
const grid = renderManager.infiniteGrid;
grid.enabled = true;
grid.minorStep = 1;
grid.majorStep = 10;

Constructors

constructor

Properties

axisWidth destroyed enabled fadeEnd fadeStart followCamera gridHalfSize initialized majorColor majorStep minorColor minorStep worldForward worldRight worldUp xAxisColor zAxisColor

Methods

destroy init render

Constructors

constructor

Properties

axisWidth

axisWidth: number

Default axis width multiplier relative to minorStep.

destroyed

destroyed: boolean = false

True once destroy() has been called.

enabled

enabled: boolean = false

When true, RenderManager will render this grid each frame.

fadeEnd

fadeEnd: number

Default fade end distance from camera in XZ.

fadeStart

fadeStart: number

Default fade start distance from camera in XZ.

followCamera

followCamera: boolean

When true, the quad is centered under the camera in XZ by default.

gridHalfSize

gridHalfSize: number

Default half-size of the rendered quad in world units.

initialized

initialized: boolean = false

True once init() has successfully allocated resources.

majorColor

majorColor: [number, number, number]

Default major grid color.

majorStep

majorStep: number

Default spacing for major grid lines.

minorColor

minorColor: [number, number, number]

Default minor grid color.

minorStep

minorStep: number

Default spacing for minor grid lines.

worldForward

worldForward: [number, number, number]

World-space "forward" direction (second floor-plane axis). Default is [0,1,0], matching the Scene default.

worldRight

worldRight: [number, number, number]

World-space "right" direction (first floor-plane axis). Default is [1,0,0], matching the Scene default.

worldUp

worldUp: [number, number, number]

World-space "up" direction. Matches the Scene's CoordinateSystem.worldUp. Default is [0,0,1] (Z-up), matching the Scene default.

xAxisColor

xAxisColor: [number, number, number]

Default X-axis color.

zAxisColor

zAxisColor: [number, number, number]

Default Z-axis color.

Methods

destroy

init

render

Settings

Member Visibility

On This Page

Constructors
Properties
Methods