Repository: pascalorg/editor

Stars: 13210

CLAUDE.md Copy Chapter

AGENTS.md

README.md Copy Chapter

Pascal Editor

A 3D building editor built with React Three Fiber and WebGPU.


https://github.com/user-attachments/assets/8b50e7cf-cebe-4579-9cf3-8786b35f7b6b

Repository Architecture Copy Chapter

This is a Turborepo monorepo with three main packages:

editor-v2/
├── apps/
│   └── editor/          # Next.js application
├── packages/
│   ├── core/            # Schema definitions, state management, systems
│   └── viewer/          # 3D rendering components

Separation of Concerns Copy Section

| Package | Responsibility |
|---------|---------------|
| @pascal-app/core | Node schemas, scene state (Zustand), systems (geometry generation), spatial queries, event bus |
| @pascal-app/viewer | 3D rendering via React Three Fiber, default camera/controls, post-processing |
| apps/editor | UI components, tools, custom behaviors, editor-specific systems |

The viewer renders the scene with sensible defaults. The editor extends it with interactive tools, selection management, and editing capabilities.

Stores Copy Section

Each package has its own Zustand store for managing state:

| Store | Package | Responsibility |
|-------|---------|----------------|
| useScene | @pascal-app/core | Scene data: nodes, root IDs, dirty nodes, CRUD operations. Persisted to IndexedDB with undo/redo via Zundo. |
| useViewer | @pascal-app/viewer | Viewer state: current selection (building/level/zone IDs), level display mode (stacked/exploded/solo), camera mode. |
| useEditor | apps/editor | Editor state: active tool, structure layer visibility, panel states, editor-specific preferences. |

Access patterns:

// Subscribe to state changes (React component)
const nodes = useScene((state) => state.nodes)
const levelId = useViewer((state) => state.selection.levelId)
const activeTool = useEditor((state) => state.tool)
// Access state outside React (callbacks, systems)
const node = useScene.getState().nodes[id]
useViewer.getState().setSelection({ levelId: 'level_123' })

---

Core Concepts Copy Chapter

Nodes Copy Section

Nodes are the data primitives that describe the 3D scene. All nodes extend BaseNode:

BaseNode {
  id: string              // Auto-generated with type prefix (e.g., "wall_abc123")
  type: string            // Discriminator for type-safe handling
  parentId: string | null // Parent node reference
  visible: boolean
  camera?: Camera         // Optional saved camera position
  metadata?: JSON         // Arbitrary metadata (e.g., { isTransient: true })
}

Node Hierarchy:

Site
└── Building
    └── Level
        ├── Wall → Item (doors, windows)
        ├── Slab
        ├── Ceiling → Item (lights)
        ├── Roof
        ├── Zone
        ├── Scan (3D reference)
        └── Guide (2D reference)

Nodes are stored in a flat dictionary (Record<id, Node>), not a nested tree. Parent-child relationships are defined via parentId and children arrays.

---

Scene State (Zustand Store) Copy Section

The scene is managed by a Zustand store in @pascal-app/core:

useScene.getState() = {
  nodes: Record<id, AnyNode>,  // All nodes
  rootNodeIds: string[],       // Top-level nodes (sites)
  dirtyNodes: Set<string>,     // Nodes pending system updates
  createNode(node, parentId),
  updateNode(id, updates),
  deleteNode(id),
}

Middleware:
- Persist - Saves to IndexedDB (excludes transient nodes)
- Temporal (Zundo) - Undo/redo with 50-step history

---

Scene Registry Copy Section

The registry maps node IDs to their Three.js objects for fast lookup:

sceneRegistry = {
  nodes: Map<id, Object3D>,    // ID → 3D object
  byType: {
    wall: Set<id>,
    item: Set<id>,
    zone: Set<id>,
    // ...
  }
}

Renderers register their refs using the useRegistry hook:

const ref = useRef<Mesh>(null!)
useRegistry(node.id, 'wall', ref)

This allows systems to access 3D objects directly without traversing the scene graph.

---

Node Renderers Copy Section

Renderers are React components that create Three.js objects for each node type:

SceneRenderer
└── NodeRenderer (dispatches by type)
    ├── BuildingRenderer
    ├── LevelRenderer
    ├── WallRenderer
    ├── SlabRenderer
    ├── ZoneRenderer
    ├── ItemRenderer
    └── ...

Pattern:
1. Renderer creates a placeholder mesh/group
2. Registers it with useRegistry
3. Systems update geometry based on node data

Example (simplified):

const WallRenderer = ({ node }) => {
  const ref = useRef<Mesh>(null!)
  useRegistry(node.id, 'wall', ref)
  return (
    <mesh ref={ref}>
      <boxGeometry args={[0, 0, 0]} />  {/ Replaced by WallSystem /}
      <meshStandardMaterial />
      {node.children.map(id => <NodeRenderer key={id} nodeId={id} />)}
    </mesh>
  )
}

---

Systems Copy Section

Systems are React components that run in the render loop (useFrame) to update geometry and transforms. They process dirty nodes marked by the store.

Core Systems (in @pascal-app/core):

| System | Responsibility |
|--------|---------------|
| WallSystem | Generates wall geometry with mitering and CSG cutouts for doors/windows |
| SlabSystem | Generates floor geometry from polygons |
| CeilingSystem | Generates ceiling geometry |
| RoofSystem | Generates roof geometry |
| ItemSystem | Positions items on walls, ceilings, or floors (slab elevation) |

