Triangular Engine

Peer Dependencies (must be in your app)

Configure angular.json Assets

Add the following to your project's angular.json → architect.build.options.assets:

{
  "glob": "**/*",
  "input": "node_modules/triangular-engine/assets",
  "output": "triangular-engine"
}

For DRACO-compressed GLTF models, also add:

{
  "glob": "**/*",
  "input": "node_modules/three/examples/jsm/libs/draco/",
  "output": "draco/"
}

Local Development with npm link

When working with a locally-built version of the library:

# In the triangular-engine workspace
npm run link

# In your app
npm link triangular-engine

Critical: You MUST set "preserveSymlinks": true in your app's angular.json → architect.build.options to avoid NullInjectorError issues (e.g. _HighContrastModeDetector token failures).

Also add to your app's tsconfig.json:

{
  "compilerOptions": {
    "paths": {
      "triangular-engine": ["node_modules/triangular-engine"]
    }
  }
}

2. Core Pattern: Providing the Engine

Every component that hosts a <scene> MUST provide EngineService. Use the static helper:

import { Component } from "@angular/core";
import { EngineModule, EngineService } from "triangular-engine";

@Component({
  selector: "app-my-scene",
  imports: [EngineModule],
  providers: EngineService.provide({ showFPS: true }),
  template: `
    <scene>
      <!-- 3D content here -->
    </scene>
  `,
})
export class MySceneComponent {}

Engine Options

EngineService.provide({
  showFPS: true, // Show FPS counter
  transparent: true, // Transparent canvas background
  preferredRenderer: "webgl", // 'webgl' | 'webgpu'
});

Rules

• One <scene> per component/viewport. Do NOT nest multiple <scene> elements.
• Always import EngineModule — it re-exports all engine components.
• Provide EngineService at the component level, NOT at the root/module level.

3. Component Selectors Reference

All components are standalone. Import EngineModule for convenience.

Core Nodes

Camera & Controls

Geometry

Materials

Lights

Post-Processing (WebGL only)

GLTF

CSS Renderers

Physics (Rapier)

Physics (Jolt)

Features & UI

4. Common Object3D Inputs

All 3D node components extend Object3DComponent and accept:

5. Services

EngineService

Core rendering and control service. Inject it in components that host <scene>.

private readonly engineService = inject(EngineService);

Key APIs:

• scene — The Three.js Scene instance
• renderer — The WebGLRenderer or WebGPURenderer
• camera$ — BehaviorSubject<Camera> for the active camera
• tick$ — BehaviorSubject<number> emitting delta time each frame
• elapsedTime$ — BehaviorSubject<number> total elapsed time
• switchCamera(camera) — Switch active camera
• requestSingleRender() — Trigger a single render frame
• setFPSLimit(fps) — Limit rendering FPS
• composer — EffectComposer | undefined for post-processing
• Input streams: keydown$, keyup$, mousemove$, mouseup$, mousedown$, click$, wheel$, contextmenu$

PhysicsService

Rapier physics world management.

• world$, beforeStep$, stepped$
• getRigidBodyById(id) — Look up a rigid body by its string ID
• setSimulatePhysics(paused) — Pause/resume physics
• setDebugState(debug) — Toggle debug visualization

LoaderService

Asset loading with caching.

• loadAndCacheGltf(path, cachePath?, force?) — Load and cache GLTF
• loadAndCacheTexture(path) — Load and cache texture
• Sets Draco decoder path to /draco/

6. Code Examples

Minimal Scene

@Component({
  selector: "app-demo",
  imports: [EngineModule],
  providers: EngineService.provide({ showFPS: true }),
  template: `
    <scene>
      <camera [position]="[4, 3, 6]" [lookAt]="[0, 0, 0]" />
      <directionalLight [position]="[3, 5, 2]" />
      <mesh>
        <boxGeometry [params]="[2, 2, 2]" />
        <meshStandardMaterial />
      </mesh>
    </scene>
  `,
})
export class DemoComponent {}

Mesh with Material

<mesh [position]="[0, 1, 0]" [castShadow]="true">
  <boxGeometry [params]="[1, 1, 1]" />
  <meshStandardMaterial [params]="{ color: '#88c' }" />
</mesh>

Texture Loading

