@orillusion/core

---

Class: SkinnedMeshRenderer

Defined in: src/components/renderer/SkinnedMeshRenderer.ts:20

Skin Mesh Renderer Component Renders a deformable mesh. Deformable meshes include skin meshes (meshes with bones and bound poses), meshes with mixed shapes, and meshes running cloth simulations.

Extends

• MeshRenderer

Constructors

Constructor

new SkinnedMeshRenderer(): SkinnedMeshRenderer

Defined in: src/components/renderer/SkinnedMeshRenderer.ts:28

Returns

SkinnedMeshRenderer

Overrides

MeshRenderer.constructor

Properties

object3D

object3D: Object3D = null

Defined in: src/components/ComponentBase.ts:29

owner object3D

Inherited from

MeshRenderer.object3D

---

isDestroyed

isDestroyed: boolean = false

Defined in: src/components/ComponentBase.ts:77

Inherited from

MeshRenderer.isDestroyed

---

receiveShadow

receiveShadow: boolean

Defined in: src/components/renderer/MeshRenderer.ts:23

Enabling this option allows the grid to display any shadows cast on the grid.

Inherited from

MeshRenderer.receiveShadow

---

morphData

morphData: MorphTargetData

Defined in: src/components/renderer/MeshRenderer.ts:24

Inherited from

MeshRenderer.morphData

---

instanceCount

instanceCount: number = 0

Defined in: src/components/renderer/RenderNode.ts:35

Inherited from

MeshRenderer.instanceCount

---

lodLevel

lodLevel: number = 0

Defined in: src/components/renderer/RenderNode.ts:36

Inherited from

MeshRenderer.lodLevel

---

alwaysRender

alwaysRender: boolean = false

Defined in: src/components/renderer/RenderNode.ts:37

Inherited from

MeshRenderer.alwaysRender

---

instanceID

instanceID: string

Defined in: src/components/renderer/RenderNode.ts:38

Inherited from

MeshRenderer.instanceID

---

drawType

drawType: number = 0

Defined in: src/components/renderer/RenderNode.ts:39

Inherited from

MeshRenderer.drawType

---

isRenderOrderChange?

optional isRenderOrderChange?: boolean

Defined in: src/components/renderer/RenderNode.ts:55

Inherited from

MeshRenderer.isRenderOrderChange

---

needSortOnCameraZ?

optional needSortOnCameraZ?: boolean

Defined in: src/components/renderer/RenderNode.ts:56

Inherited from

MeshRenderer.needSortOnCameraZ

---

shadowCacheMode

shadowCacheMode: "auto" | "static" | "dynamic" = 'auto'

Defined in: src/components/renderer/RenderNode.ts:437

Shadow cache classification.

• 'auto' (default): renderer is drawn to the shadow map every frame as part of the single-pass render — matches historical behaviour.
• 'static': renderer is drawn only to the cached static depth layer, rebuilt lazily when the light moves or the scene explicitly marks the static cache dirty. Use for buildings, terrain, prop meshes that don't move.
• 'dynamic': renderer is drawn every frame on top of the copied-in static layer. Use for characters, physics objects, anything that moves.

Only consulted when engine.setting.shadow.enableStaticCache === true; otherwise all renderers behave as 'auto'.

Inherited from

MeshRenderer.shadowCacheMode

---

skinJointsName

skinJointsName: string[]

Defined in: src/components/renderer/SkinnedMeshRenderer.ts:22

Ordered names of the joints this skin is bound to.

Accessors

visibleLayer

Get Signature

get visibleLayer(): number

Defined in: src/components/ComponentBase.ts:46

Composition-layer membership bitmask. The pass / camera / collector filters via

(component.visibleLayer & pass.layerMask & camera.cullingMask) !== 0

Defaults to VisibleLayer.Default (bit 0) so a fresh subclass is visible to passes whose layerMask is VisibleLayer.All (which includes bit 0). Application code can assign project-specific bits (1..31) to organise the scene into composition layers.

Returns

number

Set Signature

set visibleLayer(value): void

Defined in: src/components/ComponentBase.ts:50

Parameters

value

number

Returns

void

Inherited from

MeshRenderer.visibleLayer

---

eventDispatcher

Get Signature

get eventDispatcher(): CEventDispatcher

Defined in: src/components/ComponentBase.ts:63

Returns

CEventDispatcher

Set Signature

set eventDispatcher(value): void

Defined in: src/components/ComponentBase.ts:68

Parameters

value

CEventDispatcher

Returns

void

