@univerjs-pro/engine-shape 0.18.0 → 0.19.0

package/lib/types/index.d.ts

@@ -1,7 +1,7 @@
 export { BasicShapeModel as ShapeModel } from '../src/model/shape-model';
 export { LineShapeRenderModel } from '../src/render-engine/line-shape-render-model';
 export { BaseShapeRenderModel } from '../src/render-engine/shape-render-model';
-export { BasicShapeEnum, ShapeArrowSizeEnum, ShapeArrowTypeEnum, ShapeFillEnum, ShapeGradientTypeEnum, ShapeLineCapEnum, ShapeLineDashEnum, ShapeLineJoinEnum, ShapeLineTypeEnum, ShapeOperatorEnum, ShapeRenderModeEnum, ShapeTypeEnum } from '../src/shape-enum';
+export { BasicShapeEnum, ShapeArrowSizeEnum, ShapeArrowTypeEnum, ShapeFillEnum, ShapeGradientTypeEnum, ShapeLineCapEnum, ShapeLineDashEnum, ShapeLineJoinEnum, ShapeLineTypeEnum, ShapeOperatorEnum, ShapeRenderModeEnum, ShapeSketchTypeEnum, ShapeTypeEnum } from '../src/shape-enum';
 export type { IConnectorLayoutResult, IConnectorRouteLayoutResult, IConnectPointInfo, ICustomShapeTextData, ICxnShapeData, IDrawingRect, IGdContext, IGdContextBase, ILineType, IPathCommand, IPresetShapeConfig, IShapeAdjustItem, IShapeAdjustItemResolved, IShapeContextOptions, IBasicShapeData as IShapeData, IShapeHitTestResult, IShapeJSONData, IShapeLineStyle, IShapeModel, IShapePath, IShapePoint, IShapePointWithAdjName, IShapeRect, IShapeRelation, IShapeRelationItem, IShapeRenderParameters, IShapeText, ShapeAdjustHandleTypeEnum, ShapeHitTestHitTypeEnum, } from '../src/shape-type';
 export { AccentBorderCallout1Shape } from '../src/shapes/accent-border-callout1-shape';
 export { AccentBorderCallout2Shape } from '../src/shapes/accent-border-callout2-shape';

package/lib/types/render-engine/sketch-stroke-renderer.d.ts

@@ -0,0 +1,79 @@
+import { ShapeSketchTypeEnum } from '../shape-enum';
+/**
+ * Resolved (numeric) path command after gd evaluation and scaling.
+ * Used by SketchStrokeRenderer to draw sketch-style strokes.
+ */
+export type IResolvedPathCommand = {
+    cmd: 'M';
+    x: number;
+    y: number;
+} | {
+    cmd: 'L';
+    x: number;
+    y: number;
+} | {
+    cmd: 'C';
+    cp1x: number;
+    cp1y: number;
+    cp2x: number;
+    cp2y: number;
+    x: number;
+    y: number;
+} | {
+    cmd: 'Q';
+    cpx: number;
+    cpy: number;
+    x: number;
+    y: number;
+} | {
+    cmd: 'A';
+    centerX: number;
+    centerY: number;
+    wR: number;
+    hR: number;
+    startAngle: number;
+    endAngle: number;
+    anticlockwise: boolean;
+} | {
+    cmd: 'z';
+};
+/**
+ * Renders shape stroke with a hand-drawn / sketch visual effect.
+ *
+ * All sketch-related rendering logic lives here. The caller is responsible
+ * for setting strokeStyle, lineWidth, lineDash, lineJoin, lineCap on the
+ * canvas context *before* calling render().
+ */
+export declare class SketchStrokeRenderer {
+    /**
+     * Build and stroke a sketch-style path on `ctx`.
+     *
+     * @param ctx       Canvas rendering context (strokeStyle etc. should already be configured)
+     * @param commands  The resolved (numeric) path commands that describe the original shape outline
+     * @param sketchType  Which sketch mode to apply
+     * @param seed      Integer seed for the seeded RNG – same seed produces identical output
+     */
+    static render(ctx: CanvasRenderingContext2D, commands: IResolvedPathCommand[], sketchType: ShapeSketchTypeEnum, seed: number): void;
+    private static _renderPass;
+    /**
+     * Draw a sketchy straight line from (x0,y0) to (x1,y1).
+     *
+     * The line is split into sub-segments.  Each interior split point is
+     * displaced perpendicularly by a seeded-random amount.  The resulting
+     * noisy chain is smoothed with a chain of quadratic bezier curves so the
+     * output looks like a natural hand-drawn stroke rather than a polygon.
+     */
+    private static _sketchLine;
+    /**
+     * Draw a sketchy cubic bezier by perturbing the control points.
+     */
+    private static _sketchCubic;
+    /**
+     * Draw a sketchy quadratic bezier by perturbing the control point.
+     */
+    private static _sketchQuadratic;
+    /**
+     * Draw a sketchy ellipse arc by applying slight noise to the center and radii.
+     */
+    private static _sketchArc;
+}

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

