@univerjs-pro/engine-shape 0.25.1 → 1.0.0-alpha.1

package/lib/types/index.d.ts

@@ -1,8 +1,8 @@
-export { BasicShapeModel as ShapeModel } from '../src/model/shape-model';
+export { BasicShapeModel as ShapeModel } from '../src/models/shape-model';
 export { LineShapeRenderModel } from '../src/render-engine/line-shape-render-model';
 export { BaseShapeRenderModel } from '../src/render-engine/shape-render-model';
-export { BasicShapeEnum, ImageFillModeEnum, ImageSourceTypeEnum, ShapeArrowSizeEnum, ShapeArrowTypeEnum, ShapeFillEnum, ShapeGradientTypeEnum, ShapeLineCapEnum, ShapeLineDashEnum, ShapeLineJoinEnum, ShapeLineTypeEnum, ShapeOperatorEnum, ShapeRenderModeEnum, ShapeSketchTypeEnum, ShapeTypeEnum } from '../src/shape-enum';
-export type { IBasicShapeData, IConnectorLayoutResult, IConnectorRouteLayoutResult, IConnectPointInfo, ICustomShapeTextData, ICxnShapeData, IDrawingRect, IGdContext, IGdContextBase, ILineType, IPathCommand, IPresetShapeConfig, IShapeAdjustItem, IShapeAdjustItemResolved, IShapeContextOptions, IShapeData, IShapeHitTestResult, IShapeJSONData, IShapeLineStyle, IShapeModel, IShapePath, IShapePoint, IShapePointWithAdjName, IShapeRect, IShapeRelation, IShapeRelationItem, IShapeRenderParameters, IShapeText, ShapeAdjustHandleTypeEnum, ShapeHitTestHitTypeEnum, } from '../src/shape-type';
+export { BasicShapeEnum, ImageFillModeEnum, ImageSourceTypeEnum, ShapeArrowSizeEnum, ShapeArrowTypeEnum, ShapeFillEnum, ShapeGradientTypeEnum, ShapeLineCapEnum, ShapeLineDashEnum, ShapeLineJoinEnum, ShapeLineTypeEnum, ShapeOperatorEnum, ShapePresetShadowValEnum, ShapeRenderModeEnum, ShapeSketchTypeEnum, ShapeTypeEnum } from '../src/shape-enum';
+export type { IBasicShapeData, IConnectorLayoutResult, IConnectorRouteLayoutResult, IConnectPointInfo, ICustomShapeTextData, ICxnShapeData, IDrawingRect, IGdContext, IGdContextBase, ILineType, IPathCommand, IPresetShapeConfig, IShapeAdjustItem, IShapeAdjustItemResolved, IShapeContextOptions, IShapeData, IShapeHitTestResult, IShapeJSONData, IShapeLineStyle, IShapeModel, IShapePath, IShapePoint, IShapePointWithAdjName, IShapeRect, IShapeRelation, IShapeRelationItem, IShapeRenderParameters, IShapeShadowEffect, IShapeText, IShapeTextRectPadding, ShapeAdjustHandleTypeEnum, ShapeHitTestHitTypeEnum, ShapeTextDirection, } from '../src/shape-type';
 export { AccentBorderCallout1Shape } from '../src/shapes/accent-border-callout1-shape';
 export { AccentBorderCallout2Shape } from '../src/shapes/accent-border-callout2-shape';
 export { AccentBorderCallout3Shape } from '../src/shapes/accent-border-callout3-shape';
@@ -197,4 +197,5 @@ export { ShapeDefaultConfig } from './shape-default';
 export { freeRouteBentConnectorLinePoints } from './util/connector-points-util';
 export type { IBentConnectorResult } from './util/connector-points-util';
 export { ConnectorCoordinateTransform } from './util/connector-transform';
+export { createUniqueShapeName } from './util/shape-name';
 export { isConnectorShape, isCurvedConnectorShape } from './util/shape-util';

