Class ShadowLight Abstract

有阴影能力的灯光抽象类

export
abstract
implements: {IShadowLight}

Hierarchy

Light
- ShadowLight
  - DirectLight
  - SpotLight

Implements

IShadowLight

Index

Constructors

constructor

new ShadowLight(params?: ILightConfigParams): ShadowLight

Overrides Light.constructor
- Defined in glc/dist/Light/ShadowLight.d.ts:33
Parameters
- Optional params: ILightConfigParams
Returns ShadowLight

Properties

Protected _color

_color: Color

参数

Protected _colorKey

_colorKey: string

Protected _frustum

_frustum: Frustum

Private _hasShadowChanged

_hasShadowChanged: any

Private _isFrustumDirty

_isFrustumDirty: any

Protected _isLocalMatrixDirty

_isLocalMatrixDirty: boolean

Private _isProjectionMatrixDirty

_isProjectionMatrixDirty: any

Private _isViewMatrixDirty

_isViewMatrixDirty: any

_listeners

_listeners: Map<string, TinoeEventListener[]>

Protected _localMatrix

_localMatrix: Matrix4

Protected _onKey

_onKey: string

宏设置

Protected _projectionMatrixFromLight

_projectionMatrixFromLight: Matrix4

Protected _shouldUpdateWorldMatrix

_shouldUpdateWorldMatrix: boolean

Protected _viewMatrixFromLight

_viewMatrixFromLight: Matrix4

Protected _viewProjMatrixFromLight

_viewProjMatrixFromLight: Matrix4

children

children: Object3D[]

coreData

coreData: CoreData

name

name: string

parent

parent: Object3D

position

position: Vector3

rotation

rotation: Quaternion

scale

scale: Vector3

shadowBias

shadowBias: number

Readonly type

type: LightTypeEn

up

visible

visible: boolean

worldMatrix

worldMatrix: Matrix4

Accessors

color

get color(): Color
set color(value: Color): void

Inherited from Light.color
- Defined in glc/dist/Light/Light.d.ts:39
灯光颜色

Returns Color
Inherited from Light.color
- Defined in glc/dist/Light/Light.d.ts:40
灯光颜色

Parameters
- value: Color
Returns void

frustum

get frustum(): Frustum

- Defined in glc/dist/Light/ShadowLight.d.ts:40
灯光的投影视锥

readonly
memberof
ShadowLight

Returns Frustum

hasShadowChanged

get hasShadowChanged(): boolean

- Defined in glc/dist/Light/ShadowLight.d.ts:28
Returns boolean

isOn

get isOn(): boolean
set isOn(value: boolean): void

Inherited from Light.isOn
- Defined in glc/dist/Light/Light.d.ts:26
灯光开关

Returns boolean
Inherited from Light.isOn
- Defined in glc/dist/Light/Light.d.ts:27
灯光开关

Parameters
- value: boolean
Returns void

localMatrix

get localMatrix(): Matrix4

Inherited from Light.localMatrix
- Defined in glc/dist/Object3D.d.ts:15
Returns Matrix4

projectionMatrixFromLight

get projectionMatrixFromLight(): Matrix4

Implementation of IShadowLight.projectionMatrixFromLight
- Defined in glc/dist/Light/ShadowLight.d.ts:47
返回来自灯光的投影矩阵

readonly
memberof
ShadowLight

Returns Matrix4

viewMatrixFromLight

get viewMatrixFromLight(): Matrix4

Implementation of IShadowLight.viewMatrixFromLight
- Defined in glc/dist/Light/ShadowLight.d.ts:53
返回来自灯光的视图矩阵

readonly
memberof
ShadowLight

Returns Matrix4

Methods

Protected _addChild

_addChild(c: Object3D): void

Inherited from Light._addChild
- Defined in glb/dist/node/index.d.ts:16
添加子节点

Parameters
- c: Object3D
  
  子节点
Returns void

Protected _onPositionChange

_onPositionChange(): void

Inherited from Light._onPositionChange
- Defined in glc/dist/Object3D.d.ts:21
Returns void

Protected _onRotationChange

_onRotationChange(): void

Inherited from Light._onRotationChange
- Defined in glc/dist/Object3D.d.ts:22
Returns void

Protected _onScaleChange

_onScaleChange(): void

Inherited from Light._onScaleChange
- Defined in glc/dist/Object3D.d.ts:23
Returns void

Protected _onTransformChange

