Class: SkinnedMeshRenderer ​

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.

Hierarchy ​

• MeshRenderer

  ↳ SkinnedMeshRenderer

Constructors ​

• constructor

Properties ​

• object3D
• isDestroyed
• receiveShadow
• instanceCount
• lodLevel
• alwaysRender
• instanceID
• drawType
• isRenderOrderChange
• needSortOnCameraZ
• preInit
• skinJointsName

Accessors ​

• eventDispatcher
• isStart
• transform
• enable
• geometry
• material
• renderLayer
• rendererMask
• renderOrder
• materials
• castShadow
• castGI
• castReflection
• skeletonAnimation
• skinInverseBindMatrices
• inverseBindMatrixBuffer
• jointIndexTableBuffer

Methods ​

• stop
• onUpdate
• onLateUpdate
• onBeforeUpdate
• onGraphic
• onParentChange
• onDisable
• copyComponent
• setMorphInfluence
• setMorphInfluenceIndex
• onCompute
• destroy
• init
• attachSceneOctree
• detachSceneOctree
• addMask
• removeMask
• hasMask
• addRendererMask
• removeRendererMask
• selfCloneMaterials
• renderPass
• renderPass2
• recordRenderPass2
• beforeDestroy
• start
• onEnable
• cloneTo

Constructors ​

constructor ​

• new SkinnedMeshRenderer()

Overrides ​

MeshRenderer.constructor

Defined in ​

src/components/renderer/SkinnedMeshRenderer.ts:25

Properties ​

object3D ​

• object3D: Object3D = null

owner object3D

Inherited from ​

MeshRenderer.object3D

Defined in ​

src/components/ComponentBase.ts:17

isDestroyed ​

• Optional isDestroyed: boolean

Inherited from ​

MeshRenderer.isDestroyed

Defined in ​

src/components/ComponentBase.ts:38

receiveShadow ​

• receiveShadow: boolean

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

Inherited from ​

MeshRenderer.receiveShadow

Defined in ​

src/components/renderer/MeshRenderer.ts:21

instanceCount ​

• instanceCount: number = 0

Inherited from ​

MeshRenderer.instanceCount

Defined in ​

src/components/renderer/RenderNode.ts:33

lodLevel ​

• lodLevel: number = 0

Inherited from ​

MeshRenderer.lodLevel

Defined in ​

src/components/renderer/RenderNode.ts:34

alwaysRender ​

• alwaysRender: boolean = false

Inherited from ​

MeshRenderer.alwaysRender

Defined in ​

src/components/renderer/RenderNode.ts:35

instanceID ​

• instanceID: string

Inherited from ​

MeshRenderer.instanceID

Defined in ​

src/components/renderer/RenderNode.ts:36

drawType ​

• drawType: number = 0

Inherited from ​

MeshRenderer.drawType

Defined in ​

src/components/renderer/RenderNode.ts:37

isRenderOrderChange ​

• Optional isRenderOrderChange: boolean

Inherited from ​

MeshRenderer.isRenderOrderChange

Defined in ​

src/components/renderer/RenderNode.ts:52

needSortOnCameraZ ​

• Optional needSortOnCameraZ: boolean

Inherited from ​

MeshRenderer.needSortOnCameraZ

Defined in ​

src/components/renderer/RenderNode.ts:53

preInit ​

• preInit: boolean = false

Inherited from ​

MeshRenderer.preInit

Defined in ​

src/components/renderer/RenderNode.ts:56

skinJointsName ​

• skinJointsName: string[]

Defined in ​

src/components/renderer/SkinnedMeshRenderer.ts:19

Accessors ​

eventDispatcher ​

• get eventDispatcher(): CEventDispatcher

Returns ​

CEventDispatcher

Inherited from ​

MeshRenderer.eventDispatcher

Defined in ​

src/components/ComponentBase.ts:23

• set eventDispatcher(value): void

Parameters ​

