ice-render 0.0.36 → 0.0.39

package/dist/types/control-panel/transform-controls/TransformControlPanel.d.ts

@@ -41,9 +41,27 @@ export default class TransformControlPanel extends ICEControlPanel {
     protected initEvents(): void;
     enable(): void;
     disable(): void;
-    protected setControlPositions(): void;
+    /**
+     * @overwrite
+     * @method keyboardEvtHandler 键盘事件处理
+     * !ICEControlPanel 的 zIndex 总是大于其它组件，当 ICEControlPanel 显示时，总是会优先判定为被选中的组件，会导致对应的 _targetComponent 收不到鼠标和键盘事件，所以 ICEControlPanel 的实现类需要自己考虑是否需要进行事件转发。
+     * !如果当前的 targetComponent 不为空，转发键盘事件。
+     * @see {ICEControlPanel}
+     * @see {ICEComponent}
+     * @param evt
+     * @returns
+     */
+    protected keyboardEvtHandler(evt: any): void;
     private rotateEvtHandler;
     private resizeEvtHandler;
+    /**
+     * @overwrite
+     * @method updateControlPositions 更新内部控制手柄的位置
+     *
+     * 控制面板每次重绘时，会在 doRender() 方法内部会调用 updateControlPositions() 来 更新控制手柄的位置。
+     * @see ICEConrolPanel.doRender()
+     */
+    protected updateControlPositions(): void;
     protected updatePanel(): void;
     set targetComponent(component: ICEComponent);
     get targetComponent(): ICEComponent;

package/dist/types/event/{DOMEventBridge.d.ts → DOMEventDispatcher.d.ts}

@@ -1,12 +1,14 @@
 import ICE from '../ICE';
 /**
- * @class DOMEventBridge
+ * @class DOMEventDispatcher
  *
- * 事件桥接器，把原生 DOM 事件转发给 canvas 内部的组件。
+ * - DOM 事件转发器，监听事件总线上的事件，转发给 canvas 内部指定的组件。
+ * - 原生的鼠标和键盘事件都通过此工具类进行转发。
  *
+ * @see {DOMEventInterceptor}
  * @author 大漠穷秋<damoqiongqiu@126.com>
  */
-declare class DOMEventBridge {
+declare class DOMEventDispatcher {
     private selectionCandidates;
     private ice;
     private _stopped;
@@ -24,4 +26,4 @@ declare class DOMEventBridge {
      */
     private findTargetComponent;
 }
-export default DOMEventBridge;
+export default DOMEventDispatcher;

package/dist/types/event/{MouseEventInterceptor.d.ts → DOMEventInterceptor.d.ts}

@@ -1,5 +1,5 @@
-export default MouseEventInterceptor;
-declare namespace MouseEventInterceptor {
+export default DOMEventInterceptor;
+declare namespace DOMEventInterceptor {
     const evtBuses: any[];
     function start(): void;
     function regitserEvtBus(evtBus: any): void;

package/dist/types/graphic/ICEComponent.d.ts

@@ -73,9 +73,25 @@ declare abstract class ICEComponent extends ICEEventTarget {
     state: any;
     constructor(props?: any);
     /**
-     * 子类需要提供自己的实现。
+     * @method initEvents 注册事件
+     *
+     * 子类可以提供自己的实现，也可以把此方法覆盖成空函数。
+     *
+     * @see {ICEComponent.keyboardEvtHandler}
      */
     protected initEvents(): void;
+    /**
+     * @method keyboardEvtHandler 默认键盘事件处理
+     *
+     * - ICE 中的所有组件默认都可以接收键盘事件，子类可以覆盖此方法提供自己的实现。
+     * - 子类如果不需要响应键盘事件，可以覆盖一个空实现，或者在构造完成之后删掉对键盘事件的监听。
+     *
+     * !注意，这里只支持标准写法，不再兼容历史的 charCode 和 keyCode 写法。
+     * !W3C 标准按键值定义 https://www.w3.org/TR/uievents-key/#key-attribute-value
+     * @param evt
+     * @returns
+     */
+    protected keyboardEvtHandler(evt: any): void;
     /**
      * !Important: 核心方法，FrameManager 会调度此方法进行实际的渲染操作。
      * !Important: 这些方法调用有顺序
@@ -226,6 +242,7 @@ declare abstract class ICEComponent extends ICEEventTarget {
      * - FIXME:立即停止组件上的所有动画效果
      * - 需要清理绑定的事件
      * - 带有子节点的组件需要先销毁子节点，然后再销毁自身。
+     * - 子类需要覆盖此方法，释放自己占有的资源。
      */
     destory(): void;
 }

package/dist/types/graphic/link/ICELinkHook.d.ts

@@ -15,6 +15,15 @@ import ICECircle from '../shape/ICECircle';
 export default class ICELinkHook extends ICECircle {
     constructor(props?: any);
     protected initEvents(): void;
+    /**
+     * @overwrite
+     * @method keyboardEvtHandler 键盘事件处理
+     * !ICELinkHook 不响应键盘事件。
+     * @see {ICEComponent.keyboardEvtHandler}
+     * @param evt
+     * @returns
+     */
+    protected keyboardEvtHandler(evt: any): void;
     /**
      *
      * 在 mousedown 事件处理器里面可以直接访问 this.evtBus ，因为能接收到 mousedown 事件说明组件已经渲染出来了。

package/dist/types/graphic/link/ICELinkSlot.d.ts

@@ -30,6 +30,15 @@ declare class ICELinkSlot extends ICECircle {
      */
     constructor(props?: any);
     protected initEvents(): void;
+    /**
+     * @overwrite
+     * @method keyboardEvtHandler 键盘事件处理
+     * !ICELinkSlot 不响应键盘事件。
+     * @see {ICEComponent.keyboardEvtHandler}
+     * @param evt
+     * @returns
+     */
+    protected keyboardEvtHandler(evt: any): void;
     protected beforeRenderHandler(evt: ICEEvent): void;
     protected beforeRemoveHandler(evt: ICEEvent): void;
     /**

package/dist/types/graphic/link/ICEPolyLine.d.ts

@@ -17,12 +17,19 @@ import ICEDotPath from '../ICEDotPath';
  * @author 大漠穷秋<damoqiongqiu@126.com>
  */
 declare class ICEPolyLine extends ICEDotPath {
-    readonly isLine: true;
     /**
+     * 类型标识
+     * 用来解决 TypeScript 的 instanceof 兼容性问题， https://github.com/microsoft/TypeScript/issues/22585
+     * 仅供内部使用，业务代码不可依赖此属性
+     */
+    isLine: boolean;
+    /**
+     * 数据结构：
      * {
      *  start:{componnet:ICEComponent,position:'T'},
      *  end:{component:ICEComponent,position:'B'}
      * }
+     * !注意：此结构与 state 上的 links 结构不同，state.links 只存 id，position 信息，而且会被序列化，此结构不会被序列化。
      */
     protected links: any;
     /**
@@ -199,5 +206,10 @@ declare class ICEPolyLine extends ICEDotPath {
      * @returns {Array<any>}
      */
     private getLines;
+    /**
+     * @overwrite
+     * @method destory
+     */
+    destory(): void;
 }
 export default ICEPolyLine;

package/dist/types/index.d.ts

@@ -12,7 +12,8 @@ export { default as LineControlPanel } from './control-panel/link-controls/LineC
 export { default as ResizeControl } from './control-panel/transform-controls/ResizeControl';
 export { default as RotateControl } from './control-panel/transform-controls/RotateControl';
 export { default as TransformControlPanel } from './control-panel/transform-controls/TransformControlPanel';
-export { default as DOMEventBridge } from './event/DOMEventBridge';
+export { default as DOMEventDispatcher } from './event/DOMEventDispatcher';
+export { default as DOMEventInterceptor } from './event/DOMEventInterceptor';
 export { default as EventBus } from './event/EventBus';
 export { default as ICEEventTarget } from './event/ICEEventTarget';
 export { default as GeoLine } from './geometry/GeoLine';
@@ -25,9 +26,9 @@ export { default as ICEDotPath } from './graphic/ICEDotPath';
 export { default as ICEImage } from './graphic/ICEImage';
 export { default as ICEPath } from './graphic/ICEPath';
 export { default as ICEBezier } from './graphic/link/ICEBezier';
-export { default as ICEPolyLine } from './graphic/link/ICEPolyLine';
 export { default as ICELinkHook } from './graphic/link/ICELinkHook';
 export { default as ICELinkSlot } from './graphic/link/ICELinkSlot';
+export { default as ICEPolyLine } from './graphic/link/ICEPolyLine';
 export { default as ICEVisioLink } from './graphic/link/ICEVisioLink';
 export { default as ICECircle } from './graphic/shape/ICECircle';
 export { default as ICEEllipse } from './graphic/shape/ICEEllipse';

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "大漠穷秋",
   "name": "ice-render",
-  "version": "0.0.36",
+  "version": "0.0.39",
   "description": "A canvas engine for interactive graphics.",
   "repository": "https://gitee.com/ice-render/ice-render",
   "module": "dist/index.js",

package/dist/types/consts/MOUSE_EVENT_MAPPING_CONSTS.d.ts

@@ -1,13 +0,0 @@
-export default mouseEvents;
-/**
- * Copyright (c) 2022 大漠穷秋.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- *
- */
-/**
- * 原生 DOM 事件与 ICE 内部转发事件之间的对应关系
- * @author 大漠穷秋<damoqiongqiu@126.com>
- */
-declare const mouseEvents: string[][];