如何开发一个工具

Tool是引擎提供的工具基类，这个类提供了丰富的输入事件函数以及工具状态函数，所有的自定义工具都需要继承自这个类。

创建一个自定义工具

🌏 必须重载的方法

名称	类型	描述
active	public	激活工具
deactivate	public	冻结工具

🌏 可选择重载的方法

名称	类型	描述
onPointerDown	public	鼠标按下输入事件
onPointerUp	public	鼠标抬起输入事件
onPointerMove	public	鼠标移动输入事件
onPointerCancel	public	指针取消事件
onClick	public	鼠标点击输入事件
onDblClick	public	鼠标双击输入事件
onWheel	public	滚轮输入事件
onKeyDown	public	键盘输入按下事件
onKeyUp	public	键盘输入抬起事件

下面的代码展示了如何扩展一个工具并使用。首先，我们定义一个“测量”工具类：

import {

    Engine,
    Tool

} from '@tx3d/core';

/**
 * 测量工具
 */
class MeasureTool extends Tool {

    //#region Fields

    // 单点延迟触发
    private _clickTimeId: NodeJS.Timeout;

    // 结果回调
    private onCompleted: any;

    constructor( engine: Engine ) {

        super( engine );

        // 单击延迟触发
		this._clickTimeId = null;

    }

    //#endregion

    //#region  public functions

    /**
     * 激活工具
     *
     * @param {MeasureToolParameters} parameters
     */
    active( parameters: MeasureToolParameters = {} ): void {

        // 激活工具，初始化工具逻辑

    }

    /**
     * 停用工具
     */
    deactivate(): void {
        
        // 释放工具中引用资源等...

    }

    /**
     * 响应‘click’事件
     *
     * @param {PointerEvent} event
     */
    onClick( event: MouseEvent ): void {

		// 取消上次延时未执行的方法
		clearTimeout( this._clickTimeId );

        // 延时执行
		this._clickTimeId = setTimeout( () => {

           // 鼠标单击事件触发后的逻辑， 在此处写，延时执行是因为规避three.js中难以区分双击和单击事件

		}, 250 );

    }

    /**
     * 响应dblclick事件
     *
     * @param {MouseEvent} event
     */
    onDblClick( event: MouseEvent ): void {

        // 鼠标双击输入事件

		// 取消上次延时未执行的方法
		clearTimeout( this._clickTimeId );

    }

    /**
     * 响应‘pointerup’事件
     *
     * @param {PointerEvent} event
     */
    onPointerUp( event: PointerEvent ): void {

        // 鼠标输入抬起事件

    }

    /**
     * 响应‘pointermove’事件
     *
     * @param {PointerEvent} event
     */
    onPointerMove( event: PointerEvent ): void {

       // 鼠标移动时逻辑

    }

    /**
     * 响应‘keydown’事件
     *
     * @param {KeyboardEvent} event
     */
    onKeyDown( event: KeyboardEvent ): void {

        // 键盘输入按下事件

    }

    /**
     * 响应‘keyup’事件
     *
     * @param {KeyboardEvent} event
     */
    onKeyUp( event: KeyboardEvent ): void {

        // 键盘输入抬起事件

    }

    //#endregion

}