Class: SceneGraph — Kata docs
Kata docs

kata-framework


Class: SceneGraph

Defined in: packages/kata-core/src/assets/sceneGraph.ts:31

Constructors

Constructor

new SceneGraph(): SceneGraph;

Returns

SceneGraph

Methods

buildFromScenes()

buildFromScenes(scenes): void;

Defined in: packages/kata-core/src/assets/sceneGraph.ts:35

Parameters

scenes

KSONScene[]

Returns

void


getAllSceneIds()

getAllSceneIds(): string[];

Defined in: packages/kata-core/src/assets/sceneGraph.ts:138

Returns all scene IDs known to the graph.

Returns

string[]


getDeadEnds()

getDeadEnds(): string[];

Defined in: packages/kata-core/src/assets/sceneGraph.ts:92

Returns scene IDs that have no outbound edges.

Returns

string[]


getOrphans()

getOrphans(startId): string[];

Defined in: packages/kata-core/src/assets/sceneGraph.ts:84

Returns scene IDs that are not reachable from startId.

Parameters

startId

string

Returns

string[]


getPreloadSet()

getPreloadSet(
   sceneId, 
   registry, 
   depth?): string[];

Defined in: packages/kata-core/src/assets/sceneGraph.ts:72

Parameters

sceneId

string

registry

AssetRegistry

depth?

number = 1

Returns

string[]


getReachable()

getReachable(sceneId, depth?): string[];

Defined in: packages/kata-core/src/assets/sceneGraph.ts:47

Parameters

sceneId

string

depth?

number = 1

Returns

string[]


toDOT()

toDOT(): string;

Defined in: packages/kata-core/src/assets/sceneGraph.ts:118

Returns a Graphviz DOT format string representing the graph.

Returns

string


toJSON()

toJSON(): object;

Defined in: packages/kata-core/src/assets/sceneGraph.ts:102

Returns a JSON-serializable representation of the graph.

Returns

object

edges
edges: object[];
nodes
nodes: object[];