Skip to content

Class: SkinnedMeshRenderer2

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

Constructors

Properties

Accessors

Methods

Constructors

constructor

new SkinnedMeshRenderer2(): SkinnedMeshRenderer2

Returns

SkinnedMeshRenderer2

Overrides

MeshRenderer.constructor

Defined in

src/components/renderer/SkinnedMeshRenderer2.ts:26

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


morphData

morphData: MorphTargetData

Inherited from

MeshRenderer.morphData

Defined in

src/components/renderer/MeshRenderer.ts:24


instanceCount

instanceCount: number = 0

Inherited from

MeshRenderer.instanceCount

Defined in

src/components/renderer/RenderNode.ts:35


lodLevel

lodLevel: number = 0

Inherited from

MeshRenderer.lodLevel

Defined in

src/components/renderer/RenderNode.ts:36


alwaysRender

alwaysRender: boolean = false

Inherited from

MeshRenderer.alwaysRender

Defined in

src/components/renderer/RenderNode.ts:37


instanceID

instanceID: string

Inherited from

MeshRenderer.instanceID

Defined in

src/components/renderer/RenderNode.ts:38


drawType

drawType: number = 0

Inherited from

MeshRenderer.drawType

Defined in

src/components/renderer/RenderNode.ts:39


isRenderOrderChange

Optional isRenderOrderChange: boolean

Inherited from

MeshRenderer.isRenderOrderChange

Defined in

src/components/renderer/RenderNode.ts:55


needSortOnCameraZ

Optional needSortOnCameraZ: boolean

Inherited from

MeshRenderer.needSortOnCameraZ

Defined in

src/components/renderer/RenderNode.ts:56


isRecievePostEffectUI

Optional isRecievePostEffectUI: boolean

Inherited from

MeshRenderer.isRecievePostEffectUI

Defined in

src/components/renderer/RenderNode.ts:57


skinJointsName

skinJointsName: string[]

Defined in

src/components/renderer/SkinnedMeshRenderer2.ts:20

Accessors

eventDispatcher

get eventDispatcher(): CEventDispatcher

Returns

CEventDispatcher

Inherited from

MeshRenderer.eventDispatcher

Defined in

src/components/ComponentBase.ts:23

set eventDispatcher(value): void

Parameters

NameType
valueCEventDispatcher

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

NameType
valueboolean

Returns

void

Inherited from

MeshRenderer.enable

Defined in

src/components/ComponentBase.ts:54


material

get material(): Material

material

Returns

Material

Inherited from

MeshRenderer.material

Defined in

src/components/renderer/MeshRenderer.ts:99

set material(value): void

Parameters

NameType
valueMaterial

Returns

void

Inherited from

MeshRenderer.material

Defined in

src/components/renderer/MeshRenderer.ts:103


renderLayer

get renderLayer(): RenderLayer

Returns

RenderLayer

Inherited from

MeshRenderer.renderLayer

Defined in

src/components/renderer/RenderNode.ts:110

set renderLayer(value): void

Parameters

NameType
valueRenderLayer

Returns

void

Inherited from

MeshRenderer.renderLayer

Defined in

src/components/renderer/RenderNode.ts:114


rendererMask

get rendererMask(): number

Returns

number

Inherited from

MeshRenderer.rendererMask

Defined in

src/components/renderer/RenderNode.ts:152

set rendererMask(value): void

Parameters

NameType
valuenumber

Returns

void

Inherited from

MeshRenderer.rendererMask

Defined in

src/components/renderer/RenderNode.ts:156


renderOrder

get renderOrder(): number

Returns

number

Inherited from

MeshRenderer.renderOrder

Defined in

src/components/renderer/RenderNode.ts:160

set renderOrder(value): void

Parameters

NameType
valuenumber

Returns

void

Inherited from

MeshRenderer.renderOrder

Defined in

src/components/renderer/RenderNode.ts:164


materials

get materials(): Material[]

Returns

Material[]

Inherited from

MeshRenderer.materials

Defined in

src/components/renderer/RenderNode.ts:173

set materials(value): void

Parameters

NameType
valueMaterial[]

Returns

void

Inherited from

MeshRenderer.materials

Defined in

src/components/renderer/RenderNode.ts:177


castShadow

get castShadow(): boolean

Returns

boolean

Inherited from

MeshRenderer.castShadow

Defined in

src/components/renderer/RenderNode.ts:345

