Class: SceneObject

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

Extends

• Object3D<Object3DEventMap & object>

Extended by

• EntityObject
• GuiObject
• BlockObject
• ModelObject
• SkinObject

Implements

• Disposable
• Instanceable
• Transformable

Constructors

Constructor

new SceneObject(options?): SceneObject;

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

Parameters

Parameter	Type
options?	Partial<SceneObjectOptions>

Returns

SceneObject

Overrides

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

Properties

Property	Modifier	Type	Default value	Defined in
_instanceCounter	public	number	0	packages/minerender/src/renderer/SceneObject.ts:41
isSceneObject	readonly	true	true	packages/minerender/src/renderer/SceneObject.ts:26
options	readonly	SceneObjectOptions	undefined	packages/minerender/src/renderer/SceneObject.ts:34
DEFAULT_OPTIONS	readonly	SceneObjectOptions	undefined	packages/minerender/src/renderer/SceneObject.ts:28

Accessors

instanceCounter

Get Signature

get instanceCounter(): number;

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

Returns

number

---

isInstanced

Get Signature

get isInstanced(): boolean;

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

Returns

boolean

---

scene

Get Signature

get scene(): MineRenderScene;

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

Returns

MineRenderScene

Set Signature

set scene(scene): void;

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

Parameters

Parameter	Type
scene	MineRenderScene

Returns

void

Methods

dispose()

dispose(): void;

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

Returns

void

Implementation of

Disposable.dispose

---

disposeAndRemoveAllChildren()

disposeAndRemoveAllChildren(): void;

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

Returns

void

---

getGroupByName()

getGroupByName(name): Maybe<Object3D<Object3DEventMap>>;

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

Get a group by its name

Parameters

Parameter	Type
name	string

Returns

Maybe<Object3D<Object3DEventMap>>

---

getInstanceReference()

getInstanceReference(mesh, index): Maybe<InstanceReference<SceneObject>>;

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

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:318

Parameters

Parameter	Type
index	number
matrix	Matrix4

Returns

Matrix4

Implementation of

Instanceable.getMatrixAt

---

getMeshByName()

getMeshByName(name): Maybe<Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>>;

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

Get a mesh by its name

Parameters

Parameter	Type
name	string

Returns

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

---

getPosition()

getPosition(): Vector3;

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

Returns

Vector3

Implementation of

Transformable.getPosition

---

getPositionAt()

getPositionAt(index, vector?): Vector3;

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

Parameters

Parameter	Type
index	number
vector	Vector3

Returns

Vector3

Implementation of

Instanceable.getPositionAt

---

getRotation()

getRotation(): Euler;

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

Returns

Euler

Implementation of

Transformable.getRotation

---

getRotationAt()

getRotationAt(index, euler?): Euler;

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

Parameters

Parameter	Type
index	number
euler	Euler

Returns

Euler

Implementation of

Instanceable.getRotationAt

---

getScale()

getScale(): Vector3;

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

Returns

Vector3

Implementation of

Transformable.getScale

---

getScaleAt()

getScaleAt(index, vector?): Vector3;

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

Parameters

Parameter	Type
index	number
vector	Vector3

Returns

Vector3

Implementation of

Instanceable.getScaleAt

---

init()

init(): Promise<void>;

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

Returns

Promise<void>

---

isInstanceActive()

isInstanceActive(index, reference): boolean;

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

Parameters

Parameter	Type
index	number
reference	InstanceReference<Instanceable>

Returns

boolean

Implementation of

Instanceable.isInstanceActive

---

iterateAllMeshes()

iterateAllMeshes(cb): void;

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

Parameters

Parameter	Type
cb	(mesh) => void

Returns

void

---

nextInstance()

nextInstance(): InstanceReference<SceneObject>;

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

Returns

InstanceReference<SceneObject>

Implementation of

Instanceable.nextInstance

---

notifyDirty()

notifyDirty(): void;

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

Returns

void

---

removeFromScene()

removeFromScene(): void;

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

Returns

void

---

removeInstanceAt()

removeInstanceAt(index): void;

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

Parameters

Parameter	Type
index	number

Returns

void

Implementation of

Instanceable.removeInstanceAt

---

setMatrixAt()

setMatrixAt(index, matrix): void;

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

Parameters

Parameter	Type
index	number
matrix	Matrix4

Returns

void

Implementation of

Instanceable.setMatrixAt

---

setPosition()

setPosition(position): void;

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

Parameters

Parameter	Type
position	Vector3

Returns

void

Implementation of

Transformable.setPosition

---

setPositionAt()

setPositionAt(index, position): void;

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

Parameters

Parameter	Type
index	number
position	Vector3

Returns

void

Implementation of

Instanceable.setPositionAt

---

setPositionRotationScale()

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

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

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:334

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:429

Parameters

Parameter	Type
rotation	Euler

Returns

void

Implementation of

Transformable.setRotation

---

setRotationAt()

setRotationAt(index, rotation): void;

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

Parameters

Parameter	Type
index	number
rotation	Euler

Returns

void

Implementation of

Instanceable.setRotationAt

---

setScale()

setScale(scale): void;

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

Parameters

Parameter	Type
scale	Vector3

Returns

void

Implementation of

Transformable.setScale

---

setScaleAt()

setScaleAt(index, scale): void;

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

Parameters

Parameter	Type
index	number
scale	Vector3

Returns

void

Implementation of

Instanceable.setScaleAt

---

toggleGroupVisibility()

toggleGroupVisibility(name, visible?): boolean;

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

Toggle visibility of a group

Parameters

Parameter	Type	Description
name	string	name of the group
visible?	boolean	set the visibility directly, if not set toggles it

Returns

boolean

---

toggleMeshVisibility()

toggleMeshVisibility(name, visible?): boolean;

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

Toggle visibility of a mesh

Parameters

Parameter	Type	Description
name	string	name of the mesh
visible?	boolean	set the visibility directly, if not set toggles it

Returns

boolean

Inherited three.js API

Members inherited from Object3D are documented by three.js. MineRender overrides are listed above.