ice-render 1.0.1 → 1.0.4

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

@@ -5,22 +5,26 @@ import ICERect from '../../graphic/shape/ICERect';
  * - 调整尺寸的操作手柄不能独立存在，只能依附在某个宿主对象上。
  * - 此手柄只能调整尺寸，不能实现翻转
  *
- * TODO: 补全 props 配置项
- * {
- *   direction: 改变的方向，共有3个可选的值： x/y/both
- *   position: 手柄在变换矩形4个边上的位置，共有8个：lt/t/rt/r/rb/b/lb/l
- * }
  */
 export default class ResizeControl extends ICERect {
+    /**
+     * props:
+     * {
+     *   direction: 改变的方向，共有3个可选的值： x/y/both
+     *   position: 手柄在变换矩形4个边上的位置，共有8个：lt/t/rt/r/rb/b/lb/l
+     *   quadrant: 当前所在的象限
+     * }
+     * @param props
+     */
     constructor(props: any);
     protected initEvents(): void;
     /**
-     * 围绕几何中心点调整宽高。
      * @param evt
      */
     private resizeEvtHandler;
     /**
      * @overwrite
+     * @method moveGlobalPosition
      * ResizeControl 不能自由移动自己的位置，自能在X轴、Y轴，以及矩形的2条对角线上移动位置。
      *
      * 在全局空间(canvas)中移动指定的位移。

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

@@ -4,10 +4,6 @@ import ICECircle from '../../graphic/shape/ICECircle';
  *
  * - 旋转手柄不能独立存在，只能依附在某个宿主对象上。
  * - 此手柄仅用来修改组件的旋转角度。
- *
- * TODO: 补全 props 配置项
- * {
- * }
  */
 export default class RotateControl extends ICECircle {
     constructor(props: any);

package/dist/types/event/ICEEventTarget.d.ts

@@ -56,13 +56,6 @@ declare abstract class ICEEventTarget {
      * @returns
      */
     off(eventName: string, fn: Function, scope?: any): void;
-    /**
-     * @method once
-     * 一次性事件，触发一次就自动删除自己。
-     * @param eventName
-     * @param fn
-     */
-    once(eventName: string, fn: Function, scope?: any): void;
     /**
      * @method dispatchEvent
      *
@@ -76,6 +69,13 @@ declare abstract class ICEEventTarget {
      * @returns
      */
     trigger(eventName: string, originalEvent?: any, param?: {}): boolean;
+    /**
+     * @method once
+     * 一次性事件，触发一次就自动删除自己。
+     * @param eventName
+     * @param fn
+     */
+    once(eventName: string, fn: Function, scope?: any): void;
     /**
      * @method suspend
      * 挂起事件。

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

@@ -233,11 +233,18 @@ declare abstract class ICEComponent extends ICEEventTarget {
      */
     globalToLocal(globalX: number, globalY: number): number[];
     /**
+     * @method getRotateAngle 获取组件的旋转角度。
      * 根据变换矩阵计算组件在全局空间(canvas)中的旋转角度。
+     * @param refresh 如果为 true ，则重新计算变换矩阵，否则使用缓存的变换矩阵。
      * @returns
      */
-    getRotateAngle(): number;
-    getLocalLeftTop(): {
+    getRotateAngle(refresh?: boolean): number;
+    /**
+     * @method getLocalLeftTop 得到组件在局部坐标系中的左上角坐标。
+     * @param refresh 如果为 true ，则重新计算变换矩阵，否则使用缓存的变换矩阵。
+     * @returns
+     */
+    getLocalLeftTop(refresh?: boolean): {
         left: number;
         top: number;
         width: number;

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

@@ -7,11 +7,8 @@
  */
 import ICEComponent from './ICEComponent';
 /**
- * @class ICEPath
- *
- * 路径
- *
  * @abstract
+ * @class ICEPath 路径
  * @author 大漠穷秋<damoqiongqiu@126.com>
  */
 declare abstract class ICEPath extends ICEComponent {

package/dist/types/graphic/container/ICEGroup.d.ts

@@ -1,11 +1,10 @@
 import ICEComponent from '../ICEComponent';
 import ICERect from '../shape/ICERect';
 /**
- * @class ICEGroup
+ * @class ICEGroup 容器型组件
  *
- * 容器型组件
- *
- * ICEGroup 可以包含自身，利用此组件可以构造出树形的对象结构。
+ * - ICEGroup 可以带有子组件，所有容器型的组件都应该继承 ICEGroup
+ * - ICEGroup 可以包含自身，利用此组件可以构造出树形的组件结构。
  *
  * @author 大漠穷秋<damoqiongqiu@126.com>
  */

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

@@ -18,11 +18,12 @@ import ICECircle from '../shape/ICECircle';
 declare class ICELinkSlot extends ICECircle {
     private _hostComponent;
     /**
-     * position 有4个取值，分别位于宿主边界盒子的4个边的几何中点上：
-     * - T: 顶部
-     * - R: 右侧
-     * - B: 底部
-     * - L: 左侧
+     * position 的取值：
+     * - T: 宿主边界盒子的顶边中点
+     * - R: 宿主边界盒子的右边中点
+     * - B: 宿主边界盒子的底边中点
+     * - L: 宿主边界盒子的左边中点
+     * - C: 宿主边界盒子的几何中心点
      *
      * 连接插槽自身不可拖拽、不可连接。
      * @param props

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

@@ -13,6 +13,7 @@ import ICE from '../../ICE';
 export default class ICELinkSlotManager {
     private slotRadius;
     private ice;
+    private collision;
     constructor(ice: ICE);
     start(): this;
     stop(): this;
@@ -20,8 +21,8 @@ export default class ICELinkSlotManager {
     private hookMouseUpHandler;
     protected globalMouseUpHandler(evt?: ICEEvent): void;
     /**
-     * 创建连接插槽，插槽默认分布在组件最小边界盒子的4条边几何中点位置。
-     * 有顺序，按照 TRBL 上右下左 创建，插槽的 ID 会被序列化。
+     * @method createLinkSlots
+     * 创建5个连接插槽，插槽默认分布在组件最小边界盒子的4条边中点和几何中心点。
      */
     protected createLinkSlots(): void;
 }

package/dist/types/graphic/shape/ICECircle.d.ts

@@ -7,9 +7,9 @@
  */
 import ICEEllipse from './ICEEllipse';
 /**
- * @class ICECircle
+ * @class ICECircle 正圆形
  *
- * 正圆形，采用椭圆绘制方法，正圆形作为椭圆的特殊情况。
+ * 采用椭圆绘制方法，正圆形作为椭圆的特殊情况。
  *
  * @author 大漠穷秋<damoqiongqiu@126.com>
  */

package/dist/types/graphic/shape/ICEEllipse.d.ts

@@ -1,9 +1,6 @@
 import ICEPath from '../ICEPath';
 /**
- * @class ICEEllipse
- *
- * 椭圆形。
- *
+ * @class ICEEllipse 椭圆形
  * @author 大漠穷秋<damoqiongqiu@126.com>
  */
 declare class ICEEllipse extends ICEPath {

package/dist/types/graphic/shape/ICEIsogon.d.ts

@@ -1,9 +1,7 @@
 import ICEDotPath from '../ICEDotPath';
 /**
  *
- * @class ICEIsogon
- *
- * 正N边形
+ * @class ICEIsogon 正N边形
  *
  * @author 大漠穷秋<damoqiongqiu@126.com>
  */

package/dist/types/graphic/shape/ICEStar.d.ts

@@ -1,9 +1,6 @@
 import ICEDotPath from '../ICEDotPath';
 /**
- * @class ICEStar
- *
- * 正 N 角星
- *
+ * @class ICEStar 正N角星
  * @author 大漠穷秋<damoqiongqiu@126.com>
  */
 declare class ICEStar extends ICEDotPath {

package/dist/types/graphic/text/ICEText.d.ts

@@ -1,6 +1,7 @@
 import ICEComponent from '../ICEComponent';
 /**
  * TODO:draw text along Path2D
+ * @class ICEText 文本
  * @author 大漠穷秋<damoqiongqiu@126.com>
  */
 declare class ICEText extends ICEComponent {

package/dist/types/renderer/CanvasRenderer.d.ts

@@ -1,9 +1,7 @@
 import ICEEventTarget from '../event/ICEEventTarget';
 import ICE from '../ICE';
 /**
- * @class CanvasRenderer
- *
- * Canvas 渲染器
+ * @class CanvasRenderer Canvas 渲染器
  *
  * - 一个 ICE 实例上，只能有一个渲染器实例。
  *

package/dist/types/util/ImageCache.d.ts

@@ -1,7 +1,9 @@
 import ICE from '../ICE';
 /**
- * @class ImageCache
- * 图片缓存类
+ * @class ImageCache 图片缓存器
+ *
+ * 以图片的 url 作为 key，图片对象作为 value，缓存图片。
+ *
  * @author 大漠穷秋<damoqiongqiu@126.com>
  */
 export default class ImageCache {

package/package.json

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