Viewer Systems (in @pascal-app/viewer):

| System | Responsibility |
|--------|---------------|
| LevelSystem | Handles level visibility and vertical positioning (stacked/exploded/solo modes) |
| ScanSystem | Controls 3D scan visibility |
| GuideSystem | Controls guide image visibility |

Processing Pattern:

useFrame(() => {
  for (const id of dirtyNodes) {
    const obj = sceneRegistry.nodes.get(id)
    const node = useScene.getState().nodes[id]
    // Update geometry, transforms, etc.
    updateGeometry(obj, node)
    dirtyNodes.delete(id)
  }
})

---

Dirty Nodes Copy Section

When a node changes, it's marked as dirty in useScene.getState().dirtyNodes. Systems check this set each frame and only recompute geometry for dirty nodes.

// Automatic: createNode, updateNode, deleteNode mark nodes dirty
useScene.getState().updateNode(wallId, { thickness: 0.2 })
// → wallId added to dirtyNodes
// → WallSystem regenerates geometry next frame
// → wallId removed from dirtyNodes

Manual marking:

useScene.getState().dirtyNodes.add(wallId)

---

Event Bus Copy Section

Inter-component communication uses a typed event emitter (mitt):

// Node events
emitter.on('wall:click', (event) => { ... })
emitter.on('item:enter', (event) => { ... })
emitter.on('zone:context-menu', (event) => { ... })
// Grid events (background)
emitter.on('grid:click', (event) => { ... })
// Event payload
NodeEvent {
  node: AnyNode
  position: [x, y, z]
  localPosition: [x, y, z]
  normal?: [x, y, z]
  stopPropagation: () => void
}

---

Spatial Grid Manager Copy Section

Handles collision detection and placement validation:

spatialGridManager.canPlaceOnFloor(levelId, position, dimensions, rotation)
spatialGridManager.canPlaceOnWall(wallId, t, height, dimensions)
spatialGridManager.getSlabElevationAt(levelId, x, z)

Used by item placement tools to validate positions and calculate slab elevations.

---

Editor Architecture Copy Chapter

The editor extends the viewer with:

Tools Copy Section

Tools are activated via the toolbar and handle user input for specific operations:

- SelectTool - Selection and manipulation
- WallTool - Draw walls
- ZoneTool - Create zones
- ItemTool - Place furniture/fixtures
- SlabTool - Create floor slabs

Selection Manager Copy Section

The editor uses a custom selection manager with hierarchical navigation:

Site → Building → Level → Zone → Items

Each depth level has its own selection strategy for hover/click behavior.

Editor-Specific Systems Copy Section

- ZoneSystem - Controls zone visibility based on level mode
- Custom camera controls with node focusing

---

Data Flow Copy Chapter

User Action (click, drag)
       ↓
Tool Handler
       ↓
useScene.createNode() / updateNode()
       ↓
Node added/updated in store
Node marked dirty
       ↓
React re-renders NodeRenderer
useRegistry() registers 3D object
       ↓
System detects dirty node (useFrame)
Updates geometry via sceneRegistry
Clears dirty flag

---

Technology Stack Copy Chapter

- React 19 + Next.js 16
- Three.js (WebGPU renderer)
- React Three Fiber + Drei
- Zustand (state management)
- Zod (schema validation)
- Zundo (undo/redo)
- three-bvh-csg (Boolean geometry operations)
- Turborepo (monorepo management)
- Bun (package manager)

---

Getting Started Copy Chapter

Development Copy Section

Run the development server from the root directory to enable hot reload for all packages:

Install dependencies

bun install
Run development server (builds packages + starts editor with watch mode)

bun dev
This will:

1. Build @pascal-app/core and @pascal-app/viewer

2. Start watching both packages for changes

3. Start the Next.js editor dev server

Open http://localhost:3000

Important: Always run bun dev from the root directory to ensure the package watchers are running. This enables hot reload when you edit files in packages/core/src/ or packages/viewer/src/.

Building for Production Copy Section

Build all packages

turbo build
Build specific package

turbo build --filter=@pascal-app/core

Publishing Packages Copy Section

Build packages

turbo build --filter=@pascal-app/core --filter=@pascal-app/viewer
Publish to npm

npm publish --workspace=@pascal-app/core --access public
npm publish --workspace=@pascal-app/viewer --access public

---

Key Files Copy Chapter

| Path | Description |
|------|-------------|
| packages/core/src/schema/ | Node type definitions (Zod schemas) |
| packages/core/src/store/use-scene.ts | Scene state store |
| packages/core/src/hooks/scene-registry/ | 3D object registry |
| packages/core/src/systems/ | Geometry generation systems |
| packages/viewer/src/components/renderers/ | Node renderers |
| packages/viewer/src/components/viewer/ | Main Viewer component |
| apps/editor/components/tools/ | Editor tools |
| apps/editor/store/ | Editor-specific state |

---

Contributors Copy Chapter

<a href="https://github.com/Aymericr"><img src="https://avatars.githubusercontent.com/u/4444492?v=4" width="60" height="60" alt="Aymeric Rabot" style="border-radius:50%"></a>
<a href="https://github.com/wass08"><img src="https://avatars.githubusercontent.com/u/6551176?v=4" width="60" height="60" alt="Wassim Samad" style="border-radius:50%"></a>

---

<a href="https://trendshift.io/repositories/23831" target="_blank"><img src="https://trendshift.io/api/badge/repositories/23831" alt="pascalorg/editor | Trendshift" width="250" height="55"/></a>