@univerjs/engine-render 0.1.17 → 0.2.0

package/lib/types/viewport.d.ts

@@ -102,7 +102,7 @@ export declare class Viewport {
     private _isWheelPreventDefaultX;
     private _isWheelPreventDefaultY;
     private _scrollStopNum;
-    private _renderClipState;
+    private _clipViewport;
     private _active;
     private _paddingStartX;
     private _paddingEndX;
@@ -201,9 +201,12 @@ export declare class Viewport {
      * only viewMain would call scrollTo, other views did not call scroll, see scroll.render-controller
      * @param pos
      *
-     * when scrolling:
-     *
+     * when scrolling by trackpad:
+     * scene.input-manager@_onMouseWheel --> scene@triggerMouseWheel --> sheet-render.controller@scene.onMouseWheelObserver.add --> scrollManagerService.setScrollInfo -->
      * scroll.render-controller@_scrollManagerService.scrollInfo$.subscribe --> scrollTo
+     * scroll-manager.service@_scrollInfo$.next -->scroll.render-controller@_scrollManagerService.scrollInfo$.subscribe -->
+     * viewportMain.scrollTo(config);
+     *
      *
      * when change skelenton:
      * _currentSkeletonBefore$ ---> scroll.render-controller@_updateSceneSize --> setSearchParam --> scene@_setTransForm ---> viewport.resetCanvasSizeAndUpdateScrollBar ---> scrollTo ---> _scroll
@@ -213,8 +216,13 @@ export declare class Viewport {
      * _currentSkeleton$ ---> selection.render-controller ---> setCurrentSelection ---> formula@_autoScroll ---> scrollTo
      * _currentSkeleton$ ---> freeze.render-controller@_refreshFreeze --> viewport.resize ---> scrollTo  ---> _scroll
      *
+     *
+     *
      * TODO: @lumix many side effects in scrollTo, it would update scrollXY & viewportScrollXY, and notify listeners of scrollInfo$
      *
+     * TODO: @lumix Other controller should call scrollManagerService to set scrollInfo$
+     * example in scroll.operation.ts
+     *
      * Debug
      * window.scene.getViewports()[0].scrollTo({x: 14.2, y: 1.8}, true)
      */
@@ -224,6 +232,7 @@ export declare class Viewport {
     } | undefined;
     /**
      * current position plus offset, relative
+     * normally triggered by scroll-timer(in sheet)
      * @param pos
      * @returns isLimited
      */
@@ -231,7 +240,16 @@ export declare class Viewport {
         isLimitedX: boolean;
         isLimitedY: boolean;
     } | undefined;
+    /**
+     *
+     * @param pos
+     * @param isTrigger
+     */
     scrollByBar(pos: IScrollBarPosition, isTrigger?: boolean): void;
+    scrollByViewportScroll({ deltaX, deltaY }: {
+        deltaX?: number | undefined;
+        deltaY?: number | undefined;
+    }): void;
     /**
      * current position plus offset relatively
      * the caller no need to deal with the padding when frozen
@@ -276,8 +294,19 @@ export declare class Viewport {
     private _makeDefaultViewport;
     private _calcViewportInfo;
     getBounding(): IViewportInfo;
-    getRelativeVector(coord: Vector2): Vector2;
+    /**
+     * convert vector to scene coordinate, include row & col
+     * @param vec
+     * @returns Vector2
+     */
+    transformVector2SceneCoord(vec: Vector2): Vector2;
     getAbsoluteVector(coord: Vector2): Vector2;
+    /**
+     * At f7140a7c11, only doc need this method.
+     * In sheet, wheel event is handled by scroll-manager.service@setScrollInfo
+     * @param evt
+     * @param state
+     */
     onMouseWheel(evt: IWheelEvent, state: EventState): void;
     isHit(coord: Vector2): boolean | undefined;
     pickScrollBar(coord: Vector2): import('./shape').Rect<import('./shape').IRectProps> | null | undefined;
@@ -310,7 +339,7 @@ export declare class Viewport {
     private _triggerScrollStop;
     /**
      * Scroll Viewport
-     * Only the 'viewMain' will enter this function, other viewports will not.
+     * This function called by viewMain only, other viewports will not.
      *
      * caller: scroll.render-controller viewportMain.scrollTo({x, y}))
      * this._scrollManagerService.scrollInfo$.subscribe --> scrollTo --> _scroll
@@ -318,7 +347,7 @@ export declare class Viewport {
      * @param scrollBarPos viewMain 滚动条的位置
      * @param isTrigger
      */
-    private _scrollToScrollbarPos;
+    private _scrollCore;
     expandBounds(value: {
         top: number;
         left: number;