Class CSM

级联阴影脚本组件

Export

Date

2025.10.23

Author

lyx

Hierarchy

Script
- CSM

Constructors

constructor

new CSM(entity, parameters?): CSM
Parameters
- entity: Entity
- parameters: CSMParameters = {}
Returns CSM

Overrides Script.constructor

Properties

`Protected` _engine

_engine: Engine

`Protected` _entity

_entity: Entity

`Protected` _started

_started: boolean

`Readonly` isScript

isScript: boolean

脚本组件标识

Memberof

Script

userData

userData: {
[key: string]: any;
}

用户数据

Type declaration

[key: string]: any

Memberof

Component

Accessors

enabled

get enabled(): boolean
获取组件是否启用

Returns boolean

Memberof
Component

Inherited from Script.enabled
set enabled(value): void
启用或禁用组件
Parameters
- value: boolean
Returns void

Memberof
Component

Inherited from Script.enabled

engine

get engine(): Engine
获取引擎对象

Returns Engine

Memberof
EngineObject

Inherited from Script.engine

entity

get entity(): Entity
获取组件所属实体

Returns Entity

Memberof
Component

Inherited from Script.entity

fade

set fade(value): void
设置阴影是否开启淡出效果
Parameters
- value: boolean
Returns void

Memberof
CSM

lightColor

set lightColor(value): void
设置产生阴影的方向光颜色
Parameters
- value: ColorRepresentation
Returns void

Memberof
CSM

lightDirection

set lightDirection(value): void
设置产生阴影的方向光方向（归一化）
Parameters
- value: number[] | Vector3
Returns void

Memberof
CSM

lightFar

set lightFar(value): void
设置方向光阴影相机远裁剪面距离
Parameters
- value: number
Returns void

Memberof
CSM

lightIntensity

set lightIntensity(value): void
设置产生阴影的方向光强度
Parameters
- value: number
Returns void

Memberof
CSM

lightMargin

set lightMargin(value): void
设置级联阴影锥的边距
Parameters
- value: number
Returns void

Memberof
CSM

lightNear

set lightNear(value): void
设置方向光阴影相机近裁剪面距离
Parameters
- value: number
Returns void

Memberof
CSM

maxFar

set maxFar(value): void
设置阴影阴影最远可视距离
Parameters
- value: number
Returns void

Memberof
CSM

mode

set mode(value): void
设置级联视锥体分割模式
Parameters
- value: "custom" | "practical" | "uniform" | "logarithmic"
Returns void

Memberof
CSM

shadowBias

set shadowBias(value): void
设置阴影深度偏移
Parameters
- value: number
Returns void

Memberof
CSM

started

get started(): boolean
获取脚本是否已启用

Returns boolean

Memberof
Script

Inherited from Script.started

Methods

`Protected` _onAwake

_onAwake(): void
Protected
唤醒脚本

Returns void

Memberof
Script

Inherited from Script._onAwake

`Protected` _onDestroy

_onDestroy(): void
Protected
销毁脚本

Returns void

Memberof
Script

Inherited from Script._onDestroy

`Protected` _onDisable

_onDisable(): void
Protected
禁用脚本

Returns void

Memberof
Script

Inherited from Script._onDisable

`Protected` _onEnable

_onEnable(): void
Protected
启用脚本

Returns void

Memberof
Script

Inherited from Script._onEnable

addEventListener

addEventListener(type, callback, parameters?): number
添加事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- callback: ((event) => void)
  
  事件监听回调
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
- Optional parameters: {
  priority?: Priority;
  target?: any;
  }
  
  事件参数
  - Optional priority?: Priority
  - Optional target?: any
Returns number

Memberof
EventDispatcher

Inherited from Script.addEventListener

destroy

destroy(): void
销毁组件

Returns void

Memberof
Component

Inherited from Script.destroy

dispatchEvent

dispatchEvent(event): void
分发事件
Parameters
- event: {
  type: string;
  [key: string]: any;
  }
  - [key: string]: any
  - type: string
Returns void

Memberof
EventDispatcher

Inherited from Script.dispatchEvent

dispose

dispose(): void
释放接口

Returns void

Memberof
EventDispatcher

Inherited from Script.dispose

onAwake

onAwake(): void
脚本唤醒回调（首次启用脚本时调用且只会被调用一次）

Returns void

Memberof
Script

Inherited from Script.onAwake

onCameraChanged

onCameraChanged(event): void
‘camerachanged’事件回调
Parameters
- event: any
Returns void

Memberof
Script

Inherited from Script.onCameraChanged

onClick

onClick(event): void
‘click’事件回调
Parameters
- event: MouseEvent
Returns void

Memberof
Script

Inherited from Script.onClick

onCollisionEnter

onCollisionEnter(collision): void
进入碰撞器响应
Parameters
- collision: Collision
  
  碰撞信息
Returns void

Memberof
Script

Inherited from Script.onCollisionEnter

onCollisionExit

onCollisionExit(collision): void
离开碰撞器响应
Parameters
- collision: Collision
  
  碰撞信息
Returns void

Memberof
Script

Inherited from Script.onCollisionExit

onCollisionStay

onCollisionStay(collision): void
逗留在碰撞器中响应
Parameters
- collision: Collision
  
  碰撞信息
Returns void

Memberof
Script

Inherited from Script.onCollisionStay

onDblClick

onDblClick(event): void
‘dblclick’事件回调
Parameters
- event: MouseEvent
Returns void

