RoyInterface / Exports / component/RoyLightComponent / RoyLightComponent

Class: RoyLightComponent

component/RoyLightComponent.RoyLightComponent

Hierarchy

• RoyComponent

  ↳ RoyLightComponent

  ↳↳ RoyDirectionLightComponent

  ↳↳ RoyOmniLightComponent

  ↳↳ RoyRectLightComponent

  ↳↳ RoySpotLightComponent

  ↳↳ RoySunLightComponent

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
• CLASS_NAME
• m_light

Accessors

• handleID
• sceneNode
• name
• compTypeName
• compClassifyType
• requireDirtyBox
• requireUpdatePriority
• requireUpdate
• enabled
• visibleLayer
• mouseEnabled
• mouseEnabledOnInvisible
• occlusionEnabled
• boundBoxValid
• boundBox
• gizmoItem
• transDataInfo
• canTransfer
• light
• color
• intensity
• lightMask
• horizontal
• position
• direction
• shadowCaster

Methods

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

Constructors

constructor

• new RoyLightComponent(node): RoyLightComponent

Parameters

Name	Type
node	RoySceneNode

Returns

RoyLightComponent

Overrides

RoyComponent.constructor

Properties

s_handleID

▪ Static Protected s_handleID: number = 0

Inherited from

RoyComponent.s_handleID

---

m_handleID

• Protected m_handleID: number = 0

Inherited from

RoyComponent.m_handleID

---

m_sceneNode

• Protected m_sceneNode: RoySceneNode

Inherited from

RoyComponent.m_sceneNode

---

m_name

• Protected m_name: string = ''

Inherited from

RoyComponent.m_name

---

m_compTypeName

• Protected m_compTypeName: string = ''

Inherited from

RoyComponent.m_compTypeName

---

m_compClassifyType

• Protected m_compClassifyType: RoyComponentClassifyType = RoyComponentClassifyType.CCT_LOGIC

Inherited from

RoyComponent.m_compClassifyType

---

m_requireDirtyBox

• Protected m_requireDirtyBox: boolean = false

Inherited from

RoyComponent.m_requireDirtyBox

---

m_requireUpdatePriority

• Protected m_requireUpdatePriority: number = 0

Inherited from

RoyComponent.m_requireUpdatePriority

---

m_requireUpdate

• Protected m_requireUpdate: boolean = false

Inherited from

RoyComponent.m_requireUpdate

---

m_visibleLayer

• Protected m_visibleLayer: number = RoyLayer.Base

Inherited from

RoyComponent.m_visibleLayer

---

m_mouseEnabled

• Protected m_mouseEnabled: boolean = false

Inherited from

RoyComponent.m_mouseEnabled

---

m_mouseEnabledOnInvisible

• Protected m_mouseEnabledOnInvisible: boolean = false

Inherited from

RoyComponent.m_mouseEnabledOnInvisible

---

m_occlusionEnabled

• Protected m_occlusionEnabled: boolean = false

Inherited from

RoyComponent.m_occlusionEnabled

---

m_boundBoxValid

• Protected m_boundBoxValid: boolean = true

Inherited from

RoyComponent.m_boundBoxValid

---

m_boundBox

• Protected m_boundBox: AABB

Inherited from

RoyComponent.m_boundBox

---

m_userData

• Protected m_userData: object = {}

Inherited from

RoyComponent.m_userData

---

m_gizmoItem

• Protected m_gizmoItem: RoyGizmoItem

Inherited from

RoyComponent.m_gizmoItem

---

m_transDataInfo

• Protected m_transDataInfo: RoyTransDataInfo

Inherited from

RoyComponent.m_transDataInfo

---

m_canTransfer

• Protected m_canTransfer: boolean = true

Inherited from

RoyComponent.m_canTransfer

---

CLASS_NAME

▪ Static Protected CLASS_NAME: string = 'RoyLightComponent'

---

m_light

• Protected m_light: RoyLight3D

Accessors

handleID

• get handleID(): number

Returns

number

Inherited from

RoyComponent.handleID

---

sceneNode

• get sceneNode(): RoySceneNode

Returns

RoySceneNode

Inherited from

RoyComponent.sceneNode

---

name

• get name(): string

Returns

string

Inherited from

RoyComponent.name

• set name(value): void

Parameters

Name	Type
value	string

Returns

void

Inherited from

RoyComponent.name

---

compTypeName

• get compTypeName(): string

Returns

string

Inherited from

RoyComponent.compTypeName

---

compClassifyType

• get compClassifyType(): RoyComponentClassifyType

Returns

RoyComponentClassifyType

Inherited from

RoyComponent.compClassifyType

---

requireDirtyBox

• get requireDirtyBox(): boolean

Returns

boolean

Inherited from

RoyComponent.requireDirtyBox

---

requireUpdatePriority

• get requireUpdatePriority(): number

Returns

number

Inherited from

RoyComponent.requireUpdatePriority

---

requireUpdate

• get requireUpdate(): boolean

Returns

boolean

Inherited from

RoyComponent.requireUpdate

---

enabled

• get enabled(): boolean

Returns

boolean

Inherited from

RoyComponent.enabled

• set enabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyComponent.enabled

---

visibleLayer

• get visibleLayer(): number

Returns

number

Inherited from

RoyComponent.visibleLayer

