1. 事件分配器
位于:BOS3D.EventDispatcher
1.1. 方法
1.1.1. apply
为给定的对象添加事件调度器
名称 | 说明 | 类型 | 是否必须 | 示例 |
---|---|---|---|---|
object | 要添加事件调度器的对象 | 对象 object | 是 | {a:0,b:1} |
调用方式:
/**
* 为给定的对象添加 事件调度器
* @function apply
* @param {object} object 要添加事件调度器的对象
*/
var object = { a: 0, b: 1 };
BOS3D.EventDispatcher.apply(object);
1.1.2. addEventListener
添加一个事件监听
名称 | 说明 | 类型 | 是否必须 | 示例 |
---|---|---|---|---|
type | 监听的类型 | 字符串 string | 是 | BOS3D.EVENTS.ON_CLICK_PICK |
listener | 监听的回调 | 方法 function | 是 | function(){} |
调用方式:
/**
* 添加一个事件监听.
* @function addEventListener
* @param {(string | type)} type 监听的类型
* @param {function} listener 监听的回调
*/
BOS3D.EventDispatcher.addEventListener(BOS3D.EVENTS.ON_CLICK_PICK, function () {});
object.addEventListener(BOS3D.EVENTS.ON_CLICK_PICK, function () {});
1.1.3. removeEventListener
移除一个事件监听
名称 | 说明 | 类型 | 是否必须 | 示例 |
---|---|---|---|---|
type | 监听的类型 | 字符串 string | 是 | BOS3D.EVENTS.ON_CLICK_PICK |
listener | 监听的回调 | 方法 function | 是 | function(){} |
调用方式:
/**
* 移除一个事件监听.
* @function removeEventListener
* @param {(string | type)} type 监听的类型
* @param {function} listener 监听的回调
*/
BOS3D.EventDispatcher.removeEventListener(BOS3D.EVENTS.ON_CLICK_PICK, function () {});
object.removeEventListener(BOS3D.EVENTS.ON_CLICK_PICK, function () {});
1.1.4. removeAllEventListener
移除所有事件监听
名称 | 说明 | 类型 | 是否必须 | 示例 |
---|---|---|---|---|
无 | null | null | null | null |
调用方式:
/**
* 移除一个事件监听.
* @function removeAllEventListener
*/
BOS3D.EventDispatcher.removeAllEventListener();
object.removeAllEventListener();
1.1.5. hasEventListener
判断一个监听是否存在,如果指定的监听器已经存在,则返回 true,否则将返回 false。
名称 | 说明 | 类型 | 是否必须 | 示例 |
---|---|---|---|---|
type | 监听的类型 | 字符串 string | 是 | BOS3D.EVENTS.ON_CLICK_PICK |
listener | 监听的回调 | 方法 function | 是 | function(){} |
调用方式:
/**
* 判断一个监听是否存在,如果指定的监听器已经存在,则返回true,否则将返回false。
* @function hasEventListener
* @param {(string)} type 监听的类型
* @param {function} listener 监听的回调
*/
BOS3D.EventDispatcher.hasEventListener(BOS3D.EVENTS.ON_CLICK_PICK, function () {});
object.hasEventListener(BOS3D.EVENTS.ON_CLICK_PICK, function () {});
1.1.6. dispatchEvent
该方法用来触发事件。
名称 | 说明 | 类型 | 是否必须 | 示例 |
---|---|---|---|---|
event | 事件类型或事件对象 | 字符串 string 或 对象 obkect | 是 | BOS3D.EVENTS.ON_CLICK_PICK 或者 {type:BOS3D.EVENTS.ON_CLICK_PICK,add:{} |
调用方式:
/**
* 该方法用来触发事件
* @function dispatchEvent
* @param {(string | type)} event 事件类型
*/
BOS3D.EventDispatcher.dispatchEvent(BOS3D.EVENTS.ON_CLICK_PICK);
BOS3D.EventDispatcher.dispatchEvent({ type: BOS3D.EVENTS.ON_CLICK_PICK, add: {} });
object.dispatchEvent({ type: BOS3D.EVENTS.ON_CLICK_PICK, add: {} });