Class SceneGraphIndex

The path → node map for one attached root.

Index

Constructors

Properties

byName epoch misses root

Accessors

Methods

onChildAdded onChildRemoved detach find uniqueHolderWithin walk renamed isKnownMiss rememberMiss pruneDetached addSubtree removeSubtree addNode removeNode key unkey

Constructors

constructor

new SceneGraphIndex(root: Node): SceneGraphIndex
Parameters
- root: Node
Returns SceneGraphIndex
- Defined in src/utils/scene-graph-index.ts:125

Properties

`Private` `Readonly`byName

byName: Map<string, Node[]> = ...

Name → live members holding it (length > 1 ⇒ ambiguous).

`Private`epoch

epoch: number = 0

Bumped by every edit that could turn a remembered miss into a hit.

`Private`misses

misses: WeakMap<Node, MissMemo> = ...

Lookup root → the names a walk from it missed during epoch.

`Readonly`root

root: Node

Accessors

size

get size(): number
Number of distinct indexed names (diagnostics / tests).

Returns number
- Defined in src/utils/scene-graph-index.ts:138

Methods

`Private` `Readonly`onChildAdded

onChildAdded(event: ChildEvent): void
Parameters
- event: ChildEvent
Returns void
- Defined in src/utils/scene-graph-index.ts:118

`Private` `Readonly`onChildRemoved

onChildRemoved(event: ChildEvent): void
Parameters
- event: ChildEvent
Returns void
- Defined in src/utils/scene-graph-index.ts:121

detach

detach(): void
Stop maintaining the index and release every member.

Returns void
- Defined in src/utils/scene-graph-index.ts:130

find

find(scope: Node, name: string): Node | undefined
scope.getObjectByName(name), answered from the map where it is exact.
Parameters
- scope: Node
- name: string
Returns Node | undefined
- Defined in src/utils/scene-graph-index.ts:143

`Private`uniqueHolderWithin

uniqueHolderWithin(holders: Node[], scope: Node): Node | undefined
The one live holder of a name, when it lies within scope.
Parameters
- holders: Node[]
- scope: Node
Returns Node | undefined
- Defined in src/utils/scene-graph-index.ts:155

`Private`walk

walk(scope: Node, name: string): Node | undefined
The exact answer by walking, remembering a miss and repairing a hit.
Parameters
- scope: Node
- name: string
Returns Node | undefined
- Defined in src/utils/scene-graph-index.ts:169

renamed

renamed(node: Node, previous: string, next: string): void
— called by a member's name accessor.
Parameters
- node: Node
- previous: string
- next: string
Returns void
- Defined in src/utils/scene-graph-index.ts:179

`Private`isKnownMiss

isKnownMiss(scope: Node, name: string): boolean
Parameters
- scope: Node
- name: string
Returns boolean
- Defined in src/utils/scene-graph-index.ts:185

`Private`rememberMiss

rememberMiss(scope: Node, name: string): void
Parameters
- scope: Node
- name: string
Returns void
- Defined in src/utils/scene-graph-index.ts:190

`Private`pruneDetached

pruneDetached(holders: readonly Node[]): void
Parameters
- holders: readonly Node[]
Returns void
- Defined in src/utils/scene-graph-index.ts:203

`Private`addSubtree

addSubtree(top: Node): void
Parameters
- top: Node
Returns void
- Defined in src/utils/scene-graph-index.ts:209

`Private`removeSubtree

removeSubtree(top: Node): void
Parameters
- top: Node
Returns void
- Defined in src/utils/scene-graph-index.ts:216

`Private`addNode

addNode(node: Node): void
Parameters
- node: Node
Returns void
- Defined in src/utils/scene-graph-index.ts:222

`Private`removeNode

removeNode(node: Node): void
Parameters
- node: Node
Returns void
- Defined in src/utils/scene-graph-index.ts:234

`Private`key

key(node: Node, name: string): void
Parameters
- node: Node
- name: string
Returns void
- Defined in src/utils/scene-graph-index.ts:242

`Private`unkey

unkey(node: Node, name: string): void
Parameters
- node: Node
- name: string
Returns void
- Defined in src/utils/scene-graph-index.ts:249