Returns ​

void

Inherited from ​

MeshRenderer.eventDispatcher

Defined in ​

src/components/ComponentBase.ts:28

isStart ​

• get isStart(): boolean

Returns ​

boolean

Inherited from ​

MeshRenderer.isStart

Defined in ​

src/components/ComponentBase.ts:40

transform ​

• get transform(): Transform

Return the Transform component attached to the Object3D.

Returns ​

Transform

Inherited from ​

MeshRenderer.transform

Defined in ​

src/components/ComponentBase.ts:47

enable ​

• get enable(): boolean

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

Returns ​

boolean

Inherited from ​

MeshRenderer.enable

Defined in ​

src/components/ComponentBase.ts:68

• set enable(value): void

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

Parameters ​

Returns ​

void

Inherited from ​

MeshRenderer.enable

Defined in ​

src/components/ComponentBase.ts:54

geometry ​

• get geometry(): GeometryBase

The geometry of the mesh determines its shape

Returns ​

GeometryBase

Inherited from ​

MeshRenderer.geometry

Defined in ​

src/components/renderer/MeshRenderer.ts:50

• set geometry(value): void

Parameters ​

Returns ​

void

Inherited from ​

MeshRenderer.geometry

Defined in ​

src/components/renderer/MeshRenderer.ts:55

material ​

• get material(): Material

material

Returns ​

Material

Inherited from ​

MeshRenderer.material

Defined in ​

src/components/renderer/MeshRenderer.ts:82

• set material(value): void

Parameters ​

Returns ​

void

Inherited from ​

MeshRenderer.material

Defined in ​

src/components/renderer/MeshRenderer.ts:87

renderLayer ​

• get renderLayer(): RenderLayer

Returns ​

RenderLayer

Inherited from ​

MeshRenderer.renderLayer

Defined in ​

src/components/renderer/RenderNode.ts:103

• set renderLayer(value): void

Parameters ​

Returns ​

void

Inherited from ​

MeshRenderer.renderLayer

Defined in ​

src/components/renderer/RenderNode.ts:107

rendererMask ​

• get rendererMask(): number

Returns ​

number

Inherited from ​

MeshRenderer.rendererMask

Defined in ​

src/components/renderer/RenderNode.ts:141

• set rendererMask(value): void

Parameters ​

Returns ​

void

Inherited from ​

MeshRenderer.rendererMask

Defined in ​

src/components/renderer/RenderNode.ts:145

renderOrder ​

• get renderOrder(): number

Returns ​

number

Inherited from ​

MeshRenderer.renderOrder

Defined in ​

src/components/renderer/RenderNode.ts:149

• set renderOrder(value): void

Parameters ​

Returns ​

void

Inherited from ​

MeshRenderer.renderOrder

Defined in ​

src/components/renderer/RenderNode.ts:153

materials ​

• get materials(): Material[]

Returns ​

Material[]

Inherited from ​

MeshRenderer.materials

Defined in ​

src/components/renderer/RenderNode.ts:161

• set materials(value): void

Parameters ​

Returns ​

void

Inherited from ​

MeshRenderer.materials

Defined in ​

src/components/renderer/RenderNode.ts:166

castShadow ​

• get castShadow(): boolean

Returns ​

boolean

Inherited from ​

MeshRenderer.castShadow

Defined in ​

src/components/renderer/RenderNode.ts:315

• set castShadow(value): void

Parameters ​

Returns ​

void

Inherited from ​

MeshRenderer.castShadow

Defined in ​

src/components/renderer/RenderNode.ts:320

castGI ​

• get castGI(): boolean

Returns ​

boolean

Inherited from ​

MeshRenderer.castGI

Defined in ​

src/components/renderer/RenderNode.ts:325

• set castGI(value): void

Parameters ​

Returns ​

void

Inherited from ​

MeshRenderer.castGI

Defined in ​

src/components/renderer/RenderNode.ts:330

