NgtpGrid

Preview

canvas.ts

import { ChangeDetectionStrategy, Component } from '@angular/core';
import { PostprocessingWrapper } from '@postprocessing/wrapper.ts';
import { NgtCanvas, provideNgtRenderer } from 'angular-three/dom';
import { SceneGraph } from './scene-graph';

@Component({
    selector: 'app-grid',
    template: `
        <ngt-canvas [camera]="{ position: [0, 0, 5], fov: 50 }">
            <app-postprocessing-wrapper *canvasContent [lights]="true" background="#0a0a1a" [grid]="false">
                <app-scene-graph />
            </app-postprocessing-wrapper>
        </ngt-canvas>
    `,
    changeDetection: ChangeDetectionStrategy.OnPush,
    host: { class: 'grid-demo relative block h-full' },
    imports: [NgtCanvas, PostprocessingWrapper, SceneGraph],
})
export default class Grid {
    static clientProviders = [provideNgtRenderer()];
}

scene-graph.ts

import { ChangeDetectionStrategy, Component, CUSTOM_ELEMENTS_SCHEMA, ElementRef, viewChild } from '@angular/core';
import { beforeRender, NgtArgs } from 'angular-three';
import { NgtpBloom, NgtpEffectComposer, NgtpGrid } from 'angular-three-postprocessing';
import * as THREE from 'three';

@Component({
    selector: 'app-scene-graph',
    template: `
        <ngt-mesh #mesh>
            <ngt-torus-knot-geometry *args="[1, 0.3, 128, 32]" />
            <ngt-mesh-standard-material color="#ff00ff" [emissive]="'#ff00ff'" [emissiveIntensity]="0.3" />
        </ngt-mesh>

        <ngtp-effect-composer>
            <ngtp-grid [options]="{ scale: 0.6, lineWidth: 0.3 }" />
            <ngtp-bloom [options]="{ intensity: 0.5, luminanceThreshold: 0.4 }" />
        </ngtp-effect-composer>
    `,
    schemas: [CUSTOM_ELEMENTS_SCHEMA],
    changeDetection: ChangeDetectionStrategy.OnPush,
    imports: [NgtArgs, NgtpEffectComposer, NgtpGrid, NgtpBloom],
})
export class SceneGraph {
    private meshRef = viewChild.required<ElementRef<THREE.Mesh>>('mesh');

    constructor() {
        beforeRender(({ delta }) => {
            const mesh = this.meshRef().nativeElement;
            mesh.rotation.x += delta * 0.2;
            mesh.rotation.y += delta * 0.3;
        });
    }
}

The grid effect overlays a grid pattern on the scene, useful for technical visualizations, retro aesthetics, or debugging.

Usage

import { NgtpEffectComposer, NgtpGrid } from 'angular-three-postprocessing';

@Component({
  template: `
    <ngtp-effect-composer>
      <ngtp-grid [options]="{
        scale: 1.0,
        lineWidth: 0.5
      }" />
    </ngtp-effect-composer>
  `,
  imports: [NgtpEffectComposer, NgtpGrid],
})
export class SceneGraph {}

Options

Property	Type	Default	Description
scale	number	1.0	Scale of the grid pattern
lineWidth	number	0.0	Width of grid lines

Example: Cyberpunk Grid

@Component({
  template: `
    <ngt-mesh>
      <ngt-torus-knot-geometry *args="[1, 0.3, 128, 32]" />
      <ngt-mesh-standard-material color="#ff00ff" [emissive]="'#ff00ff'" [emissiveIntensity]="0.5" />
    </ngt-mesh>

    <ngtp-effect-composer>
      <ngtp-grid [options]="{
        scale: 0.5,
        lineWidth: 0.3
      }" />
      <ngtp-bloom [options]="{ intensity: 0.5 }" />
    </ngtp-effect-composer>
  `,
  imports: [NgtpEffectComposer, NgtpGrid, NgtpBloom, NgtArgs],
  schemas: [CUSTOM_ELEMENTS_SCHEMA],
})
export class SceneGraph {}

Tips

• Smaller scale values create a finer grid
• Combine with bloom for a glowing grid effect
• Works well with neon/cyberpunk color schemes
• Can be used for technical or scientific visualizations