@vvfx/sdk 0.0.0-alpha.41 → 0.0.0-alpha.42

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _galacean_effects from '@galacean/effects';
-import { spec, Player } from '@galacean/effects';
+import { spec, math, Player } from '@galacean/effects';
 export { generateGUID, spec } from '@galacean/effects';
 
 type ViewItemTypedProperty = {
@@ -44,7 +44,282 @@ type SetItemPropertyValueParam = {
             propertyValue: PageFormTypeAndPropertyReference[T][N];
         };
     }[keyof PageFormTypeAndPropertyReference[T]];
-}[keyof PageFormTypeAndPropertyReference];
+}[keyof PageFormTypeAndPropertyReference] | {
+    itemId: string;
+    type: spec.ItemType;
+    propertyName: 'position';
+    propertyValue: spec.vec2 | spec.vec3;
+};
+
+/**
+ * @class 二维线段
+ */
+declare class Line2 {
+    start: Vector2;
+    end: Vector2;
+    constructor(start?: Vector2, end?: Vector2);
+    /**
+     * 设置二维线段
+     * @param {Vector2} start 线段起点
+     * @param {Vector2} end 线段终点
+     * @returns {Line2} 二维线段
+     */
+    set(start: Vector2, end: Vector2): this;
+    /**
+     * 复制二维线段
+     * @param {Line2} line 复制对象
+     * @returns {Line2} 复制结果
+     */
+    copyFrom(line: Line2): this;
+    /**
+     * 二维线段求方向
+     * @returns {Vector2} 二维线段方向
+     */
+    direction(): Vector2;
+    /**
+     * 二维线段求中点
+     * @param {Vector2} [target=new Vector2()] 目标保存对象
+     * @returns {Vector2} 二维线段中点
+     */
+    getCenter(target?: Vector2): Vector2;
+    /**
+     * 二维线段向量值
+     * @param {Vector2} [target=new Vector2()] 目标保存对象
+     * @returns {Vector2} 二维线段向量值
+     */
+    delta(target?: Vector2): Vector2;
+    /**
+     * 二维线段欧式距离平方(应用于计算)
+     * @returns {number} 计算结果
+     */
+    distanceSq(): number;
+    /**
+     * 二维线段欧式距离
+     * @returns {number} 计算结果
+     */
+    distance(): number;
+    /**
+     * 求二维线段比例点
+     * @param {number} t 比例值
+     * @param {Vector2} target 目标保存对象
+     * @returns {Vector2} 比例点结果
+     */
+    at(t: number, target?: Vector2): Vector2;
+    /**
+     * 求点与线段的最短距离
+     * @param {Vector2} point 二维空间点
+     * @param {boolean} clampToLine 是否限制于线段内
+     * @returns {number} 距离结果
+     */
+    closestPointToPointParameter(point: Vector2, clampToLine: boolean): number;
+    /**
+     * 求点与线段的最近交点
+     * @param {Vector2} point 二维空间点
+     * @param {boolean} clampToLine 是否限制于线段内
+     * @param {Vector2} target 目标保存对象
+     * @returns {Vector2} 最近交点
+     */
+    closestPointToPoint(point: Vector2, clampToLine: boolean, target?: Vector2): Vector2;
+    /**
+     * 二维线段判等
+     * @param {Line2} line 二维线段
+     * @returns {boolean} 判等结果
+     */
+    equals(line: Line2): boolean;
+    /**
+     * 克隆二维线段
+     * @returns {Line2} 克隆结果
+     */
+    clone(): Line2;
+    /**
+     * 二维线段求长度
+     * @returns {number} 长度
+     */
+    length(): number;
+    /**
+     * 二维线段判断相交
+     * @param {Line2} other 二维线段
+     * @returns {boolean} 相交判断结果
+     */
+    crossWithLine(other: Line2): boolean;
+}
+
+declare class Vector2 extends math.Vector2 {
+    subtract(other: Vector2): this;
+    toViewCoordinate(width: number, height: number): this;
+    clone(): Vector2;
+    distanceTo(other: Vector2): number;
+    scaleByCenter(scalar: Vector2, anchor?: Vector2): Vector2;
+    round(precision?: number): this;
+    /**
+     * 点到直线的最短距离
+     * @returns {{d: number, t: number}} d表示距离，t表示最近点在直线的比例
+     */
+    distanceToLine(line: Line2): {
+        d: number;
+        t: number;
+    };
+}
+
+/**
+ * @class 二维包围盒
+ */
+declare class Box2 {
+    /**
+     * @member {Vector2[]} corners 二维包围盒角点
+     */
+    corners: Vector2[];
+    min: Vector2;
+    max: Vector2;
+    /**
+     * 构造函数，传入值为空时表示空包围盒
+     * @param {Vector2} [min=new Vector2(Infinity, Infinity)] 最小点
+     * @param {Vector2} [max=new Vector2(-Infinity, -Infinity)] 最大点
+     */
+    constructor(min?: Vector2, max?: Vector2);
+    /**
+     * 通过最大最小点设置二维包围盒
+     * @param {Vector2} min 最小点
+     * @param {Vector2} max 最大点
+     * @returns {Box2} 二维包围盒
+     */
+    set(min: Vector2, max: Vector2): this;
+    /**
+     * 通过角点设置二维包围盒
+     * @param {Vector2[]} vecArray 二维空间点数组
+     * @returns {Box2} 二维包围盒
+     */
+    setFromVec2Array(vecArray: Vector2[]): this;
+    setFromVec2ArrayWithOutCorners(vecArray: Vector2[]): this;
+    /**
+     * 通过中心与大小设置二维包围盒
+     * @param {Vector2} center 二维中心点
+     * @param {Vector2} size 二维大小
+     * @returns {Box2} 二维包围盒
+     */
+    setFromCenterAndSize(center: Vector2, size: Vector2): this;
+    /**
+     * 克隆二维包围盒
+     * @returns {Box2} 克隆结果
+     */
+    clone(): Box2;
+    /**
+     * 复制二维包围盒
+     * @param {Box2} box 二维包围盒
+     * @returns {Box2} 复制结果
+     */
+    copyFrom(box: Box2): this;
+    /**
+     * 二维包围盒置空
+     * @returns {Box2} 置空结果
+     */
+    makeEmpty(): this;
+    /**
+     * 二维包围盒判空
+     * @returns {boolean} 判空结果
+     */
+    isEmpty(): boolean;
+    /**
+     * 获取二维包围盒角点
+     * @returns {Vector2[]} 二维包围盒角点
+     */
+    getCorners(): Vector2[];
+    /**
+     * 获取二维包围盒中心点
+     * @param {Vector2} [target=new Vector2()] 目标点(用以存放二维包围盒中心点)
+     * @returns {Vector2} 二维包围盒中心点
+     */
+    getCenter(target?: Vector2): Vector2;
+    /**
+     * 获取二维包围盒大小
+     * @param {Vector2} [target=new Vector2()] 目标向量(用以存放二维包围盒大小)
+     * @returns {Vector2} 二维包围盒大小
+     */
+    getSize(target?: Vector2): Vector2;
+    /**
+     * 通过二维空间点扩展二维包围盒
+     * @param {Vector2} point 二维空间点
+     * @returns {Box2} 扩展包围盒
+     */
+    expandByPoint(point: Vector2): this;
+    /**
+     * 通过向量扩展二维包围盒
+     * @param {Vector2} vector 二维向量
+     * @returns {Box2} 扩展结果
+     */
+    expandByVector(vector: Vector2): this;
+    /**
+     * 通过大小扩展二维包围盒
+     * @param {number} scalar 扩展大小
+     * @returns {Box2} 扩展结果
+     */
+    expandByScalar(scalar: number): this;
+    /**
+     * 判断二维包围盒是否包含二维空间点
+     * @param {Vector2} point 二维空间点
+     * @param {boolean} [isOrthogonal=true] 包围盒正交判断(默认为true)
+     * @returns {boolean} 点包含判断结果
+     */
+    containsPoint(point: Vector2, isOrthogonal?: boolean): boolean;
+    /**
+     * 判断二维包围盒包含关系(if this contains other)
+     * @param {Box2} box 其它包围盒
+     * @returns {boolean} 二维包围盒包含判断结果
+     */
+    containsBox(box: Box2): boolean;
+    /**
+     * 获取点以包围盒左上角顶点为原点的相对位置
+     * @param {Vector2} point 指定二维空间点
+     * @param {Vector2} [target=new Vector2()] 目标空间点
+     * @returns {Vector2} 计算结果空间点
+     */
+    getParameter(point: Vector2, target?: Vector2): Vector2;
+    /**
+     * 求点与二维包围盒的最近点
+     * @param {Vector2} point 二维空间点
+     * @param {Vector2} [target=new Vector2()] 结果点
+     * @returns {Vector2} 二维空间点
+     */
+    clampPoint(point: Vector2, target?: Vector2): Vector2;
+    /**
+     * 求点到二维包围盒的距离
+     * @param {Vector2} point 二维空间点
+     * @returns {number} 距离
+     */
+    distanceToPoint(point: Vector2): number;
+    /**
+     * 二维包围盒求交集
+     * @param {Box2} box 二维包围盒
+     * @returns {Box2} 求交结果
+     */
+    intersect(box: Box2): this;
+    /**
+     * 二维包围盒求并集
+     * @param {Box2} box 二维包围盒
+     * @returns {Box2} 求并结果
+     */
+    union(box: Box2): this;
+    /**
+     * 二维包围盒位移
+     * @param {Vector2} offset 位移向量
+     * @returns {Box2} 位移结果
+     */
+    translate(offset: Vector2): this;
+    scale(scalar: number, center?: Vector2): this;
+    /**
+     * 二维包围盒判等
+     * @param {Box2} box 二维包围盒
+     * @returns {boolean} 判等结果
+     */
+    equals(box: Box2): boolean;
+    /**
+     * 判断二维包围盒相交关系(if this intersect other)
+     * @param {Box2} box 二维包围盒
+     * @param {boolean} [isOrthogonal=true] 正交判断(当前包围盒)
+     * @returns {boolean} 相交判断结果
+     */
+    intersectsBox(box: Box2, isOrthogonal?: boolean): boolean;
+}
 
 declare const MEDIA_TYPE: {
     readonly APNG: "APNG";
@@ -202,7 +477,7 @@ type ExportMediaItemOptions = {
     apngConfig?: ApngConfig;
 };
 
-type SDKMode = 'product' | 'template';
+type SDKMode = 'editor' | 'template';
 /**
  * @description SDK功能配置
  */
@@ -242,6 +517,8 @@ type SDKConfig = {
         selectorGizmoConfig: SelectorGizmoConfig;
         transformGizmoEnabled: boolean;
         transformGizmoConfig: TransformGizmoConfig;
+        pictureCutGizmoEnabled: boolean;
+        pictureCutGizmoConfig: PictureCutGizmoConfig;
     };
 };
 /**
@@ -420,6 +697,71 @@ type TransformGizmoConfig = {
      */
     rotationCircleSize: number;
 };