• set visibleLayer(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

RoyComponent.visibleLayer

---

mouseEnabled

• get mouseEnabled(): boolean

Returns

boolean

Inherited from

RoyComponent.mouseEnabled

• set mouseEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyComponent.mouseEnabled

---

mouseEnabledOnInvisible

• get mouseEnabledOnInvisible(): boolean

Returns

boolean

Inherited from

RoyComponent.mouseEnabledOnInvisible

• set mouseEnabledOnInvisible(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyComponent.mouseEnabledOnInvisible

---

occlusionEnabled

• get occlusionEnabled(): boolean

Returns

boolean

Inherited from

RoyComponent.occlusionEnabled

• set occlusionEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyComponent.occlusionEnabled

---

boundBoxValid

• get boundBoxValid(): boolean

Returns

boolean

Inherited from

RoyComponent.boundBoxValid

• set boundBoxValid(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyComponent.boundBoxValid

---

boundBox

• get boundBox(): AABB

Returns

AABB

Inherited from

RoyComponent.boundBox

---

gizmoItem

• get gizmoItem(): RoyGizmoItem

Returns

RoyGizmoItem

Inherited from

RoyComponent.gizmoItem

---

transDataInfo

• get transDataInfo(): RoyTransDataInfo

Returns

RoyTransDataInfo

Inherited from

RoyComponent.transDataInfo

---

canTransfer

• get canTransfer(): boolean

Returns

boolean

Inherited from

RoyComponent.canTransfer

---

light

• get light(): RoyLight3D

Returns

RoyLight3D

---

color

• get color(): number[]

Returns

number[]

• set color(value): void

Parameters

Name	Type
value	number[]

Returns

void

---

intensity

• get intensity(): number

Returns

number

• set intensity(value): void

Parameters

Name	Type
value	number

Returns

void

---

lightMask

• get lightMask(): number

Returns

number

• set lightMask(value): void

Parameters

Name	Type
value	number

Returns

void

---

horizontal

• get horizontal(): Vec3

Returns

Vec3

---

position

• get position(): Vec3

Returns

Vec3

---

direction

• get direction(): Vec3

Returns

Vec3

---

shadowCaster

• get shadowCaster(): boolean

Returns

boolean

• set shadowCaster(value): void

Parameters

Name	Type
value	boolean

Returns

void

Methods

getBoundBox

▸ getBoundBox(): AABB

Returns

AABB

Inherited from

RoyComponent.getBoundBox

---

setUserData

▸ setUserData(key, value): void

Parameters

Name	Type
key	string
value	unknown

Returns

void

Inherited from

RoyComponent.setUserData

---

getUserData

▸ getUserData(key): unknown

Parameters

Name	Type
key	string

Returns

unknown

Inherited from

RoyComponent.getUserData

---

deleteUserData

▸ deleteUserData(key): void

Parameters

Name	Type
key	string

Returns

void

Inherited from

RoyComponent.deleteUserData

---

markTransDataDirty

▸ markTransDataDirty(): void

Returns

void

Inherited from

RoyComponent.markTransDataDirty

---

markCanTransfer

▸ markCanTransfer(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyComponent.markCanTransfer

---

markCullDirty

▸ markCullDirty(): void

Returns

void

Inherited from

RoyComponent.markCullDirty

---

updateOcclusion

▸ updateOcclusion(): void

Returns

void

Inherited from

RoyComponent.updateOcclusion

---

raycast

▸ raycast(rl): RoyQueryResultRay[]

Parameters

Name	Type
rl	RadialLine

Returns

RoyQueryResultRay[]

Inherited from

RoyComponent.raycast

---

frustumQuery

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

Parameters

Name	Type
frustum	Frustum
intersection	Intersection
options	SceneQueryOptions

Returns

RoyQueryResultFrustum[]

Inherited from

RoyComponent.frustumQuery

---

removeRelObjectFromMap

▸ removeRelObjectFromMap(dataTransfer): void

Parameters

Name	Type
dataTransfer	RoyDataTransferRecv

Returns

void

Inherited from

RoyComponent.removeRelObjectFromMap

---

collectTransData

▸ collectTransData(dataTransfer): boolean

Parameters

Name	Type
dataTransfer	RoyDataTransferSend

Returns

boolean

Inherited from

RoyComponent.collectTransData

---

serializeTransData

▸ serializeTransData(dataTransfer): Object

Parameters

Name	Type
dataTransfer	RoyDataTransferSend

Returns

Object

Name	Type
ptlType	string
ptlName	string

Inherited from

RoyComponent.serializeTransData

---

deserializeTransData

▸ deserializeTransData(dataTransfer, compData): void

Parameters

Name	Type
dataTransfer	RoyDataTransferRecv
compData	RoyComponentData

Returns

void

Inherited from

RoyComponent.deserializeTransData

---

destroy

▸ destroy(): void

Returns

void

Overrides

RoyComponent.destroy

---

update

▸ update(royCamera): void

Parameters

Name	Type
royCamera	RoyCamera3D

Returns

void

Overrides

RoyComponent.update

---

onEnable

▸ onEnable(): void

Returns

void

Overrides

RoyComponent.onEnable

---

onDisable

▸ onDisable(): void

Returns

void

Overrides

RoyComponent.onDisable

---

onAddToScene

▸ onAddToScene(): void

Returns

void

Overrides

RoyComponent.onAddToScene

---

onRemoveFromScene

▸ onRemoveFromScene(): void

Returns

void

Overrides

RoyComponent.onRemoveFromScene