package/lib/types/{model → models}/shape-model.d.ts

@@ -5,6 +5,7 @@ export declare function deepMerge<T extends Record<string, any>>(target: T, ...s
 export declare class BasicShapeModel implements IShapeModel {
     protected _shapeType: ShapeTypeEnum;
     private readonly _id;
+    private _name?;
     protected _shapeData: IShapeData;
     /**
      * this property is only used for LineShapeRenderModel to indicate whether to render line points for routing
@@ -13,12 +14,14 @@ export declare class BasicShapeModel implements IShapeModel {
     private _context;
     private _renderModel;
     private _adjustNameMap;
-    constructor(shapeType: ShapeTypeEnum, id: string, shapeData?: IShapeData);
+    constructor(shapeType: ShapeTypeEnum, id: string, shapeData?: IShapeData, name?: string);
     changeShapeType(shapeType: ShapeTypeEnum, shapeData?: IShapeData): void;
     getShapeType(): ShapeTypeEnum;
     getShapeRelation(): IShapeRelation | undefined;
     getBasicShapeType(): BasicShapeEnum;
     getId(): string;
+    getName(): string | undefined;
+    setName(name?: string): void;
     /**
      * get shape text data
      * @returns The shape text data
@@ -68,6 +71,9 @@ export declare class BasicShapeModel implements IShapeModel {
     private _getAdjScope;
     private _setAdjustValue;
     clearAdjustValue(): void;
+    cloneShapeDataForShapeType(shapeType: ShapeTypeEnum): IShapeData;
+    cloneSnapshot(): IShapeJSONData;
+    cloneSnapshotForShapeType(shapeType: ShapeTypeEnum): IShapeJSONData;
     /**
      * et adjust value by adj name
      * @param {string} adjName The name of adj point
@@ -113,8 +119,11 @@ export declare class BasicShapeModel implements IShapeModel {
      */
     buildClipPath(canvasContext: CanvasRenderingContext2D, rect: IShapeRect): IShapeRect | false;
     getDrawingPoints(): IShapePointWithAdjName[];
-    calcAdjValue(rect: IShapeRect, point: IShapePoint, adjustInfo: IShapeAdjustItemResolved, isFlipH: boolean, isFlipV: boolean): number;
+    calcAdjValue(rect: IShapeRect, point: IShapePoint, adjustInfo: IShapeAdjustItemResolved, _isFlipH: boolean, _isFlipV: boolean): number;
     dispose(): void;
+    private _getSnapshotAdjustValues;
+    private _cloneShapeDataWithSnapshotAdjustValues;
     toJSON(): IShapeJSONData;
     fromJSON(json: IShapeJSONData): void;
+    private _createRenderModel;
 }

package/lib/types/render-engine/custom-shape-render-model.d.ts

@@ -0,0 +1,7 @@
+import type { IPresetShapeConfig } from '../shape-type';
+import { BaseShapeRenderModel } from './shape-render-model';
+export declare class CustomShapeRenderModel extends BaseShapeRenderModel {
+    readonly name: string;
+    readonly presetShapeConfig: IPresetShapeConfig;
+    constructor(name: string, presetShapeConfig: IPresetShapeConfig);
+}

package/lib/types/render-engine/line-shape-render-model.d.ts

@@ -1,6 +1,14 @@
 import type { IShapeData, IShapePoint, IShapeRect, IShapeRenderParameters } from '../shape-type';
 import type { BaseShapeContext } from './base-shape-context';
 import { BaseShapeRenderModel } from './shape-render-model';
+/**
+ * Interface for storing complete path command information for line shapes
+ * Used to preserve bezier curve data when redrawing with arrow adjustments
+ */
+export interface ILinePathCommand {
+    command: string;
+    points: number[];
+}
 /**
  * Base class for line-type shapes (connectors, lines).
  *
@@ -13,6 +21,11 @@ import { BaseShapeRenderModel } from './shape-render-model';
  */
 export declare abstract class LineShapeRenderModel extends BaseShapeRenderModel {
     protected _isLineShape: boolean;
+    static toRoundedPolylineCommands(commands: ILinePathCommand[], cornerRadius: number): ILinePathCommand[];
+    private static _cloneLinePathCommands;
+    private static _isLineOnlyPolyline;
+    private static _getPolylineCommandPoint;
+    private static _getRoundedCorner;
     /**
      * Check if a point is near a line segment.
      *
@@ -84,8 +97,10 @@ export declare abstract class LineShapeRenderModel extends BaseShapeRenderModel
     render(canvasContext: CanvasRenderingContext2D, rect: IShapeRect, shapeContext: BaseShapeContext, shapeData: IShapeData, renderOption: IShapeRenderParameters): void;
     private _scalePoints;
     private _executePathCommand;
+    private _drawLinePathCommands;
     private _applyFill;
     private _applyStrokeWithArrows;
+    private _getLineCornerRadius;
     /**
      * Extract start and end points with tangent direction points for arrow rendering
      * For bezier curves, uses control points to get correct tangent direction

package/lib/types/render-engine/point-to-shape-transform.d.ts

@@ -1,13 +1,13 @@
 import type { IShapePoint } from '../shape-type';
-interface Point {
+interface IPoint {
     x: number;
     y: number;
 }
-interface TransformResult {
+interface ITransformResult {
     rotation: 0 | 90 | 180 | 270;
     flipH: boolean;
     flipV: boolean;
     restorePoints: IShapePoint[];
 }
-export declare function resolveTransform(points: Point[]): TransformResult;
+export declare function resolveTransform(points: IPoint[]): ITransformResult;
 export {};

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

@@ -23,7 +23,10 @@ export declare abstract class BaseShapeRenderModel {
      * @param gdRecord The current gdRecord used to calculate text rect, if the shape has transformed, should use the latest gdRecord
      * @returns {IShapeRect} The text rectangle within the shape
      */
-    getTextRect(rect: IShapeRect, gdRecord: Partial<IGdContext>): IShapeRect;
+    getTextRect(rect: IShapeRect, gdRecord: Partial<IGdContext>, shapeData?: IShapeData): IShapeRect;
+    private _hasExplicitTextRectPadding;
+    private _getPaddedWholeRect;
+    private _getTextRectPadding;
     /**
      * 计算所有可填充路径（fill !== 'none'）的实际包围盒。
      *

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

@@ -30,6 +30,55 @@ export declare enum ShapeDirectionEnum {
     Left = 180,
     Up = 270
 }
+/**
+ * OOXML ST_PresetShadowVal values used by `<a:prstShdw prst="...">`.
+ *
+ * The enum member names intentionally keep the OOXML `shdw*` numbering so JSON
+ * can map back to OOXML losslessly. Use each member's JSDoc for the human-readable
+ * Office preset name.
+ */
+export declare enum ShapePresetShadowValEnum {
+    /** OOXML shdw1: Top Left Drop Shadow, a regular outer shadow toward the top-left. */
+    Shdw1 = "shdw1",
+    /** OOXML shdw2: Top Right Drop Shadow, a regular outer shadow toward the top-right. */
+    Shdw2 = "shdw2",
+    /** OOXML shdw3: Back Left Perspective Shadow, a perspective shadow behind the shape on the left. */
+    Shdw3 = "shdw3",
+    /** OOXML shdw4: Back Right Perspective Shadow, a perspective shadow behind the shape on the right. */
+    Shdw4 = "shdw4",
+    /** OOXML shdw5: Bottom Left Drop Shadow, a regular outer shadow toward the bottom-left. */
+    Shdw5 = "shdw5",
+    /** OOXML shdw6: Bottom Right Drop Shadow, a regular outer shadow toward the bottom-right. */
+    Shdw6 = "shdw6",
+    /** OOXML shdw7: Front Left Perspective Shadow, a perspective shadow in front of the shape on the left. */
+    Shdw7 = "shdw7",
+    /** OOXML shdw8: Front Right Perspective Shadow, a perspective shadow in front of the shape on the right. */
+    Shdw8 = "shdw8",
+    /** OOXML shdw9: Top Left Small Drop Shadow, a smaller top-left outer shadow. */
+    Shdw9 = "shdw9",
+    /** OOXML shdw10: Top Left Large Drop Shadow, a larger top-left outer shadow. */
+    Shdw10 = "shdw10",
+    /** OOXML shdw11: Back Left Long Perspective Shadow, a longer back-left perspective shadow. */
+    Shdw11 = "shdw11",
+    /** OOXML shdw12: Back Right Long Perspective Shadow, a longer back-right perspective shadow. */
+    Shdw12 = "shdw12",
+    /** OOXML shdw13: Top Left Double Drop Shadow, a double-layer top-left outer shadow. */
+    Shdw13 = "shdw13",
+    /** OOXML shdw14: Bottom Right Small Drop Shadow, a smaller bottom-right outer shadow. */
+    Shdw14 = "shdw14",
+    /** OOXML shdw15: Front Left Long Perspective Shadow, a longer front-left perspective shadow. */
+    Shdw15 = "shdw15",
+    /** OOXML shdw16: Front Right Long Perspective Shadow, a longer front-right perspective shadow. */
+    Shdw16 = "shdw16",
+    /** OOXML shdw17: 3D Outer Box Shadow, a 3D-style shadow outside the shape box. */
+    Shdw17 = "shdw17",
+    /** OOXML shdw18: 3D Inner Box Shadow, a 3D-style shadow inside the shape box. */
+    Shdw18 = "shdw18",
+    /** OOXML shdw19: Back Center Perspective Shadow, a centered perspective shadow behind the shape. */
+    Shdw19 = "shdw19",
+    /** OOXML shdw20: Front Bottom Shadow, a front-facing shadow below the shape. */
+    Shdw20 = "shdw20"
+}
 /**
  * Shape fill type enum
  * Currently, PatternFill and PictureFill are not supported, but we define them for future use, if will be treat as Nofill currently.

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

@@ -1,4 +1,4 @@
-import type { BasicShapeEnum, ImageFillModeEnum, ImageSourceTypeEnum, ShapeArrowSizeEnum, ShapeArrowTypeEnum, ShapeFillEnum, ShapeGradientTypeEnum, ShapeLineCapEnum, ShapeLineDashEnum, ShapeLineJoinEnum, ShapeLineTypeEnum, ShapeOperatorEnum, ShapeRenderModeEnum, ShapeSketchTypeEnum, ShapeTypeEnum } from './shape-enum';
+import type { BasicShapeEnum, ImageFillModeEnum, ImageSourceTypeEnum, ShapeArrowSizeEnum, ShapeArrowTypeEnum, ShapeFillEnum, ShapeGradientTypeEnum, ShapeLineCapEnum, ShapeLineDashEnum, ShapeLineJoinEnum, ShapeLineTypeEnum, ShapeOperatorEnum, ShapePresetShadowValEnum, ShapeRenderModeEnum, ShapeSketchTypeEnum, ShapeTypeEnum } from './shape-enum';
 /**
  * GdContext 用来计算 OOXML Shape 的 Geometry Definitions (gd)
  * 包含：
@@ -104,6 +104,7 @@ export interface IGdContextBase {
     lsd32: number;
 }
 export interface IGdContext extends IGdContextBase {
+    [key: string]: number | undefined;
     x0?: number;
     x1?: number;
     x2?: number;
@@ -550,8 +551,16 @@ export interface IShapePath {
     /** Parsed path data array (alternative to data string) */
     dataArray?: IPathCommand[];
 }
+export type ShapeTextDirection = 'horz' | 'vert' | 'vert270' | 'wordArtVert' | 'eaVert' | 'mongolianVert' | 'wordArtVertRtl';
 export interface IShapeTextAlign {
     isHorizontal: boolean;
+    textDirection?: ShapeTextDirection;
+}
+export interface IShapeTextRectPadding {
+    left: number;
+    top: number;
+    right: number;
+    bottom: number;
 }
 export interface IShapeText extends IShapeTextAlign {
     isRichText: false;
@@ -566,11 +575,36 @@ export interface IShapeText extends IShapeTextAlign {
 export interface ICustomShapeTextData extends IShapeTextAlign {
     dataModel?: unknown;
 }
+/**
+ * A shape outer-shadow effect. Distances and blur radius use slide drawing
+ * units; direction is in degrees where 0 points right and 90 points down.
+ */
+export interface IShapeShadowEffect {
+    /** Shadow color as a CSS color string. */
+    color: string;
+    /** OOXML preset shadow value, when the shadow originated from `<a:prstShdw>`. */
+    preset?: ShapePresetShadowValEnum;
+    /** Shadow opacity, from 0 (transparent) to 1 (opaque). */
+    opacity?: number;
+    /** Blur radius in slide drawing units. */
+    blurRadius?: number;
+    /** Direction angle in degrees, with 0 pointing right and 90 pointing down. */
+    direction?: number;
+    /** Offset distance from the shape in slide drawing units. */
+    distance?: number;
+    /** Horizontal shadow scale factor; 1 means 100%. */
+    sx?: number;
+    /** Vertical shadow scale factor; 1 means 100%. */
+    sy?: number;
+    /** Whether the shadow rotates together with the shape. */
+    rotateWithShape?: boolean;
+}
 /**
  * This interface defines the shape data structure , and this part will save in json
  */
 export interface IBasicShapeData {
     shapeType?: ShapeTypeEnum;
+    isTextBox?: boolean;
     fill?: {
         color?: string;
         fillType?: ShapeFillEnum;
@@ -580,6 +614,7 @@ export interface IBasicShapeData {
         gradientStops?: Array<{
             position: number;
             color: string;
+            opacity?: number;
         }>;
         /**
          * Image fill source, can be a URL or base64 data URI. When fillType is 'image', this specifies the image to use for filling the shape.
@@ -630,7 +665,16 @@ export interface IBasicShapeData {
     };
     stroke?: IShapeLineStyle;
     adjustValues?: Record<string, number>;
+    isCustom?: boolean;
+    customGeometry?: IPresetShapeConfig;
+    /** Basic outer shadow effect applied while rendering the shape path. */
+    outerShadow?: IShapeShadowEffect;
     shapeText?: IShapeText | ICustomShapeTextData;
+    /**
+     * Text box inset used to calculate the editable/rendered text rect.
+     * Values use the same drawing units as the shape rect.
+     */
+    textRectPadding?: IShapeTextRectPadding;
 }
 export interface ICxnShapeData extends IBasicShapeData {
     points?: Array<{
@@ -656,6 +700,7 @@ export interface IGroupShapeData {
 export type IShapeData = IBasicShapeData | ICxnShapeData;
 export interface IShapeJSONData {
     id: string;
+    name?: string;
     shapeData: IShapeData;
     shapeType: ShapeTypeEnum;
 }
@@ -812,6 +857,7 @@ export interface IShapeLineStyle {
     color?: string;
     width?: number;
     opacity?: number;
+    cornerRadius?: number;
     dashType?: ShapeLineDashEnum;
     capType?: ShapeLineCapEnum;
     lineJoinType?: ShapeLineJoinEnum;
@@ -824,6 +870,8 @@ export interface IShapeLineStyle {
 export interface IShapeModel {
     getBasicShapeType(): BasicShapeEnum;
     getId(): string;
+    getName(): string | undefined;
+    setName(name?: string): void;
     dispose(): void;
     getShapeData(): IShapeData;
 }

package/lib/types/util/shape-name.d.ts

@@ -0,0 +1 @@
+export declare function createUniqueShapeName(shapeType: string, usedNames: Iterable<string | undefined | null>): string;