@univerjs/engine-render 0.6.10 → 0.7.0-beta.1

package/lib/types/canvas.d.ts

@@ -1,3 +1,4 @@
+import { ICanvasColorService } from './services/canvas-color.service';
 import { UniverRenderingContext } from './context';
 /**
  * canvas render mode
@@ -15,11 +16,12 @@ export declare enum CanvasRenderMode {
     Printing = 1
 }
 interface ICanvasProps {
+    colorService?: ICanvasColorService;
+    id?: string;
     width?: number;
     height?: number;
     pixelRatio?: number;
     mode?: CanvasRenderMode;
-    id?: string;
 }
 /**
  * View Renderer constructor. It is a wrapper around native canvas element.
@@ -38,7 +40,7 @@ export declare class Canvas {
     private _context;
     private _width;
     private _height;
-    constructor(props?: ICanvasProps);
+    constructor(_props?: ICanvasProps);
     getCanvasEle(): HTMLCanvasElement;
     /**
      * get canvas context

package/lib/types/context.d.ts

@@ -1,4 +1,8 @@
+import { ICanvasColorService } from './services/canvas-color.service';
 import { IRenderConfig } from './services/render-config';
+export interface IUniverRenderingContextOptions {
+    canvasColorService?: ICanvasColorService;
+}
 export declare class UniverRenderingContext2D implements CanvasRenderingContext2D {
     __mode: string;
     private _transformCache;
@@ -7,7 +11,8 @@ export declare class UniverRenderingContext2D implements CanvasRenderingContext2
     private _systemType;
     private _browserType;
     renderConfig: Readonly<IRenderConfig>;
-    constructor(context: CanvasRenderingContext2D);
+    private _canvasColorService?;
+    constructor(context: CanvasRenderingContext2D, options?: IUniverRenderingContextOptions);
     private _id;
     getId(): string;
     setId(id: string): void;

package/lib/types/engine.d.ts

@@ -6,6 +6,7 @@ import { Scene } from './scene';
 import { Disposable, EventSubject } from '@univerjs/core';
 import { Observable, Subject } from 'rxjs';
 import { Canvas, CanvasRenderMode } from './canvas';
+import { ICanvasColorService } from './services/canvas-color.service';
 export interface IEngineOption {
     elementWidth: number;
     elementHeight: number;
@@ -13,6 +14,7 @@ export interface IEngineOption {
     renderMode?: CanvasRenderMode;
 }
 export declare class Engine extends Disposable {
+    readonly canvasColorService?: ICanvasColorService | undefined;
     renderEvenInBackground: boolean;
     private readonly _beginFrame$;
     readonly beginFrame$: Observable<number>;
@@ -23,8 +25,8 @@ export declare class Engine extends Disposable {
     /**
      * Pass event to scene.input-manager
      */
-    onInputChanged$: EventSubject<IEvent>;
-    onTransformChange$: EventSubject<ITransformChangeState>;
+    readonly onInputChanged$: EventSubject<IEvent>;
+    readonly onTransformChange$: EventSubject<ITransformChangeState>;
     private _scenes;
     private _activeScene;
     /**
@@ -38,9 +40,6 @@ export declare class Engine extends Disposable {
     private _renderingQueueLaunched;
     private _renderFrameTasks;
     private _requestNewFrameHandler;
-    /**
-     * frameCount
-     */
     private _frameId;
     private _usingSafari;
     private _resizeObserver;
