Skip to content

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 ​

Constructors ​

Constructor ​

ts
new SkinObject(options?): SkinObject;

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

Parameters ​

ParameterType
options?DeepPartial<SkinObjectOptions>

Returns ​

SkinObject

Overrides ​

SceneObject.constructor

Properties ​

PropertyModifierTypeDefault valueOverridesInherited fromDefined in
_instanceCounterpublicnumber0-SceneObject._instanceCounterpackages/minerender/src/renderer/SceneObject.ts:42
isSceneObjectreadonlytruetrue-SceneObject.isSceneObjectpackages/minerender/src/renderer/SceneObject.ts:27
optionsreadonlySkinObjectOptionsundefinedSceneObject.options-packages/minerender/src/skin/scene/SkinObject.ts:17
DEFAULT_OPTIONSreadonlySceneObjectOptionsundefined-SceneObject.DEFAULT_OPTIONSpackages/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

Inherited from ​

SceneObject.instanceCounter


isInstanced ​

Get Signature ​

ts
get isInstanced(): boolean;

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

Returns ​

boolean

Inherited from ​

SceneObject.isInstanced


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

Inherited from ​

SceneObject.scene

Methods ​

dispose() ​

ts
dispose(): void;

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

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.

Overrides ​

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

Inherited from ​

SceneObject.disposeAndRemoveAllChildren


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

Inherited from ​

SceneObject.getGroupByName


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

Inherited from ​

SceneObject.getInstanceReference


getMatrixAt() ​

ts
getMatrixAt(index, matrix?): Matrix4;

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

Parameters ​

ParameterType
indexnumber
matrixMatrix4

Returns ​

Matrix4

Inherited from ​

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

Inherited from ​

SceneObject.getMeshByName


getPosition() ​

ts
getPosition(): Vector3;

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

Returns ​

Vector3

Inherited from ​

SceneObject.getPosition


getPositionAt() ​

ts
getPositionAt(index, vector?): Vector3;

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

Parameters ​

ParameterType
indexnumber
vectorVector3

Returns ​

Vector3

Inherited from ​

SceneObject.getPositionAt


getRotation() ​

ts
getRotation(): Euler;

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

Returns ​

Euler

Inherited from ​

SceneObject.getRotation


getRotationAt() ​

ts
getRotationAt(index, euler?): Euler;

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

Parameters ​

ParameterType
indexnumber
eulerEuler

Returns ​

Euler

Inherited from ​

SceneObject.getRotationAt


getScale() ​

ts
getScale(): Vector3;

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

Returns ​

Vector3

Inherited from ​

SceneObject.getScale


getScaleAt() ​

ts
getScaleAt(index, vector?): Vector3;

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

Parameters ​

ParameterType
indexnumber
vectorVector3

Returns ​

Vector3

Inherited from ​

SceneObject.getScaleAt


init() ​

ts
init(): Promise<void>;

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

Returns ​

Promise<void>

Overrides ​

SceneObject.init


isInstanceActive() ​

ts
isInstanceActive(index, reference): boolean;

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

Parameters ​

ParameterType
indexnumber
referenceInstanceReference<Instanceable>

Returns ​

boolean

Inherited from ​

SceneObject.isInstanceActive


iterateAllMeshes() ​

ts
iterateAllMeshes(cb): void;

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

Parameters ​

ParameterType
cb(mesh) => void

Returns ​

void

Inherited from ​

SceneObject.iterateAllMeshes


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>

Inherited from ​

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

Inherited from ​

SceneObject.notifyDirty


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

Inherited from ​

SceneObject.removeFromScene


removeInstanceAt() ​

ts
removeInstanceAt(index): void;

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

Parameters ​

ParameterType
indexnumber

Returns ​

void

Inherited from ​

SceneObject.removeInstanceAt


setCapeTexture() ​

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

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

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

Parameters ​

ParameterTypeDefault value
src?stringundefined
layout?CapeLayout"minecraft"

Returns ​

Promise<void>


setInstanceVisibleAt() ​

ts
setInstanceVisibleAt(index, visible): void;

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

Parameters ​

ParameterType
indexnumber
visibleboolean

Returns ​

void

Inherited from ​

SceneObject.setInstanceVisibleAt


setLegacy() ​

ts
setLegacy(legacy?): Promise<void>;

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

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

Parameters ​

ParameterType
legacy?boolean

Returns ​

Promise<void>


setMatrixAt() ​

ts
setMatrixAt(index, matrix): void;

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

Parameters ​

ParameterType
indexnumber
matrixMatrix4

Returns ​

void

Inherited from ​

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

Inherited from ​

SceneObject.setPosition


setPositionAt() ​

ts
setPositionAt(index, position): void;

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

Parameters ​

ParameterType
indexnumber
positionVector3

Returns ​

void

Inherited from ​

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

Inherited from ​

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

Inherited from ​

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

Inherited from ​

SceneObject.setRotation


setRotationAt() ​

ts
setRotationAt(index, rotation): void;

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

Parameters ​

ParameterType
indexnumber
rotationEuler

Returns ​

void

Inherited from ​

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

Inherited from ​

SceneObject.setScale


setScaleAt() ​

ts
setScaleAt(index, scale): void;

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

Parameters ​

ParameterType
indexnumber
scaleVector3

Returns ​

void

Inherited from ​

SceneObject.setScaleAt


setSkinTexture() ​

ts
setSkinTexture(src): Promise<void>;

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

Loads a skin texture, detecting slim arms and legacy layouts by default. To override detection, set slim or legacy in the options passed to new SkinObject(options) or scene.addSkin(src, options). Use setSlim or setLegacy to change these settings later.

Parameters ​

ParameterTypeDescription
srcstringURL of the skin texture.

Returns ​

Promise<void>


setSlim() ​

ts
setSlim(slim?): void;

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

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

Parameters ​

ParameterType
slim?boolean

Returns ​

void


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.

Inherited from ​

SceneObject.toggleGroupVisibility


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

SceneObject.toggleMeshVisibility