@vvfx/sdk 0.2.7 → 0.2.9

package/dist/sdk-item/text-item.js

@@ -0,0 +1,223 @@
+import { generateGUID, spec } from '../shared';
+import { SDKItemType } from './types';
+import { BaseItem } from './base-item';
+import { deepClone } from '../utils/common-utils';
+/**
+ * @description 文本元素 SDKItem 类
+ * @description 支持属性扩展
+ */
+export class TextItem extends BaseItem {
+    /**
+     * @description 元素类型
+     */
+    type = SDKItemType.TEXT;
+    /**
+     * @description 元素属性
+     */
+    property;
+    constructor(options) {
+        super(options);
+        // 初始化属性，设置默认值
+        this.property = {
+            position: options.property?.position ?? [0, 0],
+            rotation: options.property?.rotation ?? [0, 0, 0],
+            width: options.property?.width ?? 0,
+            height: options.property?.height ?? 0,
+            scale: options.property?.scale ?? [1, 1],
+            fontFamily: options.property?.fontFamily ?? '',
+            color: options.property?.color ?? [0, 0, 0, 1],
+            fontWeight: options.property?.fontWeight ?? spec.TextWeight.normal,
+            text: options.property?.text ?? '',
+            textAlign: options.property?.textAlign ?? spec.TextAlignment.left,
+            fontSize: options.property?.fontSize ?? 24,
+            fontStyle: options.property?.fontStyle ?? spec.FontStyle.normal,
+            lineHeight: options.property?.lineHeight ?? 24,
+            outlineColor: options.property?.outlineColor,
+            outlineWidth: options.property?.outlineWidth,
+            outlineEnabled: options.property?.outlineEnabled ?? false,
+            fontUrl: options.property?.fontUrl,
+            letterSpacing: options.property?.letterSpacing ?? 0
+        };
+    }
+    // ==================== 便捷访问器 ====================
+    get pixelWidth() {
+        return this.width;
+    }
+    get pixelHeight() {
+        return this.height;
+    }
+    /**
+     * @description 文本内容
+     */
+    get text() {
+        return this.property.text;
+    }
+    set text(value) {
+        this.property.text = value;
+    }
+    /**
+     * @description 字体名称
+     */
+    get fontFamily() {
+        return this.property.fontFamily;
+    }
+    set fontFamily(value) {
+        this.property.fontFamily = value;
+    }
+    /**
+     * @description 字号
+     */
+    get fontSize() {
+        return this.property.fontSize;
+    }
+    set fontSize(value) {
+        this.property.fontSize = value;
+    }
+    /**
+     * @description 字重
+     */
+    get fontWeight() {
+        return this.property.fontWeight;
+    }
+    set fontWeight(value) {
+        this.property.fontWeight = value;
+    }
+    /**
+     * @description 字体样式
+     */
+    get fontStyle() {
+        return this.property.fontStyle;
+    }
+    set fontStyle(value) {
+        this.property.fontStyle = value;
+    }
+    /**
+     * @description 文本对齐方式
+     */
+    get textAlign() {
+        return this.property.textAlign;
+    }
+    set textAlign(value) {
+        this.property.textAlign = value;
+    }
+    /**
+     * @description 文本颜色 [r, g, b, a]
+     */
+    get color() {
+        return this.property.color;
+    }
+    set color(value) {
+        this.property.color = value;
+    }
+    /**
+     * @description 文本宽度
+     */
+    get width() {
+        return this.property.width;
+    }
+    set width(value) {
+        this.property.width = value;
+    }
+    /**
+     * @description 行高
+     */
+    get lineHeight() {
+        return this.property.lineHeight;
+    }
+    set lineHeight(value) {
+        this.property.lineHeight = value;
+    }
+    /**
+     * @description 文本高度
+     */
+    get height() {
+        return this.property.height;
+    }
+    set height(value) {
+        this.property.height = value;
+    }
+    /**
+     * @description 描边颜色
+     */
+    get outlineColor() {
+        return this.property.outlineColor;
+    }
+    set outlineColor(value) {
+        this.property.outlineColor = value;
+    }
+    /**
+     * @description 描边宽度
+     */
+    get outlineWidth() {
+        return this.property.outlineWidth;
+    }
+    set outlineWidth(value) {
+        this.property.outlineWidth = value;
+    }
+    /**
+     * @description 描边开关
+     */
+    get outlineEnabled() {
+        return this.property.outlineEnabled ?? false;
+    }
+    set outlineEnabled(value) {
+        this.property.outlineEnabled = value;
+    }
+    /**
+     * @description 位置
+     */
+    get position() {
+        return this.property.position;
+    }
+    set position(value) {
+        this.property.position = value;
+    }
+    /**
+     * @description 旋转（二维旋转角度）
+     */
+    get rotation() {
+        return this.property.rotation[2];
+    }
+    set rotation(value) {
+        this.property.rotation[2] = value;
+    }
+    // ==================== 实现抽象方法 ====================
+    /**
+     * @description 转换为 CreateInfo
+     * @param withParent 是否包含父节点ID
+     */
+    toCreateInfo(withParent) {
+        const extension = this.getAllExtension();
+        return {
+            type: SDKItemType.TEXT,
+            id: this.id,
+            name: this.name,
+            parentId: withParent ? this.parentId : undefined,
+            extension: Object.keys(extension).length > 0 ? extension : undefined,
+            property: deepClone(this.property)
+        };
+    }
+    /**
+     * @description 克隆 SDKItem
+     */
+    clone() {
+        return new TextItem({
+            id: generateGUID(),
+            name: this.name,
+            parentId: this.parentId,
+            duration: this.duration,
+            delay: this.delay,
+            endBehavior: this.endBehavior,
+            isLocked: this.isLocked,
+            isCoreEditable: this.isCoreEditable,
+            property: deepClone(this.property),
+            extension: this.getAllExtension()
+        });
+    }
+}
+/**
+ * @description 类型守卫：检查是否是 TextItem
+ */
+export function isTextItem(obj) {
+    return obj instanceof TextItem;
+}

