@univerjs/engine-render 0.6.0-alpha.0 → 0.6.0-experimental.20250212-dbe9830

package/lib/types/scene.d.ts

@@ -25,7 +25,13 @@ export interface ISceneInputControlOptions {
 export declare class Scene extends Disposable {
     private _parent;
     private _sceneKey;
+    /**
+     * Width of scene content, does not affected by zoom.
+     */
     private _width;
+    /**
+     * Height of scene content, does not affected by zoom.
+     */
     private _height;
     private _scaleX;
     private _scaleY;
@@ -87,8 +93,18 @@ export declare class Scene extends Disposable {
     set height(num: number);
     set scaleX(scaleX: number);
     set scaleY(scaleY: number);
+    /**
+     * ancestorScaleX means this.scaleX * ancestorScaleX
+     */
     get ancestorScaleX(): number;
+    /**
+     * ancestorScaleY means this.scaleY * ancestorScaleY
+     */
     get ancestorScaleY(): number;
+    getAncestorScale(): {
+        scaleX: number;
+        scaleY: number;
+    };
     get ancestorLeft(): number;
     get ancestorTop(): number;
     set cursor(val: CURSOR_TYPE);
@@ -103,8 +119,18 @@ 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;
-    setScaleValue(scaleX: number, scaleY: number): void;
+    /**
+     * Unlike @scale, this method doesn't emit event.
+     * @param scaleX
+     * @param scaleY
+     */
+    setScaleValueOnly(scaleX: number, scaleY: number): void;
     /**
      * Set scale, and then emit event to update Viewport scroll state.
      * @param scaleX
@@ -113,9 +139,9 @@ export declare class Scene extends Disposable {
      */
     scale(scaleX?: number, scaleY?: number): this;
     /**
-     * current scale plus offset, relative
+     * Apply scaleXY base on current scaleX and scaleY
      */
-    scaleBy(scaleX?: number, scaleY?: number): this;
+    scaleBy(deltaScaleX?: number, deltaScaleY?: number): this;
     /**
      * Reset canvas size and update scroll
      * @param state
@@ -249,10 +275,6 @@ export declare class Scene extends Disposable {
     getCoordRelativeToViewport(coord: Vector2): Vector2;
     clearLayer(): void;
     clearViewports(): void;
-    getAncestorScale(): {
-        scaleX: number;
-        scaleY: number;
-    };
     getPrecisionScale(): {
         scaleX: number;
         scaleY: number;
@@ -280,7 +302,12 @@ export declare class Scene extends Disposable {
     triggerDragEnter(evt: IDragEvent): boolean;
     triggerDrop(evt: IDragEvent): boolean;
     private _createDefaultLayer;
-    private _setTransForm;
+    /**
+     * Triggered when scale, resize of scene.
+     * origin name: _setTransForm
+     *
+     */
+    private _transformHandler;
     /**
      * If scene.event is disabled, scene.pick(cursor Pos) return null.
      * Then only scene itself can response to pointer event, all objects under the scene would not.

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

@@ -1,5 +1,5 @@
 /**
- * Copyright 2023-present DreamNum Inc.
+ * 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.

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

@@ -1,5 +1,5 @@
 /**
- * Copyright 2023-present DreamNum Inc.
+ * 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.

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

@@ -1,5 +1,5 @@
 /**
- * Copyright 2023-present DreamNum Inc.
+ * 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.

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

@@ -1,5 +1,5 @@
 /**
- * Copyright 2023-present DreamNum Inc.
+ * 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.

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

@@ -1,5 +1,5 @@
 /**
- * Copyright 2023-present DreamNum Inc.
+ * 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.

package/lib/types/viewport.d.ts

@@ -80,8 +80,8 @@ export declare class Viewport {
      * scrollX means scroll x value for scrollbar in viewMain
      * use getBarScroll to get scrolling value(scrollX, scrollY) for scrollbar
      */
-    scrollX: number;
-    scrollY: number;
+    _scrollX: number;
+    _scrollY: number;
     private _preScrollX;
     private _preScrollY;
     /**
@@ -200,6 +200,10 @@ export declare class Viewport {
     get viewportScrollX(): number;
     set viewportScrollY(val: number);
     get viewportScrollY(): number;
+    set scrollX(val: number);
+    set scrollY(val: number);
+    get scrollX(): number;
+    get scrollY(): number;
     set top(num: number);
     set left(num: number);
     set bottom(num: number);
@@ -216,6 +220,9 @@ export declare class Viewport {
     get canvas(): UniverCanvas | null;
     enable(): void;
     disable(): void;
+    /**
+     * canvas resize & freeze change would invoke this method
+     */
     resetCanvasSizeAndUpdateScroll(): void;
     setScrollBar(instance: BaseScrollBar): void;
     removeScrollBar(): void;