@vvfx/sdk 0.0.0-alpha.85 → 0.0.0-alpha.87

package/dist/index.d.cts

@@ -582,8 +582,8 @@ type SDKConfig = {
         textGizmoConfig: TextGizmoConfig;
         maskGizmoEnabled: boolean;
         maskGizmoConfig: MaskGizmoConfig;
-        spriteTextEditEnabled: boolean;
-        spriteTextEditConfig: SpriteTextEditConfig;
+        spriteTextEditGizmoEnabled: boolean;
+        spriteTextEditGizmoConfig: SpriteTextEditGizmoConfig;
     };
 };
 /**
@@ -700,6 +700,10 @@ type PreferenceGizmoConfig = {
  * @description 选择功能参数
  */
 type SelectorGizmoConfig = {
+    /**
+     * @description 视频预选中时
+     */
+    videoPreSelectedPlay: boolean;
     /**
      * @description 预选框线宽
      */
@@ -774,9 +778,17 @@ type TransformGizmoConfig = {
      */
     pictureLogoUrl: string;
     /**
-     * @description
+     * @description 空节点Logo地址
      */
     nullLogoUrl: string;
+    /**
+     * @description 文本Logo地址
+     */
+    textLogoUrl: string;
+    /**
+     * @description 视频Logo地址
+     */
+    videoLogoUrl: string;
     /**
      * @description 大小文字颜色
      */
@@ -1019,11 +1031,23 @@ type MaskGizmoConfig = {
 /**
  * @description 精准改字编辑参数
  */
-type SpriteTextEditConfig = {
+type SpriteTextEditGizmoConfig = {
     /**
      * @description 文案颜色
      */
     textColor: number;
+    /**
+     * @description 包围盒线框宽度
+     */
+    boxLineWidth: number;
+    /**
+     * @description 包围盒间隔线长度
+     */
+    dashLineDash: number;
+    /**
+     * @description 包围盒间隔线间隔
+     */
+    dashLineGap: number;
     /**
      * @description 预选中文案颜色
      */
@@ -1036,6 +1060,30 @@ type SpriteTextEditConfig = {
      * @description 编辑包围盒透明度
      */
     editBoxAlpha: number;
+    /**
+     * @description 编辑包围盒线框颜色
+     */
+    editBoxLineColor: number;
+    /**
+     * @description 编辑包围盒线框透明度
+     */
+    editBoxLineAlpha: number;
+    /**
+     * @description 已更改编辑包围盒颜色
+     */
+    hasChangedEditBoxColor: number;
+    /**
+     * @description 已更改编辑包围盒透明度
+     */
+    hasChangedEditBoxAlpha: number;
+    /**
+     * @description 已更改编辑包围盒线框颜色
+     */
+    hasChangedEditBoxLineColor: number;
+    /**
+     * @description 已更改编辑包围盒线框透明度
+     */
+    hasChangedEditBoxLineAlpha: number;
     /**
      * @description 编辑包围盒预选颜色
      */
@@ -1044,6 +1092,30 @@ type SpriteTextEditConfig = {
      * @description 编辑包围盒预选透明度
      */
     editBoxPreSelectedAlpha: number;
+    /**
+     * @description 编辑包围盒预选线框颜色
+     */
+    editBoxLinePreSelectedColor: number;
+    /**
+     * @description 编辑包围盒预选线框透明度
+     */
+    editBoxLinePreSelectedAlpha: number;
+    /**
+     * @description 已更改编辑包围盒预选颜色
+     */
+    hasChangedEditBoxPreSelectedColor: number;
+    /**
+     * @description 已更改编辑包围盒预选透明度
+     */
+    hasChangedEditBoxPreSelectedAlpha: number;
+    /**
+   * @description 已更改编辑包围盒线框颜色
+   */
+    hasChangedEditBoxLinePreSelectedColor: number;
+    /**
+     * @description 已更改编辑包围盒线框透明度
+     */
+    hasChangedEditBoxLinePreSelectedAlpha: number;
     /**
      * @description 选中状态标记包围盒颜色
      */
@@ -1068,6 +1140,10 @@ type SpriteTextInitParam = {
     info: SpriteTextInitInfo[];
 };
 type SpriteTextInitInfo = {
+    /**
+     * @description 是否被修改过
+     */
+    hasChanged: boolean;
     /**
      * @description 文字内容
      */
@@ -1084,6 +1160,7 @@ declare module '@pixi/graphics' {
         fillBox(box: Box2): void;
         drawBox(box: Box2): void;
         drawLine(line: Line2 | Point[]): void;
+        drawDashLine(toX: number, toY: number, dash: number, gap: number): void;
     }
 }
 
@@ -1123,9 +1200,10 @@ type SDKEvents = {
     'itemOnDragStart': [type: GizmoType];
     'itemOnDrag': [type: GizmoType];
     'itemOnDragEnd': [type: GizmoType];
-    'spriteTextSelected': [{
+    'spriteTextClick': [{
         id: string;
         index: number;
+        text: string;
     } | undefined];
 };
 declare class SDK {
@@ -1151,7 +1229,7 @@ declare class SDK {
     get undoRedo(): UndoRedo;
     private get exportOptions();
     dispose(): void;
-    on: <E extends "progress" | "loadingItemChange" | "selectedItemChange" | "preSelectedItemChange" | "selectedViewChange" | "pageDataChange" | "zoomChange" | "itemPropertyChange" | "exportProgress" | "exportDone" | "exportComplete" | "sdkConfigChange" | "cutBoxChange" | "expandBoxChange" | "textInput" | "undoRedoChange" | "viewportTransform" | "itemOnDragStart" | "itemOnDrag" | "itemOnDragEnd" | "spriteTextSelected">(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" | "undoRedoChange" | "viewportTransform" | "itemOnDragStart" | "itemOnDrag" | "itemOnDragEnd" | "spriteTextClick">(eventName: E, listener: _galacean_effects.EventEmitterListener<SDKEvents[E]>, options?: _galacean_effects.EventEmitterOptions) => () => void;
     setSDKMode(mode: SDKMode): void;
     private getInitParam;
     /**
@@ -1332,6 +1410,7 @@ declare class SDK {
      * @param spriteInfo 图层元素信息
      */
     addSpriteItem(spriteInfo: SpriteCreateInfo, scene?: spec.JSONScene): Promise<string | undefined>;
+    addVideoItem(videoInfo: VideoCreateInfo, scene?: spec.JSONScene): Promise<string | undefined>;
     openPictureCutGizmo(): void;
     closePictureCutGizmo(): void;
     getCutInfo(): {
@@ -1351,7 +1430,7 @@ declare class SDK {
     closeMaskGizmo(): void;
     getMask(): string | null | undefined;
     setMaskGizmoConfig(config: Partial<MaskGizmoConfig>): void;
-    openLoadingGizmo(id: string, loadingBox?: Box2): void;
+    openLoadingGizmo(id: string, loadingBox?: Box2, clearResult?: boolean): void;
     closeLoadingGizmo(id: string): void;
     /**
      * @description 元素打组
@@ -1416,6 +1495,8 @@ declare class SDK {
     closeSpriteTextEditGizmo(): void;
     changeSpriteTextSelectedIndex(id: string, index: number): void;
     changeSpriteTextSelectedText(id: string, index: number, text: string): void;
+    getBoundingBoxByItemCreateInfo(createInfo: ItemCreateInfo): Box2;
+    getBoundingBoxByItemCreateInfos(createInfos: ItemCreateInfo[]): Box2;
 }
 
 type SizeAdaptDirection = 'x' | 'y';
@@ -1447,6 +1528,9 @@ type TextFormProperty = BaseFormProperty & {
      */
     outlineEnabled?: boolean;
 };
+type VideoFormProperty = BaseFormProperty & {
+    video: string;
+};
 /**
  * @description 页面表单类型和属性引用
  */
@@ -1469,7 +1553,7 @@ type PageFormTypeAndPropertyReference = {
     [spec.ItemType.shape]: BaseFormProperty;
     [spec.ItemType.postProcessVolume]: BaseFormProperty;
     [spec.ItemType.node]: BaseFormProperty;
-    [spec.ItemType.video]: BaseFormProperty;
+    [spec.ItemType.video]: VideoFormProperty;
     [spec.ItemType.audio]: BaseFormProperty;
     [spec.ItemType.richtext]: TextFormProperty;
 };
@@ -1899,7 +1983,61 @@ type TextCreateInfo = {
      */
     url?: string;
 };
-type ItemCreateInfo = NullCreateInfo | SpriteCreateInfo | TextCreateInfo;
+/**
+ * @description 视频创建信息
+ */
+type VideoCreateInfo = {
+    type: 'video';
+    /**
+     * @description 视频名称
+     */
+    name?: string;
+    /**
+     * @description 元素id
+     */
+    id?: string;
+    /**
+     * @description 父节点id
+     */
+    parentId?: string;
+    /**
+     * @description 视频资源地址
+     */
+    url: string;
+    /**
+     * @description 视频元素像素大小
+     */
+    size: spec.vec2;
+    /**
+     * @description 视频元素缩放
+     */
+    scale?: spec.vec2;
+    /**
+     * @description 视频元素旋转
+     */
+    rotation?: number;
+    /**
+     * @description 视频元素二维位置
+     */
+    position: spec.vec2;
+    /**
+     * @description 是否静音
+     */
+    muted?: boolean;
+    /**
+     * @description 是否为透明视频
+     */
+    transparent?: boolean;
+    /**
+     * @description 播放速率
+     */
+    playbackRate?: number;
+    /**
+     * @description 音量
+     */
+    volume?: number;
+};
+type ItemCreateInfo = NullCreateInfo | SpriteCreateInfo | TextCreateInfo | VideoCreateInfo;
 /**
  * @description 场景创建信息
  */

package/dist/index.d.ts

@@ -582,8 +582,8 @@ type SDKConfig = {
         textGizmoConfig: TextGizmoConfig;
         maskGizmoEnabled: boolean;
         maskGizmoConfig: MaskGizmoConfig;
-        spriteTextEditEnabled: boolean;
-        spriteTextEditConfig: SpriteTextEditConfig;
+        spriteTextEditGizmoEnabled: boolean;
+        spriteTextEditGizmoConfig: SpriteTextEditGizmoConfig;
     };
 };
 /**
@@ -700,6 +700,10 @@ type PreferenceGizmoConfig = {
  * @description 选择功能参数
  */
 type SelectorGizmoConfig = {
+    /**
+     * @description 视频预选中时
+     */
+    videoPreSelectedPlay: boolean;
     /**
      * @description 预选框线宽
      */
@@ -774,9 +778,17 @@ type TransformGizmoConfig = {
      */
     pictureLogoUrl: string;
     /**
-     * @description
+     * @description 空节点Logo地址
      */
     nullLogoUrl: string;
+    /**
+     * @description 文本Logo地址
+     */
+    textLogoUrl: string;
+    /**
+     * @description 视频Logo地址
+     */
+    videoLogoUrl: string;
     /**
      * @description 大小文字颜色
      */
@@ -1019,11 +1031,23 @@ type MaskGizmoConfig = {
 /**
  * @description 精准改字编辑参数
  */
-type SpriteTextEditConfig = {
+type SpriteTextEditGizmoConfig = {
     /**
      * @description 文案颜色
      */
     textColor: number;
+    /**
+     * @description 包围盒线框宽度
+     */
+    boxLineWidth: number;
+    /**
+     * @description 包围盒间隔线长度
+     */
+    dashLineDash: number;
+    /**
+     * @description 包围盒间隔线间隔
+     */
+    dashLineGap: number;
     /**
      * @description 预选中文案颜色
      */
@@ -1036,6 +1060,30 @@ type SpriteTextEditConfig = {
      * @description 编辑包围盒透明度
      */
     editBoxAlpha: number;
+    /**
+     * @description 编辑包围盒线框颜色
+     */
+    editBoxLineColor: number;
+    /**
+     * @description 编辑包围盒线框透明度
+     */
+    editBoxLineAlpha: number;
+    /**
+     * @description 已更改编辑包围盒颜色
+     */
+    hasChangedEditBoxColor: number;
+    /**
+     * @description 已更改编辑包围盒透明度
+     */
+    hasChangedEditBoxAlpha: number;
+    /**
+     * @description 已更改编辑包围盒线框颜色
+     */
+    hasChangedEditBoxLineColor: number;
+    /**
+     * @description 已更改编辑包围盒线框透明度
+     */
+    hasChangedEditBoxLineAlpha: number;
     /**
      * @description 编辑包围盒预选颜色
      */
@@ -1044,6 +1092,30 @@ type SpriteTextEditConfig = {
      * @description 编辑包围盒预选透明度
      */
     editBoxPreSelectedAlpha: number;
+    /**
+     * @description 编辑包围盒预选线框颜色
+     */
+    editBoxLinePreSelectedColor: number;
+    /**
+     * @description 编辑包围盒预选线框透明度
+     */
+    editBoxLinePreSelectedAlpha: number;
+    /**
+     * @description 已更改编辑包围盒预选颜色
+     */
+    hasChangedEditBoxPreSelectedColor: number;
+    /**
+     * @description 已更改编辑包围盒预选透明度
+     */
+    hasChangedEditBoxPreSelectedAlpha: number;
+    /**
+   * @description 已更改编辑包围盒线框颜色
+   */
+    hasChangedEditBoxLinePreSelectedColor: number;
+    /**
+     * @description 已更改编辑包围盒线框透明度
+     */
+    hasChangedEditBoxLinePreSelectedAlpha: number;
     /**
      * @description 选中状态标记包围盒颜色
      */
@@ -1068,6 +1140,10 @@ type SpriteTextInitParam = {
     info: SpriteTextInitInfo[];
 };
 type SpriteTextInitInfo = {
+    /**
+     * @description 是否被修改过
+     */
+    hasChanged: boolean;
     /**
      * @description 文字内容
      */
@@ -1084,6 +1160,7 @@ declare module '@pixi/graphics' {
         fillBox(box: Box2): void;
         drawBox(box: Box2): void;
         drawLine(line: Line2 | Point[]): void;
+        drawDashLine(toX: number, toY: number, dash: number, gap: number): void;
     }
 }
 
@@ -1123,9 +1200,10 @@ type SDKEvents = {
     'itemOnDragStart': [type: GizmoType];
     'itemOnDrag': [type: GizmoType];
     'itemOnDragEnd': [type: GizmoType];
-    'spriteTextSelected': [{
+    'spriteTextClick': [{
         id: string;
         index: number;
+        text: string;
     } | undefined];
 };
 declare class SDK {
@@ -1151,7 +1229,7 @@ declare class SDK {
     get undoRedo(): UndoRedo;
     private get exportOptions();
     dispose(): void;
-    on: <E extends "progress" | "loadingItemChange" | "selectedItemChange" | "preSelectedItemChange" | "selectedViewChange" | "pageDataChange" | "zoomChange" | "itemPropertyChange" | "exportProgress" | "exportDone" | "exportComplete" | "sdkConfigChange" | "cutBoxChange" | "expandBoxChange" | "textInput" | "undoRedoChange" | "viewportTransform" | "itemOnDragStart" | "itemOnDrag" | "itemOnDragEnd" | "spriteTextSelected">(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" | "undoRedoChange" | "viewportTransform" | "itemOnDragStart" | "itemOnDrag" | "itemOnDragEnd" | "spriteTextClick">(eventName: E, listener: _galacean_effects.EventEmitterListener<SDKEvents[E]>, options?: _galacean_effects.EventEmitterOptions) => () => void;
     setSDKMode(mode: SDKMode): void;
     private getInitParam;
     /**
@@ -1332,6 +1410,7 @@ declare class SDK {
      * @param spriteInfo 图层元素信息
      */
     addSpriteItem(spriteInfo: SpriteCreateInfo, scene?: spec.JSONScene): Promise<string | undefined>;
+    addVideoItem(videoInfo: VideoCreateInfo, scene?: spec.JSONScene): Promise<string | undefined>;
     openPictureCutGizmo(): void;
     closePictureCutGizmo(): void;
     getCutInfo(): {
@@ -1351,7 +1430,7 @@ declare class SDK {
     closeMaskGizmo(): void;
     getMask(): string | null | undefined;
     setMaskGizmoConfig(config: Partial<MaskGizmoConfig>): void;
-    openLoadingGizmo(id: string, loadingBox?: Box2): void;
+    openLoadingGizmo(id: string, loadingBox?: Box2, clearResult?: boolean): void;
     closeLoadingGizmo(id: string): void;
     /**
      * @description 元素打组
@@ -1416,6 +1495,8 @@ declare class SDK {
     closeSpriteTextEditGizmo(): void;
     changeSpriteTextSelectedIndex(id: string, index: number): void;
     changeSpriteTextSelectedText(id: string, index: number, text: string): void;
+    getBoundingBoxByItemCreateInfo(createInfo: ItemCreateInfo): Box2;
+    getBoundingBoxByItemCreateInfos(createInfos: ItemCreateInfo[]): Box2;
 }
 
 type SizeAdaptDirection = 'x' | 'y';
@@ -1447,6 +1528,9 @@ type TextFormProperty = BaseFormProperty & {
      */
     outlineEnabled?: boolean;
 };
+type VideoFormProperty = BaseFormProperty & {
+    video: string;
+};
 /**
  * @description 页面表单类型和属性引用
  */
@@ -1469,7 +1553,7 @@ type PageFormTypeAndPropertyReference = {
     [spec.ItemType.shape]: BaseFormProperty;
     [spec.ItemType.postProcessVolume]: BaseFormProperty;
     [spec.ItemType.node]: BaseFormProperty;
-    [spec.ItemType.video]: BaseFormProperty;
+    [spec.ItemType.video]: VideoFormProperty;
     [spec.ItemType.audio]: BaseFormProperty;
     [spec.ItemType.richtext]: TextFormProperty;
 };
@@ -1899,7 +1983,61 @@ type TextCreateInfo = {
      */
     url?: string;
 };
-type ItemCreateInfo = NullCreateInfo | SpriteCreateInfo | TextCreateInfo;
+/**
+ * @description 视频创建信息
+ */
+type VideoCreateInfo = {
+    type: 'video';
+    /**
+     * @description 视频名称
+     */
+    name?: string;
+    /**
+     * @description 元素id
+     */
+    id?: string;
+    /**
+     * @description 父节点id
+     */
+    parentId?: string;
+    /**
+     * @description 视频资源地址
+     */
+    url: string;
+    /**
+     * @description 视频元素像素大小
+     */
+    size: spec.vec2;
+    /**
+     * @description 视频元素缩放
+     */
+    scale?: spec.vec2;
+    /**
+     * @description 视频元素旋转
+     */
+    rotation?: number;
+    /**
+     * @description 视频元素二维位置
+     */
+    position: spec.vec2;
+    /**
+     * @description 是否静音
+     */
+    muted?: boolean;
+    /**
+     * @description 是否为透明视频
+     */
+    transparent?: boolean;
+    /**
+     * @description 播放速率
+     */
+    playbackRate?: number;
+    /**
+     * @description 音量
+     */
+    volume?: number;
+};
+type ItemCreateInfo = NullCreateInfo | SpriteCreateInfo | TextCreateInfo | VideoCreateInfo;
 /**
  * @description 场景创建信息
  */