RoyInterface / Exports / component/RoySkinMeshComponent / RoySkinMeshComponent

Class: RoySkinMeshComponent

component/RoySkinMeshComponent.RoySkinMeshComponent

Hierarchy

• RoyMeshComponent

  ↳ RoySkinMeshComponent

Table of contents

Constructors

• constructor

Properties

• s_handleID
• m_handleID
• m_sceneNode
• m_name
• m_compTypeName
• m_compClassifyType
• m_requireDirtyBox
• m_requireUpdatePriority
• m_requireUpdate
• m_visibleLayer
• m_mouseEnabled
• m_mouseEnabledOnInvisible
• m_occlusionEnabled
• m_boundBoxValid
• m_boundBox
• m_userData
• m_gizmoItem
• m_transDataInfo
• m_canTransfer
• cacheInvertWorldMatrix
• cacheLocalFrustum
• cacheMat4
• cacheVec3
• cacheLocalRay
• cacheRayDir
• cacheRayPos
• cacheWorldPos
• m_mesh
• m_dispObject3DList
• m_dispOjbect3DMap
• tempResult
• CLASS_NAME
• m_skinAnimator
• m_skinInfo
• m_curPlayTime
• m_startTime
• m_lastPlayTime
• m_curAnimIndex
• m_speedRate
• m_loop
• m_playing

Accessors

• handleID
• sceneNode
• name
• compTypeName
• compClassifyType
• requireDirtyBox
• requireUpdatePriority
• requireUpdate
• enabled
• mouseEnabled
• mouseEnabledOnInvisible
• boundBoxValid
• boundBox
• gizmoItem
• transDataInfo
• canTransfer
• mesh
• dispObject3DList
• dispObject3Dmap
• occlusionEnabled
• visibleLayer
• skinAnimator
• skinInfo
• curAnimIndex
• speedRate
• loop
• playing

Methods

• setUserData
• getUserData
• deleteUserData
• markTransDataDirty
• markCullDirty
• updateOcclusion
• create
• destroy
• onEnable
• onDisable
• onAddToScene
• onRemoveFromScene
• getBoundBox
• setMesh
• removePrimitive
• addPrimitive
• verify
• setGeometryRange
• getIndexOffset
• getIndexCount
• getPrimitiveType
• setMaterial
• getMaterial
• setRenderPriority
• getRenderPriority
• setNextPage
• getNextPage
• setCastShadow
• setReceiveShadow
• setVisibleLayer
• setLightMask
• setExcludeDraftNormal
• setMousePriority
• getMousePriority
• setSelected
• setFocus
• setDraftID
• setBatchModelMatrix
• update
• updateLod
• raycast
• raycastPrimitive
• frustumQuery
• frustumQueryPrimitive
• markCanTransfer
• removeRelObjectFromMap
• collectTransData
• serializeTransData
• deserializeTransData
• setSkinAnimator
• setSkinInfo
• applyAnimation
• removeAnimation
• playAnimation
• pauseAnimation
• setAnimationTime
• getCurrentPlayTime
• getAnimationDuration
• resetBoneMatrices
• updateAnimation
• updateBoneMatrices

Constructors

constructor

• new RoySkinMeshComponent(node): RoySkinMeshComponent

Parameters

Name	Type
node	RoySceneNode

Returns

RoySkinMeshComponent

Overrides

RoyMeshComponent.constructor

Properties

s_handleID

▪ Static Protected s_handleID: number = 0

Inherited from

RoyMeshComponent.s_handleID

---

m_handleID

• Protected m_handleID: number = 0

Inherited from

RoyMeshComponent.m_handleID

---

m_sceneNode

• Protected m_sceneNode: RoySceneNode

Inherited from

RoyMeshComponent.m_sceneNode

---

m_name

• Protected m_name: string = ''

Inherited from

RoyMeshComponent.m_name

---

m_compTypeName

• Protected m_compTypeName: string = ''

Inherited from

RoyMeshComponent.m_compTypeName

---

m_compClassifyType

