@univerjs/engine-render 0.2.10 → 0.2.12

package/lib/types/basics/interfaces.d.ts

@@ -100,3 +100,10 @@ export interface INodeSearch {
 export interface INodePosition extends INodeSearch {
     isBack: boolean;
 }
+export interface IAfterRender$Info {
+    frameTimeMetric: Record<string, number | number[]>;
+    tags: {
+        scrolling: boolean;
+    } & Record<string, any>;
+}
+export type ITimeMetric = [string, number];

package/lib/types/basics/performance-monitor.d.ts

@@ -1,32 +1,51 @@
-/**
- * Copyright 2023-present DreamNum Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+import { Disposable } from '@univerjs/core';
+export declare const DEFAULT_FRAME_SAMPLE_SIZE = 60;
+export declare const DEFAULT_FRAME_LIST_SIZE: number;
+export interface IBasicFrameInfo {
+    FPS: number;
+    frameTime: number;
+    elapsedTime: number;
+}
+export interface IExtendFrameInfo extends IBasicFrameInfo {
+    [key: string]: any;
+    scrolling: boolean;
+}
+export interface ISummaryFrameInfo {
+    FPS: ISummaryMetric;
+    frameTime: ISummaryMetric;
+    [key: string]: ISummaryMetric;
+}
+export interface ISummaryMetric {
+    avg: number;
+    min: number;
+    max: number;
+}
 /**
  * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  */
-export declare class PerformanceMonitor {
+export declare class PerformanceMonitor extends Disposable {
     private _enabled;
     private _rollingFrameTime;
     private _lastFrameTimeMs;
     /**
-     * constructor
-     * @param frameSampleSize The number of samples required to saturate the sliding window
+     * Counting frame in a second.
+     */
+    private _frameCountInLastSecond;
+    /**
+     *  The millisecond value of the last second. For counting frame in a second.
+     */
+    private _lastSecondTimeMs;
+    /**
+     * The FPS values recorded in the past 1 second.
+     */
+    private _recFPSValueLastSecond;
+    /**
+     * @param {number} frameSampleSize The number of samples required to saturate the sliding window
      */
     constructor(frameSampleSize?: number);
+    dispose(): void;
     /**
-     * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
+     * Returns the average frame time in milliseconds of the sliding window (or the subset of frames sampled so far)
      */
     get averageFrameTime(): number;
     /**
@@ -34,7 +53,7 @@ export declare class PerformanceMonitor {
      */
     get averageFrameTimeVariance(): number;
     /**
-     * Returns the frame time of the most recent frame
+     * Returns the frame time of the last recent frame.
      */
     get instantaneousFrameTime(): number;
     /**
@@ -54,11 +73,13 @@ export declare class PerformanceMonitor {
      */
     get isEnabled(): boolean;
     /**
-     * Samples current frame
-     * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
+     * Samples current frame, set averageFPS instantaneousFrameTime
+     * this method is called each frame by engine renderLoop  --> endFrame.
+     * @param timestamp A timestamp in milliseconds of the current frame to compare with other frames
      */
-    sampleFrame(timeMs?: number): void;
-    Now(): number;
+    sampleFrame(timestamp?: number): void;
+    endFrame(timestamp: number): void;
+    now(): number;
     /**
      * Enables contributions to the sliding window sample set
      */
@@ -82,12 +103,16 @@ export declare class RollingAverage {
     /**
      * Current average
      */
-    average: number;
+    averageFrameTime: number;
     /**
      * Current variance
      */
     variance: number;
     protected _samples: number[];
+    /**
+     * for isStaturated
+     * max value of _sampleCount is length of _samples
+     */
     protected _sampleCount: number;
     protected _pos: number;
     protected _m2: number;
@@ -96,11 +121,15 @@ export declare class RollingAverage {
      * @param length The number of samples required to saturate the sliding window
      */
     constructor(length: number);
+    /**
+     * Calc average frameTime and variance.
+     */
+    calcAverageFrameTime(): void;
     /**
      * Adds a sample to the sample set
-     * @param v The sample value
+     * @param frameTime The sample value
      */
-    add(v: number): void;
+    addFrameTime(frameTime: number): void;
     /**
      * Returns previously added values or null if outside of history or outside the sliding window domain
      * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that

package/lib/types/basics/tools.d.ts

@@ -128,10 +128,11 @@ export declare function inCurrentAndAboveViewRanges(ranges: IRange[], rowIndex:
  */
 export declare function inRowViewRanges(ranges: IRange[], rowIndex: number): boolean;
 /**
- * 如果 range 有相交, 那么扩展到第一组 range 中.
- * @param ranges
+ * If there is an intersection in ranges to the mainRanges, extend it to the first set of ranges.
+ * @param {IRange[]} mainRanges target ranges
+ * @param {IRange[]} ranges
  */
-export declare function mergeRangeIfIntersects(mainRanges: IRange[], ranges: IRange[]): IRange[];
+export declare function expandRangeIfIntersects(mainRanges: IRange[], ranges: IRange[]): IRange[];
 export declare function clampRanges(range: IRange): {
     startRow: number;
     startColumn: number;

package/lib/types/components/docs/layout/line-breaker/break.d.ts

@@ -16,7 +16,8 @@
 export declare enum BreakPointType {
     Normal = "Normal",
     Mandatory = "Mandatory",
-    Hyphen = "Hyphen"
+    Hyphen = "Hyphen",
+    Link = "Link"
 }
 export declare class Break {
     position: number;

package/lib/types/components/docs/layout/line-breaker/enhancers/hyphen-enhancer.d.ts

@@ -3,7 +3,6 @@ import { Break } from '../break';
 import { IBreakPoints, LineBreaker } from '../line-breaker';
 import { Hyphen } from '../../hyphenation/hyphen';
 import { Lang } from '../../hyphenation/lang';
-export declare function isLetter(char: string): boolean;
 export declare class LineBreakerHyphenEnhancer implements IBreakPoints {
     private _lineBreaker;
     private _hyphen;
@@ -15,7 +14,7 @@ export declare class LineBreakerHyphenEnhancer implements IBreakPoints {
     private _word;
     private _hyphenIndex;
     private _hyphenSlice;
-    private _content;
+    content: string;
     constructor(_lineBreaker: LineBreaker, _hyphen: Hyphen, _lang: Lang, _doNotHyphenateCaps?: boolean);
     nextBreakPoint(): Nullable<Break>;
 }

package/lib/types/components/docs/layout/line-breaker/enhancers/link-enhancer.d.ts

@@ -0,0 +1,15 @@
+import { Nullable } from '@univerjs/core';
+import { IBreakPoints, LineBreaker } from '../line-breaker';
+import { Break } from '../break';
+export declare class LineBreakerLinkEnhancer implements IBreakPoints {
+    private _lineBreaker;
+    private _curBreak;
+    private _nextBreak;
+    private _isInLink;
+    private _link;
+    private _index;
+    private _linkSlice;
+    content: string;
+    constructor(_lineBreaker: LineBreaker);
+    nextBreakPoint(): Nullable<Break>;
+}

package/lib/types/components/docs/layout/line-breaker/enhancers/utils.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export declare function isLetter(char: string): boolean;
+export declare function getWord(str: string): string;
+export declare function getSlicePosition(lastPos: number, hyphenSlice: string[], index: number): number;

package/lib/types/components/docs/view-model/document-view-model.d.ts

@@ -55,7 +55,7 @@ export declare class DocumentViewModel implements IDisposable {
     getCustomBlock(index: number): import('@univerjs/core').ICustomBlock | undefined;
     getCustomBlockWithoutSetCurrentIndex(index: number): import('@univerjs/core').ICustomBlock | undefined;
     getTable(index: number): import('@univerjs/core').ITable | undefined;
-    getCustomRangeRaw(index: number): import('@univerjs/core').ICustomRange | undefined;
+    getCustomRangeRaw(index: number): import('@univerjs/core').ICustomRange<Record<string, any>> | undefined;
     getCustomRange(index: number): Nullable<ICustomRangeForInterceptor>;
     getCustomDecorationRaw(index: number): import('@univerjs/core').ICustomDecoration | undefined;
     getCustomDecoration(index: number): Nullable<ICustomDecorationForInterceptor>;

package/lib/types/components/sheets/extensions/background.d.ts

@@ -8,5 +8,5 @@ export declare class Background extends SheetExtension {
     Z_INDEX: number;
     PRINTING_Z_INDEX: number;
     get zIndex(): number;
-    draw(ctx: UniverRenderingContext, parentScale: IScale, spreadsheetSkeleton: SpreadsheetSkeleton, diffRanges: IRange[], { viewRanges, checkOutOfViewBound }: IDrawInfo): void;
+    draw(ctx: UniverRenderingContext, _parentScale: IScale, spreadsheetSkeleton: SpreadsheetSkeleton, diffRanges: IRange[], { viewRanges, checkOutOfViewBound }: IDrawInfo): void;
 }

package/lib/types/components/sheets/extensions/border.d.ts

@@ -5,6 +5,6 @@ import { SheetExtension } from './sheet-extension';
 export declare class Border extends SheetExtension {
     uKey: string;
     Z_INDEX: number;
-    draw(ctx: UniverRenderingContext, parentScale: IScale, spreadsheetSkeleton: SpreadsheetSkeleton, diffRanges?: IRange[]): void;
+    draw(ctx: UniverRenderingContext, _parentScale: IScale, spreadsheetSkeleton: SpreadsheetSkeleton, diffRanges: IRange[]): void;
     private _getOverflowExclusion;
 }

package/lib/types/components/sheets/extensions/custom.d.ts

@@ -5,5 +5,5 @@ import { SheetExtension } from './sheet-extension';
 export declare class Custom extends SheetExtension {
     protected Z_INDEX: number;
     uKey: string;
-    draw(ctx: UniverRenderingContext, parentScale: IScale, skeleton: SpreadsheetSkeleton, diffRanges?: IRange[] | undefined): void;
+    draw(ctx: UniverRenderingContext, _parentScale: IScale, skeleton: SpreadsheetSkeleton, diffRanges: IRange[] | undefined): void;
 }

package/lib/types/components/sheets/extensions/row-header-layout.d.ts

@@ -1,7 +1,7 @@
 import { IScale } from '@univerjs/core';
 import { UniverRenderingContext } from '../../../context';
 import { SpreadsheetSkeleton } from '../sheet-skeleton';
-import { IARowCfg, IARowCfgObj, IColumnStyleCfg, IRowStyleCfg } from '../interfaces.ts';
+import { IARowCfg, IARowCfgObj, IColumnStyleCfg, IRowStyleCfg } from '../interfaces';
 import { SheetExtension } from './sheet-extension';
 export interface IRowsHeaderCfgParam {
     headerStyle?: Partial<IRowStyleCfg>;

package/lib/types/components/sheets/extensions/sheet-extension.d.ts

@@ -4,6 +4,10 @@ import { SpreadsheetSkeleton } from '../sheet-skeleton';
 export declare enum SHEET_EXTENSION_TYPE {
     GRID = 0
 }
+/**
+ * for distinguish doc & slides extensions, now only used when metric performance.
+ */
+export declare const SHEET_EXTENSION_PREFIX = "sheet-ext-";
 export declare class SheetExtension extends ComponentExtension<SpreadsheetSkeleton, SHEET_EXTENSION_TYPE, IRange[]> {
     type: SHEET_EXTENSION_TYPE;
     /**

package/lib/types/components/sheets/spreadsheet.d.ts

@@ -1,7 +1,8 @@
 import { IRange } from '@univerjs/core';
 import { IBoundRectNoAngle, IViewportInfo, Vector2 } from '../../basics/vector2';
 import { Canvas } from '../../canvas';
-import { UniverRenderingContext } from '../../context';
+import { UniverRenderingContext2D } from '../../context';
+import { Scene } from '../../scene';
 import { Documents } from '../docs/document';
 import { Background } from './extensions/background';
 import { Border } from './extensions/border';
@@ -35,7 +36,14 @@ export declare class Spreadsheet extends SheetComponent {
      * @param ctx
      * @param viewportInfo
      */
-    draw(ctx: UniverRenderingContext, viewportInfo: IViewportInfo): void;
+    draw(ctx: UniverRenderingContext2D, viewportInfo: IViewportInfo): void;
+    addRenderFrameTimeMetricToScene(timeKey: string, val: number, scene: Scene): void;
+    addRenderTagToScene(renderKey: string, val: any, scene?: Scene): void;
+    /**
+     * override for return type as Scene.
+     * @returns Scene
+     */
+    getScene(): Scene;
     isHit(coord: Vector2): boolean;
     getNoMergeCellPositionByIndex(rowIndex: number, columnIndex: number): {
         startY: number;
@@ -61,13 +69,13 @@ export declare class Spreadsheet extends SheetComponent {
      */
     makeDirty(state?: boolean): this;
     setDirtyArea(dirtyBounds: IBoundRectNoAngle[]): void;
-    renderByViewport(mainCtx: UniverRenderingContext, viewportInfo: IViewportInfo, spreadsheetSkeleton: SpreadsheetSkeleton): void;
+    renderByViewport(mainCtx: UniverRenderingContext2D, viewportInfo: IViewportInfo, spreadsheetSkeleton: SpreadsheetSkeleton): void;
     paintNewAreaForScrolling(viewportInfo: IViewportInfo, param: IPaintForScrolling): void;
     /**
      * Redraw the entire viewport.
      */
     refreshCacheCanvas(viewportInfo: IViewportInfo, param: IPaintForRefresh): void;
-    render(mainCtx: UniverRenderingContext, viewportInfo: IViewportInfo): this | undefined;
+    render(mainCtx: UniverRenderingContext2D, viewportInfo: IViewportInfo): this | undefined;
     /**
      * applyCache from cache canvas
      * @param cacheCanvas Source Image
@@ -81,8 +89,8 @@ export declare class Spreadsheet extends SheetComponent {
      * @param dw
      * @param dh
      */
-    protected _applyCache(cacheCanvas: Canvas, ctx: UniverRenderingContext, sx?: number, sy?: number, sw?: number, sh?: number, dx?: number, dy?: number, dw?: number, dh?: number): void;
-    protected _draw(ctx: UniverRenderingContext, bounds?: IViewportInfo): void;
+    protected _applyCache(cacheCanvas: Canvas, ctx: UniverRenderingContext2D, sx?: number, sy?: number, sw?: number, sh?: number, dx?: number, dy?: number, dw?: number, dh?: number): void;
+    protected _draw(ctx: UniverRenderingContext2D, bounds?: IViewportInfo): void;
     private _getAncestorSize;
     private _getAncestorParent;
     private _initialDefaultExtension;
@@ -98,6 +106,6 @@ export declare class Spreadsheet extends SheetComponent {
     private _clearBackground;
     sheetContentViewport(): SHEET_VIEWPORT_KEY[];
     sheetHeaderViewport(): SHEET_VIEWPORT_KEY[];
-    testShowRuler(cacheCtx: UniverRenderingContext, viewportInfo: IViewportInfo): void;
+    testShowRuler(cacheCtx: UniverRenderingContext2D, viewportInfo: IViewportInfo): void;
     testGetRandomLightColor(): string;
 }

package/lib/types/controllers/config.schema.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export declare const PLUGIN_CONFIG_KEY = "engine-render.config";
+export declare const configSymbol: unique symbol;
+export interface IUniverEngineRenderConfig {
+}
+export declare const defaultPluginConfig: IUniverEngineRenderConfig;

package/lib/types/engine.d.ts

@@ -1,22 +1,33 @@
-import { Observable } from 'rxjs';
+import { Observable, Subject } from 'rxjs';
 import { CURSOR_TYPE } from './basics/const';
+import { ITimeMetric } from './basics/interfaces';
+import { IBasicFrameInfo } from './basics/performance-monitor';
 import { Canvas, CanvasRenderMode } from './canvas';
 import { Scene } from './scene';
 import { ThinEngine } from './thin-engine';
 export declare class Engine extends ThinEngine<Scene> {
     renderEvenInBackground: boolean;
     private readonly _beginFrame$;
-    readonly beginFrame$: Observable<void>;
+    readonly beginFrame$: Observable<number>;
     private readonly _endFrame$;
-    readonly endFrame$: Observable<void>;
+    readonly endFrame$: Observable<IBasicFrameInfo>;
+    readonly renderFrameTimeMetric$: Subject<ITimeMetric>;
+    readonly renderFrameTags$: Subject<[string, any]>;
+    /**
+     * time when render start, for elapsedTime
+     */
+    private _renderStartTime;
     private _rect$;
     get clientRect$(): Observable<void>;
     private _container;
     private _canvas;
     private _renderingQueueLaunched;
-    private _activeRenderLoops;
+    private _renderFrameTasks;
     private _renderFunction;
     private _requestNewFrameHandler;
+    /**
+     * frameCount
+     */
     private _frameId;
     private _usingSafari;
     private _resizeObserver;
@@ -44,6 +55,8 @@ export declare class Engine extends ThinEngine<Scene> {
     private _previousWidth;
     private _previousHeight;
     constructor(elemWidth?: number, elemHeight?: number, pixelRatio?: number, mode?: CanvasRenderMode);
+    _init(): void;
+    get elapsedTime(): number;
     get width(): number;
     get height(): number;
     get requestNewFrameHandler(): number;
@@ -70,8 +83,10 @@ export declare class Engine extends ThinEngine<Scene> {
      */
     resizeBySize(width: number, height: number): void;
     dispose(): void;
+    addFunction2RenderLoop(renderFunction: () => void): void;
+    startRenderLoop(): void;
     /**
-     * Register and execute a render loop. The engine can have more than one render function
+     * Register and execute a render loop. The engine could manage more than one render function
      * @param renderFunction defines the function to continuously execute
      */
     runRenderLoop(renderFunction: () => void): void;
@@ -83,11 +98,11 @@ export declare class Engine extends ThinEngine<Scene> {
     /**
      * Begin a new frame
      */
-    beginFrame(): void;
+    _beginFrame(_timestamp: number): void;
     /**
      * End the current frame
      */
-    endFrame(): void;
+    _endFrame(timestamp: number): void;
     /**
      * Gets the current framerate
      * @returns a number representing the framerate
@@ -98,11 +113,17 @@ export declare class Engine extends ThinEngine<Scene> {
      * @returns a number representing the delta time in ms
      */
     getDeltaTime(): number;
-    _renderFrame(): void;
+    /**
+     * Exec all function in _renderFrameTasks
+     */
+    private _renderFrame;
     private _cancelFrame;
     private _getHostWindow;
-    private _renderLoop;
-    private _measureFps;
+    /**
+     * call itself by raf
+     * Exec all function in _renderFrameTasks in _renderFrame()
+     */
+    private _renderFunctionCore;
     private _handleKeyboardAction;
     private _handlePointerAction;
     private _handleDragAction;

package/lib/types/render-engine.d.ts

@@ -1,11 +1,14 @@
-import { Injector, Plugin } from '@univerjs/core';
+import { IConfigService, Injector, Plugin } from '@univerjs/core';
 import { Engine } from './engine';
+import { IUniverEngineRenderConfig } from './controllers/config.schema';
 /**
  * The global rendering engine.
  */
 export declare const IRenderingEngine: import('@univerjs/core').IdentifierDecorator<Engine>;
 export declare class UniverRenderEnginePlugin extends Plugin {
+    private readonly _config;
     readonly _injector: Injector;
+    private readonly _configService;
     static pluginName: string;
-    constructor(_config: undefined, _injector: Injector);
+    constructor(_config: Partial<IUniverEngineRenderConfig>, _injector: Injector, _configService: IConfigService);
 }

package/lib/types/scene.d.ts

@@ -3,15 +3,15 @@ import { BaseObject } from './base-object';
 import { CURSOR_TYPE } from './basics/const';
 import { IDragEvent, IKeyboardEvent, IMouseEvent, IPointerEvent, IWheelEvent } from './basics/i-events';
 import { ISceneTransformState } from './basics/interfaces';
+import { ITransformerConfig } from './basics/transformer-config';
 import { Vector2 } from './basics/vector2';
 import { UniverRenderingContext } from './context';
 import { Layer } from './layer';
-import { Transformer } from './scene.transformer';
 import { SceneViewer } from './scene-viewer';
+import { Transformer } from './scene.transformer';
 import { ThinEngine } from './thin-engine';
 import { ThinScene } from './thin-scene';
 import { Viewport } from './viewport';
-import { ITransformerConfig } from './basics/transformer-config';
 import { Engine } from './engine';
 export declare class Scene extends ThinScene {
     private _parent;
@@ -68,6 +68,7 @@ export declare class Scene extends ThinScene {
     getEngine(): Nullable<Engine>;
     getLayers(): Layer[];
     getLayer(zIndex?: number): Layer;
+    findLayerByZIndex(zIndex?: number): Nullable<Layer>;
     getLayerMaxZIndex(): number;
     addLayer(...argument: Layer[]): void;
     /**
@@ -173,7 +174,12 @@ export declare class Scene extends ThinScene {
         scaleY: number;
     };
     dispose(): void;
-    pick(vec: Vector2): Nullable<BaseObject | Scene | ThinScene>;
+    /**
+     * Get the object under the pointer, if scene.event is disabled, the object is null.
+     * @param {Vector2} coord
+     * @return {Nullable<BaseObject | Scene | ThinScene>} object under the pointer
+     */
+    pick(coord: Vector2): Nullable<BaseObject | Scene | ThinScene>;
     triggerKeyDown(evt: IKeyboardEvent): void;
     triggerKeyUp(evt: IKeyboardEvent): void;
     triggerPointerUp(evt: IPointerEvent | IMouseEvent): boolean;

package/lib/types/scene.input-manager.d.ts

@@ -11,6 +11,7 @@ export declare class InputManager extends Disposable {
     static TripleClickDelay: number;
     /** If you need to check double click without raising a single click at first click, enable this flag */
     static ExclusiveDoubleClickMode: boolean;
+    private _scene;
     /** This is a defensive check to not allow control attachment prior to an already active one. If already attached, previous control is unattached before attaching the new one. */
     private _alreadyAttached;
     private _onInput$;
@@ -28,7 +29,6 @@ export declare class InputManager extends Disposable {
     private _onDragLeave;
     private _onDragOver;
     private _onDrop;
-    private _scene;
     private _currentMouseEnterPicked;
     private _startingPosition;
     private _delayedTimeout;
@@ -48,7 +48,13 @@ export declare class InputManager extends Disposable {
      * Detaches all event handlers
      */
     detachControl(): void;
-    private _getCurrentObject;
+    /**
+     * Just call this._scene?.pick, nothing special.
+     * @param offsetX
+     * @param offsetY
+     * @returns
+     */
+    private _getObjectAtPos;
     private _checkDirectSceneEventTrigger;
     /**
      * @hidden

package/lib/types/scroll-timer.d.ts

@@ -19,6 +19,9 @@ export declare class ScrollTimer {
     private _moveY;
     private _scrollX;
     private _scrollY;
+    /**
+     * Custmize scroll function.
+     */
     private _scrollFunction;
     constructor(_scene: Scene, _scrollTimerType?: ScrollTimerType, _padding?: IPaddingData | undefined);
     static create(scene: any, scrollTimerType?: ScrollTimerType, padding?: IPaddingData): ScrollTimer;
@@ -27,7 +30,7 @@ export declare class ScrollTimer {
     setActiveViewport(viewport: Viewport): void;
     getActiveViewport(): any;
     startScroll(offsetX: number, offsetY: number, targetViewport?: any): void;
-    private _scroll;
+    private _autoScroll;
     scrolling(offsetX: number, offsetY: number, scrollFunction: (x?: number, y?: number) => void): void;
     stopScroll(): void;
     dispose(): void;

package/lib/types/thin-scene.d.ts

@@ -43,14 +43,19 @@ export declare abstract class ThinScene extends Disposable {
     get scaleX(): number;
     get scaleY(): number;
     get sceneKey(): string;
-    get evented(): boolean;
+    get objectsEvented(): boolean;
     set transform(trans: Transform);
     set width(num: number);
     set height(num: number);
     set scaleX(scaleX: number);
     set scaleY(scaleY: number);
-    enableEvent(): void;
-    disableEvent(): void;
+    enableObjectsEvent(): void;
+    /**
+     * If scene.event is disabled, scene.pick(curosrPos) return null.
+     * Then only scene itself can response to pointer event, all objects under the scene would not.
+     * see sceneInputManager@_onPointerMove
+     */
+    disableObjectsEvent(): void;
     triggerKeyDown(evt: IKeyboardEvent): void;
     triggerKeyUp(evt: IKeyboardEvent): void;
     abstract triggerPointerUp(evt: IPointerEvent | IMouseEvent): void;