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
new InstanceReference<T>(instanceable, index): InstanceReference<T>;Defined in: packages/minerender/src/instance/InstanceReference.ts:16
Parameters
| Parameter | Type |
|---|---|
instanceable | T |
index | number |
Returns
InstanceReference<T>
Properties
| Property | Modifier | Type | Default value | Defined in |
|---|---|---|---|---|
index | readonly | number | undefined | packages/minerender/src/instance/InstanceReference.ts:16 |
instanceable | readonly | T | undefined | packages/minerender/src/instance/InstanceReference.ts:16 |
isInstanceReference | readonly | true | true | packages/minerender/src/instance/InstanceReference.ts:14 |
Methods
dispose()
dispose(): void;Defined in: packages/minerender/src/instance/InstanceReference.ts:33
Returns
void
Implementation of
getMatrix()
getMatrix(matrix?): Matrix4;Defined in: packages/minerender/src/instance/InstanceReference.ts:37
Parameters
| Parameter | Type |
|---|---|
matrix? | Matrix4 |
Returns
Matrix4
getPosition()
getPosition(): Vector3;Defined in: packages/minerender/src/instance/InstanceReference.ts:59
Returns
Vector3
Implementation of
getRotation()
getRotation(): Euler;Defined in: packages/minerender/src/instance/InstanceReference.ts:67
Returns
Euler
Implementation of
getScale()
getScale(): Vector3;Defined in: packages/minerender/src/instance/InstanceReference.ts:75
Returns
Vector3
Implementation of
nextInstance()
nextInstance(): InstanceReference<SceneObject>;Defined in: packages/minerender/src/instance/InstanceReference.ts:19
Returns
InstanceReference<SceneObject>
removeFromScene()
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()
setMatrix(matrix): void;Defined in: packages/minerender/src/instance/InstanceReference.ts:41
Parameters
| Parameter | Type |
|---|---|
matrix | Matrix4 |
Returns
void
setPosition()
setPosition(position): void;Defined in: packages/minerender/src/instance/InstanceReference.ts:55
Parameters
| Parameter | Type |
|---|---|
position | Vector3 |
Returns
void
Implementation of
setPositionRotationScale()
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
| Parameter | Type |
|---|---|
position? | Vector3 |
rotation? | Euler |
scale? | Vector3 |
Returns
void
Implementation of
Transformable.setPositionRotationScale
setRotation()
setRotation(rotation): void;Defined in: packages/minerender/src/instance/InstanceReference.ts:63
Parameters
| Parameter | Type |
|---|---|
rotation | Euler |
Returns
void
Implementation of
setScale()
setScale(scale): void;Defined in: packages/minerender/src/instance/InstanceReference.ts:71
Parameters
| Parameter | Type |
|---|---|
scale | Vector3 |
Returns
void
Implementation of
setVisible()
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
| Parameter | Type |
|---|---|
visible | boolean |
Returns
void