Memberof
Script

Inherited from Script.onDblClick

onDisable

onDisable(): void
禁用回调

Returns void

Memberof
CSM

Overrides Script.onDisable

onEnable

onEnable(): void
启用回调

Returns void

Memberof
CSM

Overrides Script.onEnable

onKeyDown

onKeyDown(event): void
‘keydown’事件回调
Parameters
- event: KeyboardEvent
Returns void

Memberof
Script

Inherited from Script.onKeyDown

onKeyUp

onKeyUp(event): void
‘keyup’事件回调
Parameters
- event: KeyboardEvent
Returns void

Memberof
Script

Inherited from Script.onKeyUp

onLateUpdate

onLateUpdate(timeSinceLastFrame, totalTime): void
帧更新
Parameters
- timeSinceLastFrame: number
- totalTime: number
Returns void

Memberof
CSM

Overrides Script.onLateUpdate

onPhysicsUpdate

onPhysicsUpdate(): void
物理更新回调，每一帧可以调用多次

Returns void

Memberof
Script

Inherited from Script.onPhysicsUpdate

onPointerCancel

onPointerCancel(event): void
‘pointercancel’事件回调
Parameters
- event: PointerEvent
Returns void

Memberof
Script

Inherited from Script.onPointerCancel

onPointerDown

onPointerDown(event): void
‘pointerdown’事件回调
Parameters
- event: PointerEvent
Returns void

Memberof
Script

Inherited from Script.onPointerDown

onPointerMove

onPointerMove(event): void
‘pointermove’事件回调
Parameters
- event: PointerEvent
Returns void

Memberof
Script

Inherited from Script.onPointerMove

onPointerUp

onPointerUp(event): void
‘pointerup’事件回调
Parameters
- event: PointerEvent
Returns void

Memberof
Script

Inherited from Script.onPointerUp

onResize

onResize(event): void
‘resize’事件回调
Parameters
- event: any
Returns void

Memberof
Script

Inherited from Script.onResize

onStart

onStart(): void
脚本开始执行回调（在首次帧循环时调用且只会被调用一次）

Returns void

Memberof
Script

Inherited from Script.onStart

onTriggerEnter

onTriggerEnter(collision): void
进入触发器响应
Parameters
- collision: Collision
  
  碰撞信息
Returns void

Memberof
Script

Inherited from Script.onTriggerEnter

onTriggerExit

onTriggerExit(collision): void
离开触发器响应
Parameters
- collision: Collision
  
  碰撞信息
Returns void

Memberof
Script

Inherited from Script.onTriggerExit

onTriggerStay

onTriggerStay(collision): void
逗留在触发器中响应
Parameters
- collision: Collision
  
  碰撞信息
Returns void

Memberof
Script

Inherited from Script.onTriggerStay

onUpdate

onUpdate(timeSinceLastFrame, totalTime): void
脚本更新回调（逐帧调用）
Parameters
- timeSinceLastFrame: number
  
  距离上一帧更新的时长（单位：毫秒）
- totalTime: number
  
  总时长 (单位：毫秒)
Returns void

Memberof
Script

Inherited from Script.onUpdate

onWheel

onWheel(event): void
‘wheel’事件回调
Parameters
- event: WheelEvent
Returns void

Memberof
Script

Inherited from Script.onWheel

postRenderDepth

postRenderDepth(event): void
‘postrenderdepth’事件回调
Parameters
- event: any
Returns void

Memberof
Script

Inherited from Script.postRenderDepth

preRenderDepth

preRenderDepth(event): void
‘prerenderdepth’事件回调
Parameters
- event: any
Returns void

Memberof
Script

Inherited from Script.preRenderDepth

removeAllEventListeners

removeAllEventListeners(): void
移除所有事件监听器

Returns void

Memberof
EventDispatcher

Inherited from Script.removeAllEventListeners

removeEventListener

removeEventListener(type, callback?): void
移除事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- Optional callback: ((event) => void)
  
  事件监听回调（可选，不设置则表示移除所有监听器）
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
Returns void

Memberof
EventDispatcher

Inherited from Script.removeEventListener

removeEventListenerByEventId

removeEventListenerByEventId(eventID): void
通过事件Id移除事件监听器
Parameters
- eventID: number
Returns void

Memberof
EventDispatcher

Inherited from Script.removeEventListenerByEventId

setActive

setActive(value): void
激活或冻结组件
Parameters
- value: boolean
Returns void

Memberof
Component

Inherited from Script.setActive

setupMaterial

setupMaterial(material): void
修改材质注入CSM阴影相关Shader
Parameters
- material: Material
  
  材质对象
Returns void

Memberof
CSM
setupMaterial(renderable): void
修改材质注入CSM阴影相关Shader，从渲染组件根节点开始递归遍历修改所有满足条件的材质
Parameters
- renderable: Renderable
  
  渲染组件
Returns void

Memberof
CSM
setupMaterial(entity): void
修改材质注入CSM阴影相关Shader，从实体根节点开始递归遍历修改所有满足条件的材质
Parameters
- entity: Entity
  
  实体对象
Returns void

Memberof
CSM

updateProperties

updateProperties(parameters): Promise<void>
批量更新组件属性
Parameters
- parameters: {
  [key: string]: any;
  }
  - [key: string]: any
Returns Promise<void>

Memberof
Component

Inherited from Script.updateProperties