Class: SceneObject
Defined in: packages/minerender/src/renderer/SceneObject.ts:25
Base for renderable Minecraft objects, with named parts and optional shared instances. Use notifyDirty after changing a part directly so the renderer redraws it.
Extends
Object3D<Object3DEventMap&object>
Extended by
Implements
Constructors
Constructor
new SceneObject(options?): SceneObject;Defined in: packages/minerender/src/renderer/SceneObject.ts:48
Parameters
| Parameter | Type |
|---|---|
options? | Partial<SceneObjectOptions> |
Returns
SceneObject
Overrides
Object3D<Object3DEventMap & { change: {} }>.constructorProperties
| Property | Modifier | Type | Default value | Defined in |
|---|---|---|---|---|
_instanceCounter | public | number | 0 | packages/minerender/src/renderer/SceneObject.ts:42 |
isSceneObject | readonly | true | true | packages/minerender/src/renderer/SceneObject.ts:27 |
options | readonly | SceneObjectOptions | undefined | packages/minerender/src/renderer/SceneObject.ts:35 |
DEFAULT_OPTIONS | readonly | SceneObjectOptions | undefined | packages/minerender/src/renderer/SceneObject.ts:29 |
Accessors
instanceCounter
Get Signature
get instanceCounter(): number;Defined in: packages/minerender/src/renderer/SceneObject.ts:246
Number of live placements, excluding released instance slots.
Returns
number
isInstanced
Get Signature
get isInstanced(): boolean;Defined in: packages/minerender/src/renderer/SceneObject.ts:241
Returns
boolean
scene
Get Signature
get scene(): MineRenderScene;Defined in: packages/minerender/src/renderer/SceneObject.ts:58
Returns
Set Signature
set scene(scene): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:53
Parameters
| Parameter | Type |
|---|---|
scene | MineRenderScene |
Returns
void
Methods
dispose()
dispose(): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:523
Frees the GPU-related resources allocated by this instance.
Returns
void
Remarks
Call this method whenever this instance is no longer used in your app. Geometries, materials and textures are potentially shared with other 3D objects and must be disposed of separately.
Implementation of
Overrides
Object3D.disposedisposeAndRemoveAllChildren()
disposeAndRemoveAllChildren(): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:530
Releases instance slots and removes children, disposing children that implement Disposable.
Returns
void
getGroupByName()
getGroupByName(name): Maybe<Object3D<Object3DEventMap>>;Defined in: packages/minerender/src/renderer/SceneObject.ts:110
Finds a named part, such as head, without the internal group: prefix. Returns undefined when the group does not exist.
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
Maybe<Object3D<Object3DEventMap>>
getInstanceReference()
getInstanceReference(mesh, index): Maybe<InstanceReference<SceneObject>>;Defined in: packages/minerender/src/renderer/SceneObject.ts:274
Returns the live reference for a raycast hit on this object's instance mesh.
Parameters
| Parameter | Type |
|---|---|
mesh | Object3D |
index | number |
Returns
Maybe<InstanceReference<SceneObject>>
getMatrixAt()
getMatrixAt(index, matrix?): Matrix4;Defined in: packages/minerender/src/renderer/SceneObject.ts:323
Parameters
| Parameter | Type |
|---|---|
index | number |
matrix | Matrix4 |
Returns
Matrix4
Implementation of
getMeshByName()
getMeshByName(name): Maybe<Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>>;Defined in: packages/minerender/src/renderer/SceneObject.ts:179
Finds a named mesh without the internal mesh: prefix, or returns undefined.
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
Maybe<Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>>
getPosition()
getPosition(): Vector3;Defined in: packages/minerender/src/renderer/SceneObject.ts:457
Returns
Vector3
Implementation of
getPositionAt()
getPositionAt(index, vector?): Vector3;Defined in: packages/minerender/src/renderer/SceneObject.ts:394
Parameters
| Parameter | Type |
|---|---|
index | number |
vector | Vector3 |
Returns
Vector3
Implementation of
getRotation()
getRotation(): Euler;Defined in: packages/minerender/src/renderer/SceneObject.ts:477
Returns
Euler
Implementation of
getRotationAt()
getRotationAt(index, euler?): Euler;Defined in: packages/minerender/src/renderer/SceneObject.ts:406
Parameters
| Parameter | Type |
|---|---|
index | number |
euler | Euler |
Returns
Euler
Implementation of
getScale()
getScale(): Vector3;Defined in: packages/minerender/src/renderer/SceneObject.ts:497
Returns
Vector3
Implementation of
getScaleAt()
getScaleAt(index, vector?): Vector3;Defined in: packages/minerender/src/renderer/SceneObject.ts:418
Parameters
| Parameter | Type |
|---|---|
index | number |
vector | Vector3 |
Returns
Vector3
Implementation of
init()
init(): Promise<void>;Defined in: packages/minerender/src/renderer/SceneObject.ts:63
Returns
Promise<void>
isInstanceActive()
isInstanceActive(index, reference): boolean;Defined in: packages/minerender/src/renderer/SceneObject.ts:278
Parameters
| Parameter | Type |
|---|---|
index | number |
reference | InstanceReference<Instanceable> |
Returns
boolean
Implementation of
iterateAllMeshes()
iterateAllMeshes(cb): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:193
Parameters
| Parameter | Type |
|---|---|
cb | (mesh) => void |
Returns
void
nextInstance()
nextInstance(): InstanceReference<SceneObject>;Defined in: packages/minerender/src/renderer/SceneObject.ts:255
Allocates a placement of this instanced object, reusing a released slot when available.
Returns
InstanceReference<SceneObject>
Implementation of
notifyDirty()
notifyDirty(): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:67
Marks ancestor scenes for redraw and emits a change event.
Returns
void
removeFromScene()
removeFromScene(): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:554
Detaches the object from its parent and requests a redraw.
Returns
void
removeInstanceAt()
removeInstanceAt(index): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:282
Parameters
| Parameter | Type |
|---|---|
index | number |
Returns
void
Implementation of
setInstanceVisibleAt()
setInstanceVisibleAt(index, visible): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:347
Parameters
| Parameter | Type |
|---|---|
index | number |
visible | boolean |
Returns
void
Implementation of
Instanceable.setInstanceVisibleAt
setMatrixAt()
setMatrixAt(index, matrix): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:333
Parameters
| Parameter | Type |
|---|---|
index | number |
matrix | Matrix4 |
Returns
void
Implementation of
setPosition()
setPosition(position): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:446
Sets position in scene units. For a shared model, updates every live instance.
Parameters
| Parameter | Type |
|---|---|
position | Vector3 |
Returns
void
Implementation of
setPositionAt()
setPositionAt(index, position): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:389
Parameters
| Parameter | Type |
|---|---|
index | number |
position | Vector3 |
Returns
void
Implementation of
setPositionRotationScale()
setPositionRotationScale(
position?,
rotation?,
scale?
): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:426
Updates supplied transform components. For a shared model, affects every live instance.
Parameters
| Parameter | Type |
|---|---|
position? | Vector3 |
rotation? | Euler |
scale? | Vector3 |
Returns
void
Implementation of
Transformable.setPositionRotationScale
setPositionRotationScaleAt()
setPositionRotationScaleAt(
index,
position?,
rotation?,
scale?
): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:368
Parameters
| Parameter | Type |
|---|---|
index | number |
position? | Vector3 |
rotation? | Euler |
scale? | Vector3 |
Returns
void
Implementation of
Instanceable.setPositionRotationScaleAt
setRotation()
setRotation(rotation): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:466
Sets rotation in radians. For a shared model, updates every live instance.
Parameters
| Parameter | Type |
|---|---|
rotation | Euler |
Returns
void
Implementation of
setRotationAt()
setRotationAt(index, rotation): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:401
Parameters
| Parameter | Type |
|---|---|
index | number |
rotation | Euler |
Returns
void
Implementation of
setScale()
setScale(scale): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:486
Sets scale factors. For a shared model, updates every live instance.
Parameters
| Parameter | Type |
|---|---|
scale | Vector3 |
Returns
void
Implementation of
setScaleAt()
setScaleAt(index, scale): void;Defined in: packages/minerender/src/renderer/SceneObject.ts:413
Parameters
| Parameter | Type |
|---|---|
index | number |
scale | Vector3 |
Returns
void
Implementation of
toggleGroupVisibility()
toggleGroupVisibility(name, visible?): boolean;Defined in: packages/minerender/src/renderer/SceneObject.ts:120
Changes a named group's visibility and requests a redraw.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | Part name without the group: prefix. |
visible? | boolean | Visibility to assign. Omit it to toggle the current value. |
Returns
boolean
The resulting visibility, or false if the group does not exist.
toggleMeshVisibility()
toggleMeshVisibility(name, visible?): boolean;Defined in: packages/minerender/src/renderer/SceneObject.ts:189
Changes a named mesh's visibility and requests a redraw.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | Mesh name without the mesh: prefix. |
visible? | boolean | Visibility to assign. Omit it to toggle the current value. |
Returns
boolean
The resulting visibility, or false if the mesh does not exist.
Inherited three.js API
Members inherited from Object3D are documented by three.js. MineRender overrides are listed above.