• Protected m_compClassifyType: RoyComponentClassifyType = RoyComponentClassifyType.CCT_LOGIC

Inherited from

RoyMeshComponent.m_compClassifyType

---

m_requireDirtyBox

• Protected m_requireDirtyBox: boolean = false

Inherited from

RoyMeshComponent.m_requireDirtyBox

---

m_requireUpdatePriority

• Protected m_requireUpdatePriority: number = 0

Inherited from

RoyMeshComponent.m_requireUpdatePriority

---

m_requireUpdate

• Protected m_requireUpdate: boolean = false

Inherited from

RoyMeshComponent.m_requireUpdate

---

m_visibleLayer

• Protected m_visibleLayer: number = RoyLayer.Base

Inherited from

RoyMeshComponent.m_visibleLayer

---

m_mouseEnabled

• Protected m_mouseEnabled: boolean = false

Inherited from

RoyMeshComponent.m_mouseEnabled

---

m_mouseEnabledOnInvisible

• Protected m_mouseEnabledOnInvisible: boolean = false

Inherited from

RoyMeshComponent.m_mouseEnabledOnInvisible

---

m_occlusionEnabled

• Protected m_occlusionEnabled: boolean = false

Inherited from

RoyMeshComponent.m_occlusionEnabled

---

m_boundBoxValid

• Protected m_boundBoxValid: boolean = true

Inherited from

RoyMeshComponent.m_boundBoxValid

---

m_boundBox

• Protected m_boundBox: AABB

Inherited from

RoyMeshComponent.m_boundBox

---

m_userData

• Protected m_userData: object = {}

Inherited from

RoyMeshComponent.m_userData

---

m_gizmoItem

• Protected m_gizmoItem: RoyGizmoItem

Inherited from

RoyMeshComponent.m_gizmoItem

---

m_transDataInfo

• Protected m_transDataInfo: RoyTransDataInfo

Inherited from

RoyMeshComponent.m_transDataInfo

---

m_canTransfer

• Protected m_canTransfer: boolean = true

Inherited from

RoyMeshComponent.m_canTransfer

---

cacheInvertWorldMatrix

▪ Static Protected cacheInvertWorldMatrix: Mat4

Inherited from

RoyMeshComponent.cacheInvertWorldMatrix

---

cacheLocalFrustum

▪ Static Protected cacheLocalFrustum: Frustum

Inherited from

RoyMeshComponent.cacheLocalFrustum

---

cacheMat4

▪ Static Protected cacheMat4: Mat4

Inherited from

RoyMeshComponent.cacheMat4

---

cacheVec3

▪ Static Protected cacheVec3: Vec3

Inherited from

RoyMeshComponent.cacheVec3

---

cacheLocalRay

▪ Static Protected cacheLocalRay: RadialLine

Inherited from

RoyMeshComponent.cacheLocalRay

---

cacheRayDir

▪ Static Protected cacheRayDir: Vec3

Inherited from

RoyMeshComponent.cacheRayDir

---

cacheRayPos

▪ Static Protected cacheRayPos: Vec3

Inherited from

RoyMeshComponent.cacheRayPos

---

cacheWorldPos

▪ Static Protected cacheWorldPos: Vec3

Inherited from

RoyMeshComponent.cacheWorldPos

---

m_mesh

• Protected m_mesh: RoyMesh

Inherited from

RoyMeshComponent.m_mesh

---

m_dispObject3DList

• Protected m_dispObject3DList: RoyObject3D[]

Inherited from

RoyMeshComponent.m_dispObject3DList

---

m_dispOjbect3DMap

• Protected m_dispOjbect3DMap: Map<string, RoyObject3D>

Inherited from

RoyMeshComponent.m_dispOjbect3DMap

---

tempResult

• Protected tempResult: RoyQueryResultRay

Inherited from

RoyMeshComponent.tempResult

---

CLASS_NAME

▪ Static CLASS_NAME: string = 'RoySkinMeshComponent'

Overrides

RoyMeshComponent.CLASS_NAME

---

m_skinAnimator

• Private m_skinAnimator: RoyAnimator

---

m_skinInfo