+/**
+ * @description 图片裁切参数
+ */
+type PictureCutGizmoConfig = {
+    /**
+     * @description 蒙版颜色
+     */
+    maskColor: number;
+    /**
+     * @description 蒙版透明度
+     */
+    maskAlpha: number;
+    /**
+     * @description 裁切包围盒线框宽度
+     */
+    cutBoxLineWidth: number;
+    /**
+     * @description 裁切包围盒线框颜色
+     */
+    cutBoxLineColor: number;
+    /**
+     * @description 裁切包围盒线框透明度
+     */
+    cutBoxLineAlpha: number;
+    /**
+     * @description 元素包围盒线框宽度
+     */
+    itemBoxLineWidth: number;
+    /**
+     * @description 元素包围盒线框颜色
+     */
+    itemBoxLineColor: number;
+    /**
+     * @description 元素包围盒线框透明度
+     */
+    itemBoxLineAlpha: number;
+    /**
+     * @description 裁切包围盒角度半径
+     */
+    cutBoxCornerRadius: number;
+    /**
+     * @description 裁切包围盒角点宽度
+     */
+    cutBoxCornerLineWidth: number;
+    /**
+     * @description 裁切包围盒角点颜色
+     */
+    cutBoxCornerLineColor: number;
+    /**
+     * @description 裁切包围盒角点透明度
+     */
+    cutBoxCornerLineAlpha: number;
+    /**
+     * @description 裁切包围盒角点填充色
+     */
+    cutBoxCornerFillColor: number;
+    /**
+     * @description 缩放判断距离
+     */
+    scaleInteractionDistance: number;
+    /**
+     * @description 单向缩放判断距离
+     */
+    directionScaleInteractionDistance: number;
+};
 
 type SDKEvents = {
     'selectedItemChange': [id: string[]];
@@ -441,6 +783,7 @@ type SDKEvents = {
     'exportDone': [item: ExportMediaItemOptions | undefined, success: boolean, buffer?: FileBuffer];
     'exportComplete': [success: boolean, taskInfos: ExportMediaItemOptions[], buffers?: FileBuffer[]];
     'sdkConfigChange': [preSDKConfig: SDKConfig, curSDKConfig: SDKConfig];
+    'cutBoxChange': [box: Box2];
 };
 declare class SDK {
     static config: SDKConfig;
@@ -461,7 +804,7 @@ declare class SDK {
     get exportStatus(): string | undefined;
     private get exportOptions();
     dispose(): void;
-    on: <E extends "progress" | "selectedItemChange" | "preSelectedItemChange" | "selectedViewChange" | "pageDataChange" | "zoomChange" | "itemPropertyChange" | "exportProgress" | "exportDone" | "exportComplete" | "sdkConfigChange">(eventName: E, listener: _galacean_effects.EventEmitterListener<SDKEvents[E]>, options?: _galacean_effects.EventEmitterOptions) => () => void;
+    on: <E extends "progress" | "selectedItemChange" | "preSelectedItemChange" | "selectedViewChange" | "pageDataChange" | "zoomChange" | "itemPropertyChange" | "exportProgress" | "exportDone" | "exportComplete" | "sdkConfigChange" | "cutBoxChange">(eventName: E, listener: _galacean_effects.EventEmitterListener<SDKEvents[E]>, options?: _galacean_effects.EventEmitterOptions) => () => void;
     private getInitParam;
     /**
      * 检测导出是否需要重新初始化
@@ -597,7 +940,7 @@ declare class SDK {
      * @description 设置导出功能初始化配置
      * @param exportConfig
      */
-    setExportConfig(exportConfig: ExportConfig): void;
+    setExportConfig(exportConfig: Partial<ExportConfig>): void;
     /**
      * @description 设置预选框参数
      * @param preSelectedColor 预选框颜色
@@ -634,12 +977,20 @@ declare class SDK {
      * @param spriteInfo 图层元素信息
      */
     addSpriteItem(spriteInfo: SpriteCreateInfo): Promise<void>;
+    openPictureCutGizmo(): void;
+    closePictureCutGizmo(): void;
+    /**
+     * @description 元素打组
+     * @param children 子元素ID
+     */
+    groupItems(nullInfo: NullCreateInfo): void;
+    deleteItems(idInfo: string | string[]): void;
 }
 
 type SizeAdaptDirection = 'x' | 'y';
 
 type BaseFormProperty = {
-    position: [number, number, number];
+    position: [number, number];
     rotation: [number, number, number];
     size: [number, number];
     visible: boolean;
@@ -978,5 +1329,34 @@ type SpriteCreateInfo = {
      */
     position: spec.vec2;
 };
+/**
+ * @description 空节点创建信息
+ */
+type NullCreateInfo = {
+    /**
+     * @description 元素id
+     */
+    id?: string;
+    /**
+     * @description 元素名称
+     */
+    name?: string;
+    /**
+     * @description 空节点缩放
+     */
+    scale?: spec.vec2;
+    /**
+     * @description 子元素id
+     */
+    children: string[];
+    /**
+     * @description 空节点旋转
+     */
+    rotation?: number;
+    /**
+     * @description 空节点位移
+     */
+    translation?: spec.vec2;
+};
 
-export { type ActiveData, type BaseFormProperty, type PageData, type PageFormTypedProperty, type PageProperty, SDK, type SDKEvents, type SDKInputParam, type SDKOptions, type SpecificPageFormProps, type SpriteCreateInfo, type SpriteFormProperty, type TextFormProperty, type ViewItem, type ViewParam, type ViewProperty };
+export { type ActiveData, type BaseFormProperty, Box2, type PageData, type PageFormTypedProperty, type PageProperty, SDK, type SDKEvents, type SDKInputParam, type SDKOptions, type SpecificPageFormProps, type SpriteCreateInfo, type SpriteFormProperty, type TextFormProperty, type ViewItem, type ViewParam, type ViewProperty };