@leafer/interface 1.0.0-rc.1 → 1.0.0-rc.10

package/src/display/ILeaf.ts

@@ -1,21 +1,21 @@
-import { ILeafer } from '../app/ILeafer'
+import { ILeaferBase } from '../app/ILeafer'
 import { IEventer } from '../event/IEventer'
 
 import { ILeaferCanvas, IHitCanvas } from '../canvas/ILeaferCanvas'
 import { IRenderOptions } from '../renderer/IRenderer'
 
-import { IObject, __Number, __Boolean, __Value, __String } from '../data/IData'
-import { IMatrixWithBoundsData, IMatrix, IPointData, IBoundsData, IRadiusPointData, IMatrixDecompositionAttr, IMatrixWithLayoutData } from '../math/IMath'
+import { IObject, INumber, IBoolean, IValue, IString } from '../data/IData'
+import { IMatrixWithBoundsData, IMatrix, IPointData, IBoundsData, IRadiusPointData, ILayoutAttr, ILayoutBoundsData, IMatrixData, IMatrixWithBoundsScaleData } from '../math/IMath'
 import { IFunction } from '../function/IFunction'
 
 import { ILeafDataProxy } from './module/ILeafDataProxy'
 import { ILeafMatrix } from './module/ILeafMatrix'
 import { ILeafBounds } from './module/ILeafBounds'
-import { ILeafLayout, ILayoutBoundsType, ILayoutLocationType } from '../layout/ILeafLayout'
+import { ILeafLayout, IBoundsType, ILocationType } from '../layout/ILeafLayout'
 import { ILeafHit } from './module/ILeafHit'
 import { ILeafRender } from './module/ILeafRender'
-import { ILeafMask } from './module/ILeafMask'
 import { ILeafData } from '../data/ILeafData'
