Skip to content

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 ​

ts
new SceneObject(options?): SceneObject;

Defined in: packages/minerender/src/renderer/SceneObject.ts:48

Parameters ​

ParameterType
options?Partial<SceneObjectOptions>

Returns ​

SceneObject

Overrides ​

ts
Object3D<Object3DEventMap & { change: {} }>.constructor

Properties ​

PropertyModifierTypeDefault valueDefined in
_instanceCounterpublicnumber0packages/minerender/src/renderer/SceneObject.ts:42
isSceneObjectreadonlytruetruepackages/minerender/src/renderer/SceneObject.ts:27
optionsreadonlySceneObjectOptionsundefinedpackages/minerender/src/renderer/SceneObject.ts:35
DEFAULT_OPTIONSreadonlySceneObjectOptionsundefinedpackages/minerender/src/renderer/SceneObject.ts:29

Accessors ​

instanceCounter ​

Get Signature ​

ts
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 ​

ts
get isInstanced(): boolean;

Defined in: packages/minerender/src/renderer/SceneObject.ts:241

Returns ​

boolean


scene ​

Get Signature ​

ts
get scene(): MineRenderScene;

Defined in: packages/minerender/src/renderer/SceneObject.ts:58

Returns ​

MineRenderScene

Set Signature ​

ts
set scene(scene): void;

Defined in: packages/minerender/src/renderer/SceneObject.ts:53

Parameters ​
ParameterType
sceneMineRenderScene
Returns ​

void

Methods ​

dispose() ​

ts
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 ​

Disposable.dispose

Overrides ​

ts
Object3D.dispose

disposeAndRemoveAllChildren() ​

ts
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() ​

ts
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 ​

ParameterType
namestring

Returns ​

Maybe<Object3D<Object3DEventMap>>


getInstanceReference() ​

ts
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 ​

ParameterType
meshObject3D
indexnumber

Returns ​

Maybe<InstanceReference<SceneObject>>


getMatrixAt() ​

ts
getMatrixAt(index, matrix?): Matrix4;

Defined in: packages/minerender/src/renderer/SceneObject.ts:323

Parameters ​

ParameterType
indexnumber
matrixMatrix4

Returns ​

Matrix4

Implementation of ​

Instanceable.getMatrixAt


getMeshByName() ​

ts
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 ​

ParameterType
namestring

Returns ​

Maybe<Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>>


getPosition() ​

ts
getPosition(): Vector3;

Defined in: packages/minerender/src/renderer/SceneObject.ts:457

Returns ​

Vector3

Implementation of ​

Transformable.getPosition


getPositionAt() ​

ts
getPositionAt(index, vector?): Vector3;

Defined in: packages/minerender/src/renderer/SceneObject.ts:394

Parameters ​

ParameterType
indexnumber
vectorVector3

Returns ​

Vector3

Implementation of ​

Instanceable.getPositionAt


getRotation() ​

ts
getRotation(): Euler;

Defined in: packages/minerender/src/renderer/SceneObject.ts:477

Returns ​

Euler

Implementation of ​

Transformable.getRotation


getRotationAt() ​

ts
getRotationAt(index, euler?): Euler;

Defined in: packages/minerender/src/renderer/SceneObject.ts:406

Parameters ​

ParameterType
indexnumber
eulerEuler

Returns ​

Euler

Implementation of ​

Instanceable.getRotationAt


getScale() ​

ts
getScale(): Vector3;

Defined in: packages/minerender/src/renderer/SceneObject.ts:497

Returns ​

Vector3

Implementation of ​

Transformable.getScale


getScaleAt() ​

ts
getScaleAt(index, vector?): Vector3;

Defined in: packages/minerender/src/renderer/SceneObject.ts:418

Parameters ​

ParameterType
indexnumber
vectorVector3

Returns ​

Vector3

Implementation of ​

Instanceable.getScaleAt


init() ​

ts
init(): Promise<void>;

Defined in: packages/minerender/src/renderer/SceneObject.ts:63

Returns ​

Promise<void>


isInstanceActive() ​

ts
isInstanceActive(index, reference): boolean;

Defined in: packages/minerender/src/renderer/SceneObject.ts:278

Parameters ​

ParameterType
indexnumber
referenceInstanceReference<Instanceable>

Returns ​

boolean

Implementation of ​

Instanceable.isInstanceActive


iterateAllMeshes() ​

