Skip to content

Class: InstanceManager ​

Defined in: packages/minerender/src/instance/InstanceManager.ts:9

Shares initialized model objects by cache key and allocates references to their placements.

Constructors ​

Constructor ​

ts
new InstanceManager(): InstanceManager;

Defined in: packages/minerender/src/instance/InstanceManager.ts:15

Returns ​

InstanceManager

Properties ​

PropertyModifierTypeDefault valueDefined in
isInstanceManagerreadonlytruetruepackages/minerender/src/instance/InstanceManager.ts:11

Methods ​

get() ​

ts
get<T>(key): Promise<Maybe<InstanceReference<T>>>;

Defined in: packages/minerender/src/instance/InstanceManager.ts:19

Allocates a new placement of a cached model, or returns undefined if the key is unknown.

Type Parameters ​

Type Parameter
T extends SceneObject

Parameters ​

ParameterType
keystring

Returns ​

Promise<Maybe<InstanceReference<T>>>


getOrCreate() ​

ts
getOrCreate<T>(key, supplier): Promise<InstanceReference<T>>;

Defined in: packages/minerender/src/instance/InstanceManager.ts:29

Allocates a placement, calling the supplier once when the shared model is first needed.

Type Parameters ​

Type Parameter
T extends SceneObject

Parameters ​

ParameterType
keystring
supplier() => T | Promise<T>

Returns ​

Promise<InstanceReference<T>>


reset() ​

ts
reset(): void;

Defined in: packages/minerender/src/instance/InstanceManager.ts:47

Forgets cached models without disposing them or releasing their existing placements.

Returns ​

void