_onTransformChange(): void

Inherited from Light._onTransformChange
- Defined in glc/dist/Object3D.d.ts:19
Returns void

Protected _removeChild

_removeChild(c: Object3D): void

Inherited from Light._removeChild
- Defined in glb/dist/node/index.d.ts:11
删除子节点

Parameters
- c: Object3D
  
  子节点
Returns void

Protected _tapTransformChange

_tapTransformChange(obj: ObservedInstanceType<(new (x?: number, y?: number, z?: number) => Vector3 & { elements: readonly number[]; tapChange: any }) & typeof Vector3> | ObservedInstanceType<(new (x?: number, y?: number, z?: number, w?: number) => Quaternion & { elements: readonly number[]; tapChange: any }) & typeof Quaternion>): void

Inherited from Light._tapTransformChange
- Defined in glc/dist/Object3D.d.ts:20
Parameters
- obj: ObservedInstanceType<(new (x?: number, y?: number, z?: number) => Vector3 & { elements: readonly number[]; tapChange: any }) & typeof Vector3> | ObservedInstanceType<(new (x?: number, y?: number, z?: number, w?: number) => Quaternion & { elements: readonly number[]; tapChange: any }) & typeof Quaternion>
Returns void

addChildren

addChildren(...children: Object3D[]): void

Inherited from Light.addChildren
- Defined in glb/dist/node/index.d.ts:21
添加1～n个子节点

Parameters
- Rest ...children: Object3D[]
  
  待添加节点
Returns void

addEventListener

addEventListener(type: string, handler: ((data: any) => any), once?: boolean): void

Inherited from Light.addEventListener
- Defined in glb/dist/event/EventEmitter.d.ts:28
注册handler

memberof
EventEmitter

Parameters
- type: string
- handler: ((data: any) => any)
  - - (data: any): any
    - Parameters
      - data: any
      Returns any
- Optional once: boolean
Returns void

clone

clone(): Object3D

Inherited from Light.clone
- Defined in glc/dist/Object3D.d.ts:104
克隆

memberof
Node

Returns Object3D

destroy

destroy(): void

Inherited from Light.destroy
- Defined in glc/dist/Object3D.d.ts:98
销毁 TODO: Mesh的销毁是否需要特殊处理

Returns void

disable

disable(): void

Inherited from Light.disable
- Defined in glc/dist/Object3D.d.ts:93
Returns void

dispatch

dispatch(type: any, event: TinoeEvent): void

Inherited from Light.dispatch
- Defined in glc/dist/Object3D.d.ts:105
派发事件

Parameters
- type: any
- event: TinoeEvent
Returns void

enable

enable(): void

Inherited from Light.enable
- Defined in glc/dist/Object3D.d.ts:92
Returns void

getChildByName

getChildByName(name: string, findAll?: boolean): Object3D | Node<Node<any>>[]

Inherited from Light.getChildByName
- Defined in glb/dist/node/index.d.ts:37
根据name标识查找子节点

Parameters
- name: string
  
  标识
- Optional findAll: boolean
  
  是否查找所有符合name标识的节点
Returns Object3D | Node<Node<any>>[]
查找到的节点

off

off(type?: string, handler?: ((data: any) => any)): void

Inherited from Light.off
- Defined in glb/dist/event/EventEmitter.d.ts:44
注销事件

memberof
EventEmitter

Parameters
- Optional type: string
- Optional handler: ((data: any) => any)
  - - (data: any): any
    - Parameters
      - data: any
      Returns any
Returns void
{void}

on

on(type: string, handler: ((data: any) => any), once?: boolean): void

Inherited from Light.on
- Defined in glb/dist/event/EventEmitter.d.ts:20
注册handler

memberof
EventEmitter

Parameters
- type: string
- handler: ((data: any) => any)
  - - (data: any): any
    - Parameters
      - data: any
      Returns any
- Optional once: boolean
Returns void

recoverChangeFlag

recoverChangeFlag(): void

- Defined in glc/dist/Light/ShadowLight.d.ts:61
Returns void

removeChildren

removeChildren(...children: Object3D[]): void

Inherited from Light.removeChildren
- Defined in glb/dist/node/index.d.ts:26
删除1～n个字节点

Parameters
- Rest ...children: Object3D[]
  
  待删除节点
Returns void

removeEventListener

removeEventListener(type?: string, handler?: ((data: any) => any), once?: boolean): void

