Class: SkinObject

Defined in: packages/minerender/src/skin/scene/SkinObject.ts:15

A player model facing +Z. Left and right parts are the player's own: left is +X, right is -X.

Extends

• SceneObject

Constructors

Constructor

new SkinObject(options?): SkinObject;

Defined in: packages/minerender/src/skin/scene/SkinObject.ts:28

Parameters

Parameter	Type
options?	DeepPartial<SkinObjectOptions>

Returns

SkinObject

Overrides

SceneObject.constructor

Properties

Property	Modifier	Type	Default value	Overrides	Inherited from	Defined in
_instanceCounter	public	number	0	-	SceneObject._instanceCounter	packages/minerender/src/renderer/SceneObject.ts:41
isSceneObject	readonly	true	true	-	SceneObject.isSceneObject	packages/minerender/src/renderer/SceneObject.ts:26
options	readonly	SkinObjectOptions	undefined	SceneObject.options	-	packages/minerender/src/skin/scene/SkinObject.ts:17
DEFAULT_OPTIONS	readonly	SceneObjectOptions	undefined	-	SceneObject.DEFAULT_OPTIONS	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

Inherited from

SceneObject.instanceCounter

---

isInstanced

Get Signature

get isInstanced(): boolean;

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

Returns

boolean

Inherited from

SceneObject.isInstanced

---

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

Inherited from

SceneObject.scene

Methods

dispose()

dispose(): void;

Defined in: packages/minerender/src/skin/scene/SkinObject.ts:196

Returns

void

Overrides

SceneObject.dispose

---

disposeAndRemoveAllChildren()

disposeAndRemoveAllChildren(): void;

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

Returns

void

Inherited from

SceneObject.disposeAndRemoveAllChildren

---

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

Inherited from

SceneObject.getGroupByName

---

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

Inherited from

SceneObject.getInstanceReference

---

getMatrixAt()

getMatrixAt(index, matrix?): Matrix4;

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

Parameters

Parameter	Type
index	number
matrix	Matrix4

Returns

Matrix4

Inherited from

SceneObject.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>>

Inherited from

SceneObject.getMeshByName

---

getPosition()

getPosition(): Vector3;

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

Returns

Vector3

Inherited from

SceneObject.getPosition

---

getPositionAt()

getPositionAt(index, vector?): Vector3;

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

Parameters

Parameter	Type
index	number
vector	Vector3

Returns

Vector3

Inherited from

SceneObject.getPositionAt

---

getRotation()

getRotation(): Euler;

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

Returns

Euler

Inherited from

SceneObject.getRotation

---

getRotationAt()

getRotationAt(index, euler?): Euler;

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

Parameters

Parameter	Type
index	number
euler	Euler

Returns

Euler

Inherited from

SceneObject.getRotationAt

---

getScale()

getScale(): Vector3;

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

Returns

Vector3

Inherited from

SceneObject.getScale

---

getScaleAt()

getScaleAt(index, vector?): Vector3;

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

Parameters

Parameter	Type
index	number
vector	Vector3

Returns

Vector3

Inherited from

SceneObject.getScaleAt

---

init()

init(): Promise<void>;

Defined in: packages/minerender/src/skin/scene/SkinObject.ts:34

Returns

Promise<void>

Overrides

SceneObject.init

---

isInstanceActive()

isInstanceActive(index, reference): boolean;

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

Parameters

Parameter	Type
index	number
reference	InstanceReference<Instanceable>

Returns

boolean

Inherited from

SceneObject.isInstanceActive

---

iterateAllMeshes()

iterateAllMeshes(cb): void;

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

Parameters

Parameter	Type
cb	(mesh) => void

Returns

void

Inherited from

SceneObject.iterateAllMeshes

---

nextInstance()

nextInstance(): InstanceReference<SceneObject>;

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

Returns

InstanceReference<SceneObject>

Inherited from

SceneObject.nextInstance

---

notifyDirty()

notifyDirty(): void;

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

Returns

void

Inherited from

SceneObject.notifyDirty

---

removeFromScene()

removeFromScene(): void;

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

Returns

void

Inherited from

SceneObject.removeFromScene

---

removeInstanceAt()

removeInstanceAt(index): void;

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

Parameters

Parameter	Type
index	number

Returns

void

Inherited from

SceneObject.removeInstanceAt

---

setCapeTexture()

setCapeTexture(src?, layout?): Promise<void>;

Defined in: packages/minerender/src/skin/scene/SkinObject.ts:138

Load a cape texture in the selected layout, or pass undefined to remove the cape.

Parameters

Parameter	Type	Default value
src?	string	undefined
layout?	CapeLayout	"minecraft"

Returns

Promise<void>

---

setLegacy()

setLegacy(legacy?): Promise<void>;

Defined in: packages/minerender/src/skin/scene/SkinObject.ts:190

Select the texture layout, or pass undefined to detect it from image dimensions.

Parameters

Parameter	Type
legacy?	boolean

Returns

Promise<void>

---

setMatrixAt()

setMatrixAt(index, matrix): void;

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

Parameters

Parameter	Type
index	number
matrix	Matrix4

Returns

void

Inherited from

SceneObject.setMatrixAt

---

setPosition()

setPosition(position): void;

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

Parameters

Parameter	Type
position	Vector3

Returns

void

Inherited from

SceneObject.setPosition

---

setPositionAt()

setPositionAt(index, position): void;

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

Parameters

Parameter	Type
index	number
position	Vector3

Returns

void

Inherited from

SceneObject.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

Inherited from

SceneObject.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

Inherited from

SceneObject.setPositionRotationScaleAt

---

setRotation()

setRotation(rotation): void;

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

Parameters

Parameter	Type
rotation	Euler

Returns

void

Inherited from

SceneObject.setRotation

---

setRotationAt()

setRotationAt(index, rotation): void;

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

Parameters

Parameter	Type
index	number
rotation	Euler

Returns

void

Inherited from

SceneObject.setRotationAt

---

setScale()

setScale(scale): void;

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

Parameters

Parameter	Type
scale	Vector3

Returns

void

Inherited from

SceneObject.setScale

---

setScaleAt()

setScaleAt(index, scale): void;

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

Parameters

Parameter	Type
index	number
scale	Vector3

Returns

void

Inherited from

SceneObject.setScaleAt

---

setSkinTexture()

setSkinTexture(src): Promise<void>;

Defined in: packages/minerender/src/skin/scene/SkinObject.ts:117

Parameters

Parameter	Type
src	string

Returns

Promise<void>

---

setSlim()

setSlim(slim?): void;

Defined in: packages/minerender/src/skin/scene/SkinObject.ts:169

Select the arm model, or pass undefined to use texture detection.

Parameters

Parameter	Type
slim?	boolean

Returns

void

---

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

Inherited from

SceneObject.toggleGroupVisibility

---

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 from

SceneObject.toggleMeshVisibility