package/dist/sdk-item/types.d.ts

@@ -1,5 +1,5 @@
 import type { SpriteItemProperty, TextItemProperty, VideoItemProperty, GeneratorItemProperty, GroupItemProperty, EffectsItemProperty, FrameItemProperty, CardItemProperty } from '../types';
-import { spec } from '../shared';
+import { spec } from '../shared/spec';
 /**
  * @description SDKItem 基础选项接口
  * @description 支持扩展属性，允许添加任意额外属性
@@ -131,10 +131,6 @@ export declare enum SDKItemType {
     FRAME = "frame",
     CARD = "card"
 }
-/**
- * @description SDKItemType 与 spec.ItemType 的映射关系
- */
-export declare const SDKItemTypeToSpecItemType: Record<SDKItemType, spec.ItemType>;
 /**
  * @description Card 卡片元素 SDKItem 选项
  * @description 在 Player 中以 SpriteItem 形式渲染
@@ -145,9 +141,3 @@ export type CardItemOptions = SDKItemOptions & {
      */
     property?: Partial<CardItemProperty>;
 };
-/**
- * @description 根据 SDKItemType 获取对应的 spec.ItemType
- * @param sdkItemType SDKItem 类型
- * @returns 对应的 spec.ItemType
- */
-export declare function getSpecItemType(sdkItemType: SDKItemType): spec.ItemType;

package/dist/sdk-item/types.js

@@ -0,0 +1,15 @@
+/**
+ * @description SDKItem 类型（独立于 spec.ItemType）
+ * @description 包含所有 SDK 层级的元素类型，包括虚拟类型如 generator
+ */
+export var SDKItemType;
+(function (SDKItemType) {
+    SDKItemType["SPRITE"] = "sprite";
+    SDKItemType["TEXT"] = "text";
+    SDKItemType["VIDEO"] = "video";
+    SDKItemType["GROUP"] = "group";
+    SDKItemType["GENERATOR"] = "generator";
+    SDKItemType["EFFECTS"] = "effects";
+    SDKItemType["FRAME"] = "frame";
+    SDKItemType["CARD"] = "card";
+})(SDKItemType || (SDKItemType = {}));

package/dist/sdk-item/video-item.js