@@ -319,3 +319,18 @@ export declare enum ShapeArrowSizeEnum {
     Medium = 2,
     Large = 3
 }
+/**
+ * Shape sketch (hand-drawn) style enum.
+ * Controls how strongly the stroke is perturbed to look like a hand-drawn line.
+ *
+ * - None      – regular vector stroke, no perturbation
+ * - Curved    – very slight smooth waviness
+ * - Freehand  – moderate irregular deformation
+ * - HandDrawn – heavy rough deformation rendered in two overlapping passes
+ */
+export declare enum ShapeSketchTypeEnum {
+    None = 0,
+    Curved = 1,
+    Freehand = 2,
+    HandDrawn = 3
+}

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

@@ -1,4 +1,4 @@
-import type { BasicShapeEnum, ShapeArrowSizeEnum, ShapeArrowTypeEnum, ShapeFillEnum, ShapeGradientTypeEnum, ShapeLineCapEnum, ShapeLineDashEnum, ShapeLineJoinEnum, ShapeLineTypeEnum, ShapeOperatorEnum, ShapeRenderModeEnum, ShapeTypeEnum } from './shape-enum';
+import type { BasicShapeEnum, ShapeArrowSizeEnum, ShapeArrowTypeEnum, ShapeFillEnum, ShapeGradientTypeEnum, ShapeLineCapEnum, ShapeLineDashEnum, ShapeLineJoinEnum, ShapeLineTypeEnum, ShapeOperatorEnum, ShapeRenderModeEnum, ShapeSketchTypeEnum, ShapeTypeEnum } from './shape-enum';
 /**
  * GdContext 用来计算 OOXML Shape 的 Geometry Definitions (gd)
  * 包含：
@@ -746,6 +746,7 @@ export interface IShapeRenderParameters {
     flipH?: boolean;
     flipV?: boolean;
     angle?: number;
+    oKey: string;
 }
 export interface IShapeRelationItem {
     shapeId: string;
@@ -768,6 +769,10 @@ export interface IShapeLineStyle {
     capType?: ShapeLineCapEnum;
     lineJoinType?: ShapeLineJoinEnum;
     lineStrokeType?: ShapeLineTypeEnum;
+    /**
+     * Hand-drawn / sketch style.  Defaults to `ShapeSketchTypeEnum.None`.
+     */
+    sketchType?: ShapeSketchTypeEnum;
 }
 export interface IShapeModel {
     getBasicShapeType(): BasicShapeEnum;

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

@@ -6,3 +6,4 @@ import { ShapeTypeEnum } from '../shape-enum';
  */
 export declare function isConnectorShape(shapeType: ShapeTypeEnum): boolean;
 export declare function isCurvedConnectorShape(shapeType: ShapeTypeEnum): boolean;
+export declare function getSketchSeed(shapeId: string): number;