Class ToolManager

工具管理器

Export

Date

2022.6.1

Author

lyx

Hierarchy

Constructors

constructor

Properties

_engine

Accessors

activatedTool engine

Methods

activateTool addEventListener addTool deactivateTool dispatchEvent dispose getTool removeAllEventListeners removeEventListener removeEventListenerByEventId removeTool

Constructors

constructor

Properties

Protected _engine

_engine: Engine

Accessors

activatedTool

  • get activatedTool(): Tool

  • 获取当前激活的工具

    Returns Tool

    Memberof

    ToolManager

engine

  • get engine(): Engine

  • 获取引擎对象

    Returns Engine

    Memberof

    EngineObject

Methods

activateTool

  • 激活指定类型工具

    Type Parameters

    Parameters

    • type: (new (engine, parameters) => T)
        • new (engine, parameters): T

        • Parameters

          • engine: Engine
          • parameters: any

          Returns T

    • parameters: any

    Returns void

    Memberof

    ToolManager

addEventListener

  • 添加事件监听器

    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

addTool

  • 添加工具

    Type Parameters

    Parameters

    • type: (new (engine, parameters) => T)
        • new (engine, parameters): T

        • Parameters

          • engine: Engine
          • parameters: any

          Returns T

    • Optional parameters: any

    Returns T

    Memberof

    ToolManager

deactivateTool

  • 停用当前激活的工具

    Returns void

    Memberof

    ToolManager

dispatchEvent

  • 分发事件

    Parameters

    • event: {
          type: string;
          [key: string]: any;
      }
      • [key: string]: any
      • type: string

    Returns void

    Memberof

    EventDispatcher

dispose

getTool

  • 获取指定类型工具

    Type Parameters

    Parameters

    • type: (new (engine, parameters) => T)
        • new (engine, parameters): T

        • Parameters

          • engine: Engine
          • parameters: any

          Returns T

    Returns T

    Memberof

    ToolManager

removeAllEventListeners

removeEventListener

  • 移除事件监听器

    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

removeEventListenerByEventId

  • 通过事件Id移除事件监听器

    Parameters

    • eventID: number

    Returns void

    Memberof

    EventDispatcher

removeTool

  • 移除工具

    Type Parameters

    Parameters

    • type: (new (engine, parameters) => T)
        • new (engine, parameters): T

        • Parameters

          • engine: Engine
          • parameters: any

          Returns T

    Returns void

    Memberof

    ToolManager

Settings

Member Visibility

Theme

On This Page