Skip to content

Class: InstanceReference<T> ​

Defined in: packages/minerender/src/instance/InstanceReference.ts:12

Controls one placement of a shared model. Transform methods affect only this instance. After removeFromScene or dispose, accessing its transforms throws.

Type Parameters ​

Type Parameter
T extends Instanceable

Implements ​

Constructors ​

Constructor ​

ts
new InstanceReference<T>(instanceable, index): InstanceReference<T>;

Defined in: packages/minerender/src/instance/InstanceReference.ts:16

Parameters ​

ParameterType
instanceableT
indexnumber

Returns ​

InstanceReference<T>

Properties ​

PropertyModifierTypeDefault valueDefined in
indexreadonlynumberundefinedpackages/minerender/src/instance/InstanceReference.ts:16
instanceablereadonlyTundefinedpackages/minerender/src/instance/InstanceReference.ts:16
isInstanceReferencereadonlytruetruepackages/minerender/src/instance/InstanceReference.ts:14

Methods ​

dispose() ​

ts
dispose(): void;

Defined in: packages/minerender/src/instance/InstanceReference.ts:33

Returns ​

void

Implementation of ​

Disposable.dispose


getMatrix() ​

ts
getMatrix(matrix?): Matrix4;

Defined in: packages/minerender/src/instance/InstanceReference.ts:37

Parameters ​

ParameterType
matrix?Matrix4

Returns ​

Matrix4


getPosition() ​

ts
getPosition(): Vector3;

Defined in: packages/minerender/src/instance/InstanceReference.ts:59

Returns ​

Vector3

Implementation of ​

Transformable.getPosition


getRotation() ​

ts
getRotation(): Euler;

Defined in: packages/minerender/src/instance/InstanceReference.ts:67

Returns ​

Euler

Implementation of ​

Transformable.getRotation


getScale() ​

ts
getScale(): Vector3;

Defined in: packages/minerender/src/instance/InstanceReference.ts:75

Returns ​

Vector3

Implementation of ​

Transformable.getScale


nextInstance() ​

ts
nextInstance(): InstanceReference<SceneObject>;

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

Returns ​

InstanceReference<SceneObject>


removeFromScene() ​

ts
removeFromScene(): void;

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

Releases this placement's slot for reuse. Repeated calls have no effect.

Returns ​

void


setMatrix() ​

ts
setMatrix(matrix): void;

Defined in: packages/minerender/src/instance/InstanceReference.ts:41

Parameters ​

ParameterType
matrixMatrix4

Returns ​

void


setPosition() ​

ts
setPosition(position): void;

Defined in: packages/minerender/src/instance/InstanceReference.ts:55

Parameters ​

ParameterType
positionVector3

Returns ​

void

Implementation of ​

Transformable.setPosition


setPositionRotationScale() ​

ts
setPositionRotationScale(
   position?, 
   rotation?, 
   scale?
): void;

Defined in: packages/minerender/src/instance/InstanceReference.ts:51

Updates the supplied transform components. Positions use scene units and rotations use radians.

Parameters ​

ParameterType
position?Vector3
rotation?Euler
scale?Vector3

Returns ​

void

Implementation of ​

Transformable.setPositionRotationScale


setRotation() ​

ts
setRotation(rotation): void;

Defined in: packages/minerender/src/instance/InstanceReference.ts:63

Parameters ​

ParameterType
rotationEuler

Returns ​

void

Implementation of ​

Transformable.setRotation


setScale() ​

ts
setScale(scale): void;

Defined in: packages/minerender/src/instance/InstanceReference.ts:71

Parameters ​

ParameterType
scaleVector3

Returns ​

void

Implementation of ​

Transformable.setScale


setVisible() ​

ts
setVisible(visible): void;

Defined in: packages/minerender/src/instance/InstanceReference.ts:46

Hides or restores this placement while preserving its transform and allocated slot.

Parameters ​

ParameterType
visibleboolean

Returns ​

void