@univerjs/engine-render 1.0.0-alpha.6 → 1.0.0-alpha.8

package/lib/types/index.d.ts

@@ -15,6 +15,8 @@
  */
 export * from './base-object';
 export * from './basics';
+export { combineDrawingEffectFilter, createDrawingEffectFilter, expandDrawingEffectBounds, resolveDrawingEffectMasks, resolveGlowEffect, resolveOuterShadowEffect, } from './basics/drawing-effect';
+export type { IResolvedDrawingShadow } from './basics/drawing-effect';
 export { getOffsetRectForDom } from './basics/position';
 export * from './canvas';
 export * from './components';
@@ -34,7 +36,7 @@ export type { IDocumentSkeletonColumnPagePathInfo, IDocumentSkeletonLineContext,
 export { getLastColumn } from './components/docs/layout/tools';
 export { Liquid } from './components/docs/liquid';
 export type { DocsTableRenderViewportProvider, IDocsTableRenderViewport, } from './components/docs/table-render-viewport';
-export { getDocsTableRenderViewport, setDocsTableRenderViewportProvider, } from './components/docs/table-render-viewport';
+export { getDocsTableRenderViewport, getDocsTableViewportLeft, setDocsTableRenderViewportProvider, } from './components/docs/table-render-viewport';
 export { DataStreamTreeNode } from './components/docs/view-model/data-stream-tree-node';
 export { DocumentViewModel } from './components/docs/view-model/document-view-model';
 export { DocumentEditArea } from './components/docs/view-model/document-view-model';
@@ -48,7 +50,7 @@ export type { IDrawingGroupShadow } from './drawing-group';
 export * from './engine';
 export * from './group';
 export * from './layer';
-export { IRenderingEngine, UniverRenderEnginePlugin } from './plugin';
+export { UniverRenderEnginePlugin } from './plugin';
 export { getCurrentTypeOfRenderer, IRenderManagerService, RenderManagerService, withCurrentTypeOfRenderer, } from './render-manager/render-manager.service';
 export { type RenderComponentType } from './render-manager/render-manager.service';
 export { RenderUnit } from './render-manager/render-unit';

package/lib/types/plugin.d.ts

@@ -15,13 +15,6 @@
  */
 import type { IUniverEngineRenderConfig } from './config/config';
 import { IConfigService, Injector, Plugin } from '@univerjs/core';
-import { Engine } from './engine';
-/**
- * The global rendering engine.
- *
- * @deprecated There will be no more default global render engine in the future.
- */
-export declare const IRenderingEngine: import("@wendellhu/redi").IdentifierDecorator<Engine>;
 export declare class UniverRenderEnginePlugin extends Plugin {
     private readonly _config;
     readonly _injector: Injector;

package/lib/types/render-manager/render-manager.service.d.ts

@@ -33,12 +33,6 @@ export interface IRenderManagerService extends IDisposable {
      */
     createRender(unitId: string, createUnitOptions?: ICreateUnitOptions): IRender;
     removeRender(unitId: string): void;
-    /**
-     * @deprecated use getRenderUnitById instead
-     * Get RenderUnit By Id, RenderUnit implements IRender
-     * @param unitId
-     */
-    getRenderById(unitId: string): Nullable<IRender>;
     /**
      * Get RenderUnit By Id, RenderUnit implements IRender
      * @param unitId
@@ -47,10 +41,6 @@ export interface IRenderManagerService extends IDisposable {
     getAllRenderersOfType(type: UniverInstanceType): RenderUnit[];
     getRenderAll(): Map<string, IRender>;
     defaultEngine: Engine;
-    /** @deprecated */
-    createRender$: Observable<string>;
-    /** @deprecated this design is very very weird! Remove it. */
-    create(unitId: string): void;
     created$: Observable<IRender>;
     disposed$: Observable<string>;
     has(unitId: string): boolean;
@@ -67,9 +57,6 @@ export declare class RenderManagerService extends Disposable implements IRenderM
     private readonly _themeService;
     private _defaultEngine;
     private _renderMap;
-    private readonly _createRender$;
-    /** @deprecated */
-    readonly createRender$: Observable<string>;
     private readonly _renderCreated$;
     readonly created$: Observable<IRender>;
     private readonly _renderDisposed$;
@@ -92,7 +79,6 @@ export declare class RenderManagerService extends Disposable implements IRenderM
      */
     private _getRenderDepsByType;
     private _initDarkModeListener;
-    create(unitId: string): void;
     /**
      * create renderUnit & init deps from renderDependencies
      * @param unitId
@@ -118,13 +104,6 @@ export declare class RenderManagerService extends Disposable implements IRenderM
     private _addRenderUnit;
     removeRender(unitId: string): void;
     has(unitId: string): boolean;
-    /**
-     * @deprecated use getRenderUnitById instead
-     * Get RenderUnit from this._renderMap.
-     * @param unitId
-     * @returns RenderUnit, aka IRender
-     */
-    getRenderById(unitId: string): Nullable<IRender>;
     getRenderUnitById(unitId: string): Nullable<IRender>;
     getRenderAll(): Map<string, IRender>;
     private _disposeItem;

package/lib/types/scene.d.ts

@@ -15,7 +15,7 @@
  */
 import type { Nullable } from '@univerjs/core';
 import type { BaseObject } from './base-object';
-import type { IDragEvent, IKeyboardEvent, IMouseEvent, IPointerEvent, IWheelEvent } from './basics/i-events';
+import type { IDragEvent, IMouseEvent, IPointerEvent, IWheelEvent } from './basics/i-events';
 import type { ISceneTransformState, ITransformChangeState } from './basics/interfaces';
 import type { ITransformerConfig } from './basics/transformer-config';
 import type { Vector2 } from './basics/vector2';
@@ -77,14 +77,6 @@ export declare class Scene extends Disposable {
     onDblclick$: EventSubject<IMouseEvent | IPointerEvent>;
     onTripleClick$: EventSubject<IMouseEvent | IPointerEvent>;
     onMouseWheel$: EventSubject<IWheelEvent>;
-    /**
-     * @deprecated  use `fromGlobalEvent('keydown')` from rx.js instead.
-     */
-    onKeyDown$: EventSubject<IKeyboardEvent>;
-    /**
-     * @deprecated  use `fromGlobalEvent('keyup')` from rx.js instead.
-     */
-    onKeyUp$: EventSubject<IKeyboardEvent>;
     private _beforeRender$;
     readonly beforeRender$: import("rxjs").Observable<Nullable<Canvas>>;
     private _afterRender$;
@@ -137,12 +129,6 @@ export declare class Scene extends Disposable {
     resetCursor(): void;
     setCursor(val: CURSOR_TYPE): void;
     setDefaultCursor(val: CURSOR_TYPE): void;
-    /**
-     * @deprecated use transformByState instead.
-     * @param width
-     * @param height
-     */
-    resize(width?: number, height?: number): this;
     /**
      * Unlike @scale, this method doesn't emit event.
      * @param scaleX
@@ -252,15 +238,6 @@ export declare class Scene extends Disposable {
      */
     findViewportByPosToScene(coord: Vector2): Viewport | undefined;
     getActiveViewportByCoord(coord: Vector2): Viewport | undefined;
-    /**
-     * @deprecated use `getScrollXYInfoByViewport` instead.
-     * @param pos
-     * @param viewPort
-     */
-    getVpScrollXYInfoByPosToVp(pos: Vector2, viewPort?: Viewport): {
-        x: number;
-        y: number;
-    };
     /**
      * getViewportScrollXYInfo by viewport under cursor position
      * prev getScrollXYByRelativeCoords
@@ -276,12 +253,6 @@ export declare class Scene extends Disposable {
         x: number;
         y: number;
     };
-    /**
-     * @deprecated use `getCoordRelativeToViewport` instead
-     * @param coord
-     * @returns
-     */
-    getRelativeToViewportCoord(coord: Vector2): Vector2;
     /**
      * Get coord to active viewport.
      * In a nested scene scenario, it is necessary to obtain the relative offsets layer by layer.

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

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import type { BaseObject } from './base-object';
-import type { IDragEvent, IKeyboardEvent, IMouseEvent, IPointerEvent, IWheelEvent } from './basics/i-events';
+import type { IDragEvent, IMouseEvent, IPointerEvent, IWheelEvent } from './basics/i-events';
 import type { ISceneInputControlOptions, Scene } from './scene';
 import { Disposable } from '@univerjs/core';
 export declare class InputManager extends Disposable {
@@ -55,8 +55,6 @@ export declare class InputManager extends Disposable {
     _onPointerCancel(evt: IPointerEvent): void;
     _onPointerOut(evt: IPointerEvent): void;
     _onMouseWheel(evt: IWheelEvent): void;
-    _onKeyDown(evt: IKeyboardEvent): void;
-    _onKeyUp(evt: IKeyboardEvent): void;
     _onDragEnter(evt: IDragEvent): void;
     _onDragLeave(evt: IDragEvent): void;
     _onDragOver(evt: IDragEvent): void;

package/lib/types/shape/index.d.ts

@@ -19,6 +19,7 @@ export * from './control';
 export * from './dashedrect';
 export * from './drawing';
 export * from './image';
+export { type ILineProps, Line } from './line';
 export * from './path';
 export * from './rect';
 export * from './regular-polygon';

package/lib/types/shape/line.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * 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 type { IPosition } from '@univerjs/core';
+import type { Vector2 } from '../basics/vector2';
+import type { UniverRenderingContext } from '../context';
+import type { IShapeProps } from './shape';
+import { Shape } from './shape';
+export interface ILineProps extends Omit<IShapeProps, 'left' | 'top' | 'width' | 'height'>, IPosition {
+}
+/**
+ * A line segment defined by two endpoints in its parent's coordinate system.
+ *
+ * The BaseObject bounds are derived internally so callers only describe line geometry.
+ */
+export declare class Line extends Shape<ILineProps> {
+    private _startX;
+    private _startY;
+    private _endX;
+    private _endY;
+    constructor(key?: string, props?: ILineProps);
+    get startX(): number;
+    get startY(): number;
+    get endX(): number;
+    get endY(): number;
+    static drawWith(ctx: UniverRenderingContext, props: ILineProps): void;
+    setPoints(position: IPosition): this;
+    setProps(props?: Partial<ILineProps>): this;
+    isHit(coord: Vector2): boolean;
+    toJson(): {
+        startX: number;
+        startY: number;
+        endX: number;
+        endY: number;
+    };
+    protected _draw(ctx: UniverRenderingContext): void;
+    private static _drawSegment;
+}

package/lib/types/shape/shape.d.ts

@@ -15,7 +15,7 @@
  */
 import type { IOffset, IScale, ISize, Nullable } from '@univerjs/core';
 import type { IObjectFullState } from '../basics/interfaces';
-import type { IViewportInfo, Vector2 } from '../basics/vector2';
+import type { IBoundRectNoAngle, IViewportInfo, Vector2 } from '../basics/vector2';
 import type { UniverRenderingContext } from '../context';
 import { BaseObject, ObjectType } from '../base-object';
 export type LineJoin = 'round' | 'bevel' | 'miter';
@@ -55,6 +55,9 @@ export interface IShapeProps extends IObjectFullState, ISize, IOffset, IScale {
 }
 export declare const SHAPE_OBJECT_ARRAY: string[];
 export declare abstract class Shape<T extends IShapeProps> extends BaseObject {
+    private _renderCacheCanvas;
+    private _renderCacheBounds;
+    private _renderCachePixelRatio;
     private _hoverCursor;
     private _moveCursor;
     private _fillRule;
@@ -129,6 +132,9 @@ export declare abstract class Shape<T extends IShapeProps> extends BaseObject {
     toJson(): {
         [x: string]: any;
     };
+    protected _renderWithCache(ctx: UniverRenderingContext, bounds: IBoundRectNoAngle, draw: (cacheContext: UniverRenderingContext) => void): void;
+    protected _releaseRenderCache(): void;
     protected _draw(ctx: UniverRenderingContext, bounds?: IViewportInfo): void;
     private _initialProps;
+    dispose(): void;
 }

package/lib/types/viewport.d.ts

@@ -99,6 +99,7 @@ export interface IViewportReSizeParam {
 }
 export declare class Viewport {
     private _viewportKey;
+    private _transformChangeSubscription?;
     /**
      * scrollX means scroll x value for scrollbar in viewMain
      * use getBarScroll to get scrolling value(scrollX, scrollY) for scrollbar
@@ -345,11 +346,6 @@ export declare class Viewport {
     render(parentCtx?: UniverRenderingContext, objects?: BaseObject[], isMaxLayer?: boolean): void;
     private _makeDefaultViewport;
     calcViewportInfo(): IViewportInfo;
-    /**
-     * Get viewport info
-     * @deprecated use `calcViewportInfo`
-     */
-    getBounding(): IViewportInfo;
     /**
      * convert vector to scene coordinate, include row & col
      * @param vec