@tldraw/editor 4.3.0 → 4.4.0-canary.29afdff6bb04

package/src/lib/editor/derivations/notVisibleShapes.ts

@@ -9,60 +9,34 @@ import { Editor } from '../Editor'
  * @returns Incremental derivation of non visible shapes.
  */
 export function notVisibleShapes(editor: Editor) {
-	return computed<Set<TLShapeId>>('notVisibleShapes', function updateNotVisibleShapes(prevValue) {
-		const shapeIds = editor.getCurrentPageShapeIds()
-		const nextValue = new Set<TLShapeId>()
-
-		// Extract viewport bounds once to avoid repeated property access
+	return computed<Set<TLShapeId>>('notVisibleShapes', function (prevValue) {
+		const allShapeIds = editor.getCurrentPageShapeIds()
 		const viewportPageBounds = editor.getViewportPageBounds()
-		const viewMinX = viewportPageBounds.minX
-		const viewMinY = viewportPageBounds.minY
-		const viewMaxX = viewportPageBounds.maxX
-		const viewMaxY = viewportPageBounds.maxY
+		const visibleIds = editor.getShapeIdsInsideBounds(viewportPageBounds)
 
-		for (const id of shapeIds) {
-			const pageBounds = editor.getShapePageBounds(id)
-
-			// Hybrid check: if bounds exist and shape overlaps viewport, it's visible.
-			// This inlines Box.Collides to avoid function call overhead and the
-			// redundant Contains check that Box.Includes was doing.
-			if (
-				pageBounds !== undefined &&
-				pageBounds.maxX >= viewMinX &&
-				pageBounds.minX <= viewMaxX &&
-				pageBounds.maxY >= viewMinY &&
-				pageBounds.minY <= viewMaxY
-			) {
-				continue
-			}
+		const nextValue = new Set<TLShapeId>()
 
-			// Shape is outside viewport or has no bounds - check if it can be culled.
-			// We defer getShape and canCull checks until here since most shapes are
-			// typically visible and we can skip these calls for them.
-			const shape = editor.getShape(id)
-			if (!shape) continue
+		// Non-visible shapes are all shapes minus visible shapes
+		for (const id of allShapeIds) {
+			if (!visibleIds.has(id)) {
+				const shape = editor.getShape(id)
+				if (!shape) continue
 
-			const canCull = editor.getShapeUtil(shape.type).canCull(shape)
-			if (!canCull) continue
+				const canCull = editor.getShapeUtil(shape.type).canCull(shape)
+				if (!canCull) continue
 
-			nextValue.add(id)
+				nextValue.add(id)
+			}
 		}
 
-		if (isUninitialized(prevValue)) {
+		if (isUninitialized(prevValue) || prevValue.size !== nextValue.size) {
 			return nextValue
 		}
 
-		// If there are more or less shapes, we know there's a change
-		if (prevValue.size !== nextValue.size) return nextValue
-
-		// If any of the old shapes are not in the new set, we know there's a change
 		for (const prev of prevValue) {
-			if (!nextValue.has(prev)) {
-				return nextValue
-			}
+			if (!nextValue.has(prev)) return nextValue
 		}
 
-		// If we've made it here, we know that the set is the same
 		return prevValue
 	})
 }

package/src/lib/editor/managers/SpatialIndexManager/RBushIndex.ts

@@ -0,0 +1,144 @@
+import type { TLShapeId } from '@tldraw/tlschema'
+import RBush from 'rbush'
+import { Box } from '../../../primitives/Box'
+
+/**
+ * Element stored in the R-tree spatial index.
+ * Contains bounds (minX, minY, maxX, maxY) and shape ID.
+ */
+export interface SpatialElement {
+	minX: number
+	minY: number
+	maxX: number
+	maxY: number
+	id: TLShapeId
+}
+
+/**
+ * Custom RBush class for tldraw shapes.
+ */
+class TldrawRBush extends RBush<SpatialElement> {}
+
+/**
+ * Wrapper around RBush R-tree for efficient spatial queries.
+ * Maintains a map of elements currently in the tree for efficient updates.
+ */
+export class RBushIndex {
+	private rBush: TldrawRBush
+	private elementsInTree: Map<TLShapeId, SpatialElement>
+
+	constructor() {
+		this.rBush = new TldrawRBush()
+		this.elementsInTree = new Map()
+	}
+
+	/**
+	 * Search for shapes within the given bounds.
+	 * Returns set of shape IDs that intersect with the bounds.
+	 */
+	search(bounds: Box): Set<TLShapeId> {
+		const results = this.rBush.search({
+			minX: bounds.minX,
+			minY: bounds.minY,
+			maxX: bounds.maxX,
+			maxY: bounds.maxY,
+		})
+		return new Set(results.map((e: SpatialElement) => e.id))
+	}
+
+	/**
+	 * Insert or update a shape in the spatial index.
+	 * If the shape already exists, it will be removed first to prevent duplicates.
+	 */
+	upsert(id: TLShapeId, bounds: Box): void {
+		// Remove existing entry to prevent map-tree desync
+		const existing = this.elementsInTree.get(id)
+		if (existing) {
+			this.rBush.remove(existing)
+		}
+
+		const element: SpatialElement = {
+			minX: bounds.minX,
+			minY: bounds.minY,
+			maxX: bounds.maxX,
+			maxY: bounds.maxY,
+			id,
+		}
+		this.rBush.insert(element)
+		this.elementsInTree.set(id, element)
+	}
+
+	/**
+	 * Remove a shape from the spatial index.
+	 */
+	remove(id: TLShapeId): void {
+		const element = this.elementsInTree.get(id)
+		if (element) {
+			this.rBush.remove(element)
+			this.elementsInTree.delete(id)
+		}
+	}
+
+	/**
+	 * Bulk load elements into the spatial index.
+	 * More efficient than individual inserts for initial loading.
+	 */
+	bulkLoad(elements: SpatialElement[]): void {
+		this.rBush.load(elements)
+		for (const element of elements) {
+			this.elementsInTree.set(element.id, element)
+		}
+	}
+
+	/**
+	 * Clear all elements from the spatial index.
+	 */
+	clear(): void {
+		this.rBush.clear()
+		this.elementsInTree.clear()
+	}
+
+	/**
+	 * Check if a shape is in the spatial index.
+	 */
+	has(id: TLShapeId): boolean {
+		return this.elementsInTree.has(id)
+	}
+
+	/**
+	 * Get the number of elements in the spatial index.
+	 */
+	getSize(): number {
+		return this.elementsInTree.size
+	}
+
+	/**
+	 * Get all shape IDs currently in the spatial index.
+	 */
+	getAllShapeIds(): TLShapeId[] {
+		return Array.from(this.elementsInTree.keys())
+	}
+
+	/**
+	 * Get the bounds currently stored in the spatial index for a shape.
+	 * Returns undefined if the shape is not in the index.
+	 */
+	getBounds(id: TLShapeId): Box | undefined {
+		const element = this.elementsInTree.get(id)
+		if (!element) return undefined
+		return new Box(
+			element.minX,
+			element.minY,
+			element.maxX - element.minX,
+			element.maxY - element.minY
+		)
+	}
+
+	/**
+	 * Dispose of the spatial index.
+	 * Clears all data structures to prevent memory leaks.
+	 */
+	dispose(): void {
+		this.clear()
+	}
+}

package/src/lib/editor/managers/SpatialIndexManager/SpatialIndexManager.ts

@@ -0,0 +1,215 @@
+import { Computed, RESET_VALUE, computed, isUninitialized } from '@tldraw/state'
+import type { RecordsDiff } from '@tldraw/store'
+import type { TLRecord } from '@tldraw/tlschema'
+import { TLPageId, TLShape, TLShapeId, isShape } from '@tldraw/tlschema'
+import { objectMapValues } from '@tldraw/utils'
+import { Box } from '../../../primitives/Box'
+import type { Editor } from '../../Editor'
+import { RBushIndex, type SpatialElement } from './RBushIndex'
+
+/**
+ * Manages spatial indexing for efficient shape location queries.
+ *
+ * Uses an R-tree (via RBush) to enable O(log n) spatial queries instead of O(n) iteration.
+ * Handles shapes with computed bounds (arrows, groups, custom shapes) by checking all shapes'
+ * bounds on each update using the reactive bounds cache.
+ *
+ * Key features:
+ * - Incremental updates using filterHistory pattern
+ * - Leverages existing bounds cache reactivity for dependency tracking
+ * - Works with any custom shape type with computed bounds
+ * - Per-page index (rebuilds on page change)
+ * - Optimized for viewport culling queries
+ *
+ * @internal
+ */
+export class SpatialIndexManager {
+	private rbush: RBushIndex
+	private spatialIndexComputed: Computed<number>
+	private lastPageId: TLPageId | null = null
+
+	constructor(public readonly editor: Editor) {
+		this.rbush = new RBushIndex()
+		this.spatialIndexComputed = this.createSpatialIndexComputed()
+	}
+
+	private createSpatialIndexComputed() {
+		const shapeHistory = this.editor.store.query.filterHistory('shape')
+
+		return computed<number>('spatialIndex', (_prevValue, lastComputedEpoch) => {
+			if (isUninitialized(_prevValue)) {
+				return this.buildFromScratch(lastComputedEpoch)
+			}
+
+			const shapeDiff = shapeHistory.getDiffSince(lastComputedEpoch)
+
+			if (shapeDiff === RESET_VALUE) {
+				return this.buildFromScratch(lastComputedEpoch)
+			}
+
+			const currentPageId = this.editor.getCurrentPageId()
+			if (this.lastPageId !== currentPageId) {
+				return this.buildFromScratch(lastComputedEpoch)
+			}
+
+			// No shape changes - index is already up to date
+			if (shapeDiff.length === 0) {
+				return lastComputedEpoch
+			}
+
+			// Process incremental updates
+			this.processIncrementalUpdate(shapeDiff)
+
+			return lastComputedEpoch
+		})
+	}
+
+	private buildFromScratch(epoch: number): number {
+		this.rbush.clear()
+		this.lastPageId = this.editor.getCurrentPageId()
+
+		const shapes = this.editor.getCurrentPageShapes()
+		const elements: SpatialElement[] = []
+
+		// Collect all shape elements for bulk loading
+		for (const shape of shapes) {
+			const bounds = this.editor.getShapePageBounds(shape.id)
+			if (bounds) {
+				elements.push({
+					minX: bounds.minX,
+					minY: bounds.minY,
+					maxX: bounds.maxX,
+					maxY: bounds.maxY,
+					id: shape.id,
+				})
+			}
+		}
+
+		// Bulk load for efficiency
+		this.rbush.bulkLoad(elements)
+
+		return epoch
+	}
+
+	private processIncrementalUpdate(shapeDiff: RecordsDiff<TLRecord>[]): void {
+		// Track shapes we've already processed from the diff
+		const processedShapeIds = new Set<TLShapeId>()
+
+		// 1. Process shape additions, removals, and updates from diff
+		for (const changes of shapeDiff) {
+			// Handle additions (only for shapes on current page)
+			for (const shape of objectMapValues(changes.added) as TLShape[]) {
+				if (isShape(shape) && this.editor.getAncestorPageId(shape) === this.lastPageId) {
+					const bounds = this.editor.getShapePageBounds(shape.id)
+					if (bounds) {
+						this.rbush.upsert(shape.id, bounds)
+					}
+					processedShapeIds.add(shape.id)
+				}
+			}
+
+			// Handle removals
+			for (const shape of objectMapValues(changes.removed) as TLShape[]) {
+				if (isShape(shape)) {
+					this.rbush.remove(shape.id)
+					processedShapeIds.add(shape.id)
+				}
+			}
+
+			// Handle updated shapes: page changes and bounds updates
+			for (const [from, to] of objectMapValues(changes.updated) as [TLShape, TLShape][]) {
+				if (!isShape(to)) continue
+				processedShapeIds.add(to.id)
+
+				const wasOnPage = this.editor.getAncestorPageId(from) === this.lastPageId
+				const isOnPage = this.editor.getAncestorPageId(to) === this.lastPageId
+
+				if (isOnPage) {
+					const bounds = this.editor.getShapePageBounds(to.id)
+					if (bounds) {
+						this.rbush.upsert(to.id, bounds)
+					}
+				} else if (wasOnPage) {
+					this.rbush.remove(to.id)
+				}
+			}
+		}
+
+		// 2. Check remaining shapes in index for bounds changes
+		// This handles shapes with computed bounds (arrows bound to moved shapes, groups with moved children, etc.)
+		const allShapeIds = this.rbush.getAllShapeIds()
+
+		for (const shapeId of allShapeIds) {
+			if (processedShapeIds.has(shapeId)) continue
+
+			const currentBounds = this.editor.getShapePageBounds(shapeId)
+			const indexedBounds = this.rbush.getBounds(shapeId)
+
+			if (!this.areBoundsEqual(currentBounds, indexedBounds)) {
+				if (currentBounds) {
+					this.rbush.upsert(shapeId, currentBounds)
+				} else {
+					this.rbush.remove(shapeId)
+				}
+			}
+		}
+	}
+
+	private areBoundsEqual(a: Box | undefined, b: Box | undefined): boolean {
+		if (!a && !b) return true
+		if (!a || !b) return false
+		return a.minX === b.minX && a.minY === b.minY && a.maxX === b.maxX && a.maxY === b.maxY
+	}
+
+	/**
+	 * Get shape IDs within the given bounds.
+	 * Optimized for viewport culling queries.
+	 *
+	 * Note: Results are unordered. If you need z-order, combine with sorted shapes:
+	 * ```ts
+	 * const candidates = editor.spatialIndex.getShapeIdsInsideBounds(bounds)
+	 * const sorted = editor.getCurrentPageShapesSorted().filter(s => candidates.has(s.id))
+	 * ```
+	 *
+	 * @param bounds - The bounds to search within
+	 * @returns Unordered set of shape IDs within the bounds
+	 *
+	 * @public
+	 */
+	getShapeIdsInsideBounds(bounds: Box): Set<TLShapeId> {
+		this.spatialIndexComputed.get()
+		return this.rbush.search(bounds)
+	}
+
+	/**
+	 * Get shape IDs at a point (with optional margin).
+	 * Creates a small bounding box around the point and searches the spatial index.
+	 *
+	 * Note: Results are unordered. If you need z-order, combine with sorted shapes:
+	 * ```ts
+	 * const candidates = editor.spatialIndex.getShapeIdsAtPoint(point, margin)
+	 * const sorted = editor.getCurrentPageShapesSorted().filter(s => candidates.has(s.id))
+	 * ```
+	 *
+	 * @param point - The point to search at
+	 * @param margin - The margin around the point to search (default: 0)
+	 * @returns Unordered set of shape IDs that could potentially contain the point
+	 *
+	 * @public
+	 */
+	getShapeIdsAtPoint(point: { x: number; y: number }, margin = 0): Set<TLShapeId> {
+		this.spatialIndexComputed.get()
+		return this.rbush.search(new Box(point.x - margin, point.y - margin, margin * 2, margin * 2))
+	}
+
+	/**
+	 * Dispose of the spatial index manager.
+	 * Clears the R-tree to prevent memory leaks.
+	 *
+	 * @public
+	 */
+	dispose(): void {
+		this.rbush.dispose()
+		this.lastPageId = null
+	}
+}

package/src/version.ts

@@ -1,9 +1,9 @@
 // This file is automatically generated by internal/scripts/refresh-assets.ts.
 // Do not edit manually. Or do, I'm a comment, not a cop.
 
-export const version = '4.3.0'
+export const version = '4.4.0-canary.29afdff6bb04'
 export const publishDates = {
 	major: '2025-09-18T14:39:22.803Z',
-	minor: '2026-01-21T11:56:39.106Z',
-	patch: '2026-01-21T11:56:39.106Z',
+	minor: '2026-01-21T13:27:27.357Z',
+	patch: '2026-01-21T13:27:27.357Z',
 }