@univerjs/engine-render 0.2.8 → 0.2.10

package/lib/types/viewport.d.ts

@@ -195,10 +195,6 @@ export declare class Viewport {
     set preCacheBound(val: IBoundRectNoAngle | null);
     enable(): void;
     disable(): void;
-    /**
-     * invoked when canvas element size change
-     * engineResizeObserver --> engine.resizeBySize --> scene._setTransForm
-     */
     resetCanvasSizeAndUpdateScroll(): void;
     setScrollBar(instance: BaseScrollBar): void;
     removeScrollBar(): void;
@@ -216,32 +212,8 @@ export declare class Viewport {
     setPadding(param: IPosition): void;
     resetPadding(): void;
     /**
-     * There are serval cases to call this method.
-     * the most common case is scrolling. Other situations include:
-     * 1. changing the frozen row & col settings
-     * 2. changing curr skeleton
-     * 3. changing selection which cross viewport
-     * 4. changing the viewport size (also include change window size)
-     * 5. changing the scroll bar position
-     *
-     * when scrolling by trackpad:
-     * scene.input-manager@_onMouseWheel --> scene@triggerMouseWheel --> sheet-render.controller@scene.onMouseWheel$.add -->
-     * set-scroll.command.ts --> scroll.operation.ts -->
-     * scrollManagerService.setScrollInfoAndEmitEvent
-     *
-     * when change skelenton:
-     * _currentSkeletonBefore$ ---> scroll.render-controller@_updateSceneSize --> setSearchParam --> scene@_setTransForm ---> viewport.resetCanvasSizeAndUpdateScrollBar ---> scrollToXX
-     * --> onScrollAfterObserver.notifyObservers --> scroll.render-controller@onScrollAfterObserver ---> setScrollInfoToCurrSheetWithoutNotify  ---> sms._setScrollInfo
-     *
-     * _currentSkeleton$ ---> selection.render-controller ---> formula@_autoScroll ---> viewport.resize ---> get scrollXY by viewportScrollXY ---> scrollTo
-     * _currentSkeleton$ ---> selection.render-controller ---> setCurrentSelection ---> formula@_autoScroll ---> scrollTo
-     * _currentSkeleton$ ---> freeze.render-controller@_refreshFreeze --> viewport.resize ---> scrollTo  ---> _scroll
-     *
-     * Debug
-     * window.scene.getViewports()[0].scrollTo({x: 14.2, y: 1.8}, true)
-     *
-     * @param pos
-     *
+     * ScrollBar scroll to certain position.
+     * @param pos position of scrollBar
      */
     scrollToBarPos(pos: Partial<IScrollBarPosition>): {
         scrollX: number;
@@ -262,6 +234,12 @@ export declare class Viewport {
         isLimitedY: boolean;
     } | undefined;
     scrollByBar(delta: Partial<IScrollBarPosition>, isTrigger?: boolean): void;
+    /**
+     * Viewport scroll to certain position.
+     * @param pos
+     * @param isTrigger
+     * @returns IViewportScrollPosition
+     */
     scrollToViewportPos(pos: Partial<IViewportScrollPosition>, isTrigger?: boolean): {
         viewportScrollX: number;
         viewportScrollY: number;
@@ -303,12 +281,16 @@ export declare class Viewport {
         y: number;
     };
     getScrollBar(): Nullable<BaseScrollBar>;
+    /**
+     * Just record state of scroll. This method won't scroll viewport and scrollbar.
+     * @param current
+     * @returns Viewport
+     */
     updateScrollVal(current: Partial<IScrollObserverParam>): this;
     getScrollBarTransForm(): Transform;
     shouldIntoRender(): boolean;
     /**
-     * call stack: engine.renderLoop ---> scene.render ---> layer.render ---> viewport.render
-     * that means each layer call all viewports to render
+     * Render function in each render loop.
      * @param parentCtx parentCtx is cacheCtx from layer when layer._allowCache is true
      * @param objects
      * @param isMaxLayer
@@ -365,7 +347,7 @@ export declare class Viewport {
      */
     private _resizeCacheCanvas;
     /**
-     * This method will be invoked when viewport is resizing and removing rol & col
+     * Update scroll when viewport is resizing and removing rol & col
      */
     private _updateScrollByViewportScrollValue;
     private _getViewPortSize;