Inherited from

MeshRenderer.eventDispatcher

---

isStart

Get Signature

get isStart(): boolean

Defined in: src/components/ComponentBase.ts:79

Returns

boolean

Inherited from

MeshRenderer.isStart

---

transform

Get Signature

get transform(): Transform

Defined in: src/components/ComponentBase.ts:89

Return the Transform component attached to the Object3D. Null before the component is attached — addComponent assigns object3D only after construction — so constructor-time callers can probe safely via this.transform?..

Returns

Transform

Inherited from

MeshRenderer.transform

---

enable

Get Signature

get enable(): boolean

Defined in: src/components/ComponentBase.ts:113

Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.

Returns

boolean

Set Signature

set enable(value): void

Defined in: src/components/ComponentBase.ts:96

Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.

Parameters

value

boolean

Returns

void

Inherited from

MeshRenderer.enable

---

geometry

Get Signature

get geometry(): GeometryBase

Defined in: src/components/renderer/MeshRenderer.ts:53

The geometry of the mesh determines its shape

Returns

GeometryBase

Set Signature

set geometry(value): void

Defined in: src/components/renderer/MeshRenderer.ts:57

Parameters

value

GeometryBase

Returns

void

Inherited from

MeshRenderer.geometry

---

material

Get Signature

get material(): Material

Defined in: src/components/renderer/MeshRenderer.ts:99

material

Returns

Material

Set Signature

set material(value): void

Defined in: src/components/renderer/MeshRenderer.ts:103

Parameters

value

Material

Returns

void

Inherited from

MeshRenderer.material

---

batchMode

Get Signature

get batchMode(): BatchMode

Defined in: src/components/renderer/RenderNode.ts:118

Returns

BatchMode

Set Signature

set batchMode(value): void

Defined in: src/components/renderer/RenderNode.ts:122

Parameters

value

BatchMode

Returns

void

Inherited from

MeshRenderer.batchMode

---

rendererMask

Get Signature

get rendererMask(): number

Defined in: src/components/renderer/RenderNode.ts:156

Returns

number

Set Signature

set rendererMask(value): void

Defined in: src/components/renderer/RenderNode.ts:160

Parameters

value

number

Returns

void

Inherited from

MeshRenderer.rendererMask

---

renderOrder

Get Signature

get renderOrder(): number

Defined in: src/components/renderer/RenderNode.ts:164

Returns

number

Set Signature

set renderOrder(value): void

Defined in: src/components/renderer/RenderNode.ts:168

Parameters

value

number

Returns

void

Inherited from

MeshRenderer.renderOrder

---

materials

Get Signature

get materials(): Material[]

Defined in: src/components/renderer/RenderNode.ts:177

Returns

Material[]

Set Signature

set materials(value): void

Defined in: src/components/renderer/RenderNode.ts:181

Parameters

value

Material[]

Returns

void

Inherited from

MeshRenderer.materials

---

castShadow

Get Signature

get castShadow(): boolean

Defined in: src/components/renderer/RenderNode.ts:413

Returns

boolean

Set Signature

set castShadow(value): void

Defined in: src/components/renderer/RenderNode.ts:417

Parameters

value

boolean

Returns

void

Inherited from

MeshRenderer.castShadow

---

castGI

Get Signature

get castGI(): boolean

Defined in: src/components/renderer/RenderNode.ts:440

Returns

boolean

Set Signature

set castGI(value): void

Defined in: src/components/renderer/RenderNode.ts:444

Parameters

value

boolean

Returns

void

Inherited from

MeshRenderer.castGI

---

castReflection

Get Signature

get castReflection(): boolean

Defined in: src/components/renderer/RenderNode.ts:448

Returns

boolean

Set Signature

set castReflection(value): void

Defined in: src/components/renderer/RenderNode.ts:452

Parameters

value

boolean

Returns

void

Inherited from

MeshRenderer.castReflection

---

skeletonAnimation

Get Signature

get skeletonAnimation(): SkeletonAnimationComponent

Defined in: src/components/renderer/SkinnedMeshRenderer.ts:58

The skeleton animation component driving this skin.

Returns

SkeletonAnimationComponent

Set Signature

set skeletonAnimation(value): void

Defined in: src/components/renderer/SkinnedMeshRenderer.ts:62

Parameters

value

SkeletonAnimationComponent

Returns

void

---

skinInverseBindMatrices

Get Signature

get skinInverseBindMatrices(): Float32Array<ArrayBufferLike>[]

Defined in: src/components/renderer/SkinnedMeshRenderer.ts:76