castReflection ​

• get castReflection(): boolean

Returns ​

boolean

Inherited from ​

MeshRenderer.castReflection

Defined in ​

src/components/renderer/RenderNode.ts:335

• set castReflection(value): void

Parameters ​

Returns ​

void

Inherited from ​

MeshRenderer.castReflection

Defined in ​

src/components/renderer/RenderNode.ts:339

skeletonAnimation ​

• get skeletonAnimation(): SkeletonAnimationComponent

Returns ​

SkeletonAnimationComponent

Defined in ​

src/components/renderer/SkinnedMeshRenderer.ts:48

• set skeletonAnimation(value): void

Parameters ​

Returns ​

void

Defined in ​

src/components/renderer/SkinnedMeshRenderer.ts:52

skinInverseBindMatrices ​

• get skinInverseBindMatrices(): Float32Array[]

Returns ​

Float32Array[]

Defined in ​

src/components/renderer/SkinnedMeshRenderer.ts:65

• set skinInverseBindMatrices(inverseBindMatrices): void

Parameters ​

Returns ​

void

Defined in ​

src/components/renderer/SkinnedMeshRenderer.ts:69

inverseBindMatrixBuffer ​

• get inverseBindMatrixBuffer(): StorageGPUBuffer

Returns ​

StorageGPUBuffer

Defined in ​

src/components/renderer/SkinnedMeshRenderer.ts:81

jointIndexTableBuffer ​

• get jointIndexTableBuffer(): GPUBuffer

Returns ​

GPUBuffer

Defined in ​

src/components/renderer/SkinnedMeshRenderer.ts:85

Methods ​

stop ​

▸ stop(): void

Returns ​

void

Inherited from ​

MeshRenderer.stop

Defined in ​

src/components/ComponentBase.ts:114

onUpdate ​

▸ Optional onUpdate(view?): any

Parameters ​

Returns ​

any

Inherited from ​

MeshRenderer.onUpdate

Defined in ​

src/components/ComponentBase.ts:117

onLateUpdate ​

▸ Optional onLateUpdate(view?): any

Parameters ​

Returns ​

any

Inherited from ​

MeshRenderer.onLateUpdate

Defined in ​

src/components/ComponentBase.ts:118

onBeforeUpdate ​

▸ Optional onBeforeUpdate(view?): any

Parameters ​

Returns ​

any

Inherited from ​

MeshRenderer.onBeforeUpdate

Defined in ​

src/components/ComponentBase.ts:119

onGraphic ​

▸ Optional onGraphic(view?): any

Parameters ​

Returns ​

any

Inherited from ​

MeshRenderer.onGraphic

Defined in ​

src/components/ComponentBase.ts:121

onParentChange ​

▸ Optional onParentChange(lastParent?, currentParent?): any

Parameters ​

Returns ​

any

Inherited from ​

MeshRenderer.onParentChange

Defined in ​

src/components/ComponentBase.ts:122

onDisable ​

▸ onDisable(): void

Returns ​

void

Inherited from ​

MeshRenderer.onDisable

Defined in ​

src/components/renderer/MeshRenderer.ts:32

copyComponent ​

▸ copyComponent(from): SkinnedMeshRenderer

Parameters ​

Returns ​

SkinnedMeshRenderer

Inherited from ​

MeshRenderer.copyComponent

Defined in ​

src/components/renderer/MeshRenderer.ts:41

setMorphInfluence ​

▸ setMorphInfluence(key, value): void

Set deformation animation parameters

Parameters ​

Returns ​

void

Inherited from ​

MeshRenderer.setMorphInfluence

Defined in ​

src/components/renderer/MeshRenderer.ts:95

setMorphInfluenceIndex ​

▸ setMorphInfluenceIndex(index, value): void

Parameters ​

Returns ​

void

Inherited from ​

MeshRenderer.setMorphInfluenceIndex

Defined in ​