+import { IFindMethod } from '../selector/ISelector'
 
 
 export interface ICachedLeaf {
@@ -27,39 +27,47 @@ export interface ICachedLeaf {
 
 export interface ILeafAttrData {
     // layer data
-    id: __String
-    name: __String
-    className: __String
+    id: IString
+    name: IString
+    className: IString
 
     blendMode: IBlendMode
-    opacity: __Number
-    visible: __Boolean
-    isMask: __Boolean
-    isEraser: __Boolean
-    zIndex: __Number
+    opacity: INumber
+    visible: IBoolean
+    locked: IBoolean
+    zIndex: INumber
+
+    mask: IBoolean
+    maskType: IMaskType
+    eraser: IBoolean
 
     // layout data
-    x: __Number
-    y: __Number
-    width: __Number
-    height: __Number
-    scaleX: __Number
-    scaleY: __Number
-    rotation: __Number
-    skewX: __Number
-    skewY: __Number
-
-    scale: __Number | IPointData // helper
-    around: 'center' | IPointData
-
-    draggable: __Boolean
-
-    hittable: __Boolean
+    x: INumber
+    y: INumber
+    width: INumber
+    height: INumber
+    scaleX: INumber
+    scaleY: INumber
+    rotation: INumber
+    skewX: INumber
+    skewY: INumber
+
+    scale: INumber | IPointData // helper
+    around: IAround
+    lazy: IBoolean
+
+    draggable: IBoolean
+
+    editable: IBoolean
+    editSize?: IEditSize
+
+    hittable: IBoolean
     hitFill: IHitType
     hitStroke: IHitType
-    hitChildren: __Boolean
-    hitSelf: __Boolean
-    hitRadius: __Number
+    hitBox: IBoolean
+    hitChildren: IBoolean
+    hitSelf: IBoolean
+    hitRadius: INumber
 
     cursor: ICursorType | ICursorType[]
 }
@@ -70,6 +78,11 @@ export type IHitType =
     | 'all'
     | 'none'
 
+export type IMaskType =
+    | 'path'
+    | 'pixel'
+    | 'clipping'
+
 export type IBlendMode =
     | 'pass-through'
     | 'normal'
@@ -96,18 +109,31 @@ export type IBlendMode =
     | 'destination-in'
     | 'destination-out'
     | 'destination-atop'
+    | 'xor'
 
-export type IResizeType = 'size' | 'scale'
+export type IEditSize = 'size' | 'scale'
 export interface IImageCursor {
     url: string
     x?: number
     y?: number
+    rotation?: number
 }
 
-export type IAround = 'center' | IPointData
+export type IAround =
+    | 'topLeft'
+    | 'top'
+    | 'topRight'
+    | 'right'
+    | 'bottomRight'
+    | 'bottom'
+    | 'bottomLeft'
+    | 'left'
+    | 'center'
+    | IPointData
 
 export type ICursorType =
     | IImageCursor
+    | ''
     | 'auto'
     | 'default'
     | 'none'
@@ -142,53 +168,62 @@ export type ICursorType =
     | 'col-resize'
     | 'row-resize'
     | 'all-scroll'
-    | 'zoom -in'
+    | 'zoom-in'
     | 'zoom-out'
 
-export interface ICursorTypeMap {
-    [name: string]: ICursorType | ICursorType[]
-}
-export interface ILeafInputData extends IObject {
+
+export interface ILeafInputData {
     tag?: string
 
     // layer data
-    id?: __String
-    name?: __String
-    className?: __String
+    id?: IString
+    name?: IString
+    className?: IString
 
     blendMode?: IBlendMode
-    opacity?: __Number
-    visible?: __Boolean
-    isMask?: __Boolean
-    isEraser?: __Boolean
-    zIndex?: __Number
+    opacity?: INumber
+    visible?: IBoolean
+    locked?: IBoolean
+    zIndex?: INumber
+
+    mask?: IBoolean
+    maskType?: IMaskType
+    eraser?: IBoolean
 
     // layout data
-    x?: __Number
-    y?: __Number
-    width?: __Number
-    height?: __Number
-    scaleX?: __Number
-    scaleY?: __Number
-    rotation?: __Number
-    skewX?: __Number
-    skewY?: __Number
-
-    scale?: __Number | IPointData // helper
+    x?: INumber
+    y?: INumber
+    width?: INumber
+    height?: INumber
+    scaleX?: INumber
+    scaleY?: INumber
+    rotation?: INumber
+    skewX?: INumber
+    skewY?: INumber
+
+    scale?: INumber | IPointData // helper
     around?: IAround
+    lazy?: IBoolean
+
+    draggable?: IBoolean
 
-    draggable?: __Boolean
+    editable?: IBoolean
+    editSize?: IEditSize
 
-    hittable?: __Boolean
+    hittable?: IBoolean
     hitFill?: IHitType
     hitStroke?: IHitType
-    hitChildren?: __Boolean
-    hitSelf?: __Boolean
-    hitRadius?: __Number
+    hitBox?: IBoolean
+    hitChildren?: IBoolean
+    hitSelf?: IBoolean
+    hitRadius?: INumber
 
     cursor?: ICursorType | ICursorType[]
 
     children?: ILeafInputData[]
+
+    // other
+    noBounds?: boolean
 }
 export interface ILeafComputedData {
     // layer data
@@ -199,10 +234,13 @@ export interface ILeafComputedData {
     blendMode?: IBlendMode
     opacity?: number
     visible?: boolean
-    isMask?: boolean
-    isEraser?: boolean
+    locked?: boolean
     zIndex?: number
 
+    mask?: boolean
+    maskType?: IMaskType
+    eraser?: boolean
+
     // layout data
     x?: number
     y?: number
@@ -215,12 +253,18 @@ export interface ILeafComputedData {
     skewY?: number
 
     around?: IAround
+    lazy?: boolean
+    windingRule?: any
 
     draggable?: boolean
 
+    editable?: boolean
+    editSize?: IEditSize
+
     hittable?: boolean
     hitFill?: IHitType
     hitStroke?: IHitType
+    hitBox?: boolean
     hitChildren?: boolean
     hitSelf?: boolean
     hitRadius?: number
@@ -232,9 +276,10 @@ export interface ILeafComputedData {
     __complex?: boolean // 外观是否复杂
     __naturalWidth?: number
     __naturalHeight?: number
+    readonly __blendMode: string
 }
 
-export interface ILeaf extends ILeafMask, ILeafRender, ILeafHit, ILeafBounds, ILeafMatrix, ILeafDataProxy, ILeafInputData, IEventer {
+export interface ILeaf extends ILeafRender, ILeafHit, ILeafBounds, ILeafMatrix, ILeafDataProxy, ILeafInputData, IEventer {
     tag: string
     readonly __tag: string
     readonly innerName: string
@@ -242,7 +287,8 @@ export interface ILeaf extends ILeafMask, ILeafRender, ILeafHit, ILeafBounds, IL
     readonly __DataProcessor: IObject // IDataProcessor
     readonly __LayoutProcessor: IObject // ILeafLayout
 
-    leafer?: ILeafer
+    readonly app?: ILeaferBase
+    leafer?: ILeaferBase
     parent?: ILeaf
 
     readonly isApp?: boolean
@@ -251,32 +297,40 @@ export interface ILeaf extends ILeafMask, ILeafRender, ILeafHit, ILeafBounds, IL
     isBranchLeaf?: boolean
 
     __: ILeafData
+
+    proxyData?: ILeafInputData
+    __proxyData?: ILeafInputData
+
     __layout: ILeafLayout
 
-    __world: IMatrixWithLayoutData
-    __local: IMatrixWithBoundsData
+    __world: IMatrixWithBoundsScaleData
+    __local?: IMatrixWithBoundsData
+
+    __nowWorld?: IMatrixWithBoundsScaleData // use __world or __cameraWorld render
+    __cameraWorld?: IMatrixWithBoundsScaleData // use camera matrix render
+
+    readonly __localMatrix: IMatrixData
+    readonly __localBoxBounds: IBoundsData
 
     __worldOpacity: number
 
-    readonly worldTransform: IMatrixWithLayoutData
-    readonly localTransform: IMatrixWithBoundsData
+    readonly worldTransform: IMatrixData
+    readonly localTransform: IMatrixData
 
     readonly boxBounds: IBoundsData
+    readonly renderBounds: IBoundsData
     readonly worldBoxBounds: IBoundsData
     readonly worldStrokeBounds: IBoundsData
     readonly worldRenderBounds: IBoundsData
 
     readonly worldOpacity: number
 
-    __renderTime?: number // μs 1000微秒 = 1毫秒
-
     __level: number // 图层级别 root(1) -> hight
     __tempNumber?: number // 用于临时运算储存状态
 
-    readonly resizeable: boolean
-
-    readonly __hasMirror: boolean
+    readonly __worldFlipped: boolean
 
+    __hasAutoLayout?: boolean
     __hasMask?: boolean
     __hasEraser?: boolean
     __hitCanvas?: IHitCanvas
@@ -289,28 +343,43 @@ export interface ILeaf extends ILeafMask, ILeafRender, ILeafHit, ILeafBounds, IL
 
     destroyed: boolean
 
+    reset(data?: ILeafInputData): void
+    resetCustom(): void
+
     waitParent(item: IFunction): void
     waitLeafer(item: IFunction): void
-    nextRender(item: IFunction): void
+    nextRender(item: IFunction, off?: 'off'): void
 
-    __bindLeafer(leafer: ILeafer | null): void
+    __bindLeafer(leafer: ILeaferBase | null): void
 
     set(data: IObject): void
+    get(): ILeafInputData
     toJSON(): IObject
     toString(): string
+    toSVG?(): string
+    toHTML?(): string
 
     // ILeafData ->
-    __setAttr(attrName: string, newValue: __Value): void
-    __getAttr(attrName: string): __Value
+    __setAttr(attrName: string, newValue: IValue): void
+    __getAttr(attrName: string): IValue
+    setProxyAttr(name: string, newValue: IValue): void
+    getProxyAttr(name: string): IValue
+
+    // find
+    find(condition: number | string | IFindMethod, options?: any): ILeaf[]
+    findOne(condition: number | string | IFindMethod, options?: any): ILeaf
 
     forceUpdate(attrName?: string): void
 
+    updateLayout(): void
+
     // ILeafMatrix ->
     __updateWorldMatrix(): void
     __updateLocalMatrix(): void
 
     // ILeafBounds ->
     __updateWorldBounds(): void
+    __updateLocalBounds(): void
 
     __updateLocalBoxBounds(): void
     __updateLocalStrokeBounds(): void
@@ -320,6 +389,7 @@ export interface ILeaf extends ILeafMask, ILeafRender, ILeafHit, ILeafBounds, IL
     __updateStrokeBounds(): void
     __updateRenderBounds(): void
 
+    __updateAutoLayout(): void
     __updateNaturalSize(): void
 
     __updateStrokeSpread(): number
@@ -330,12 +400,14 @@ export interface ILeaf extends ILeafMask, ILeafRender, ILeafHit, ILeafBounds, IL
     // IBranchMask ->
     __updateEraser(value?: boolean): void
     __updateMask(value?: boolean): void
-    __renderMask(canvas: ILeaferCanvas, content: ILeaferCanvas, mask: ILeaferCanvas): void
-    __removeMask(child?: ILeaf): void
+    __renderMask(canvas: ILeaferCanvas, options: IRenderOptions): void
 
     // convert
-    getWorld(attrName: IMatrixDecompositionAttr): number
-    getBounds(type: ILayoutBoundsType, locationType?: ILayoutLocationType): IBoundsData
+    __getNowWorld(options: IRenderOptions): IMatrixWithBoundsScaleData // when render use other matrix
+
+    getWorld(attrName: ILayoutAttr): number // will remove
+    getBounds(type?: IBoundsType, relative?: ILocationType | ILeaf): IBoundsData
+    getLayoutBounds(type?: IBoundsType, relative?: ILocationType | ILeaf, unscale?: boolean): ILayoutBoundsData
 
     worldToLocal(world: IPointData, to?: IPointData, distance?: boolean, relative?: ILeaf): void
     localToWorld(local: IPointData, to?: IPointData, distance?: boolean, relative?: ILeaf): void
@@ -348,15 +420,27 @@ export interface ILeaf extends ILeafMask, ILeafRender, ILeafHit, ILeafBounds, IL
     getLocalPointByInner(inner: IPointData, relative?: ILeaf, distance?: boolean, change?: boolean): IPointData
     getWorldPoint(inner: IPointData, relative?: ILeaf, distance?: boolean, change?: boolean): IPointData
     getWorldPointByLocal(local: IPointData, relative?: ILeaf, distance?: boolean, change?: boolean): IPointData
+    getPagePoint(world: IPointData, relative?: ILeaf, distance?: boolean, change?: boolean): IPointData
+    getWorldPointByPage(page: IPointData, relative?: ILeaf, distance?: boolean, change?: boolean): IPointData
+
+
+    // transform
+    setTransform(transform?: IMatrixData, resize?: boolean): void
+    transform(transform?: IMatrixData, resize?: boolean): void
 
     move(x: number, y?: number): void
-    scaleOf(origin: IPointData, x: number, y?: number): void
+    scaleOf(origin: IPointData, scaleX: number, scaleY?: number, resize?: boolean): void
     rotateOf(origin: IPointData, rotation: number): void
-    skewOf(origin: IPointData, x: number, y: number): void
+    skewOf(origin: IPointData, skewX: number, skewY?: number, resize?: boolean): void
+
+    scaleResize(scaleX: number, scaleY: number, noResize?: boolean): void
+    __scaleResize(scaleX: number, scaleY: number): void
 
     // ILeafHit ->
     __hitWorld(point: IRadiusPointData): boolean
     __hit(local: IRadiusPointData): boolean
+    __hitFill(inner: IRadiusPointData, windingRule?: string): boolean
+    __hitStroke(inner: IRadiusPointData, strokeWidth: number): boolean
     __drawHitPath(canvas: ILeaferCanvas): void
     __updateHitCanvas(): void
 
@@ -365,6 +449,7 @@ export interface ILeaf extends ILeafMask, ILeafRender, ILeafHit, ILeafBounds, IL
     __drawFast(canvas: ILeaferCanvas, options: IRenderOptions): void
     __draw(canvas: ILeaferCanvas, options: IRenderOptions): void
 
+    __clip(canvas: ILeaferCanvas, options: IRenderOptions): void
     __renderShape(canvas: ILeaferCanvas, options: IRenderOptions): void
 
     __updateWorldOpacity(): void
@@ -382,4 +467,5 @@ export interface ILeaf extends ILeafMask, ILeafRender, ILeafHit, ILeafBounds, IL
     __updateSortChildren(): void
     add(child: ILeaf, index?: number): void
     remove(child?: ILeaf, destroy?: boolean): void
+    dropTo(parent: ILeaf, index?: number, resize?: boolean): void
 }

package/src/display/IView.ts

@@ -1,10 +1,7 @@
 import { IBranch } from './IBranch'
 import { ILeaf } from './ILeaf'
-import { ITransformEventData } from '../event/IEvent'
 
 export interface IZoomView extends IBranch {
     zoomLayer?: ILeaf
-    moveLayer?: ILeaf
-    transformData?: ITransformEventData
-    setZoomLayer(zoomLayer: ILeaf, moveLayer?: ILeaf): void
+    setZoomLayer(zoomLayer: ILeaf): void
 }

package/src/display/module/IBranchRender.ts

@@ -1,7 +1,7 @@
-import { ILeaferCanvas } from '../../canvas/ILeaferCanvas'
-import { IRenderOptions } from '../../renderer/IRenderer'
 import { IBranch } from '../IBranch'
 import { ILeafRender } from './ILeafRender'
+import { ILeaferCanvas } from '../../canvas/ILeaferCanvas'
+import { IRenderOptions } from '../../renderer/IRenderer'
 
 export type IBranchRenderModule = IBranchRender & ThisType<IBranch>
 

package/src/display/module/ILeafBounds.ts

@@ -4,6 +4,7 @@ export type ILeafBoundsModule = ILeafBounds & ThisType<ILeaf>
 
 export interface ILeafBounds {
     __updateWorldBounds?(): void
+    __updateLocalBounds?(): void
 
     __updateLocalBoxBounds?(): void
     __updateLocalStrokeBounds?(): void
@@ -13,6 +14,7 @@ export interface ILeafBounds {
     __updateStrokeBounds?(): void
     __updateRenderBounds?(): void
 
+    __updateAutoLayout?(): void
     __updateNaturalSize?(): void
 
     __updateStrokeSpread?(): number

package/src/display/module/ILeafDataProxy.ts

@@ -1,10 +1,12 @@
 import { ILeaf } from '../ILeaf'
-import { __Value } from '../../data/IData'
+import { IValue } from '../../data/IData'
 
 export type ILeafDataProxyModule = ILeafDataProxy & ThisType<ILeaf>
 
 export interface ILeafDataProxy {
-    __setAttr?(name: string, newValue: __Value): void
-    __getAttr?(name: string): __Value
+    __setAttr?(name: string, newValue: IValue): void
+    __getAttr?(name: string): IValue
+    setProxyAttr?(name: string, newValue: IValue): void
+    getProxyAttr?(name: string): IValue
 }
 

package/src/display/module/ILeafHit.ts

@@ -6,7 +6,9 @@ export type ILeafHitModule = ILeafHit & ThisType<ILeaf>
 
 export interface ILeafHit {
     __hitWorld?(point: IRadiusPointData): boolean
-    __hit?(local: IRadiusPointData): boolean
+    __hit?(inner: IRadiusPointData): boolean
+    __hitFill?(inner: IRadiusPointData, windingRule?: string): boolean
+    __hitStroke?(inner: IRadiusPointData, strokeWidth: number): boolean
     __drawHitPath?(canvas: ILeaferCanvas): void
     __updateHitCanvas?(): void
 }

package/src/display/module/ILeafRender.ts

@@ -9,6 +9,7 @@ export interface ILeafRender {
     __draw?(canvas: ILeaferCanvas, options: IRenderOptions): void
     __drawFast?(canvas: ILeaferCanvas, options: IRenderOptions): void
 
+    __clip?(_canvas: ILeaferCanvas, _options: IRenderOptions): void
     __renderShape?(canvas: ILeaferCanvas, options: IRenderOptions): void
 
     __updateWorldOpacity?(): void

package/src/event/IEvent.ts

@@ -3,8 +3,11 @@ import { IWatchEventData } from '../watcher/IWatcher'
 import { ILayoutBlockData } from '../layouter/ILayouter'
 import { ILeaf } from '../display/ILeaf'
 import { IScreenSizeData, IPointData } from '../math/IMath'
+import { IObject } from '../data/IData'
 
 export interface IEvent {
+    origin?: IObject
+
     type?: string
     target?: IEventTarget
     current?: IEventTarget
@@ -75,29 +78,6 @@ export interface IWatchEvent extends IEvent {
     readonly data: IWatchEventData
 }
 
-export interface ITransformEventData {
-    x: number
-    y: number
-    scaleX: number
-    scaleY: number
-    rotation: number
-
-    readonly zooming: boolean
-    readonly moving: boolean
-    readonly rotating: boolean
-    readonly changing: boolean
-}
-
-export interface ITransformEvent extends IEvent, ITransformEventData {
-    readonly x: number
-    readonly y: number
-    readonly scaleX: number
-    readonly scaleY: number
-    readonly rotation: number
-}
-export type TransformMode = 'move' | 'zoom' | 'rotate'
-
-
 export interface IMultiTouchData {
     move: IPointData,
     scale: number,

package/src/event/IEventer.ts

@@ -1,5 +1,9 @@
-import { IEvent, IFunction, IObject } from '@leafer/interface'
 import { ILeafEventer } from '../display/module/ILeafEventer'
+import { ILeaf } from '../display/ILeaf'
+import { IFunction } from '../function/IFunction'
+import { IEvent } from './IEvent'
+import { IObject } from '../data/IData'
+
 
 export type IEventListener = IFunction
 
@@ -18,6 +22,7 @@ export interface IEventListenerMap {
 
 export interface IEventListenerId {
     type: string | string[]
+    current: ILeaf
     listener: IEventListener
     options?: IEventListenerOptions | boolean
 }

package/src/event/IUIEvent.ts

@@ -23,10 +23,9 @@ export interface IUIEvent extends IEvent {
     path?: ILeafList
     throughPath?: ILeafList // 穿透path，不受层级影响，从上到下只要碰撞到区域就算，一般点击的时候
 
-    origin?: IObject
-
-    getInner?(target?: ILeaf): IPointData
-    getLocal?(target?: ILeaf): IPointData
+    getPage?(): IPointData
+    getInner?(relative?: ILeaf): IPointData
+    getLocal?(relative?: ILeaf): IPointData
 }
 
 
@@ -48,10 +47,13 @@ export interface IDragEvent extends IPointerEvent {
     totalX?: number
     totalY?: number
 
-    getInnerMove?(target?: ILeaf): IPointData
-    getLocalMove?(target?: ILeaf): IPointData
-    getInnerTotal?(target?: ILeaf): IPointData
-    getLocalTotal?(target?: ILeaf): IPointData
+    getPageMove?(total?: boolean): IPointData
+    getInnerMove?(relative?: ILeaf): IPointData
+    getLocalMove?(relative?: ILeaf): IPointData
+
+    getPageTotal?(): IPointData
+    getInnerTotal?(relative?: ILeaf): IPointData
+    getLocalTotal?(relative?: ILeaf): IPointData
 }
 
 export interface IDropEvent extends IPointerEvent {

package/src/file/IExport.ts

@@ -0,0 +1,24 @@
+import { IBlob, ILeaferCanvas } from '../canvas/ILeaferCanvas'
+import { IBoundsData } from '../math/IMath'
+
+
+export interface IExportOptions {
+    quality?: number
+    blob?: boolean
+    scale?: number
+    pixelRatio?: number
+    slice?: boolean
+    trim?: boolean
+    fill?: string
+    screenshot?: IBoundsData | boolean
+}
+
+export interface IExportResult {
+    data: ILeaferCanvas | IBlob | string | boolean
+    renderBounds?: IBoundsData
+    trimBounds?: IBoundsData
+}
+
+export interface IExportResultFunction {
+    (data: IExportResult): void
+}

package/src/file/IFileType.ts

@@ -1,2 +1,2 @@
 export type IExportImageType = 'jpg' | 'png' | 'webp'
-export type IExportFileType = IExportImageType | 'svg' | 'pdf' | 'json'
+export type IExportFileType = IExportImageType | 'svg' | 'pdf' | 'json'

package/src/function/IFunction.ts

@@ -10,4 +10,13 @@ export interface INumberFunction {
 
 export interface IPointDataFunction {
     (...arg: any): IPointData
+}
+
+
+export interface IAttrDecorator {
+    (...arg: any): IAttrDecoratorInner
+}
+
+interface IAttrDecoratorInner {
+    (target: any, key: string): any
 }