Per-joint inverse bind matrices used to skin the mesh.

Returns

Float32Array<ArrayBufferLike>[]

Set Signature

set skinInverseBindMatrices(inverseBindMatrices): void

Defined in: src/components/renderer/SkinnedMeshRenderer.ts:80

Parameters

inverseBindMatrices

Float32Array<ArrayBufferLike>[]

Returns

void

---

inverseBindMatrixBuffer

Get Signature

get inverseBindMatrixBuffer(): StorageGPUBuffer

Defined in: src/components/renderer/SkinnedMeshRenderer.ts:93

GPU buffer holding the inverse bind matrices.

Returns

StorageGPUBuffer

---

jointIndexTableBuffer

Get Signature

get jointIndexTableBuffer(): GPUBuffer

Defined in: src/components/renderer/SkinnedMeshRenderer.ts:98

GPU buffer mapping skin joints to skeleton joint indices.

Returns

GPUBuffer

Methods

stop()

stop(): void

Defined in: src/components/ComponentBase.ts:163

Returns

void

Inherited from

MeshRenderer.stop

---

onUpdate()?

optional onUpdate(view?): any

Defined in: src/components/ComponentBase.ts:166

Parameters

view?

View3D

Returns

any

Inherited from

MeshRenderer.onUpdate

---

onLateUpdate()?

optional onLateUpdate(view?): any

Defined in: src/components/ComponentBase.ts:167

Parameters

view?

View3D

Returns

any

Inherited from

MeshRenderer.onLateUpdate

---

onBeforeUpdate()?

optional onBeforeUpdate(view?): any

Defined in: src/components/ComponentBase.ts:168

Parameters

view?

View3D

Returns

any

Inherited from

MeshRenderer.onBeforeUpdate

---

onGraphic()?

optional onGraphic(view?): any

Defined in: src/components/ComponentBase.ts:170

Parameters

view?

View3D

Returns

any

Inherited from

MeshRenderer.onGraphic

---

onParentChange()?

optional onParentChange(lastParent?, currentParent?): any

Defined in: src/components/ComponentBase.ts:171

Parameters

lastParent?

Object3D

currentParent?

Object3D

Returns

any

Inherited from

MeshRenderer.onParentChange

---

onAddChild()?

optional onAddChild(child): any

Defined in: src/components/ComponentBase.ts:172

Parameters

child

Object3D

Returns

any

Inherited from

MeshRenderer.onAddChild

---

onRemoveChild()?

optional onRemoveChild(child): any

Defined in: src/components/ComponentBase.ts:173

Parameters

child

Object3D

Returns

any

Inherited from

MeshRenderer.onRemoveChild

---

onDisable()

onDisable(): void

Defined in: src/components/renderer/MeshRenderer.ts:34

Returns

void

Inherited from

MeshRenderer.onDisable

---

copyComponent()

copyComponent(from): this

Defined in: src/components/renderer/MeshRenderer.ts:43

Parameters

from

this

Returns

this

Inherited from

MeshRenderer.copyComponent

---

setMorphInfluence()

setMorphInfluence(key, value): void

Defined in: src/components/renderer/MeshRenderer.ts:110

Set deformation animation parameters

Parameters

key

string

value

number

Returns

void

Inherited from

MeshRenderer.setMorphInfluence

---

setMorphInfluenceIndex()

setMorphInfluenceIndex(index, value): void

Defined in: src/components/renderer/MeshRenderer.ts:119

Parameters

index

number

value

number

Returns

void

Inherited from

MeshRenderer.setMorphInfluenceIndex

---

onCompute()

onCompute(view, command): void

Defined in: src/components/renderer/MeshRenderer.ts:128

Parameters

view

View3D

command

GPUCommandEncoder

Returns

void

Inherited from

MeshRenderer.onCompute

---

destroy()

destroy(force?): void

Defined in: src/components/renderer/MeshRenderer.ts:157

Parameters

force?

boolean

Returns

void

Inherited from

MeshRenderer.destroy

---

init()

init(param?): void

Defined in: src/components/renderer/RenderNode.ts:73

Parameters

param?

any

Returns

void

Inherited from

MeshRenderer.init

---

attachSceneOctree()

attachSceneOctree(octree): void

Defined in: src/components/renderer/RenderNode.ts:87

Parameters

octree

Octree

Returns

void

Inherited from

MeshRenderer.attachSceneOctree

---

detachSceneOctree()

detachSceneOctree(): void