ts
iterateAllMeshes(cb): void;

Defined in: packages/minerender/src/renderer/SceneObject.ts:193

Parameters ​

ParameterType
cb(mesh) => void

Returns ​

void


nextInstance() ​

ts
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 ​

Instanceable.nextInstance


notifyDirty() ​

ts
notifyDirty(): void;

Defined in: packages/minerender/src/renderer/SceneObject.ts:67

Marks ancestor scenes for redraw and emits a change event.

Returns ​

void


removeFromScene() ​

ts
removeFromScene(): void;

Defined in: packages/minerender/src/renderer/SceneObject.ts:554

Detaches the object from its parent and requests a redraw.

Returns ​

void


removeInstanceAt() ​

ts
removeInstanceAt(index): void;

Defined in: packages/minerender/src/renderer/SceneObject.ts:282

Parameters ​

ParameterType
indexnumber

Returns ​

void

Implementation of ​

Instanceable.removeInstanceAt


setInstanceVisibleAt() ​

ts
setInstanceVisibleAt(index, visible): void;

Defined in: packages/minerender/src/renderer/SceneObject.ts:347

Parameters ​

ParameterType
indexnumber
visibleboolean

Returns ​

void

Implementation of ​

Instanceable.setInstanceVisibleAt


setMatrixAt() ​

ts
setMatrixAt(index, matrix): void;

Defined in: packages/minerender/src/renderer/SceneObject.ts:333

Parameters ​

ParameterType
indexnumber
matrixMatrix4

Returns ​

void

Implementation of ​

Instanceable.setMatrixAt


setPosition() ​

ts
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 ​

ParameterType
positionVector3

Returns ​

void

Implementation of ​

Transformable.setPosition


setPositionAt() ​

ts
setPositionAt(index, position): void;

Defined in: packages/minerender/src/renderer/SceneObject.ts:389

Parameters ​

ParameterType
indexnumber
positionVector3

Returns ​

void

Implementation of ​

Instanceable.setPositionAt


setPositionRotationScale() ​

ts
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 ​

ParameterType
position?Vector3
rotation?Euler
scale?Vector3

Returns ​

void

Implementation of ​

Transformable.setPositionRotationScale


setPositionRotationScaleAt() ​

ts
setPositionRotationScaleAt(
   index, 
   position?, 
   rotation?, 
   scale?
): void;

Defined in: packages/minerender/src/renderer/SceneObject.ts:368

Parameters ​

ParameterType
indexnumber
position?Vector3
rotation?Euler
scale?Vector3

Returns ​

void

Implementation of ​

Instanceable.setPositionRotationScaleAt


setRotation() ​

ts
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 ​

ParameterType
rotationEuler

Returns ​

void

Implementation of ​

Transformable.setRotation


setRotationAt() ​

ts
setRotationAt(index, rotation): void;

Defined in: packages/minerender/src/renderer/SceneObject.ts:401

Parameters ​

ParameterType
indexnumber
rotationEuler

Returns ​

void

Implementation of ​

Instanceable.setRotationAt


setScale() ​

ts
setScale(scale): void;

Defined in: packages/minerender/src/renderer/SceneObject.ts:486

Sets scale factors. For a shared model, updates every live instance.

Parameters ​

ParameterType
scaleVector3

Returns ​

void

Implementation of ​

Transformable.setScale


setScaleAt() ​

ts
setScaleAt(index, scale): void;

Defined in: packages/minerender/src/renderer/SceneObject.ts:413

Parameters ​

ParameterType
indexnumber
scaleVector3

Returns ​

void

Implementation of ​

Instanceable.setScaleAt


toggleGroupVisibility() ​

ts
toggleGroupVisibility(name, visible?): boolean;

Defined in: packages/minerender/src/renderer/SceneObject.ts:120

Changes a named group's visibility and requests a redraw.

Parameters ​

ParameterTypeDescription
namestringPart name without the group: prefix.
visible?booleanVisibility to assign. Omit it to toggle the current value.

Returns ​

boolean

The resulting visibility, or false if the group does not exist.


toggleMeshVisibility() ​

ts
toggleMeshVisibility(name, visible?): boolean;

Defined in: packages/minerender/src/renderer/SceneObject.ts:189

Changes a named mesh's visibility and requests a redraw.

Parameters ​

ParameterTypeDescription
namestringMesh name without the mesh: prefix.
visible?booleanVisibility 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.