@vvfx/sdk 0.1.19-alpha.36 → 0.1.19-alpha.38

package/dist/src/config.d.ts

@@ -0,0 +1,855 @@
+import { ExportMediaInitOptions } from './exporter';
+import { GlobalLayoutMode } from './utils';
+export type SDKMode = 'editor' | 'template';
+/**
+ * @description SDK功能配置
+ */
+export type SDKConfig = {
+    /**
+     * @description SDK编辑模式 - 模板编辑模式 | 编辑器模式
+     */
+    mode: SDKMode;
+    /**
+     * @description 页面功能配置
+     */
+    pageConfig: PageConfig;
+    /**
+     * @description 异步加载功能配置
+     */
+    asyncLoadConfig: AsyncLoadConfig;
+    /**
+     * @description 截图功能配置
+     */
+    screenShotConfig: ScreenShotConfig;
+    /**
+     * @description 导出视频功能配置
+     */
+    exportConfig: ExportConfig;
+    /**
+     * @description 尺寸自适应功能开关
+     */
+    sizeAdaptConfig: SizeAdaptConfig;
+    /**
+     * @description 辅助面板功能配置
+     */
+    gestureHandlerConfig: {
+        enabled: boolean;
+        loadingGizmoConfig: LoadingGizmoConfig;
+        adsorptionGizmoEnabled: boolean;
+        adsorptionGizmoConfig: AdsorptionGizmoConfig;
+        controlGizmoEnabled: boolean;
+        controlGizmoConfig: ControlGizmoConfig;
+        preferenceGizmoEnabled: boolean;
+        preferenceGizmoConfig: PreferenceGizmoConfig;
+        selectorGizmoEnabled: boolean;
+        selectorGizmoConfig: SelectorGizmoConfig;
+        transformGizmoEnabled: boolean;
+        transformGizmoConfig: TransformGizmoConfig;
+        pictureCutGizmoEnabled: boolean;
+        pictureCutGizmoConfig: PictureCutGizmoConfig;
+        pictureExpandGizmoEnabled: boolean;
+        pictureExpandGizmoConfig: PictureExpandGizmoConfig;
+        textGizmoEnbaled: boolean;
+        textGizmoConfig: TextGizmoConfig;
+        maskGizmoEnabled: boolean;
+        maskGizmoConfig: MaskGizmoConfig;
+        spriteTextEditGizmoEnabled: boolean;
+        spriteTextEditGizmoConfig: SpriteTextEditGizmoConfig;
+        iconGizmoEnabled: boolean;
+        iconGizmoConfig: IconGizmoConfig;
+        itemCreateGizmoEnabled: boolean;
+        itemCreateGizmoConfig: ItemCreateGizmoConfig;
+        /**
+         * @description 自动布局指示器配置
+         */
+        autoLayoutIndicatorConfig: AutoLayoutIndicatorConfig;
+    };
+    /**
+     * @description 元素配置
+     */
+    itemConfig: {
+        /**
+         * @description 画板元素参数配置
+         */
+        frameConfig: FrameConfig;
+        /**
+         * @description 生成器元素参数配置
+         */
+        generatorConfig: GeneratorConfig;
+        /**
+         * @description 卡片元素参数配置
+         */
+        cardConfig: CardConfig;
+    };
+};
+/**
+ * @description 画板元素参数配置
+ */
+export type FrameConfig = {
+    /**
+     * @description 自动布局边距
+     */
+    layoutPadding: number;
+    /**
+     * @description 自动布局元素间隔
+     */
+    layoutGap: number;
+    /**
+     * @description 默认画板[无子元素时]宽度
+     */
+    defaultWidth: number;
+    /**
+     * @description 默认画板[无子元素时]高度
+     */
+    defaultHeight: number;
+    /**
+     * @description 自动布局背景颜色
+     */
+    autoLayoutBackgroundColor: [number, number, number, number];
+    /**
+     * @description 自由布局背景颜色
+     */
+    freeLayoutBackgroundColor: [number, number, number, number];
+};
+/**
+ * @description 生成器元素参数配置
+ */
+export type GeneratorConfig = {
+    /**
+     * @description 生成器背景颜色
+     */
+    backgroundColor: [number, number, number, number];
+};
+/**
+ * @description 卡片类型配置条目
+ */
+export type CardTypeConfig = {
+    /**
+     * @description 卡片类型标识
+     */
+    type: string;
+    /**
+     * @description 卡片类型显示名称
+     */
+    label: string;
+    /**
+     * @description TransformGizmo 左上角展示的 icon URL
+     */
+    iconUrl: string;
+};
+/**
+ * @description 卡片元素参数配置
+ */
+export type CardConfig = {
+    /**
+     * @description 卡片元素背景颜色
+     */
+    backgroundColor: [number, number, number, number];
+    /**
+     * @description 注册的卡片类型列表，支持动态配置
+     * 每个条目包含 type 标识、显示名称和图标 URL
+     */
+    cardTypes: CardTypeConfig[];
+};
+/**
+ * @description 自动布局指示器配置
+ */
+export type AutoLayoutIndicatorConfig = {
+    /**
+     * @description 指示线宽度
+     */
+    lineWidth: number;
+    /**
+     * @description 指示线颜色
+     */
+    lineColor: number;
+};
+/**
+ * @description 页面功能配置
+ */
+export type PageConfig = {
+    /**
+     * @description 同步修改功能开关
+     */
+    asncMode: boolean;
+    /**
+     * @description 静态预览【视图只提供播放预览功能】功能开关
+     */
+    staticPreview: boolean;
+    /**
+     * @description 静态预览视图名称
+     */
+    staticPreviewName: string;
+    /**
+     * @description 需过滤的元素名称
+     */
+    filterItemNames: string[];
+    /**
+     * @description 成组操作元素显隐
+     */
+    groupVisible: boolean;
+    /**
+     * @description 缩放最大值
+     */
+    maxZoom: number;
+    /**
+     * @description 缩放最小值
+     */
+    minZoom: number;
+    /**
+     * @description 全局自适应排布模式
+     */
+    autoLayoutDefaultMode: GlobalLayoutMode;
+    /**
+     * @description 全局自适应排布间隔
+     */
+    autoLayoutDefaultGap: number;
+};
+/**
+ * @description 异步加载配置
+ */
+export type AsyncLoadConfig = {
+    enabled: boolean;
+    loadingTextureUrl: string;
+};
+/**
+ * @description 视频导出功能配置
+ */
+export type ExportConfig = {
+    enabled: boolean;
+} & ExportMediaInitOptions;
+/**
+ * @description 截图功能配置
+ */
+export type ScreenShotConfig = {
+    enabled: boolean;
+    defaultBackgroundColor: [number, number, number, number];
+};
+/**
+ * @description 尺寸自适应功能配置
+ */
+export type SizeAdaptConfig = {
+    enabled: boolean;
+};
+/**
+ * @description 对齐吸附功能参数
+ */
+export type AdsorptionGizmoConfig = {
+    /**
+   * @description 对齐吸附线宽
+   */
+    lineWidth: number;
+    /**
+     * @description 对齐线颜色
+     */
+    lineColor: number;
+    /**
+     * @description 对齐吸附距离
+     */
+    distance: number;
+};
+/**
+ * @description 视图控制功能参数
+ */
+export type ControlGizmoConfig = {
+    /**
+     * @description 缩放步长
+     */
+    zoomStep: number;
+};
+/**
+ * @description 视口展示功能参数
+ */
+export type PreferenceGizmoConfig = {
+    /**
+   * @description 视口窗包围盒颜色
+   */
+    boxColor: number;
+    /**
+     * @description 视口窗包围盒宽度
+     */
+    boxWidth: number;
+    /**
+     * @description 视口区域外遮罩颜色
+     */
+    markColor: number;
+    /**
+     * @description 视口区域外遮罩透明度
+     */
+    markAlpha: number;
+    /**
+     * @description 出血区预览开关
+     */
+    safeAreaEnabled: boolean;
+    /**
+     * @description 出血区颜色
+     */
+    safeAreaBoxColor: number;
+    /**
+     * @description 出血区透明度
+     */
+    safeAreaBoxAlpha: number;
+};
+/**
+ * @description 选择功能参数
+ */
+export type SelectorGizmoConfig = {
+    /**
+     * @description 视频预选中时
+     */
+    videoPreSelectedPlay: boolean;
+    /**
+     * @description 预选框线宽
+     */
+    preSelectedWidth: number;
+    /**
+     * @description 预选框颜色
+     */
+    preSelectedColor: number;
+    /**
+     * @description 框选区域颜色
+     */
+    regionBoxColor: number;
+    /**
+     * @description 框选区域透明度
+     */
+    regionBoxAlpha: number;
+    /**
+     * @description 框选区域包围框颜色
+     */
+    regionWireframeColor: number;
+    /**
+     * @description 框选区域包围框透明度
+     */
+    regionWireframeAlpha: number;
+    /**
+     * @description 框选区域包围框宽度
+     */
+    regionWireframeWidth: number;
+};
+/**
+ * @description 变换功能参数
+ */
+export type TransformGizmoConfig = {
+    /**
+     * @description 变换交互框颜色
+     */
+    wireframeColor: number;
+    /**
+     * @description 变换交互框透明度
+     */
+    wireframeAlpha: number;
+    /**
+     * @description 变换交互框宽度
+     */
+    wireframeWidth: number;
+    /**
+     * @description 变换交互框角点填充色
+     */
+    cornerFillColor: number;
+    /**
+     * @description 变换交互框角点线框色
+     */
+    cornerLineColor: number;
+    /**
+     * @description 变换交互框角点线框宽度
+     */
+    cornerLineWidth: number;
+    /**
+     * @description 变换交互框角点线框透明度
+     */
+    cornerLineAlpha: number;
+    /**
+     * @description 交互框缩放圆半径
+     */
+    scaleCircleSize: number;
+    /**
+     * @description 交互框旋转圆半径
+     */
+    rotationCircleSize: number;
+    /**
+     * @description 图片Logo地址
+     */
+    pictureLogoUrl: string;
+    /**
+     * @description 空节点Logo地址
+     */
+    groupLogoUrl: string;
+    /**
+     * @description 文本Logo地址
+     */
+    textLogoUrl: string;
+    /**
+     * @description 视频Logo地址
+     */
+    videoLogoUrl: string;
+    /**
+     * @description 画板Logo地址
+     */
+    frameLogoUrl: string;
+    /**
+     * @description 特效Logo地址
+     */
+    effectsLogoUrl: string;
+    /**
+     * @description 大小文字颜色
+     */
+    sizeTextColor: number;
+    /**
+     * @description 名称文字颜色
+     */
+    nameTextColor: number;
+    /**
+     * @description 选中信息展示
+     */
+    infoShowEnabled: boolean;
+};
+/**
+ * @description 图片裁切参数
+ */
+export 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;
+    /**
+     * @description 网格线数量
+     */
+    gridCount: number;
+    /**
+     * @description 网格线颜色
+     */
+    gridLineColor: number;
+    /**
+     * @description 网格线宽度
+     */
+    gridLineWidth: number;
+    /**
+     * @description 网格线透明度
+     */
+    gridLineAlpha: number;
+};
+/**
+ * @description 图片扩边参数
+ */
+export 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 网格线数量
+     */
+    gridCount: number;
+    /**
+     * @description 网格线颜色
+     */
+    gridLineColor: number;
+    /**
+     * @description 网格线宽度
+     */
+    gridLineWidth: number;
+    /**
+     * @description 网格线透明度
+     */
+    gridLineAlpha: number;
+};
+/**
+ * @description 文本交互控制器旋转交互模式
+ * 'corner': 角点旋转
+ * 'top-center': 顶部中心旋转
+ */
+export type TextGizmoRotateInteractMode = 'corner' | 'top-center';
+/**
+ * @description 文本交互控制器参数
+ */
+export type TextGizmoConfig = {
+    /**
+     * @description 旋转交互模式
+     */
+    rotateInteractMode: TextGizmoRotateInteractMode;
+    /**
+     * @description 包围盒线宽
+     */
+    boxLineWidth: number;
+    /**
+     * @description 包围盒线色
+     */
+    boxLineColor: number;
+    /**
+     * @description 旋转交互点边长 - 用于 top-center 交互模式
+     */
+    rotationCornerWidth: number;
+    /**
+     * @description 旋转交互贴图地址
+     */
+    rotationCornerTexture: string;
+    /**
+     * @description 旋转交互点半径
+     */
+    rotationCornerRadius: number;
+    /**
+     * @description top-center 模式旋转交互距离
+     */
+    rotationTopCenterInteractionDistance: number;
+    /**
+     * @description 旋转交互点填充色
+     */
+    rotationCornerFillColor: number;
+    /**
+     * @description 旋转交互点描边宽度
+     */
+    rotationCornerStrokeWidth: number;
+    /**
+     * @description 旋转交互点描边颜色
+     */
+    rotationCornerStrokeColor: number;
+    /**
+     * @description Corner 模式旋转交互距离
+     */
+    rotationCornerInteractionDistance: number;
+    /**
+     * @description 缩放交互点半径
+     */
+    scaleCornerRadius: number;
+    /**
+     * @description 缩放交互点填充色
+     */
+    scaleCornerFillColor: number;
+    /**
+     * @description 缩放交互点描边宽度
+     */
+    scaleCornerStrokeWidth: number;
+    /**
+     * @description 缩放交互点描边颜色
+     */
+    scaleCornerStrokeColor: number;
+    /**
+     * @description 触发缩放交互的距离
+     */
+    scaleInteractionDistance: number;
+    /**
+     * @description 触发边缩放交互的距离
+     */
+    widthScaleInteractionDistance: number;
+    /**
+     * @description 画板线框颜色
+     */
+    wireframeColor: number;
+    /**
+     * @description 画板线框透明度
+     */
+    wireframeAlpha: number;
+    /**
+     * @description 画板线框线宽
+     */
+    wireframeWidth: number;
+};
+/**
+ * @description 蒙版参数
+ */
+export type MaskGizmoConfig = {
+    /**
+     * @description 画笔大小
+     */
+    brushSize: number;
+    /**
+     * @description 笔刷颜色
+     */
+    brushColor: number;
+    /**
+     * @description 笔刷透明度
+     */
+    brushAlpha: number;
+    /**
+     * @description 蒙版颜色
+     */
+    maskColor: number;
+    /**
+     * @description 蒙版背景色
+     */
+    maskBackgroundColor: number;
+    /**
+     * @description 蒙版透明度
+     */
+    maskAlpha: number;
+    /**
+     * @description 蒙版图片
+     */
+    maskImage?: HTMLImageElement;
+    /**
+     * @description 元素包围盒线框宽度
+     */
+    boxLineWidth: number;
+    /**
+     * @description 元素包围盒线框颜色
+     */
+    boxLineColor: number;
+    /**
+     * @description 元素包围盒线框透明度
+     */
+    boxLineAlpha: number;
+};
+/**
+ * @description Loading 参数
+ */
+export type LoadingGizmoConfig = {
+    /**
+     * @description 加载中 effect fragment
+     */
+    loadingFragment?: string;
+};
+/**
+ * @description 精准改字编辑参数
+ */
+export type SpriteTextEditGizmoConfig = {
+    /**
+     * @description 文案颜色
+     */
+    textColor: number;
+    /**
+     * @description 包围盒线框宽度
+     */
+    boxLineWidth: number;
+    /**
+     * @description 包围盒间隔线长度
+     */
+    dashLineDash: number;
+    /**
+     * @description 包围盒间隔线间隔
+     */
+    dashLineGap: number;
+    /**
+     * @description 预选中文案颜色
+     */
+    preSelectedTextColor: number;
+    /**
+     * @description 标记包围盒颜色
+     */
+    editBoxColor: number;
+    /**
+     * @description 编辑包围盒透明度
+     */
+    editBoxAlpha: number;
+    /**
+     * @description 编辑包围盒线框颜色
+     */
+    editBoxLineColor: number;
+    /**
+     * @description 编辑包围盒线框透明度
+     */
+    editBoxLineAlpha: number;
+    /**
+     * @description 已更改编辑包围盒颜色
+     */
+    hasChangedEditBoxColor: number;
+    /**
+     * @description 已更改编辑包围盒透明度
+     */
+    hasChangedEditBoxAlpha: number;
+    /**
+     * @description 已更改编辑包围盒线框颜色
+     */
+    hasChangedEditBoxLineColor: number;
+    /**
+     * @description 已更改编辑包围盒线框透明度
+     */
+    hasChangedEditBoxLineAlpha: number;
+    /**
+     * @description 编辑包围盒预选颜色
+     */
+    editBoxPreSelectedColor: number;
+    /**
+     * @description 编辑包围盒预选透明度
+     */
+    editBoxPreSelectedAlpha: number;
+    /**
+     * @description 编辑包围盒预选线框颜色
+     */
+    editBoxLinePreSelectedColor: number;
+    /**
+     * @description 编辑包围盒预选线框透明度
+     */
+    editBoxLinePreSelectedAlpha: number;
+    /**
+     * @description 已更改编辑包围盒预选颜色
+     */
+    hasChangedEditBoxPreSelectedColor: number;
+    /**
+     * @description 已更改编辑包围盒预选透明度
+     */
+    hasChangedEditBoxPreSelectedAlpha: number;
+    /**
+   * @description 已更改编辑包围盒线框颜色
+   */
+    hasChangedEditBoxLinePreSelectedColor: number;
+    /**
+     * @description 已更改编辑包围盒线框透明度
+     */
+    hasChangedEditBoxLinePreSelectedAlpha: number;
+    /**
+     * @description 选中状态标记包围盒颜色
+     */
+    editBoxSelectedColor: number;
+    /**
+     * @description 选中状态标记包围盒颜色
+     */
+    editBoxSelectedAlpha: number;
+};
+export type IconGizmoConfig = {
+    /**
+     * @description 自动展示
+     */
+    autoShow: boolean;
+    /**
+     * @description 图标地址
+     */
+    videoPlayUrl: string;
+    /**
+     * @description 距离右下角偏移值
+     */
+    videoPlayShift: [number, number];
+    /**
+     * @description 宽
+     */
+    videoPlayWidth: number;
+    /**
+     * @description 高
+     */
+    videoPlayHeight: number;
+    imageGeneratorUrl: string;
+    videoGeneratorUrl: string;
+    generatorWidth: number;
+    generatorHeight: number;
+};
+export type ItemCreateGizmoConfig = {
+    /**
+     * @description 边框颜色
+     */
+    frameBorderColor: number;
+    /**
+     * @description 边框宽度
+     */
+    frameBorderWidth: number;
+    /**
+     * @description 边框透明度
+     */
+    frameBorderAlpha: number;
+    /**
+     * @description 填充颜色
+     */
+    frameFillColor: number;
+    /**
+     * @description 填充透明度
+     */
+    frameFillAlpha: number;
+    /**
+     * @description 选中子元素包围盒透明度
+     */
+    frameChildBoxAlpha: number;
+    /**
+     * @description 选中子元素包围盒颜色
+     */
+    frameChildBoxColor: number;
+};
+export declare const BaseConfig: SDKConfig;