Defined in: src/components/renderer/RenderNode.ts:92

Returns

void

Inherited from

MeshRenderer.detachSceneOctree

---

addMask()

addMask(mask): void

Defined in: src/components/renderer/RenderNode.ts:144

Parameters

mask

RendererMask

Returns

void

Inherited from

MeshRenderer.addMask

---

removeMask()

removeMask(mask): void

Defined in: src/components/renderer/RenderNode.ts:148

Parameters

mask

RendererMask

Returns

void

Inherited from

MeshRenderer.removeMask

---

hasMask()

hasMask(mask): boolean

Defined in: src/components/renderer/RenderNode.ts:152

Parameters

mask

RendererMask

Returns

boolean

Inherited from

MeshRenderer.hasMask

---

addRendererMask()

addRendererMask(tag): void

Defined in: src/components/renderer/RenderNode.ts:232

Parameters

tag

RendererMask

Returns

void

Inherited from

MeshRenderer.addRendererMask

---

removeRendererMask()

removeRendererMask(tag): void

Defined in: src/components/renderer/RenderNode.ts:236

Parameters

tag

RendererMask

Returns

void

Inherited from

MeshRenderer.removeRendererMask

---

refreshRenderClassification()

refreshRenderClassification(): void

Defined in: src/components/renderer/RenderNode.ts:270

Recompute renderOrder from current pass states and re-bucket this renderer in EntityCollect (opaque vs transparent map).

Called when a material's alphaMode flips at runtime — the pass.renderOrder changes (3000 ↔ 0), but EntityCollect classifies once at addRenderNode time. Without this nudge the renderer stays in its old list and gets drawn through the wrong pipeline (e.g. WBOIT continues drawing a HASH-toggled material).

Materials hop into this via Reference.getReference(material) to find every renderer holding them; sample code can also call it directly after manual state changes.

Returns

void

Inherited from

MeshRenderer.refreshRenderClassification

---

selfCloneMaterials()

selfCloneMaterials(key): this

Defined in: src/components/renderer/RenderNode.ts:295

Parameters

key

string

Returns

this

Inherited from

MeshRenderer.selfCloneMaterials

---

renderPass()

renderPass(view, passType, renderContext): void

Defined in: src/components/renderer/RenderNode.ts:456

Parameters

view

View3D

passType

PassType

renderContext

RenderContext

Returns

void

Inherited from

MeshRenderer.renderPass

---

renderPass2()

renderPass2(view, passType, rendererPassState, clusterLightingBuffer, encoder, useBundle?): void

Defined in: src/components/renderer/RenderNode.ts:528

render pass at passType

Parameters

view

View3D

passType

PassType

rendererPassState

RendererPassState

clusterLightingBuffer

ClusterLightingBuffer

encoder

GPURenderPassEncoder

useBundle?

boolean = false

Returns

void

Inherited from

MeshRenderer.renderPass2

---

recordRenderPass2()

recordRenderPass2(view, passType, rendererPassState, clusterLightingBuffer, encoder, useBundle?): void

Defined in: src/components/renderer/RenderNode.ts:586

Parameters

view

View3D

passType

PassType

rendererPassState

RendererPassState

clusterLightingBuffer

ClusterLightingBuffer

encoder

GPURenderPassEncoder

useBundle?

boolean = false

Returns

void

Inherited from

MeshRenderer.recordRenderPass2

---

preInit()

preInit(_rendererType): boolean

Defined in: src/components/renderer/RenderNode.ts:624

Parameters

_rendererType

PassType

Returns

boolean

Inherited from

MeshRenderer.preInit

---

beforeDestroy()

beforeDestroy(force?): void

Defined in: src/components/renderer/RenderNode.ts:741

before release this component, object refrences are not be set null now.

Parameters

force?

boolean

Returns

void

Inherited from

MeshRenderer.beforeDestroy

---

start()

start(): void

Defined in: src/components/renderer/SkinnedMeshRenderer.ts:34

Resolve the driving skeleton animation component from the hierarchy.

Returns

void

Overrides

MeshRenderer.start

---

onEnable()

onEnable(): void

Defined in: src/components/renderer/SkinnedMeshRenderer.ts:53

Register the renderer when enabled.

Returns

void

Overrides

MeshRenderer.onEnable

---

cloneTo()

cloneTo(obj): void

Defined in: src/components/renderer/SkinnedMeshRenderer.ts:103

Clone this skinned mesh renderer onto another object.

Parameters

obj

Object3D

Returns

void

Overrides

MeshRenderer.cloneTo