RoyInterface / Exports / scene/RoyLight3D / RoyLight3D

Class: RoyLight3D

scene/RoyLight3D.RoyLight3D

Table of contents

Constructors

• constructor

Properties

• cacheModelMatrix
• cacheRotateMat
• cacheRotation
• cacheDirection1
• cacheDirection2
• sTypeClass
• m_impl
• m_parentScene
• s_handleID
• m_handleID
• m_lightType
• m_matWorldFromLocal
• m_enabled
• m_visible
• m_color
• m_intensity
• m_lightMask
• m_falloff
• m_innerCone
• m_outerCone
• m_shadowCaster
• m_width
• m_height
• m_doubleSide
• m_iesData
• m_sunAngularRadius
• m_sunHaloSize
• m_sunHaloFalloff
• m_horizontal
• m_direction
• m_position

Accessors

• impl
• parentScene
• lightType
• enabled
• visible
• color
• intensity
• lightMask
• falloff
• innerCone
• outerCone
• shadowCaster
• width
• height
• doubleSide
• iesData
• sunAngularRadius
• sunHaloSize
• sunHaloFalloff
• horizontal
• direction
• position

Methods

• registerImplClass
• handleID
• updateWMat3D
• destroy
• onAddToScene
• onRemoveFromScene
• refreshLightParam
• refreshLightStatus
• markContentDirtyFromObject

Constructors

constructor

• new RoyLight3D(scene, lightType): RoyLight3D

Parameters

Name	Type
scene	RoyScene
lightType	Light3DType

Returns

RoyLight3D

Properties

cacheModelMatrix

▪ Static Protected cacheModelMatrix: Mat4

---

cacheRotateMat

▪ Static Protected cacheRotateMat: Mat4

---

cacheRotation

▪ Static Protected cacheRotation: Mat3

---

cacheDirection1

▪ Static Protected cacheDirection1: Vec3

---

cacheDirection2

▪ Static Protected cacheDirection2: Vec3

---

sTypeClass

▪ Static Protected sTypeClass: Object = {}

Index signature

▪ [key: number]: RoyLight3DImplClass

---

m_impl

• Private m_impl: RoyLight3DImpl[]

---

m_parentScene

• Private m_parentScene: RoyScene

---

s_handleID

▪ Static Private s_handleID: number = 1

---

m_handleID

• Private m_handleID: number

---

m_lightType

• Private m_lightType: Light3DType

---

m_matWorldFromLocal

• Private m_matWorldFromLocal: Mat4

---

m_enabled

• Private m_enabled: boolean = true

---

m_visible

• Private m_visible: boolean = true

---

m_color

• Private m_color: number[]

---

m_intensity

• Private m_intensity: number = 50.0

---

m_lightMask

• Private m_lightMask: number = 0xff

---

m_falloff

• Private m_falloff: number = 5.0

---

m_innerCone

• Private m_innerCone: number

---

m_outerCone

• Private m_outerCone: number

---

m_shadowCaster

• Private m_shadowCaster: boolean = true

---

m_width

• Private m_width: number = 0.5

---

m_height

• Private m_height: number = 0.5

---

m_doubleSide

• Private m_doubleSide: boolean = false

---

m_iesData

• Private m_iesData: Uint8Array

---

m_sunAngularRadius

• Private m_sunAngularRadius: number = 0.00951

---

m_sunHaloSize

• Private m_sunHaloSize: number = 10

---

m_sunHaloFalloff

• Private m_sunHaloFalloff: number = 80

---

m_horizontal

• Private m_horizontal: Vec3

---

m_direction

• Private m_direction: Vec3

---

m_position

• Private m_position: Vec3

Accessors

impl

• get impl(): RoyLight3DImpl[]

Returns

RoyLight3DImpl[]

---

parentScene

• get parentScene(): RoyScene

Returns

RoyScene

---

lightType

• get lightType(): Light3DType

Returns

Light3DType

---

enabled

• get enabled(): boolean

Returns

boolean

• set enabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

visible

• get visible(): boolean

Returns

boolean

• set visible(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

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

---

falloff

• get falloff(): number

Returns

number

• set falloff(value): void

Parameters

Name	Type
value	number

Returns

void

---

innerCone

• get innerCone(): number

Returns

number

• set innerCone(value): void

Parameters

Name	Type
value	number

Returns

void

---

outerCone

• get outerCone(): number

Returns

number

• set outerCone(value): void

Parameters

Name	Type
value	number

Returns

void

---

shadowCaster

• get shadowCaster(): boolean

Returns

boolean

• set shadowCaster(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

width

• get width(): number

Returns

number

• set width(value): void

Parameters

Name	Type
value	number

Returns

void

---

height

• get height(): number

Returns

number

• set height(value): void

Parameters

Name	Type
value	number

Returns

void

---

doubleSide

• get doubleSide(): boolean

Returns

boolean

• set doubleSide(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

iesData

• get iesData(): Uint8Array

Returns

Uint8Array

• set iesData(value): void

Parameters

Name	Type
value	Uint8Array

Returns

void

---

sunAngularRadius

• get sunAngularRadius(): number

Returns

number

• set sunAngularRadius(value): void

Parameters

Name	Type
value	number

Returns

void

---

sunHaloSize

• get sunHaloSize(): number

Returns

number

• set sunHaloSize(value): void

Parameters

Name	Type
value	number

Returns

void

---

sunHaloFalloff

• get sunHaloFalloff(): number

Returns

number

• set sunHaloFalloff(value): void

Parameters

Name	Type
value	number

Returns

void

---

horizontal

• get horizontal(): Vec3

Returns

Vec3

---

direction

• get direction(): Vec3

Returns

Vec3

---

position

• get position(): Vec3

Returns

Vec3

Methods

registerImplClass

▸ registerImplClass(type, classIns): void

Parameters

Name	Type
type	RendererType
classIns	RoyLight3DImplClass

Returns

void

---

handleID

▸ handleID(): number

Returns

number

---

updateWMat3D

▸ updateWMat3D(value): void

Parameters

Name	Type
value	Mat4

Returns

void

---

destroy

▸ destroy(): void

Returns

void

---

onAddToScene

▸ onAddToScene(): void

Returns

void

---

onRemoveFromScene

▸ onRemoveFromScene(): void

Returns

void

---

refreshLightParam

▸ refreshLightParam(): void

Returns

void

---

refreshLightStatus

▸ refreshLightStatus(): void

Returns

void

---

markContentDirtyFromObject

▸ markContentDirtyFromObject(): void

Returns

void