类 Occluder2DAgent

遮光器代理

索引

构造函数

方法

addOccluder clearOccluder getOccluder removeOccluder setPos setRot setScale

构造函数

constructor

new Occluder2DAgent(manager: Light2DManager): Occluder2DAgent
参数
- manager: Light2DManager
返回 Occluder2DAgent
- 定义于 src/layaAir/laya/Light2D/Occluder2DAgent.ts:25

方法

addOccluder

addOccluder(index: number, param: Occluder2DParam): LightOccluder2DCore
参数
- index: number
  Unique index
- param: Occluder2DParam
  Shader parameter object
返回 LightOccluder2DCore
Occluder Object

En
Create a occluder

Zh
创建遮光器
- 定义于 src/layaAir/laya/Light2D/Occluder2DAgent.ts:39

clearOccluder

clearOccluder(): void
返回 void
En
Clear all occluders

Zh
清除所有遮光器
- 定义于 src/layaAir/laya/Light2D/Occluder2DAgent.ts:154

getOccluder

getOccluder(index: number): LightOccluder2DCore
参数
- index: number
  Unique index
返回 LightOccluder2DCore
Occluder object (successful), undefined (failed)

Zh
Get the occluder object

Zh
获取遮光器
- 定义于 src/layaAir/laya/Light2D/Occluder2DAgent.ts:76

removeOccluder

removeOccluder(index: number): boolean
参数
- index: number
  Unique index
返回 boolean
true (successful), false(failed)

En
Remove the occluder

Zh
删除指定遮光器
- 定义于 src/layaAir/laya/Light2D/Occluder2DAgent.ts:143

setPos

setPos(index: number, x: number, y: number): LightOccluder2DCore
参数
- index: number
  Unique index
- x: number
  X Coordinate value
- y: number
  Y Coordinate value
返回 LightOccluder2DCore
Occluder object (successful), undefined (failed)

En
Set the occluder position

Zh
设置遮光器位置
- 定义于 src/layaAir/laya/Light2D/Occluder2DAgent.ts:92

setRot

setRot(index: number, rot: number): LightOccluder2DCore
参数
- index: number
  Unique index
- rot: number
  Rotation angle
返回 LightOccluder2DCore
Occluder object (successful), undefined (failed)

En
Set the occluder rotation

Zh
设置遮光器旋转
- 定义于 src/layaAir/laya/Light2D/Occluder2DAgent.ts:109

setScale

setScale(index: number, x: number, y: number): LightOccluder2DCore
参数
- index: number
  Unique index
- x: number
  X scale value
- y: number
  Y scale value
返回 LightOccluder2DCore
Occluder object (successful), undefined (failed)

En
Set the occluder scale

Zh
设置遮光器放缩
- 定义于 src/layaAir/laya/Light2D/Occluder2DAgent.ts:128