refactor(core): some perf improvements

nartc · nartc · commit 154e9b97fcad · 2025-05-17T14:53:50.000-05:00
diff --git a/libs/core/src/lib/events.ts b/libs/core/src/lib/events.ts
@@ -324,6 +324,10 @@ export function createEvents(store: SignalState<NgtState>) {
 				};
 		}
 
+		const isPointerMove = name === 'pointermove';
+		const isClickEvent = name === 'click' || name === 'contextmenu' || name === 'dblclick';
+		const filter = isPointerMove ? filterPointerEvents : undefined;
+
 		// Any other pointer goes here ...
 		return function handleEvent(event: NgtDomEvent) {
 			// NOTE: __pointerMissed$ on NgtStore is private subject since we only expose the Observable
@@ -334,10 +338,6 @@ export function createEvents(store: SignalState<NgtState>) {
 			internal.lastEvent.nativeElement = event;
 
 			// Get fresh intersects
-			const isPointerMove = name === 'pointermove';
-			const isClickEvent = name === 'click' || name === 'contextmenu' || name === 'dblclick';
-			const filter = isPointerMove ? filterPointerEvents : undefined;
-
 			const hits = intersect(event, filter);
 			const delta = isClickEvent ? calculateDistance(event) : 0;
 
diff --git a/libs/core/src/lib/instance.ts b/libs/core/src/lib/instance.ts
@@ -68,6 +68,7 @@ export function prepare<TInstance extends NgtAnyRecord = NgtAnyRecord>(
 			return _nonObjects;
 		});
 
+		instance.__ngt_id__ = crypto.randomUUID();
 		instance.__ngt__ = {
 			previousAttach: null,
 			type,
@@ -195,11 +196,52 @@ export function prepare<TInstance extends NgtAnyRecord = NgtAnyRecord>(
 	return instance;
 }
 
+interface NotificationCacheState {
+	skipCount: number;
+	lastType: 'objects' | 'nonObjects';
+}
+
+const notificationCache = new Map<string, NotificationCacheState>();
+
+/**
+ * Notify ancestors about changes to a THREE.js objects' children
+ *
+ * For example: `NgtsCenter` might have a child that asynchronously loads a 3D model
+ * in which case the model matrices will be settled later. `NgtsCenter` needs to know about this
+ * matrices change to re-center everything inside of it.
+ *
+ * The implementation here uses a naive approach to reduce the number of notifications; we cache
+ * the notifications by the instance ID and the type of the notification.
+ *
+ * 1. If there's no cache or
+ * 2. If the type is different for the same instance or
+ * 3. We've skipped the notifications for this instance more than a certain amount
+ *
+ * then we'll proceed with notification
+ */
 function notifyAncestors(instance: NgtInstanceNode | null, type: 'objects' | 'nonObjects') {
 	if (!instance) return;
+
 	const localState = getInstanceState(instance);
 	if (!localState) return;
-	const { parent } = localState.hierarchyStore.snapshot;
-	localState.hierarchyStore.update({ [type]: (localState.hierarchyStore.snapshot[type] || []).slice() });
-	notifyAncestors(parent, type);
+
+	const id = instance.__ngt_id__ || instance['uuid'];
+	if (!id) return;
+
+	const cached = notificationCache.get(id);
+
+	if (!cached || cached.lastType !== type || cached.skipCount > 5) {
+		notificationCache.set(id, { skipCount: 0, lastType: type });
+
+		if (notificationCache.size === 1) {
+			queueMicrotask(() => notificationCache.clear());
+		}
+
+		const { parent } = localState.hierarchyStore.snapshot;
+		localState.hierarchyStore.update({ [type]: (localState.hierarchyStore.snapshot[type] || []).slice() });
+		notifyAncestors(parent, type);
+		return;
+	}
+
+	notificationCache.set(id, { ...cached, skipCount: cached.skipCount + 1 });
 }
diff --git a/libs/core/src/lib/store.ts b/libs/core/src/lib/store.ts
@@ -34,6 +34,17 @@ export function storeFactory() {
 
 	const pointer = new THREE.Vector2();
 
+	// getCurrentViewport will mutate this instead of creating a new object everytime
+	const tempViewport = {
+		width: 0,
+		height: 0,
+		top: 0,
+		left: 0,
+		factor: 1,
+		distance: 0,
+		aspect: 0,
+	};
+
 	const store: SignalState<NgtState> = signalState<NgtState>({
 		id: makeId(),
 		pointerMissed$: pointerMissed$.asObservable(),
@@ -108,22 +119,28 @@ export function storeFactory() {
 
 				const distance = camera.getWorldPosition(position).distanceTo(tempTarget);
 
+				// Update the pre-allocated viewport object
+				tempViewport.top = top;
+				tempViewport.left = left;
+				tempViewport.aspect = aspect;
+				tempViewport.distance = distance;
+
 				if (is.three<THREE.OrthographicCamera>(camera, 'isOrthographicCamera')) {
-					return {
-						width: width / camera.zoom,
-						height: height / camera.zoom,
-						top,
-						left,
-						factor: 1,
-						distance,
-						aspect,
-					};
+					// For orthographic cameras
+					tempViewport.width = width / camera.zoom;
+					tempViewport.height = height / camera.zoom;
+					tempViewport.factor = 1;
+				} else {
+					// For perspective cameras
+					const fov = (camera.fov * Math.PI) / 180; // convert vertical fov to radians
+					const h = 2 * Math.tan(fov / 2) * distance; // visible height
+					const w = h * aspect; // visible width
+					tempViewport.width = w;
+					tempViewport.height = h;
+					tempViewport.factor = width / w;
 				}
 
-				const fov = (camera.fov * Math.PI) / 180; // convert vertical fov to radians
-				const h = 2 * Math.tan(fov / 2) * distance; // visible height
-				const w = h * (width / height);
-				return { width: w, height: h, top, left, factor: width / w, distance, aspect };
+				return tempViewport;
 			},
 		},
 
diff --git a/libs/core/src/lib/types.ts b/libs/core/src/lib/types.ts
@@ -238,6 +238,7 @@ export interface NgtInstanceState<TObject extends NgtAnyRecord = NgtAnyRecord> {
 }
 
 export type NgtInstanceNode<TObject extends NgtAnyRecord = NgtAnyRecord> = TObject & {
+	__ngt_id__: string;
 	__ngt__: NgtInstanceState<TObject>;
 };
 

Original file line number	Diff line number	Diff line change
`@@ -238,6 +238,7 @@ export interface NgtInstanceState<TObject extends NgtAnyRecord = NgtAnyRecord> {`
`238`	`238`	`}`
`239`	`239`
`240`	`240`	`export type NgtInstanceNode<TObject extends NgtAnyRecord = NgtAnyRecord> = TObject & {`
	`241`	`+ __ngt_id__: string;`
`241`	`242`	`__ngt__: NgtInstanceState<TObject>;`
`242`	`243`	`};`
`243`	`244`