@@ -70,16 +69,13 @@ export declare class Engine extends Disposable {
     private _previousWidth;
     private _previousHeight;
     private _unitId;
-    constructor();
-    constructor(unitId: string, options?: IEngineOption);
-    constructor(elemW: number, elemH: number, dpr?: number, renderMode?: CanvasRenderMode);
-    _init(): void;
     get unitId(): string;
     get elapsedTime(): number;
     get width(): number;
     get height(): number;
     get classType(): RENDER_CLASS_TYPE;
     get activeScene(): Scene | null;
+    constructor(unitId?: string, _options?: IEngineOption, canvasColorService?: ICanvasColorService | undefined);
     getScenes(): {
         [sceneKey: string]: Scene;
     };

package/lib/types/index.d.ts

@@ -18,7 +18,6 @@ export * from './basics';
 export { getOffsetRectForDom } from './basics/position';
 export * from './canvas';
 export * from './components';
-export { UniverRenderConfigService } from './services/render-config.service';
 export { DocBackground } from './components/docs/doc-background';
 export { Documents } from './components/docs/document';
 export type { IPageRenderConfig } from './components/docs/document';
@@ -40,7 +39,8 @@ export * from './engine';
 export * from './group';
 export * from './layer';
 export { IRenderingEngine, UniverRenderEnginePlugin } from './plugin';
-export { getCurrentTypeOfRenderer, IRenderManagerService, type RenderComponentType, RenderManagerService, withCurrentTypeOfRenderer } from './render-manager/render-manager.service';
+export { getCurrentTypeOfRenderer, IRenderManagerService, type RenderComponentType, RenderManagerService, withCurrentTypeOfRenderer, } from './render-manager/render-manager.service';
+export { CanvasColorService, DumbCanvasColorService, ICanvasColorService } from './services/canvas-color.service';
 export { type IRender, type IRenderContext, type IRenderModule, RenderUnit } from './render-manager/render-unit';
 export * from './scene';
 export { type IChangeObserverConfig } from './scene.transformer';

package/lib/types/plugin.d.ts

@@ -3,6 +3,8 @@ 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 {
@@ -11,4 +13,5 @@ export declare class UniverRenderEnginePlugin extends Plugin {
     private readonly _configService;
     static pluginName: string;
     constructor(_config: Partial<IUniverEngineRenderConfig> | undefined, _injector: Injector, _configService: IConfigService);
+    onStarting(): void;
 }

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

@@ -44,8 +44,8 @@ export interface IRenderManagerService extends IDisposable {
     registerRenderModule<T extends UnitModel>(type: UnitType, dep: Dependency<T>): IDisposable;
 }
 export declare class RenderManagerService extends Disposable implements IRenderManagerService {
-    private readonly _injector;
-    private readonly _univerInstanceService;
+    protected readonly _injector: Injector;
+    protected readonly _univerInstanceService: IUniverInstanceService;
     private _defaultEngine;
     private _renderMap;
     private readonly _createRender$;

package/lib/types/scene.d.ts

@@ -305,7 +305,6 @@ export declare class Scene extends Disposable {
     triggerDragOver(evt: IDragEvent): boolean;
     triggerDragEnter(evt: IDragEvent): boolean;
     triggerDrop(evt: IDragEvent): boolean;
-    private _createDefaultLayer;
     /**
      * Triggered when scale, resize of scene.
      * origin name: _setTransForm

package/lib/types/services/canvas-color.service.d.ts

@@ -0,0 +1,25 @@
+import { RGBColor } from './utils';
+import { Disposable, ThemeService } from '@univerjs/core';
+export declare const ICanvasColorService: import('@wendellhu/redi').IdentifierDecorator<ICanvasColorService>;
+/**
+ * This service maps a color or a theme-token to a color for rendering. Univer supports themes for rendering
+ * and dark mode. This services is responsible for abstract this complexity for rendering components.
+ */
+export interface ICanvasColorService {
+    getRenderColor(color: string): string;
+}
+export declare class DumbCanvasColorService implements ICanvasColorService {
+    getRenderColor(color: string): string;
+}
+/**
+ * This service inverts a color for dark mode. This service is exposed
+ */
+export declare class CanvasColorService extends Disposable implements ICanvasColorService {
+    private readonly _themeService;
+    private readonly _cache;
+    private _invertAlgo;
+    constructor(_themeService: ThemeService);
+    getRenderColor(color: string): string;
+}
+export declare function hexToRgb(_hex: string): RGBColor;
+export declare function rgbToHex(rgbColor: RGBColor): string;

package/lib/types/services/invert-hsl.d.ts

@@ -0,0 +1,3 @@
+import { RGBColor } from './utils';
+export declare function stringToRgb(color: string): RGBColor;
+export declare function invertColorByHSL(color: RGBColor): RGBColor;

package/lib/types/services/invert-rgb.d.ts

@@ -0,0 +1,7 @@
+import { RGBColor } from './utils';
+/**
+ * Invert a color by RGB matrix method.
+ * @param color The color to invert. Note that this color is already normalized.
+ * @returns The inverted color.
+ */
+export declare function invertColorByMatrix(color: RGBColor): RGBColor;

package/lib/types/services/render-config.service.d.ts

@@ -16,6 +16,8 @@
 /**
  * This service carries managers render config that would be passed
  * to every widget, so some rendering could be optimized.
+ *
+ * @deprecated Will be replaced by ICanvasColorService.
  */
 export declare class UniverRenderConfigService {
     private readonly _renderConfig;

package/lib/types/services/utils.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ */
+export type RGBColor = [number, number, number];
+export type HSLColor = RGBColor;
+export declare function normalizeRGBColor(color: RGBColor): RGBColor;
+export declare function denormalizeRGBColor(color: RGBColor): RGBColor;

package/lib/types/viewport.d.ts

@@ -178,7 +178,7 @@ export declare class Viewport {
     bufferEdgeX: number;
     bufferEdgeY: number;
     constructor(viewportKey: string, scene: Scene, props?: IViewProps);
-    initCacheCanvas(props?: IViewProps): void;
+    initCacheCanvas(props: IViewProps | undefined, scene: Scene): void;
     get scene(): Scene;
     get width(): Nullable<number>;
     get height(): Nullable<number>;