• Private m_skinInfo: RoySkinInfo

---

m_curPlayTime

• Private m_curPlayTime: number = 0

---

m_startTime

• Private m_startTime: number = 0

---

m_lastPlayTime

• Private m_lastPlayTime: number = 0

---

m_curAnimIndex

• Private m_curAnimIndex: number = 0

---

m_speedRate

• Private m_speedRate: number = 1.0

---

m_loop

• Private m_loop: boolean = false

---

m_playing

• Private m_playing: boolean = false

Accessors

handleID

• get handleID(): number

Returns

number

Inherited from

RoyMeshComponent.handleID

---

sceneNode

• get sceneNode(): RoySceneNode

Returns

RoySceneNode

Inherited from

RoyMeshComponent.sceneNode

---

name

• get name(): string

Returns

string

Inherited from

RoyMeshComponent.name

• set name(value): void

Parameters

Name	Type
value	string

Returns

void

Inherited from

RoyMeshComponent.name

---

compTypeName

• get compTypeName(): string

Returns

string

Inherited from

RoyMeshComponent.compTypeName

---

compClassifyType

• get compClassifyType(): RoyComponentClassifyType

Returns

RoyComponentClassifyType

Inherited from

RoyMeshComponent.compClassifyType

---

requireDirtyBox

• get requireDirtyBox(): boolean

Returns

boolean

Inherited from

RoyMeshComponent.requireDirtyBox

---

requireUpdatePriority

• get requireUpdatePriority(): number

Returns

number

Inherited from

RoyMeshComponent.requireUpdatePriority

---

requireUpdate

• get requireUpdate(): boolean

Returns

boolean

Inherited from

RoyMeshComponent.requireUpdate

---

enabled

• get enabled(): boolean

Returns

boolean

Inherited from

RoyMeshComponent.enabled

• set enabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyMeshComponent.enabled

---

mouseEnabled

• get mouseEnabled(): boolean

Returns

boolean

Inherited from

RoyMeshComponent.mouseEnabled

• set mouseEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyMeshComponent.mouseEnabled

---

mouseEnabledOnInvisible

• get mouseEnabledOnInvisible(): boolean

Returns

boolean

Inherited from

RoyMeshComponent.mouseEnabledOnInvisible