<meshStandardMaterial [map]="'assets/textures/wood.jpg'" />

GLTF Model

<gltf [gltfPath]="'assets/models/scene.glb'" [enableBVH]="true" />

Post-Processing

<scene>
  <camera [position]="[0, 0, 6]" [lookAt]="[0, 0, 0]" />
  <!-- scene content -->

  <effect-composer>
    <unrealBloomPass [strength]="1.2" [radius]="0.4" [threshold]="0.85" />
    <glitchPass [goWild]="false" />
    <smaaPass />
    <outputPass />
  </effect-composer>
</scene>

Note: outputPass should always be the last pass. Post-processing requires preferredRenderer: 'webgl'.

Physics Scene (Rapier)

<scene>
  <camera [position]="[4, 3, 6]" [lookAt]="[0, 0, 0]" />
  <directionalLight [position]="[3, 5, 2]" />

  <physics [gravity]="[0, -9.81, 0]" [debug]="false">
    <!-- Ground (Fixed) -->
    <rigidBody [rigidBodyType]="1">
      <cuboidCollider [halfExtents]="[50, 0.5, 50]" />
      <mesh [position]="[0, -0.5, 0]">
        <boxGeometry [params]="[100, 1, 100]" />
        <meshStandardMaterial [params]="{ color: '#666' }" />
      </mesh>
    </rigidBody>

    <!-- Falling Ball (Dynamic) -->
    <rigidBody [rigidBodyType]="0" [position]="[0, 4, 0]">
      <ballCollider [radius]="0.5" />
      <mesh>
        <sphereGeometry [params]="{ radius: 0.5, widthSegments: 32, heightSegments: 16 }" />
        <meshNormalMaterial />
      </mesh>
    </rigidBody>
  </physics>
</scene>

Animation via Tick

export class AnimatedSceneComponent implements OnInit {
  private readonly engineService = inject(EngineService);
  private readonly destroyRef = inject(DestroyRef);

  readonly rotation = signal<[number, number, number]>([0, 0, 0]);

  ngOnInit(): void {
    this.engineService.elapsedTime$.pipe(takeUntilDestroyed(this.destroyRef)).subscribe(() => {
      const t = this.engineService.elapsedTime$.value;
      this.rotation.set([t * 0.3, t * 0.5, 0]);
    });
  }
}

Orbit Controls

<scene>
  <orbitControls [cameraPosition]="[0, 5, 10]" [target]="[0, 0, 0]" [isActive]="true" />
  <!-- scene content -->
</scene>

7. Troubleshooting

NullInjectorError: No provider for _EngineService

Cause: Missing EngineService.provide(...) in the component hosting <scene>.

Fix: Add providers: EngineService.provide({ ... }) to your @Component.

Injection errors when using npm link (e.g. _HighContrastModeDetector)

Cause: Symlink resolution creates duplicate Angular instances.

Fix:

1. Set "preserveSymlinks": true in angular.json → build options
2. Add "paths": { "triangular-engine": ["node_modules/triangular-engine"] } to tsconfig.json

Post-processing not working

Cause: Post-processing (EffectComposer) requires WebGL renderer.

Fix: Ensure preferredRenderer: 'webgl' in your engine options (this is the default).

GLTF Draco decode failure

Cause: Draco decoder files not served.

Fix: Add the Draco asset glob to angular.json (see Setup section above).

8. Performance Tips

• Use instancedRigidBody or InstancedMesh for many similar objects
• Enable enableBVH on GLTF for faster raycasting on complex meshes
• Use setFPSLimit() to cap frame rate when full 60fps isn't needed
• Use renderOnlyWhenThisIsTriggered on <scene> for on-demand rendering (e.g., configurators)
• Prefer meshBasicMaterial for unlit objects — cheaper than meshStandardMaterial

9. Architecture Notes

• All engine components are standalone Angular components/directives
• The object graph uses Angular DI: children auto-attach to their parent Object3DComponent
• EngineModule is a convenience NgModule that re-exports all engine components
• EngineService is provided per-component (NOT singleton) — each <scene> gets its own engine instance
• Physics runs on the engine tick — PhysicsService.update() is called each frame
• Camera switching is handled via EngineService.switchCamera() or the isActive / switchCameraTrigger inputs on camera/orbit components