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

package/dist/index.d.ts

@@ -47,7 +47,7 @@ type SetItemPropertyValueParam = {
 }[keyof PageFormTypeAndPropertyReference] | {
     itemId: string;
     type: spec.ItemType;
-    propertyName: 'position';
+    propertyName: 'position' | 'size';
     propertyValue: spec.vec2 | spec.vec3;
 };
 
@@ -159,6 +159,18 @@ declare class Vector2 extends math.Vector2 {
         d: number;
         t: number;
     };
+    /**
+     * 二维向量与x轴夹角
+     * @returns {number} 弧度值
+     */
+    angle(): number;
+    /**
+     * 二维点绕点旋转
+     * @param {Vec2} center 旋转中心
+     * @param {number} angle 旋转角度
+     * @returns {Vec2} 旋转结果
+     */
+    rotateAround(center: Vector2, angle: number): this;
 }
 
 /**
@@ -190,6 +202,10 @@ declare class Box2 {
      * @returns {Box2} 二维包围盒
      */
     setFromVec2Array(vecArray: Vector2[]): this;
+    /**
+     * 通过屏幕坐标点设置二维包围盒 - 点为屏幕坐标点，x正方向为右，y正方向为向上
+     * @param vecArray 屏幕坐标点
+     */
     setFromVec2ArrayWithOutCorners(vecArray: Vector2[]): this;
     /**
      * 通过中心与大小设置二维包围盒
@@ -319,6 +335,7 @@ declare class Box2 {
      * @returns {boolean} 相交判断结果
      */
     intersectsBox(box: Box2, isOrthogonal?: boolean): boolean;
+    rotate(angle: number, center?: Vector2): this;
 }
 
 declare const MEDIA_TYPE: {
@@ -519,6 +536,12 @@ type SDKConfig = {
         transformGizmoConfig: TransformGizmoConfig;
         pictureCutGizmoEnabled: boolean;
         pictureCutGizmoConfig: PictureCutGizmoConfig;
+        pictureExpandGizmoEnabled: boolean;
+        pictureExpandGizmoConfig: PictureExpandGizmoConfig;
+        textGizmoEnbaled: boolean;
+        textGizmoConfig: TextGizmoConfig;
+        maskGizmoEnabled: boolean;
+        maskGizmoConfig: MaskGizmoConfig;
     };
 };
 /**
@@ -545,6 +568,14 @@ type PageConfig$1 = {
      * @description 成组操作元素显隐
      */
     groupVisible: boolean;
+    /**
+     * @description 缩放最大值
+     */
+    maxZoom: number;
+    /**
+     * @description 缩放最小值
+     */
+    minZoom: number;
 };
 /**
  * @description 视频导出功能配置
@@ -696,6 +727,22 @@ type TransformGizmoConfig = {
      * @description 交互框旋转圆半径
      */
     rotationCircleSize: number;
+    /**
+     * @description 图片Logo地址
+     */
+    pictureLogoUrl: string;
+    /**
+     * @description
+     */
+    nullLogoUrl: string;
+    /**
+     * @description 大小文字颜色
+     */
+    sizeTextColor: number;
+    /**
+     * @description 名称文字颜色
+     */
+    nameTextColor: number;
 };
 /**
  * @description 图片裁切参数
@@ -762,8 +809,136 @@ type PictureCutGizmoConfig = {
      */
     directionScaleInteractionDistance: number;
 };
