@vvfx/sdk 0.0.0-alpha.84 → 0.0.0-alpha.86

package/dist/index.d.cts

@@ -582,6 +582,8 @@ type SDKConfig = {
         textGizmoConfig: TextGizmoConfig;
         maskGizmoEnabled: boolean;
         maskGizmoConfig: MaskGizmoConfig;
+        spriteTextEditGizmoEnabled: boolean;
+        spriteTextEditGizmoConfig: SpriteTextEditGizmoConfig;
     };
 };
 /**
@@ -698,6 +700,10 @@ type PreferenceGizmoConfig = {
  * @description 选择功能参数
  */
 type SelectorGizmoConfig = {
+    /**
+     * @description 视频预选中时
+     */
+    videoPreSelectedPlay: boolean;
     /**
      * @description 预选框线宽
      */
@@ -772,9 +778,17 @@ type TransformGizmoConfig = {
      */
     pictureLogoUrl: string;
     /**
-     * @description
+     * @description 空节点Logo地址
      */
     nullLogoUrl: string;
+    /**
+     * @description 文本Logo地址
+     */
+    textLogoUrl: string;
+    /**
+     * @description 视频Logo地址
+     */
+    videoLogoUrl: string;
     /**
      * @description 大小文字颜色
      */
@@ -1014,8 +1028,68 @@ type MaskGizmoConfig = {
      */
     boxLineAlpha: number;
 };
+/**
+ * @description 精准改字编辑参数
+ */
+type SpriteTextEditGizmoConfig = {
+    /**
+     * @description 文案颜色
+     */
+    textColor: number;
+    /**
+     * @description 预选中文案颜色
+     */
+    preSelectedTextColor: number;
+    /**
+     * @description 标记包围盒颜色
+     */
+    editBoxColor: number;
+    /**
+     * @description 编辑包围盒透明度
+     */
+    editBoxAlpha: number;
+    /**
+     * @description 编辑包围盒预选颜色
+     */
+    editBoxPreSelectedColor: number;
+    /**
+     * @description 编辑包围盒预选透明度
+     */
+    editBoxPreSelectedAlpha: number;
+    /**
+     * @description 选中状态标记包围盒颜色
+     */
+    editBoxSelectedColor: number;
+    /**
+     * @description 选中状态标记包围盒颜色
+     */
+    editBoxSelectedAlpha: number;
+};
 
-type GizmoType = 'null' | 'selector' | 'transform' | 'control' | 'adsorption' | 'preference' | 'picture-cut' | 'text' | 'mask' | 'loading' | 'picture-expand';
+/**
+ * @description 精准改字功能初始化信息
+ */
+type SpriteTextInitParam = {
+    /**
+     * @description 元素ID
+     */
+    id: string;
+    /**
+     * @description 改字信息
+     */
+    info: SpriteTextInitInfo[];
+};
+type SpriteTextInitInfo = {
+    /**
+     * @description 文字内容
+     */
+    text: string;
+    /**
+     * @description 包围盒信息
+     */
+    box: [spec.vec2, spec.vec2, spec.vec2, spec.vec2];
+};
+type GizmoType = 'null' | 'selector' | 'transform' | 'control' | 'adsorption' | 'preference' | 'picture-cut' | 'text' | 'mask' | 'loading' | 'picture-expand' | 'sprite-text-edit';
 
 declare module '@pixi/graphics' {
     interface Graphics {
@@ -1061,6 +1135,11 @@ type SDKEvents = {
     'itemOnDragStart': [type: GizmoType];
     'itemOnDrag': [type: GizmoType];
     'itemOnDragEnd': [type: GizmoType];
+    'spriteTextSelected': [{
+        id: string;
+        index: number;
+        text: string;
+    } | undefined];
 };
 declare class SDK {
     static config: SDKConfig;
@@ -1085,7 +1164,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">(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" | "spriteTextSelected">(eventName: E, listener: _galacean_effects.EventEmitterListener<SDKEvents[E]>, options?: _galacean_effects.EventEmitterOptions) => () => void;
     setSDKMode(mode: SDKMode): void;
     private getInitParam;
     /**
@@ -1266,6 +1345,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(): {
@@ -1345,6 +1425,13 @@ declare class SDK {
     createSceneByCreateInfos(createInfos: ItemCreateInfo[], sceneInfo: SceneCreaetInfo): spec.JSONScene;
     changeItemPropertyByCreateInfo(createInfo: ItemCreateInfo | ItemCreateInfo[]): void;
     setTransformGizmoLockScale(state: boolean): void;
+    getViewBoxByBox(box: Box2): Box2;
+    openSpriteTextEditGizmo(initParam: SpriteTextInitParam[]): void;
+    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';
@@ -1376,6 +1463,9 @@ type TextFormProperty = BaseFormProperty & {
      */
     outlineEnabled?: boolean;
 };
+type VideoFormProperty = BaseFormProperty & {
+    video: string;
+};
 /**
  * @description 页面表单类型和属性引用
  */
@@ -1398,7 +1488,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;
 };
@@ -1828,7 +1918,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,6 +582,8 @@ type SDKConfig = {
         textGizmoConfig: TextGizmoConfig;
         maskGizmoEnabled: boolean;
         maskGizmoConfig: MaskGizmoConfig;
+        spriteTextEditGizmoEnabled: boolean;
+        spriteTextEditGizmoConfig: SpriteTextEditGizmoConfig;
     };
 };
 /**
@@ -698,6 +700,10 @@ type PreferenceGizmoConfig = {
  * @description 选择功能参数
  */
 type SelectorGizmoConfig = {
+    /**
+     * @description 视频预选中时
+     */
+    videoPreSelectedPlay: boolean;
     /**
      * @description 预选框线宽
      */
@@ -772,9 +778,17 @@ type TransformGizmoConfig = {
      */
     pictureLogoUrl: string;
     /**
-     * @description
+     * @description 空节点Logo地址
      */
     nullLogoUrl: string;
+    /**
+     * @description 文本Logo地址
+     */
+    textLogoUrl: string;
+    /**
+     * @description 视频Logo地址
+     */
+    videoLogoUrl: string;
     /**
      * @description 大小文字颜色
      */
@@ -1014,8 +1028,68 @@ type MaskGizmoConfig = {
      */
     boxLineAlpha: number;
 };
+/**
+ * @description 精准改字编辑参数
+ */
+type SpriteTextEditGizmoConfig = {
+    /**
+     * @description 文案颜色
+     */
+    textColor: number;
+    /**
+     * @description 预选中文案颜色
+     */
+    preSelectedTextColor: number;
+    /**
+     * @description 标记包围盒颜色
+     */
+    editBoxColor: number;
+    /**
+     * @description 编辑包围盒透明度
+     */
+    editBoxAlpha: number;
+    /**
+     * @description 编辑包围盒预选颜色
+     */
+    editBoxPreSelectedColor: number;
+    /**
+     * @description 编辑包围盒预选透明度
+     */
+    editBoxPreSelectedAlpha: number;
+    /**
+     * @description 选中状态标记包围盒颜色
+     */
+    editBoxSelectedColor: number;
+    /**
+     * @description 选中状态标记包围盒颜色
+     */
+    editBoxSelectedAlpha: number;
+};
 
-type GizmoType = 'null' | 'selector' | 'transform' | 'control' | 'adsorption' | 'preference' | 'picture-cut' | 'text' | 'mask' | 'loading' | 'picture-expand';
+/**
+ * @description 精准改字功能初始化信息
+ */
+type SpriteTextInitParam = {
+    /**
+     * @description 元素ID
+     */
+    id: string;
+    /**
+     * @description 改字信息
+     */
+    info: SpriteTextInitInfo[];
+};
+type SpriteTextInitInfo = {
+    /**
+     * @description 文字内容
+     */
+    text: string;
+    /**
+     * @description 包围盒信息
+     */
+    box: [spec.vec2, spec.vec2, spec.vec2, spec.vec2];
+};
+type GizmoType = 'null' | 'selector' | 'transform' | 'control' | 'adsorption' | 'preference' | 'picture-cut' | 'text' | 'mask' | 'loading' | 'picture-expand' | 'sprite-text-edit';
 
 declare module '@pixi/graphics' {
     interface Graphics {
@@ -1061,6 +1135,11 @@ type SDKEvents = {
     'itemOnDragStart': [type: GizmoType];
     'itemOnDrag': [type: GizmoType];
     'itemOnDragEnd': [type: GizmoType];
+    'spriteTextSelected': [{
+        id: string;
+        index: number;
+        text: string;
+    } | undefined];
 };
 declare class SDK {
     static config: SDKConfig;
@@ -1085,7 +1164,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">(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" | "spriteTextSelected">(eventName: E, listener: _galacean_effects.EventEmitterListener<SDKEvents[E]>, options?: _galacean_effects.EventEmitterOptions) => () => void;
     setSDKMode(mode: SDKMode): void;
     private getInitParam;
     /**
@@ -1266,6 +1345,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(): {
@@ -1345,6 +1425,13 @@ declare class SDK {
     createSceneByCreateInfos(createInfos: ItemCreateInfo[], sceneInfo: SceneCreaetInfo): spec.JSONScene;
     changeItemPropertyByCreateInfo(createInfo: ItemCreateInfo | ItemCreateInfo[]): void;
     setTransformGizmoLockScale(state: boolean): void;
+    getViewBoxByBox(box: Box2): Box2;
+    openSpriteTextEditGizmo(initParam: SpriteTextInitParam[]): void;
+    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';
@@ -1376,6 +1463,9 @@ type TextFormProperty = BaseFormProperty & {
      */
     outlineEnabled?: boolean;
 };
+type VideoFormProperty = BaseFormProperty & {
+    video: string;
+};
 /**
  * @description 页面表单类型和属性引用
  */
@@ -1398,7 +1488,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;
 };
@@ -1828,7 +1918,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 场景创建信息
  */