Inherited from Light.removeEventListener
- Defined in glb/dist/event/EventEmitter.d.ts:36
注销handler

memberof
EventEmitter

Parameters
- Optional type: string
- Optional handler: ((data: any) => any)
  - - (data: any): any
    - Parameters
      - data: any
      Returns any
- Optional once: boolean
Returns void

removeFromParent

removeFromParent(): void

Inherited from Light.removeFromParent
- Defined in glb/dist/node/index.d.ts:30
从父节点中删除自己

Returns void

rotate

rotate(axis: Vector3, degrees: number): void

Inherited from Light.rotate
- Defined in glc/dist/Object3D.d.ts:70
旋转

Parameters
- axis: Vector3
  
  旋转中心轴
- degrees: number
  
  旋转角度
Returns void

rotateX

rotateX(degrees: number): void

Inherited from Light.rotateX
- Defined in glc/dist/Object3D.d.ts:75
沿x轴旋转

Parameters
- degrees: number
  
  旋转角度
Returns void

rotateY

rotateY(degrees: number): void

Inherited from Light.rotateY
- Defined in glc/dist/Object3D.d.ts:80
沿y轴旋转

Parameters
- degrees: number
  
  旋转角度
Returns void

rotateZ

rotateZ(degrees: number): void

Inherited from Light.rotateZ
- Defined in glc/dist/Object3D.d.ts:85
沿z轴旋转

Parameters
- degrees: number
  
  旋转角度
Returns void

scaleX

scaleX(factor: number): void

Inherited from Light.scaleX
- Defined in glc/dist/Object3D.d.ts:54
沿x轴方向缩放

Parameters
- factor: number
  
  缩放因子
Returns void

scaleY

scaleY(factor: number): void

Inherited from Light.scaleY
- Defined in glc/dist/Object3D.d.ts:59
沿y轴方向缩放

Parameters
- factor: number
  
  缩放因子
Returns void

scaleZ

scaleZ(factor: number): void

Inherited from Light.scaleZ
- Defined in glc/dist/Object3D.d.ts:64
沿z轴方向缩放

Parameters
- factor: number
  
  缩放因子
Returns void

scaling

scaling(x: number, y: number, z: number): void

Inherited from Light.scaling
- Defined in glc/dist/Object3D.d.ts:49
缩放

Parameters
- x: number
- y: number
- z: number
Returns void

translate

translate(x: number, y: number, z: number): void

Inherited from Light.translate
- Defined in glc/dist/Object3D.d.ts:29
平移

Parameters
- x: number
- y: number
- z: number
Returns void

translateX

translateX(shift: number): void

Inherited from Light.translateX
- Defined in glc/dist/Object3D.d.ts:34
沿x轴方向平移

Parameters
- shift: number
  
  平移量
Returns void

translateY

translateY(shift: number): void

Inherited from Light.translateY
- Defined in glc/dist/Object3D.d.ts:39
沿y轴方向平移

Parameters
- shift: number
  
  平移量
Returns void

translateZ

translateZ(shift: number): void

Inherited from Light.translateZ
- Defined in glc/dist/Object3D.d.ts:44
沿z轴方向平移

Parameters
- shift: number
  
  平移量
Returns void

traverse

traverse(callback: ((n: Object3D) => void), isIncludingSelf?: boolean): void

Inherited from Light.traverse
- Defined in glb/dist/node/index.d.ts:43
遍历节点

Parameters
- callback: ((n: Object3D) => void)
  
  回调函数
  - - (n: Object3D): void
    - Parameters
      - n: Object3D
      Returns void
- Optional isIncludingSelf: boolean
  
  自己是否执行回调函数，默认为true
Returns void

turnOff

turnOff(): void

Inherited from Light.turnOff
- Defined in glc/dist/Light/Light.d.ts:35
关闭灯光

Returns void

turnOn

turnOn(): void

Inherited from Light.turnOn
- Defined in glc/dist/Light/Light.d.ts:31
打开灯光

Returns void

updateWorldMatrix

updateWorldMatrix(updateChildren?: boolean, isParentDirty?: boolean): boolean

Overrides Light.updateWorldMatrix
- Defined in glc/dist/Light/ShadowLight.d.ts:60
更新世界矩阵

memberof
ShadowLight

Parameters
- Optional updateChildren: boolean
  
  是否更新后代节点
- Optional isParentDirty: boolean
  
  是否父节点有变更
Returns boolean

Generated using TypeDoc