+/**
+ * @description 图片扩边参数
+ */
+type PictureExpandGizmoConfig = {
+    /**
+     * @description 蒙版颜色
+     */
+    maskColor: number;
+    /**
+     * @description 蒙版透明度
+     */
+    maskAlpha: number;
+    /**
+     * @description 扩边包围盒线框宽度
+     */
+    expandBoxLineWidth: number;
+    /**
+     * @description 扩边包围盒线框颜色
+     */
+    expandBoxLineColor: number;
+    /**
+     * @description 扩边包围盒线框透明度
+     */
+    expandBoxLineAlpha: number;
+    /**
+     * @description 扩边包围盒角度半径
+     */
+    expandBoxCornerRadius: number;
+    /**
+     * @description 扩边包围盒角点宽度
+     */
+    expandBoxCornerLineWidth: number;
+    /**
+     * @description 扩边包围盒角点颜色
+     */
+    expandBoxCornerLineColor: number;
+    /**
+     * @description 扩边包围盒角点透明度
+     */
+    expandBoxCornerLineAlpha: number;
+    /**
+     * @description 扩边包围盒角点填充色
+     */
+    expandBoxCornerFillColor: number;
+    /**
+     * @description 缩放判断距离
+     */
+    scaleInteractionDistance: number;
+    /**
+     * @description 单向缩放判断距离
+     */
+    directionScaleInteractionDistance: number;
+};
+/**
+ * @description 文本交互控制器参数
+ */
+type TextGizmoConfig = {
+    /**
+     * @description 包围盒线宽
+     */
+    boxLineWidth: number;
+    /**
+     * @description 包围盒线色
+     */
+    boxLineColor: number;
+    /**
+     * @description 缩放交互点半径
+     */
+    scaleCornerRadius: number;
+    /**
+     * @description 旋转交互点边长
+     */
+    rotationCornerWidth: number;
+    /**
+     * @description 旋转交互贴图地址
+     */
+    rotationCornerTexture: string;
+    /**
+     * @description 缩放交互点填充色
+     */
+    scaleCornerFillColor: number;
+    /**
+     * @description 缩放交互点描边宽度
+     */
+    scaleCornerStrokeWidth: number;
+    /**
+     * @description 缩放交互点描边颜色
+     */
+    scaleCornerStrokeColor: number;
+};
+/**
+ * @description 蒙版参数
+ */
+type MaskGizmoConfig = {
+    /**
+     * @description 画笔大小
+     */
+    brushSize: number;
+    /**
+     * @description 笔刷颜色
+     */
+    brushColor: number;
+    /**
+     * @description 笔刷透明度
+     */
+    brushAlpha: number;
+    /**
+     * @description 蒙版颜色
+     */
+    maskColor: number;
+    /**
+     * @description 蒙版透明度
+     */
+    maskAlpha: number;
+    /**
+     * @description 元素包围盒线框宽度
+     */
+    boxLineWidth: number;
+    /**
+     * @description 元素包围盒线框颜色
+     */
+    boxLineColor: number;
+    /**
+     * @description 元素包围盒线框透明度
+     */
+    boxLineAlpha: number;
+};
 
 type SDKEvents = {
+    'loadingItemChange': [id: string[]];
     'selectedItemChange': [id: string[]];
     'preSelectedItemChange': [id: string | undefined];
     'selectedViewChange': [id: number];
@@ -784,6 +959,11 @@ type SDKEvents = {
     'exportComplete': [success: boolean, taskInfos: ExportMediaItemOptions[], buffers?: FileBuffer[]];
     'sdkConfigChange': [preSDKConfig: SDKConfig, curSDKConfig: SDKConfig];
     'cutBoxChange': [box: Box2];
+    'expandBoxChange': [box: Box2];
+    'textInput': [{
+        text: string;
+        fontFamily: string;
+    }];
 };
 declare class SDK {
     static config: SDKConfig;
@@ -800,11 +980,12 @@ declare class SDK {
     _container: HTMLElement;
     private _playerContainer;
     constructor(container: HTMLElement);
+    get container(): HTMLElement;
     get pageData(): PageData | undefined;
     get exportStatus(): string | undefined;
     private get exportOptions();
     dispose(): 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;
+    on: <E extends "progress" | "loadingItemChange" | "selectedItemChange" | "preSelectedItemChange" | "selectedViewChange" | "pageDataChange" | "zoomChange" | "itemPropertyChange" | "exportProgress" | "exportDone" | "exportComplete" | "sdkConfigChange" | "cutBoxChange" | "expandBoxChange" | "textInput">(eventName: E, listener: _galacean_effects.EventEmitterListener<SDKEvents[E]>, options?: _galacean_effects.EventEmitterOptions) => () => void;
     private getInitParam;
     /**
      * 检测导出是否需要重新初始化
@@ -860,10 +1041,10 @@ declare class SDK {
      * @description 获取场景预览图
      * @returns 视图预览图
      */
-    getViewThumbnail(): {
+    getViewThumbnail(): Promise<{
         id: number;
-        thumbnail: Promise<string | undefined>;
-    }[];
+        thumbnail: string | undefined;
+    }>[];
     /**
      * @description 获取视图JSON产物
      * @returns 当前所有视图JSON产物
@@ -976,15 +1157,52 @@ declare class SDK {
      * @description 创建图层元素
      * @param spriteInfo 图层元素信息
      */
-    addSpriteItem(spriteInfo: SpriteCreateInfo): Promise<void>;
+    addSpriteItem(spriteInfo: SpriteCreateInfo): Promise<string | undefined>;
     openPictureCutGizmo(): void;
     closePictureCutGizmo(): void;
+    getCutInfo(): {
+        cutBox: Box2;
+        itemBox: Box2;
+    } | undefined;
+    setCutBox(min: Vector2, max: Vector2): Box2 | undefined;
+    openPictureExpandGizmo(): void;
+    closePictureExpandGizmo(): void;
+    getExpandInfo(): {
+        expandBox: Box2;
+        itemBox: Box2;
+    } | undefined;
+    setExpandBox(min: Vector2, max: Vector2): Box2 | undefined;
+    openMaskGizmo(brushSize: number): void;
+    clearMaskGizmo(): void;
+    closeMaskGizmo(): void;
+    getMask(): string | null | undefined;
+    openLoadingGizmo(id: string): void;
+    closeLoadingGizmo(id: string): void;
     /**
      * @description 元素打组
      * @param children 子元素ID
      */
-    groupItems(nullInfo: NullCreateInfo): void;
+    groupItems(nullInfo: NullCreateInfo): string | undefined;
+    addTextItem(textInfo: TextCreateInfo): Promise<void>;
     deleteItems(idInfo: string | string[]): void;
+    getItemCreateInfo(idInfo: string | string[]): ItemCreateInfo[];
+    createScreenShotSceneByIds(idInfo: string | string[], time?: number): Promise<string | undefined>;
+    getChildrenIds(id: string): string[];
+    /**
+     * @description 更新元素在图层中的顺序
+     * @param id 元素ID
+     * @param action 排序操作：BringToFront（置于顶层）、SendToBack（置于底层）、BringForward（上移一层）、SendBackward（下移一层）
+     */
+    updateItemOrder(id: string, action: ItemOrderAction): void;
+    /**
+     * @description 导出JSON
+     * @param idInfo 视图序号信息
+     * @returns JSON数组
+     */
+    exportJSON(idInfo?: number | number[]): spec.JSONScene[];
+    getViewBoxById(id: string): Box2;
+    getViewItemById(id: string): ViewItem | undefined;
+    getViewProperty(id: number): ViewProperty | undefined;
 }
 
 type SizeAdaptDirection = 'x' | 'y';
@@ -1000,11 +1218,17 @@ type SpriteFormProperty = BaseFormProperty & {
     image: string;
 };
 type TextFormProperty = BaseFormProperty & {
-    font: string;
-    color: [number, number, number, number];
-    weight: spec.TextWeight;
+    fontFamily: string;
+    textColor: [number, number, number, number];
+    fontWeight: spec.TextWeight;
     text: string;
-    alignment: spec.TextAlignment;
+    textAlign: spec.TextAlignment;
+    fontSize: number;
+    fontStyle: spec.FontStyle;
+    textWidth: number;
+    lineHeight: number;
+    outlineColor?: spec.vec4;
+    outlineWidth?: number;
 };
 /**
  * @description 页面表单类型和属性引用
@@ -1261,6 +1485,10 @@ type ActiveData = {
      * @description 预选中元素
      */
     preSelectedItem?: string;
+    /**
+     * @description 执行中元素
+     */
+    loadingItems?: string[];
 };
 /**
  * @description 视图元素
@@ -1300,6 +1528,7 @@ type SDKBackgroundType = 'color' | 'image' | 'chess-board';
  * @description 图层创建信息
  */
 type SpriteCreateInfo = {
+    type: 'sprite';
     /**
      * @description 图层名称
      */
@@ -1308,6 +1537,10 @@ type SpriteCreateInfo = {
      * @description 元素id
      */
     id?: string;
+    /**
+     * @description 父节点id
+     */
+    parentId?: string;
     /**
      * @description 图片资源地址
      */
@@ -1333,10 +1566,15 @@ type SpriteCreateInfo = {
  * @description 空节点创建信息
  */
 type NullCreateInfo = {
+    type: 'null';
     /**
      * @description 元素id
      */
     id?: string;
+    /**
+     * @description 父节点id
+     */
+    parentId?: string;
     /**
      * @description 元素名称
      */
@@ -1356,7 +1594,92 @@ type NullCreateInfo = {
     /**
      * @description 空节点位移
      */
-    translation?: spec.vec2;
+    position?: spec.vec2;
 };
+/**
+ * @description 文本创建信息
+ */
+type TextCreateInfo = {
+    type: 'text';
+    /**
+     * @description 元素id
+     */
+    id?: string;
+    /**
+     * @description 父节点id
+     */
+    parentId?: string;
+    /**
+     * @description 元素名称
+     */
+    name?: string;
+    /**
+     * @description 单行高度
+     */
+    lineHeight: number;
+    /**
+     * @description 文本高度
+     */
+    textHeight?: number;
+    /**
+     * @description 宽度
+     */
+    textWidth: number;
+    /**
+     * @description 字体名称
+     */
+    fontFamily: string;
+    /**
+     * @description 文本位置
+     */
+    position?: spec.vec2;
+    /**
+     * @description 文本旋转
+     */
+    rotation?: number;
+    /**
+     * @description 文字大小
+     */
+    fontSize: number;
+    /**
+     * @description 字重
+     */
+    fontWeight?: spec.TextWeight;
+    /**
+     * @description 字体格式
+     */
+    fontStyle?: spec.FontStyle;
+    /**
+     * @description 对齐方式
+     */
+    textAlign?: spec.TextAlignment;
+    /**
+     * @description 文本信息
+     */
+    text: string;
+    /**
+     * @description 填充色
+     */
+    textColor: spec.vec4;
+    /**
+     * @description 描边色
+     */
+    outlineColor?: spec.vec4;
+    /**
+     * @description 描边宽度
+     */
+    outlineWidth?: number;
+    /**
+     * @description 字体文件地址
+     */
+    url?: string;
+};
+type ItemCreateInfo = NullCreateInfo | SpriteCreateInfo | TextCreateInfo;
+declare enum ItemOrderAction {
+    BringToFront = 0,
+    SendToBack = 1,
+    BringForward = 2,
+    SendBackward = 3
+}
 
-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 };
+export { type ActiveData, type BaseFormProperty, Box2, ItemOrderAction, type NullCreateInfo, type PageData, type PageFormTypedProperty, type PageProperty, SDK, type SDKEvents, type SDKInputParam, type SDKOptions, type SpecificPageFormProps, type SpriteCreateInfo, type SpriteFormProperty, type TextCreateInfo, type TextFormProperty, Vector2, type ViewItem, type ViewItemTypedProperty, type ViewParam, type ViewProperty };