feat(core): configurable max notification skip count

nartc · nartc · commit 2554a59e3aa9 · 2025-05-17T15:03:51.000-05:00
diff --git a/libs/core/src/lib/instance.ts b/libs/core/src/lib/instance.ts
@@ -228,9 +228,10 @@ function notifyAncestors(instance: NgtInstanceNode | null, type: 'objects' | 'no
 	const id = instance.__ngt_id__ || instance['uuid'];
 	if (!id) return;
 
+	const maxNotificationSkipCount = localState.store?.snapshot.maxNotificationSkipCount || 5;
 	const cached = notificationCache.get(id);
 
-	if (!cached || cached.lastType !== type || cached.skipCount > 5) {
+	if (!cached || cached.lastType !== type || cached.skipCount > maxNotificationSkipCount) {
 		notificationCache.set(id, { skipCount: 0, lastType: type });
 
 		if (notificationCache.size === 1) {
diff --git a/libs/core/src/lib/renderer/renderer.ts b/libs/core/src/lib/renderer/renderer.ts
@@ -41,6 +41,16 @@ import { attachThreeNodes, internalDestroyNode, kebabToPascal, NgtRendererClassI
 
 export interface NgtRendererFactory2Options {
 	verbose?: boolean;
+	/**
+	 * When a change happens to an object's direct children, Angular Three will notify the object's ancestors
+	 * of this change so the ancestors are aware of the updated matrices of the object. In order to reduce the
+	 * number of notifications, Angular Three caches and skips notifications when possible.
+	 *
+	 * However, this can cause missed notifications in some cases. Control the number of skips with this option.
+	 *
+	 * @default 5
+	 */
+	maxNotificationSkipCount?: number;
 }
 
 export const NGT_RENDERER_OPTIONS = new InjectionToken<NgtRendererFactory2Options>('NGT_RENDERER_OPTIONS');
diff --git a/libs/core/src/lib/store.ts b/libs/core/src/lib/store.ts
@@ -3,6 +3,7 @@ import { ElementRef, InjectOptions, InjectionToken, effect, inject } from '@angu
 import { Subject } from 'rxjs';
 import * as THREE from 'three';
 import { injectLoop } from './loop';
+import { NGT_RENDERER_OPTIONS } from './renderer/renderer';
 import type {
 	NgtBeforeRenderRecord,
 	NgtCamera,
@@ -20,6 +21,7 @@ import { updateCamera } from './utils/update';
 
 export function storeFactory() {
 	const { invalidate, advance } = injectLoop();
+	const rendererOptions = inject(NGT_RENDERER_OPTIONS, { optional: true }) || {};
 	const document = inject(DOCUMENT);
 	const window = document.defaultView || undefined;
 
@@ -47,6 +49,7 @@ export function storeFactory() {
 
 	const store: SignalState<NgtState> = signalState<NgtState>({
 		id: makeId(),
+		maxNotificationSkipCount: rendererOptions.maxNotificationSkipCount || 5,
 		pointerMissed$: pointerMissed$.asObservable(),
 		events: { priority: 1, enabled: true, connected: false },
 
diff --git a/libs/core/src/lib/types.ts b/libs/core/src/lib/types.ts
@@ -359,6 +359,8 @@ export interface NgtState {
 	previousRoot: SignalState<NgtState> | null;
 	/** Internals */
 	internal: NgtInternalState;
+	/** maxSkipCount from renderer options */
+	maxNotificationSkipCount?: number;
 }
 
 export interface NgtCanvasOptions {

Original file line number	Diff line number	Diff line change
`@@ -359,6 +359,8 @@ export interface NgtState {`
`359`	`359`	`previousRoot: SignalState<NgtState> \| null;`
`360`	`360`	`/** Internals */`
`361`	`361`	`internal: NgtInternalState;`
	`362`	`+ /** maxSkipCount from renderer options */`
	`363`	`+ maxNotificationSkipCount?: number;`
`362`	`364`	`}`
`363`	`365`
`364`	`366`	`export interface NgtCanvasOptions {`