RoyInterface / Exports / component/RoyComponent / RoyComponent

Class: RoyComponent

component/RoyComponent.RoyComponent

Hierarchy

• RoyComponent

  ↳ RoyCameraComponent

  ↳ RoyIndirectLightComponent

  ↳ RoyLightComponent

  ↳ RoyLodComponent

  ↳ RoyMeshComponent

  ↳ RoySkyboxComponent

  ↳ RoyWireframeComponent

Implements

• RoyTransDataObject

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_enabled
• m_visibleLayer
• m_mouseEnabled
• m_mouseEnabledOnInvisible
• m_occlusionEnabled
• m_boundBoxValid
• m_boundBox
• m_userData
• m_gizmoItem
• m_transDataInfo
• m_canTransfer

Accessors

• handleID
• sceneNode
• name
• compTypeName
• compClassifyType
• requireDirtyBox
• requireUpdatePriority
• requireUpdate
• enabled
• visibleLayer
• mouseEnabled
• mouseEnabledOnInvisible
• occlusionEnabled
• boundBoxValid
• boundBox
• gizmoItem
• transDataInfo
• canTransfer

Methods

• getBoundBox
• setUserData
• getUserData
• deleteUserData
• markTransDataDirty
• markCanTransfer
• destroy
• markCullDirty
• update
• onEnable
• onDisable
• onAddToScene
• onRemoveFromScene
• updateOcclusion
• raycast
• frustumQuery
• removeRelObjectFromMap
• collectTransData
• serializeTransData
• deserializeTransData

Constructors

constructor

• new RoyComponent(node): RoyComponent

Parameters

Name	Type
node	RoySceneNode

Returns

RoyComponent

Properties

s_handleID

▪ Static Protected s_handleID: number = 0

---

m_handleID

• Protected m_handleID: number = 0

---

m_sceneNode

• Protected m_sceneNode: RoySceneNode

---

m_name

• Protected m_name: string = ''

---

m_compTypeName

• Protected m_compTypeName: string = ''

---

m_compClassifyType

• Protected m_compClassifyType: RoyComponentClassifyType = RoyComponentClassifyType.CCT_LOGIC

---

m_requireDirtyBox

• Protected m_requireDirtyBox: boolean = false

---

m_requireUpdatePriority

• Protected m_requireUpdatePriority: number = 0

---

m_requireUpdate

• Protected m_requireUpdate: boolean = false

---

m_enabled

• Private m_enabled: boolean = true

---

m_visibleLayer

• Protected m_visibleLayer: number = RoyLayer.Base

---

m_mouseEnabled

• Protected m_mouseEnabled: boolean = false

---

m_mouseEnabledOnInvisible

• Protected m_mouseEnabledOnInvisible: boolean = false

---

m_occlusionEnabled

• Protected m_occlusionEnabled: boolean = false

---

m_boundBoxValid

• Protected m_boundBoxValid: boolean = true

---

m_boundBox

• Protected m_boundBox: AABB

---

m_userData

• Protected m_userData: object = {}

---

m_gizmoItem

• Protected m_gizmoItem: RoyGizmoItem

---

m_transDataInfo

• Protected m_transDataInfo: RoyTransDataInfo

---

m_canTransfer

• Protected m_canTransfer: boolean = true

Accessors

handleID

• get handleID(): number

Returns

number

---

sceneNode

• get sceneNode(): RoySceneNode

Returns

RoySceneNode

---

name

• get name(): string

Returns

string

• set name(value): void

Parameters

Name	Type
value	string

Returns

void

---

compTypeName

• get compTypeName(): string

Returns

string

---

compClassifyType

• get compClassifyType(): RoyComponentClassifyType

Returns

RoyComponentClassifyType

---

requireDirtyBox

• get requireDirtyBox(): boolean

Returns

boolean

---

requireUpdatePriority

• get requireUpdatePriority(): number

Returns

number

---

requireUpdate

• get requireUpdate(): boolean

Returns

boolean

---

enabled

• get enabled(): boolean

Returns

boolean

• set enabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

visibleLayer

• get visibleLayer(): number

Returns

number

• set visibleLayer(value): void

Parameters

Name	Type
value	number

Returns

void

---

mouseEnabled

• get mouseEnabled(): boolean

Returns

boolean

• set mouseEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

mouseEnabledOnInvisible

• get mouseEnabledOnInvisible(): boolean

Returns

boolean

• set mouseEnabledOnInvisible(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

occlusionEnabled

• get occlusionEnabled(): boolean

Returns

boolean

• set occlusionEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

boundBoxValid

• get boundBoxValid(): boolean

Returns

boolean

• set boundBoxValid(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

boundBox

• get boundBox(): AABB

Returns

AABB

---

gizmoItem

• get gizmoItem(): RoyGizmoItem

Returns

RoyGizmoItem

---

transDataInfo

• get transDataInfo(): RoyTransDataInfo

Returns

RoyTransDataInfo

Implementation of

RoyTransDataObject.transDataInfo

---

canTransfer

• get canTransfer(): boolean

Returns

boolean

Implementation of

RoyTransDataObject.canTransfer

Methods

getBoundBox

▸ getBoundBox(): AABB

Returns

AABB

---

setUserData

▸ setUserData(key, value): void

Parameters

Name	Type
key	string
value	unknown

Returns

void

---

getUserData

▸ getUserData(key): unknown

Parameters

Name	Type
key	string

Returns

unknown

---

deleteUserData

▸ deleteUserData(key): void

Parameters

Name	Type
key	string

Returns

void

---

markTransDataDirty

▸ markTransDataDirty(): void

Returns

void

Implementation of

RoyTransDataObject.markTransDataDirty

---

markCanTransfer

▸ markCanTransfer(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

RoyTransDataObject.markCanTransfer

---

destroy

▸ destroy(): void

Returns

void

---

markCullDirty

▸ markCullDirty(): void

Returns

void

---

update

▸ update(royCamera): void

Parameters

Name	Type
royCamera	RoyCamera3D

Returns

void

---

onEnable

▸ onEnable(): void

Returns

void

---

onDisable

▸ onDisable(): void

Returns

void

---

onAddToScene

▸ onAddToScene(): void

Returns

void

---

onRemoveFromScene

▸ onRemoveFromScene(): void

Returns

void

---

updateOcclusion

▸ updateOcclusion(): void

Returns

void

---

raycast

▸ raycast(rl): RoyQueryResultRay[]

Parameters

Name	Type
rl	RadialLine

Returns

RoyQueryResultRay[]

---

frustumQuery

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

Parameters

Name	Type
frustum	Frustum
intersection	Intersection
options	SceneQueryOptions

Returns

RoyQueryResultFrustum[]

---

removeRelObjectFromMap

▸ removeRelObjectFromMap(dataTransfer): void

Parameters

Name	Type
dataTransfer	RoyDataTransferRecv

Returns

void

Implementation of

RoyTransDataObject.removeRelObjectFromMap

---

collectTransData

▸ collectTransData(dataTransfer): boolean

Parameters

Name	Type
dataTransfer	RoyDataTransferSend

Returns

boolean

Implementation of

RoyTransDataObject.collectTransData

---

serializeTransData

▸ serializeTransData(dataTransfer): Object

Parameters

Name	Type
dataTransfer	RoyDataTransferSend

Returns

Object

Name	Type
ptlType	string
ptlName	string

Implementation of

RoyTransDataObject.serializeTransData

---

deserializeTransData

▸ deserializeTransData(dataTransfer, compData): void

Parameters

Name	Type
dataTransfer	RoyDataTransferRecv
compData	RoyComponentData

Returns

void