@@ -0,0 +1,174 @@
+import { generateGUID } from '../shared';
+import { SDKItemType } from './types';
+import { BaseItem } from './base-item';
+import { deepClone } from '../utils/common-utils';
+/**
+ * @description 视频元素 SDKItem 类
+ * @description 支持属性扩展
+ */
+export class VideoItem extends BaseItem {
+    /**
+     * @description 元素类型
+     */
+    type = SDKItemType.VIDEO;
+    /**
+     * @description 元素属性
+     */
+    property;
+    constructor(options) {
+        super(options);
+        // 初始化属性
+        this.property = {
+            position: options.property?.position ?? [0, 0],
+            rotation: options.property?.rotation ?? [0, 0, 0],
+            width: options.property?.width ?? 0,
+            height: options.property?.height ?? 0,
+            scale: options.property?.scale ?? [1, 1],
+            video: options.property?.video ?? '',
+            muted: options.property?.muted ?? true,
+            transparent: options.property?.transparent ?? true,
+            playbackRate: options.property?.playbackRate ?? 1,
+            volume: options.property?.volume ?? 0,
+        };
+    }
+    // ==================== 便捷访问器 ====================
+    /**
+     * @description 视频地址
+     */
+    get video() {
+        return this.property.video;
+    }
+    set video(value) {
+        this.property.video = value;
+    }
+    /**
+     * @description 位置
+     */
+    get position() {
+        return this.property.position;
+    }
+    set position(value) {
+        this.property.position = value;
+    }
+    /**
+     * @description 宽度
+     */
+    get width() {
+        return this.property.width;
+    }
+    set width(value) {
+        this.property.width = value;
+    }
+    /**
+     * @description 高度
+     */
+    get height() {
+        return this.property.height;
+    }
+    set height(value) {
+        this.property.height = value;
+    }
+    /**
+     * @description 旋转（二维旋转角度）
+     */
+    get rotation() {
+        return this.property.rotation[2];
+    }
+    set rotation(value) {
+        this.property.rotation[2] = value;
+    }
+    /**
+     * @description 完整旋转（包含 x, y, z）
+     */
+    get fullRotation() {
+        return this.property.rotation;
+    }
+    set fullRotation(value) {
+        this.property.rotation = value;
+    }
+    /**
+     * @description 是否正在编辑关键属性
+     * @deprecated 该属性即将废弃，使用 isCoreEditable 代替
+     */
+    get keyPropertyEditing() {
+        return this.isCoreEditable;
+    }
+    set keyPropertyEditing(value) {
+        this.isCoreEditable = value;
+    }
+    /**
+     * @description 是否静音
+     */
+    get muted() {
+        return this.property.muted ?? true;
+    }
+    set muted(state) {
+        this.property.muted = state;
+    }
+    /**
+     * @description 是否为透明视频
+     */
+    get transparent() {
+        return this.property.transparent ?? true;
+    }
+    set transparent(state) {
+        this.property.transparent = state;
+    }
+    /**
+     * @description 播放音量
+     */
+    get volume() {
+        return this.property.volume ?? 0;
+    }
+    set volume(value) {
+        this.property.volume = value;
+    }
+    /**
+     * @description 播放速率
+     */
+    get playbackRate() {
+        return this.property.playbackRate ?? 1;
+    }
+    set playbackRate(value) {
+        this.property.playbackRate = value;
+    }
+    // ==================== 实现抽象方法 ====================
+    /**
+     * @description 转换为 CreateInfo
+     * @param withParent 是否包含父节点ID
+     */
+    toCreateInfo(withParent) {
+        const extension = this.getAllExtension();
+        return {
+            type: SDKItemType.VIDEO,
+            id: this.id,
+            name: this.name,
+            parentId: withParent ? this.parentId : undefined,
+            extension: Object.keys(extension).length > 0 ? extension : undefined,
+            property: deepClone(this.property)
+        };
+    }
+    /**
+     * @description 克隆 SDKItem
+     */
+    clone() {
+        return new VideoItem({
+            id: generateGUID(),
+            name: this.name,
+            parentId: this.parentId,
+            duration: this.duration,
+            delay: this.delay,
+            endBehavior: this.endBehavior,
+            isLocked: this.isLocked,
+            isCoreEditable: this.isCoreEditable,
+            property: deepClone(this.property),
+            extension: this.getAllExtension()
+        });
+    }
+}
+/**
+ * @description 类型守卫：检查是否是 VideoItem
+ */
+export function isVideoItem(obj) {
+    return obj instanceof VideoItem;
+}