set castShadow(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

MeshRenderer.castShadow

Defined in

src/components/renderer/RenderNode.ts:349


castGI

get castGI(): boolean

Returns

boolean

Inherited from

MeshRenderer.castGI

Defined in

src/components/renderer/RenderNode.ts:354

set castGI(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

MeshRenderer.castGI

Defined in

src/components/renderer/RenderNode.ts:358


castReflection

get castReflection(): boolean

Returns

boolean

Inherited from

MeshRenderer.castReflection

Defined in

src/components/renderer/RenderNode.ts:362

set castReflection(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

MeshRenderer.castReflection

Defined in

src/components/renderer/RenderNode.ts:366


geometry

get geometry(): GeometryBase

The geometry of the mesh determines its shape

Returns

GeometryBase

Overrides

MeshRenderer.geometry

Defined in

src/components/renderer/SkinnedMeshRenderer2.ts:31

set geometry(value): void

Parameters

NameType
valueGeometryBase

Returns

void

Overrides

MeshRenderer.geometry

Defined in

src/components/renderer/SkinnedMeshRenderer2.ts:35


blendShape

get blendShape(): MorphTargetData

Returns

MorphTargetData

Defined in

src/components/renderer/SkinnedMeshRenderer2.ts:64


skeletonAnimation

get skeletonAnimation(): AnimatorComponent

Returns

AnimatorComponent

Defined in

src/components/renderer/SkinnedMeshRenderer2.ts:73

set skeletonAnimation(value): void

Parameters

NameType
valueAnimatorComponent

Returns

void

Defined in

src/components/renderer/SkinnedMeshRenderer2.ts:77


skinInverseBindMatrices

get skinInverseBindMatrices(): Float32Array[]

Returns

Float32Array[]

Defined in

src/components/renderer/SkinnedMeshRenderer2.ts:90

set skinInverseBindMatrices(inverseBindMatrices): void

Parameters

NameType
inverseBindMatricesFloat32Array[]

Returns

void

Defined in

src/components/renderer/SkinnedMeshRenderer2.ts:94


inverseBindMatrixBuffer

get inverseBindMatrixBuffer(): StorageGPUBuffer

Returns

StorageGPUBuffer

Defined in

src/components/renderer/SkinnedMeshRenderer2.ts:106


jointIndexTableBuffer

get jointIndexTableBuffer(): GPUBuffer

Returns

GPUBuffer

Defined in

src/components/renderer/SkinnedMeshRenderer2.ts:110

Methods

stop

stop(): void

Returns

void

Inherited from

MeshRenderer.stop

Defined in

src/components/ComponentBase.ts:114


onUpdate

onUpdate(view?): any

Parameters

NameType
view?View3D

Returns

any

Inherited from

MeshRenderer.onUpdate

Defined in

src/components/ComponentBase.ts:117


onLateUpdate

onLateUpdate(view?): any

Parameters

NameType
view?View3D

Returns

any

Inherited from

MeshRenderer.onLateUpdate

Defined in

src/components/ComponentBase.ts:118


onBeforeUpdate

onBeforeUpdate(view?): any

Parameters

NameType
view?View3D

Returns

any

Inherited from

MeshRenderer.onBeforeUpdate

Defined in

src/components/ComponentBase.ts:119


onGraphic

onGraphic(view?): any

Parameters

NameType
view?View3D

Returns

any

Inherited from

MeshRenderer.onGraphic

Defined in

src/components/ComponentBase.ts:121


onParentChange

onParentChange(lastParent?, currentParent?): any

Parameters

NameType
lastParent?Object3D
currentParent?Object3D

Returns

any

Inherited from

MeshRenderer.onParentChange

Defined in

src/components/ComponentBase.ts:122


onAddChild

onAddChild(child): any

Parameters

NameType
childObject3D

Returns

any

Inherited from

MeshRenderer.onAddChild

Defined in

src/components/ComponentBase.ts:123


onRemoveChild

onRemoveChild(child): any

Parameters

NameType
childObject3D

Returns

any

Inherited from

MeshRenderer.onRemoveChild

Defined in

src/components/ComponentBase.ts:124


onDisable

onDisable(): void

Returns

void

Inherited from

MeshRenderer.onDisable

Defined in

src/components/renderer/MeshRenderer.ts:34


copyComponent

copyComponent(from): this

Parameters

NameType
fromthis

Returns

this

Inherited from

MeshRenderer.copyComponent

Defined in

src/components/renderer/MeshRenderer.ts:43


setMorphInfluence

setMorphInfluence(key, value): void

Set deformation animation parameters

Parameters

NameType
keystring
valuenumber

Returns

void

Inherited from

MeshRenderer.setMorphInfluence

Defined in

src/components/renderer/MeshRenderer.ts:110


setMorphInfluenceIndex

setMorphInfluenceIndex(index, value): void

Parameters

NameType
indexnumber
valuenumber

Returns

void

Inherited from

MeshRenderer.setMorphInfluenceIndex

Defined in

src/components/renderer/MeshRenderer.ts:119


onCompute

onCompute(view, command): void

Parameters

NameType
viewView3D
commandGPUCommandEncoder

Returns

void

Inherited from

MeshRenderer.onCompute

Defined in

src/components/renderer/MeshRenderer.ts:128


destroy

destroy(force?): void

Parameters

NameType
force?boolean

Returns

void

Inherited from

MeshRenderer.destroy

Defined in

src/components/renderer/MeshRenderer.ts:157


init

init(param?): void

Parameters

NameType
param?any

Returns

void

Inherited from

MeshRenderer.init

Defined in

src/components/renderer/RenderNode.ts:70


attachSceneOctree

attachSceneOctree(octree): void

Parameters

NameType
octreeOctree

Returns

void

Inherited from

MeshRenderer.attachSceneOctree

Defined in

src/components/renderer/RenderNode.ts:78


detachSceneOctree

detachSceneOctree(): void

Returns

void

Inherited from

MeshRenderer.detachSceneOctree

Defined in

src/components/renderer/RenderNode.ts:83


addMask

addMask(mask): void

Parameters

NameType
maskRendererMask

Returns

void

Inherited from

MeshRenderer.addMask

Defined in

src/components/renderer/RenderNode.ts:140


removeMask

removeMask(mask): void

Parameters

NameType
maskRendererMask

Returns

void

Inherited from

MeshRenderer.removeMask

Defined in

src/components/renderer/RenderNode.ts:144


hasMask

hasMask(mask): boolean

Parameters

NameType
maskRendererMask

Returns

boolean

Inherited from

MeshRenderer.hasMask

Defined in

src/components/renderer/RenderNode.ts:148


addRendererMask

addRendererMask(tag): void

Parameters

NameType
tagRendererMask

Returns

void

Inherited from

MeshRenderer.addRendererMask

Defined in

src/components/renderer/RenderNode.ts:228


removeRendererMask

removeRendererMask(tag): void

Parameters

NameType
tagRendererMask

Returns

void

Inherited from

MeshRenderer.removeRendererMask

Defined in

src/components/renderer/RenderNode.ts:232


selfCloneMaterials

selfCloneMaterials(key): this

Parameters

NameType
keystring

Returns

this

Inherited from

MeshRenderer.selfCloneMaterials

Defined in

src/components/renderer/RenderNode.ts:252


renderPass

renderPass(view, passType, renderContext): void

Parameters

NameType
viewView3D
passTypePassType
renderContextRenderContext

Returns

void

Inherited from

MeshRenderer.renderPass

Defined in

src/components/renderer/RenderNode.ts:370


renderPass2

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

render pass at passType

Parameters

NameTypeDefault value
viewView3Dundefined
passTypePassTypeundefined
rendererPassStateRendererPassStateundefined
clusterLightingBufferClusterLightingBufferundefined
encoderGPURenderPassEncoderundefined
useBundlebooleanfalse

Returns

void

Inherited from

MeshRenderer.renderPass2

Defined in

src/components/renderer/RenderNode.ts:438


recordRenderPass2

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

Parameters

NameTypeDefault value
viewView3Dundefined
passTypePassTypeundefined
rendererPassStateRendererPassStateundefined
clusterLightingBufferClusterLightingBufferundefined
encoderGPURenderPassEncoderundefined
useBundlebooleanfalse

Returns

void

Inherited from

MeshRenderer.recordRenderPass2

Defined in

src/components/renderer/RenderNode.ts:486


preInit

preInit(_rendererType): boolean

Parameters

NameType
_rendererTypePassType

Returns

boolean

Inherited from

MeshRenderer.preInit

Defined in

src/components/renderer/RenderNode.ts:519


beforeDestroy

beforeDestroy(force?): void

Parameters

NameType
force?boolean

Returns

void

Inherited from

MeshRenderer.beforeDestroy

Defined in

src/components/renderer/RenderNode.ts:609


start

start(): void

Returns

void

Overrides

MeshRenderer.start

Defined in

src/components/renderer/SkinnedMeshRenderer2.ts:45


onEnable

onEnable(): void

Returns

void

Overrides

MeshRenderer.onEnable

Defined in

src/components/renderer/SkinnedMeshRenderer2.ts:69


cloneTo

cloneTo(obj): void

Parameters

NameType
objObject3D

Returns

void

Overrides

MeshRenderer.cloneTo

Defined in

src/components/renderer/SkinnedMeshRenderer2.ts:114