• set mouseEnabledOnInvisible(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyMeshComponent.mouseEnabledOnInvisible

---

boundBoxValid

• get boundBoxValid(): boolean

Returns

boolean

Inherited from

RoyMeshComponent.boundBoxValid

• set boundBoxValid(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyMeshComponent.boundBoxValid

---

boundBox

• get boundBox(): AABB

Returns

AABB

Inherited from

RoyMeshComponent.boundBox

---

gizmoItem

• get gizmoItem(): RoyGizmoItem

Returns

RoyGizmoItem

Inherited from

RoyMeshComponent.gizmoItem

---

transDataInfo

• get transDataInfo(): RoyTransDataInfo

Returns

RoyTransDataInfo

Inherited from

RoyMeshComponent.transDataInfo

---

canTransfer

• get canTransfer(): boolean

Returns

boolean

Inherited from

RoyMeshComponent.canTransfer

---

mesh

• get mesh(): RoyMesh

Returns

RoyMesh

Inherited from

RoyMeshComponent.mesh

---

dispObject3DList

• get dispObject3DList(): RoyObject3D[]

Returns

RoyObject3D[]

Inherited from

RoyMeshComponent.dispObject3DList

---

dispObject3Dmap

• get dispObject3Dmap(): Map<string, RoyObject3D>

Returns

Map<string, RoyObject3D>

Inherited from

RoyMeshComponent.dispObject3Dmap

---

occlusionEnabled

• get occlusionEnabled(): boolean

Returns

boolean

Inherited from

RoyMeshComponent.occlusionEnabled

• set occlusionEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyMeshComponent.occlusionEnabled

---

visibleLayer

• get visibleLayer(): number

Returns

number

Inherited from

RoyMeshComponent.visibleLayer

• set visibleLayer(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

RoyMeshComponent.visibleLayer

---

skinAnimator

• get skinAnimator(): RoyAnimator

Returns

RoyAnimator

---

skinInfo

• get skinInfo(): RoySkinInfo

Returns

RoySkinInfo

---

curAnimIndex

• get curAnimIndex(): number

Returns

number

---

speedRate

• get speedRate(): number

Returns

number

• set speedRate(value): void

Parameters

Name	Type
value	number

Returns

void

---

loop

• get loop(): boolean

Returns

boolean

• set loop(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

playing

• get playing(): boolean

Returns

boolean

Methods

setUserData

▸ setUserData(key, value): void

Parameters

Name	Type
key	string
value	unknown

Returns

void

Inherited from

RoyMeshComponent.setUserData

---

getUserData

▸ getUserData(key): unknown

Parameters

Name	Type
key	string

Returns

unknown

Inherited from

RoyMeshComponent.getUserData

---

deleteUserData

▸ deleteUserData(key): void

Parameters

Name	Type
key	string

Returns

void

Inherited from

RoyMeshComponent.deleteUserData

---

markTransDataDirty

▸ markTransDataDirty(): void

Returns

void

Inherited from

RoyMeshComponent.markTransDataDirty

---

markCullDirty

▸ markCullDirty(): void

Returns

void

Inherited from

RoyMeshComponent.markCullDirty

---

updateOcclusion

▸ updateOcclusion(): void

Returns

void

Inherited from

RoyMeshComponent.updateOcclusion

---

create

▸ create(node): RoyComponent

Parameters

Name	Type
node	RoySceneNode

Returns

RoyComponent

Inherited from

RoyMeshComponent.create

---

destroy

▸ destroy(): void

Returns

void

Inherited from

RoyMeshComponent.destroy

---

onEnable

▸ onEnable(): void

Returns

void

Inherited from

RoyMeshComponent.onEnable

---

onDisable

▸ onDisable(): void

Returns

void

Inherited from

RoyMeshComponent.onDisable

---

onAddToScene

▸ onAddToScene(): void

Returns

void

Inherited from

RoyMeshComponent.onAddToScene

---

onRemoveFromScene

▸ onRemoveFromScene(): void

Returns

void

Inherited from

RoyMeshComponent.onRemoveFromScene

---

getBoundBox

▸ getBoundBox(): AABB

Returns

AABB

Inherited from

RoyMeshComponent.getBoundBox

---

setMesh

▸ setMesh(royMesh, primitiveCount, transDataInfo?): void

Parameters

Name	Type
royMesh	RoyMesh
primitiveCount	number
transDataInfo?	RoyTransDataInfo[]

Returns

void

Inherited from

RoyMeshComponent.setMesh

---

removePrimitive

▸ removePrimitive(disp): void

Parameters

Name	Type
disp	RoyObject3D

Returns

void

Inherited from

RoyMeshComponent.removePrimitive

---

addPrimitive

▸ addPrimitive(disp): void

Parameters

Name	Type
disp	RoyObject3D

Returns

void

Inherited from

RoyMeshComponent.addPrimitive

---

verify

▸ verify(primitiveIndex): boolean

Parameters

Name	Type
primitiveIndex	number

Returns

boolean

Inherited from

RoyMeshComponent.verify

---

setGeometryRange

▸ setGeometryRange(primitiveIndex, primitiveType, idxOffset, idxCount): void

Parameters

Name	Type
primitiveIndex	number
primitiveType	RenderableManager$PrimitiveType
idxOffset	number
idxCount	number

Returns

void

Inherited from

RoyMeshComponent.setGeometryRange

---

getIndexOffset

▸ getIndexOffset(primitiveIndex): number

Parameters

Name	Type
primitiveIndex	number

Returns

number

Inherited from

RoyMeshComponent.getIndexOffset

---

getIndexCount

▸ getIndexCount(primitiveIndex): number

Parameters

Name	Type
primitiveIndex	number

Returns

number

Inherited from

RoyMeshComponent.getIndexCount

---

getPrimitiveType

▸ getPrimitiveType(primitiveIndex): RenderableManager$PrimitiveType

Parameters

Name	Type
primitiveIndex	number

Returns

RenderableManager$PrimitiveType

Inherited from

RoyMeshComponent.getPrimitiveType

---

setMaterial

▸ setMaterial(primitiveIndex, material): void

Parameters

Name	Type
primitiveIndex	number
material	RoyMaterialBase

Returns

void

Inherited from

RoyMeshComponent.setMaterial

---

getMaterial

▸ getMaterial(primitiveIndex): RoyMaterialBase

Parameters

Name	Type
primitiveIndex	number

Returns

RoyMaterialBase

Inherited from

RoyMeshComponent.getMaterial

---

setRenderPriority

▸ setRenderPriority(primitiveIndex, value): void

Parameters

Name	Type
primitiveIndex	number
value	RoyPriorityDef

Returns

void

Inherited from

RoyMeshComponent.setRenderPriority

---

getRenderPriority

▸ getRenderPriority(primitiveIndex): number

Parameters

Name	Type
primitiveIndex	number

Returns

number

Inherited from

RoyMeshComponent.getRenderPriority

---

setNextPage

▸ setNextPage(primitiveIndex, value): boolean | 0

Parameters

Name	Type
primitiveIndex	number
value	boolean

Returns

boolean | 0

Inherited from

RoyMeshComponent.setNextPage

---

getNextPage

▸ getNextPage(primitiveIndex): boolean

Parameters

Name	Type
primitiveIndex	number

Returns

boolean

Inherited from

RoyMeshComponent.getNextPage

---

setCastShadow

▸ setCastShadow(primitiveIndex, enabled): void

Parameters

Name	Type
primitiveIndex	number
enabled	boolean

Returns

void

Inherited from

RoyMeshComponent.setCastShadow

---

setReceiveShadow

▸ setReceiveShadow(primitiveIndex, enabled): void

Parameters

Name	Type
primitiveIndex	number
enabled	boolean

Returns

void

Inherited from

RoyMeshComponent.setReceiveShadow

---

setVisibleLayer

▸ setVisibleLayer(primitiveIndex, visibleLayer): void

Parameters

Name	Type
primitiveIndex	number
visibleLayer	number

Returns

void

Inherited from

RoyMeshComponent.setVisibleLayer

---

setLightMask

▸ setLightMask(primitiveIndex, value): void

Parameters

Name	Type
primitiveIndex	number
value	number

Returns

void

Inherited from

RoyMeshComponent.setLightMask

---

setExcludeDraftNormal

▸ setExcludeDraftNormal(primitiveIndex, enabled): void

Parameters

Name	Type
primitiveIndex	number
enabled	boolean

Returns

void

Inherited from

RoyMeshComponent.setExcludeDraftNormal

---

setMousePriority

▸ setMousePriority(primitiveIndex, value): void

Parameters

Name	Type
primitiveIndex	number
value	number

Returns

void

Inherited from

RoyMeshComponent.setMousePriority

---

getMousePriority

▸ getMousePriority(primitiveIndex): number

Parameters

Name	Type
primitiveIndex	number

Returns

number

Inherited from

RoyMeshComponent.getMousePriority

---

setSelected

▸ setSelected(primitiveIndex, selected): void

Parameters

Name	Type
primitiveIndex	number
selected	boolean

Returns

void

Inherited from

RoyMeshComponent.setSelected

---

setFocus

▸ setFocus(primitiveIndex, focus): void

Parameters

Name	Type
primitiveIndex	number
focus	boolean

Returns

void

Inherited from

RoyMeshComponent.setFocus

---

setDraftID

▸ setDraftID(primitiveIndex, value): void

Parameters

Name	Type
primitiveIndex	number
value	number

Returns

void

Inherited from

RoyMeshComponent.setDraftID

---

setBatchModelMatrix

▸ setBatchModelMatrix(primitiveIndex, value, batchCount): void

Parameters

Name	Type
primitiveIndex	number
value	Float32Array
batchCount	number

Returns

void

Inherited from

RoyMeshComponent.setBatchModelMatrix

---

update

▸ update(royCamera): void

Parameters

Name	Type
royCamera	RoyCamera3D

Returns

void

Inherited from

RoyMeshComponent.update

---

updateLod

▸ updateLod(lodComp): void

Parameters

Name	Type
lodComp	RoyLodComponent

Returns

void

Inherited from

RoyMeshComponent.updateLod

---

raycast

▸ raycast(ray): RoyQueryResultRay[]

Parameters

Name	Type
ray	RadialLine

Returns

RoyQueryResultRay[]

Inherited from

RoyMeshComponent.raycast

---

raycastPrimitive

▸ raycastPrimitive(ray, localRay, primitiveIndex, vertices, indices): RoyQueryResultRay

Parameters

Name	Type
ray	RadialLine
localRay	RadialLine
primitiveIndex	number
vertices	Float32Array
indices	Uint16Array | Uint32Array

Returns

RoyQueryResultRay

Inherited from

RoyMeshComponent.raycastPrimitive

---

frustumQuery

▸ frustumQuery(frustum, intersection, options): RoyQueryResultFrustum[]

Parameters

Name	Type
frustum	Frustum
intersection	Intersection
options	SceneQueryOptions

Returns

RoyQueryResultFrustum[]

Inherited from

RoyMeshComponent.frustumQuery

---

frustumQueryPrimitive

▸ frustumQueryPrimitive(frustum, primitiveIndex, options, queryResult): void

Parameters

Name	Type
frustum	Frustum
primitiveIndex	number
options	SceneQueryOptions
queryResult	RoyQueryResultFrustum

Returns

void

Inherited from

RoyMeshComponent.frustumQueryPrimitive

---

markCanTransfer

▸ markCanTransfer(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyMeshComponent.markCanTransfer

---

removeRelObjectFromMap

▸ removeRelObjectFromMap(dataTransfer): void

Parameters

Name	Type
dataTransfer	RoyDataTransferRecv

Returns

void

Inherited from

RoyMeshComponent.removeRelObjectFromMap

---

collectTransData

▸ collectTransData(dataTransfer): boolean

Parameters

Name	Type
dataTransfer	RoyDataTransferSend

Returns

boolean

Inherited from

RoyMeshComponent.collectTransData

---

serializeTransData

▸ serializeTransData(dataTransfer): RoyMeshComponentData

Parameters

Name	Type
dataTransfer	RoyDataTransferSend

Returns

RoyMeshComponentData

Inherited from

RoyMeshComponent.serializeTransData

---

deserializeTransData

▸ deserializeTransData(dataTransfer, compData): void

Parameters

Name	Type
dataTransfer	RoyDataTransferRecv
compData	RoyComponentData

Returns

void

Inherited from

RoyMeshComponent.deserializeTransData

---

setSkinAnimator

▸ setSkinAnimator(skinAnimator): void

Parameters

Name	Type
skinAnimator	RoyAnimator

Returns

void

---

setSkinInfo

▸ setSkinInfo(skinInfo): void

Parameters

Name	Type
skinInfo	RoySkinInfo

Returns

void

---

applyAnimation

▸ applyAnimation(index?): void

Parameters

Name	Type	Default value
index	number	0

Returns

void

---

removeAnimation

▸ removeAnimation(): void

Returns

void

---

playAnimation

▸ playAnimation(): void

Returns

void

---

pauseAnimation

▸ pauseAnimation(): void

Returns

void

---

setAnimationTime

▸ setAnimationTime(value): void

Parameters

Name	Type
value	number

Returns

void

---

getCurrentPlayTime

▸ getCurrentPlayTime(): number

Returns

number

---

getAnimationDuration

▸ getAnimationDuration(index): number

Parameters

Name	Type
index	number

Returns

number

---

resetBoneMatrices

▸ resetBoneMatrices(): void

Returns

void

---

updateAnimation

▸ updateAnimation(time): void

Parameters

Name	Type
time	number

Returns

void

---

updateBoneMatrices

▸ updateBoneMatrices(): void

Returns

void