KBE3D / KBCore / effects / BaseEffect

抽象 类: BaseEffect

基础特效抽象类（所有特效类的基类） - 请勿实例化该类

继承

• BaseClass

继承于

• FogEffect
• RainEffect
• SnowEffect
• SnowCoverEffect
• LightningEffect

属性

options

options: BaseEffectOptions

BaseEffect构造参数

---

originOptions

readonly originOptions: any

原始构造参数备份

继承自

BaseClass.originOptions

---

uuid

readonly uuid: string

实例的唯一ID

继承自

BaseClass.uuid

---

_earth?

optional _earth: Earth

当前Earth管理类实例

方法

setEnable()

setEnable(val: boolean): void

设置启用状态

参数

val

boolean

返回

void

---

addTo()

addTo(earth: Earth): void

添加到地球上，同earth.addEffect

参数

earth

Earth

Earth实例

返回

void

---

removeTo()

removeTo(isDestroy?: boolean): void

移除特效，同earth.removeEffect

参数

isDestroy?

boolean = false

是否destroy销毁释放对象，默认值：false

返回

void

---

addedPromise()

addedPromise<T>(): Promise<T>

判断是否已经完成加载并添加到地球上

类型参数

T

T extends BaseEffect = BaseEffect

返回

Promise<T>

返回一个Promise<BaseEffect>，BaseEffect为泛型，可自行指定

---

destroy()

destroy(): void

销毁释放对象

返回

void

重写了

BaseClass.destroy

方法: 事件相关

on()

on(types: string | Record<any, any> | string[] | Record<EventTypeValue, any> | EventTypeValue[], fn: Function, context?: any): BaseEffect

绑定指定类型事件监听器，支持在监听中调用 event.stopPropagation() 组织事件冒泡

参数

types

事件类型

string | Record<any, any> | string[] | Record<EventTypeValue, any> | EventTypeValue[]

fn

Function

绑定的监听器回调方法

context?

any

侦听器的上下文(this关键字将指向的对象)。

返回

BaseEffect

当前对象本身，可以链式调用

继承自

BaseClass.on

---

off()

off(types: string | Record<any, any> | string[] | Record<EventTypeValue, any> | EventTypeValue[], fn: Function, context?: any): BaseEffect

解除绑定指定类型事件监听器

参数

types

事件类型,未传值时解绑所有事件

string | Record<any, any> | string[] | Record<EventTypeValue, any> | EventTypeValue[]

fn

Function

绑定的监听器回调方法,未传值时解绑所有指定类型对应事件

context?

any

侦听器的上下文(this关键字将指向的对象)。

返回

BaseEffect

当前对象本身,可以链式调用

继承自

BaseClass.off

---

emit()

emit(type: string, data?: any, propagate?: boolean): BaseEffect

触发指定类型的事件。

参数

type

string

事件类型

data?

any

传输的数据或对象，可在事件回调方法中event对象中获取进行使用

propagate?

boolean

将事件传播给父类 (用addEventParent设置)

返回

BaseEffect

当前对象本身,可以链式调用

继承自

BaseClass.emit

---

once()

once(types: string | Record<any, any> | string[] | Record<EventTypeValue, any> | EventTypeValue[], fn: Function, context?: any): BaseEffect

绑定一次性执行的指定类型事件监听器，与on类似，监听器只会被触发一次，然后被删除

参数

types

事件类型

string | Record<any, any> | string[] | Record<EventTypeValue, any> | EventTypeValue[]

fn

Function

绑定的监听器回调方法

context?

any

侦听器的上下文(this关键字将指向的对象)

返回

BaseEffect

当前对象本身,可以链式调用

继承自

BaseClass.once

---

hasListener()

hasListener(type: string, propagate?: boolean): boolean

是否有绑定指定的事件

参数

type

string

事件类型

propagate?

boolean

是否判断指定的父类 (用addEventParent设置的)

返回

boolean

是否存在

继承自

BaseClass.hasListener

---

addEventParent()

addEventParent(obj: BaseClass): BaseEffect

添加抛出事件到父类，它将接收传播的事件

参数

obj

BaseClass

父类对象

返回

BaseEffect

当前对象本身,可以链式调用

继承自

BaseClass.addEventParent

---

removeEventParent()

removeEventParent(obj: BaseClass): BaseEffect

移除抛出事件到父类

参数

obj

BaseClass

父类对象

返回

BaseEffect

当前对象本身,可以链式调用

继承自

BaseClass.removeEventParent

---

hasEventParent()

hasEventParent(obj: BaseClass): boolean

是否绑定了抛出事件到指定父类

参数

obj

BaseClass

父类对象

返回

boolean

当前对象本身,可以链式调用

继承自

BaseClass.hasEventParent

构造函数

构造函数

new BaseEffect(options?: BaseEffectOptions): BaseEffect

参数

options?

BaseEffectOptions = {}

基础特效类构造参数

返回

BaseEffect

重写了

BaseClass.constructor

访问器

target

Getter 签名

get target(): PostProcessStage | undefined

特效内部的Cesium.PostProcessStage实例

返回

PostProcessStage | undefined

---

earth

Getter 签名

get earth(): Earth | undefined

获取特效所属的earth实例 @@readonly

返回

Earth | undefined

---

viewer

Getter 签名

get viewer(): Viewer | undefined

获取Cesium.Viewer实例 @@readonly

返回

Viewer | undefined

---

type

Getter 签名

get type(): "fog" | "rain" | "snow" | "snowCover" | "lightning"

特效类型

返回

"fog" | "rain" | "snow" | "snowCover" | "lightning"

---

state

Getter 签名

get state(): StateValue

当前对象的状态

返回

StateValue

---

enable

Getter 签名

get enable(): boolean

获取启用状态

返回

boolean

Setter 签名

set enable(val: boolean): void

设置启用状态

参数

val

boolean

返回

void