@univerjs/engine-render 0.10.1 → 0.10.2

package/lib/types/base-object.d.ts

@@ -139,6 +139,7 @@ export declare abstract class BaseObject extends Disposable {
     skew(skewX?: number, skewY?: number): this;
     flip(flipX?: boolean, flipY?: boolean): this;
     /**
+     * Similar to setProps, but only props in BASE_OBJECT_ARRAY_Set
      * this[pKey] = option[pKey]
      * @param option
      */

package/lib/types/scene.d.ts

@@ -152,12 +152,18 @@ export declare class Scene extends Disposable {
     getParent(): Engine | SceneViewer;
     getEngine(): Nullable<Engine>;
     getLayers(): Layer[];
+    /**
+     * Get layer by zIndex.
+     * This method would create a new Layer if Layer is not exist.
+     * @param zIndex
+     */
     getLayer(zIndex?: number): Layer;
     findLayerByZIndex(zIndex?: number): Nullable<Layer>;
     getLayerMaxZIndex(): number;
     addLayer(...argument: Layer[]): void;
     /**
-     * Add objects to Layer( Layer is specfied by zIndex)
+     * Add objects to Layer( Layer is specified by zIndex)
+     * This method would create a new Layer if Layer is not exist.
      * If object is a group, insert all its children and group itself to _objects[].
      * @param objects
      * @param zIndex
@@ -166,7 +172,8 @@ export declare class Scene extends Disposable {
     addObjects(objects: BaseObject[], zIndex?: number): Scene;
     /**
      * Add object to Layer (Layer is specified by zIndex).
-     * If object is a group, insert all its children and group itself to _objects[].
+     * This method would create a new Layer if Layer is not exist.
+     * And if object is a group, insert all its children and group itself to _objects[].
      * @param o
      * @param zIndex layer index
      * @returns {Scene} scene
@@ -312,8 +319,9 @@ export declare class Scene extends Disposable {
      */
     private _transformHandler;
     /**
+     * Disable scene.event
      * 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.
+     * After disableObjectsEvent, only the scene itself can respond to pointer events; objects beneath the scene will not.
      * see sceneInputManager@_onPointerMove
      */
     disableObjectsEvent(): void;

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

@@ -66,6 +66,13 @@ export declare class InputManager extends Disposable {
      * @param currentObject
      * @returns
      */
+    /**
+     * If return true,  the event will be dispatched to Scene
+     * Even Scene is not a object, but scene could handle event.
+     * currentObject is null, return true
+     * @param currentObject
+     * @returns boolean
+     */
     private _shouldDispatchEventToScene;
     private _isObjectInSceneViewer;
     /**

package/lib/types/shape/scroll-bar.d.ts

@@ -33,34 +33,16 @@ export interface IScrollBarProps {
     minThumbSizeV?: number;
 }
 export declare class ScrollBar extends Disposable {
-    _enableHorizontal: boolean;
-    _enableVertical: boolean;
-    horizontalThumbSize: number;
-    horizontalMinusMiniThumb: number;
-    horizontalTrackWidth: number;
-    horizonScrollTrack: Nullable<Rect>;
-    horizonThumbRect: Nullable<Rect>;
-    verticalThumbSize: number;
-    verticalTrackHeight: number;
-    verticalMinusMiniThumb: number;
-    verticalScrollTrack: Nullable<Rect>;
-    verticalThumbRect: Nullable<Rect>;
-    placeholderBarRect: Nullable<Rect>;
+    private _enableHorizontal;
+    private _enableVertical;
+    private _horizontalMetrics;
+    private _verticalMetrics;
+    private _scrollElements;
     protected _viewport: Viewport;
     private _mainScene;
-    private _lastX;
-    private _lastY;
-    private _isHorizonMove;
-    private _isVerticalMove;
-    private _horizonPointerMoveSub;
-    private _horizonPointerUpSub;
-    private _verticalPointerMoveSub;
-    private _verticalPointerUpSub;
-    private _thumbDefaultBackgroundColor;
-    private _thumbHoverBackgroundColor;
-    private _thumbActiveBackgroundColor;
-    private _trackBackgroundColor;
-    private _trackBorderColor;
+    private _pointerState;
+    private _subscriptions;
+    private _colors;
     /**
      * The thickness of a scrolling track
      * ThumbSize = trackSize - thumbMargin * 2
@@ -85,6 +67,8 @@ export declare class ScrollBar extends Disposable {
     private _eventSub;
     constructor(view: Viewport, props?: IScrollBarProps);
     setProps(props?: IScrollBarProps): void;
+    get verticalScrollTrack(): Nullable<Rect<import('./rect').IRectProps>>;
+    get horizonScrollTrack(): Nullable<Rect<import('./rect').IRectProps>>;
     get enableHorizontal(): boolean;
     set enableHorizontal(val: boolean);
     get enableVertical(): boolean;
@@ -95,6 +79,10 @@ export declare class ScrollBar extends Disposable {
     get ratioScrollY(): number;
     get miniThumbRatioX(): number;
     get miniThumbRatioY(): number;
+    get horizontalTrackWidth(): number;
+    get horizontalThumbSize(): number;
+    get verticalTrackHeight(): number;
+    get verticalThumbSize(): number;
     hasHorizonThumb(): boolean;
     hasVerticalThumb(): boolean;
     get scrollHorizonThumbThickness(): number;
@@ -125,11 +113,13 @@ export declare class ScrollBar extends Disposable {
     makeViewDirty(state: boolean): void;
     pick(coord: Vector2): Rect<import('./rect').IRectProps> | null;
     private _initialScrollRect;
+    private _setHorizonEvented;
+    private _setVerticalEvented;
     private _initialVerticalEvent;
+    private _initialHorizontalEvent;
     private _horizonHoverFunc;
     private _horizonHoverLeaveFunc;
     private _verticalHoverFunc;
     private _verticalHoverLeaveFunc;
     private _hoverFunc;
-    private _initialHorizontalEvent;
 }

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

@@ -106,7 +106,8 @@ export declare abstract class Shape<T extends IShapeProps> extends BaseObject {
     private static _setStrokeStyles;
     render(mainCtx: UniverRenderingContext, bounds?: IViewportInfo): this;
     /**
-     * if BASE_OBJECT_ARRAY_Set.has(key) not exist, then this[_key] = props[key],
+     * if props not in BASE_OBJECT_ARRAY_Set then this[_key] = props[key]
+     * if props in BASE_OBJECT_ARRAY_Set, You should use transformByState
      * @param props
      */
     setProps(props?: T): Shape<T>;