src/components/renderer/MeshRenderer.ts:104

onCompute ​

▸ onCompute(view, command): void

Parameters ​

Returns ​

void

Inherited from ​

MeshRenderer.onCompute

Defined in ​

src/components/renderer/MeshRenderer.ts:113

destroy ​

▸ destroy(force?): void

Parameters ​

Returns ​

void

Inherited from ​

MeshRenderer.destroy

Defined in ​

src/components/renderer/MeshRenderer.ts:142

init ​

▸ init(): void

Returns ​

void

Inherited from ​

MeshRenderer.init

Defined in ​

src/components/renderer/RenderNode.ts:66

attachSceneOctree ​

▸ attachSceneOctree(octree): void

Parameters ​

Returns ​

void

Inherited from ​

MeshRenderer.attachSceneOctree

Defined in ​

src/components/renderer/RenderNode.ts:72

detachSceneOctree ​

▸ detachSceneOctree(): void

Returns ​

void

Inherited from ​

MeshRenderer.detachSceneOctree

Defined in ​

src/components/renderer/RenderNode.ts:77

addMask ​

▸ addMask(mask): void

Parameters ​

Returns ​

void

Inherited from ​

MeshRenderer.addMask

Defined in ​

src/components/renderer/RenderNode.ts:129

removeMask ​

▸ removeMask(mask): void

Parameters ​

Returns ​

void

Inherited from ​

MeshRenderer.removeMask

Defined in ​

src/components/renderer/RenderNode.ts:133

hasMask ​

▸ hasMask(mask): boolean

Parameters ​

Returns ​

boolean

Inherited from ​

MeshRenderer.hasMask

Defined in ​

src/components/renderer/RenderNode.ts:137

addRendererMask ​

▸ addRendererMask(tag): void

Parameters ​

Returns ​

void

Inherited from ​

MeshRenderer.addRendererMask

Defined in ​

src/components/renderer/RenderNode.ts:201

removeRendererMask ​

▸ removeRendererMask(tag): void

Parameters ​

Returns ​

void

Inherited from ​

MeshRenderer.removeRendererMask

Defined in ​

src/components/renderer/RenderNode.ts:205

selfCloneMaterials ​

▸ selfCloneMaterials(key): SkinnedMeshRenderer

Parameters ​

Returns ​

SkinnedMeshRenderer

Inherited from ​

MeshRenderer.selfCloneMaterials

Defined in ​

src/components/renderer/RenderNode.ts:221

renderPass ​

▸ renderPass(view, passType, renderContext): void

Parameters ​

Returns ​

void

Inherited from ​

MeshRenderer.renderPass

Defined in ​

src/components/renderer/RenderNode.ts:343

renderPass2 ​

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

render pass at passType

Parameters ​

Returns ​

void

Inherited from ​

MeshRenderer.renderPass2

Defined in ​

src/components/renderer/RenderNode.ts:399

recordRenderPass2 ​

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

Parameters ​

Returns ​

void

Inherited from ​

MeshRenderer.recordRenderPass2

Defined in ​

src/components/renderer/RenderNode.ts:444

beforeDestroy ​

▸ beforeDestroy(force?): void

Parameters ​

Returns ​

void

Inherited from ​

MeshRenderer.beforeDestroy

Defined in ​

src/components/renderer/RenderNode.ts:554

start ​

▸ start(): void

Returns ​

void

Overrides ​

MeshRenderer.start

Defined in ​

src/components/renderer/SkinnedMeshRenderer.ts:30

onEnable ​

▸ onEnable(): void

Returns ​

void

Overrides ​

MeshRenderer.onEnable

Defined in ​

src/components/renderer/SkinnedMeshRenderer.ts:44

cloneTo ​

▸ cloneTo(obj): void

Parameters ​

Returns ​

void

Overrides ​

MeshRenderer.cloneTo

Defined in ​

src/components/renderer/SkinnedMeshRenderer.ts:89