@vvfx/artis 0.0.1-alpha.0

package/dist/core/item/frame-item.d.ts

@@ -0,0 +1,153 @@
+import { FrameItemProperty, FrameLayoutMode, type LayoutInfo, type FrameItemSchema } from '../types';
+import { ArtisItemType, FrameItemOptions } from './types';
+import { BaseItem } from './base-item';
+import type { FrameManager } from '@vvfx/gizmo';
+/** Artis-only adapter between persisted element IDs and gizmo runtime instance IDs. */
+export type FrameItemIdAdapter = {
+    toRuntimeId(id: string): string | undefined;
+    toElementId(runtimeId: string): string;
+};
+/**
+ * 画板/框架元素 ArtisItem 类
+ * 支持自动布局和自由布局两种模式
+ * 底层以 composition 形式渲染
+ */
+export declare class FrameItem extends BaseItem {
+    /**
+     * 元素类型
+     */
+    readonly type = ArtisItemType.FRAME;
+    /**
+     * 预合成元素ID
+     */
+    subCompositionItemId: string;
+    /**
+     * 元素属性
+     */
+    property: FrameItemProperty;
+    private _frameManager?;
+    private _idAdapter;
+    /** Initialization buffer only; released once the item is attached to FrameManager. */
+    private _frameSeed?;
+    constructor(options: FrameItemOptions);
+    /** Attach the compatibility item facade to the gizmo-owned Frame data source. */
+    bindFrameManager(frameManager: FrameManager, idAdapter?: FrameItemIdAdapter): void;
+    private _getFrameSeed;
+    private _getRuntimeFrameData;
+    private _getLayoutMode;
+    private _getChildren;
+    private _getAutoLayoutConfig;
+    private _getLayoutInfos;
+    private _setLayoutMode;
+    private _setChildren;
+    private _setAutoLayoutConfig;
+    private _setLayoutInfos;
+    /**
+     * 子元素ID列表（只读）
+     */
+    get children(): readonly string[];
+    /**
+     * 布局模式
+     */
+    get layoutMode(): FrameLayoutMode;
+    /**
+     * 设置布局模式
+     * @param value 布局模式
+     */
+    set layoutMode(value: FrameLayoutMode);
+    /**
+     * 布局信息
+     */
+    get layoutInfos(): Record<string, LayoutInfo> | undefined;
+    /**
+     * 设置布局信息
+     * @param info 布局信息
+     */
+    set layoutInfos(info: Record<string, LayoutInfo> | undefined);
+    /**
+     * 位置
+     */
+    get position(): [number, number];
+    /**
+     * 设置位置
+     * @param value 位置坐标 [x, y]
+     */
+    set position(value: [number, number]);
+    /**
+     * 宽度
+     */
+    get width(): number;
+    /**
+     * 设置宽度
+     * @param value 宽度
+     */
+    set width(value: number);
+    /**
+     * 高度
+     */
+    get height(): number;
+    /**
+     * 设置高度
+     * @param value 高度
+     */
+    set height(value: number);
+    /**
+     * 缩放
+     */
+    get scale(): [number, number];
+    /**
+     * 设置缩放
+     * @param value 缩放比 [sx, sy]
+     */
+    set scale(value: [number, number]);
+    /**
+     * 旋转（二维旋转角度）
+     */
+    get rotation(): number;
+    /**
+     * 设置旋转角度（二维）
+     * @param value 旋转角度
+     */
+    set rotation(value: number);
+    /**
+     * 添加子元素
+     * @param itemId 子元素ID
+     * @returns 是否添加成功
+     */
+    addChild(itemId: string): boolean;
+    /**
+     * 移除子元素
+     * @param itemId 子元素ID
+     * @returns 是否移除成功
+     */
+    removeChild(itemId: string): boolean;
+    /** Set one child's layout metadata using Artis element IDs. */
+    setChildLayoutInfo(itemId: string, layoutInfo: LayoutInfo): boolean;
+    /**
+     * 是否包含指定子元素
+     * @param itemId 子元素ID
+     * @returns 是否包含
+     */
+    hasChild(itemId: string): boolean;
+    /**
+     * 清空所有子元素
+     */
+    clearChildren(): void;
+    /**
+     * 转换为 FrameItemSchema
+     * @param withParent 是否包含父节点ID
+     * @returns FrameItemSchema 对象
+     */
+    toSchema(withParent?: boolean): FrameItemSchema;
+    /**
+     * 克隆 ArtisItem
+     * @returns 新的 FrameItem 实例
+     */
+    clone(): FrameItem;
+}
+/**
+ * 类型守卫：检查是否是 FrameItem
+ * @param obj 待检查对象
+ * @returns 是否是 FrameItem 实例
+ */
+export declare function isFrameItem(obj: any): obj is FrameItem;

package/dist/core/item/generator-item.d.ts

@@ -0,0 +1,114 @@
+import { GeneratorType, type GeneratorItemProperty, type GeneratorItemSchema, type VideoItemSchema, type SpriteItemSchema } from '../types';
+import { ArtisItemType, GeneratorItemOptions } from './types';
+import { BaseItem } from './base-item';
+/**
+ * 资源生成器元素 ArtisItem 类
+ * 支持 image 和 video 两种生成器类型
+ * 在 Player 中以透明 SpriteItem 形式渲染
+ * 支持属性扩展，可转换为 SpriteItem 或 VideoItem
+ */
+export declare class GeneratorItem extends BaseItem {
+    /**
+     * 元素类型（独立类型，不属于 spec.ItemType）
+     */
+    readonly type = ArtisItemType.GENERATOR;
+    /**
+     * 元素属性（包含 generatorType）
+     */
+    property: GeneratorItemProperty;
+    constructor(options: GeneratorItemOptions);
+    /**
+     * 生成器类型
+     */
+    get generatorType(): GeneratorType;
+    /**
+     * 设置生成器类型
+     * @param value 生成器类型
+     */
+    set generatorType(value: GeneratorType);
+    /**
+     * 图片地址（生成器返回空）
+     */
+    get image(): string;
+    /**
+     * 设置图片地址（生成器不支持，操作无效）
+     * @param _value 图片地址（忽略）
+     */
+    set image(_value: string);
+    /**
+     * 位置
+     */
+    get position(): [number, number];
+    /**
+     * 设置位置
+     * @param value 位置坐标 [x, y]
+     */
+    set position(value: [number, number]);
+    /**
+     * 宽度
+     */
+    get width(): number;
+    /**
+     * 设置宽度
+     * @param value 宽度
+     */
+    set width(value: number);
+    /**
+     * 高度
+     */
+    get height(): number;
+    /**
+     * 设置高度
+     * @param value 高度
+     */
+    set height(value: number);
+    /**
+     * 旋转（二维旋转角度）
+     */
+    get rotation(): number;
+    /**
+     * 设置旋转角度（二维）
+     * @param value 旋转角度
+     */
+    set rotation(value: number);
+    /**
+     * 转换后元素名：去掉"生成器"后缀。
+     *
+     * 转换为 sprite/video 后，元素不应再带"生成器"占位语义——否则
+     * `isGeneratorPlayerItem`(sprite && name 含"生成器")仍判真，
+     * IconGizmo 会继续在该真元素上画生成器图标，造成残留。
+     * @returns 去掉"生成器"片段后的名称（如"图片生成器"→"图片"）
+     */
+    private getConvertedName;
+    /**
+     * 转换为 GeneratorItemSchema
+     * @param withParent 是否包含父节点ID
+     * @returns GeneratorItemSchema 对象
+     */
+    toSchema(withParent?: boolean): GeneratorItemSchema;
+    /**
+     * 转换为 VideoItemSchema（用于转换为视频元素）
+     * @param videoUrl 视频资源地址
+     * @param withParent 是否包含父节点ID
+     * @returns VideoItemSchema 对象
+     */
+    toVideoSchema(videoUrl: string, withParent?: boolean): VideoItemSchema;
+    /**
+     * 转换为 SpriteItemSchema（用于转换为图片元素）
+     * @param imageUrl 图片资源地址
+     * @param withParent 是否包含父节点ID
+     * @returns SpriteItemSchema 对象
+     */
+    toSpriteSchema(imageUrl: string, withParent?: boolean): SpriteItemSchema;
+    /**
+     * 克隆 ArtisItem
+     * @returns 新的 GeneratorItem 实例
+     */
+    clone(): GeneratorItem;
+}
+/**
+ * 类型守卫：检查是否是 GeneratorItem
+ * @param obj 待检查对象
+ * @returns 是否是 GeneratorItem 实例
+ */
+export declare function isGeneratorItem(obj: any): obj is GeneratorItem;

package/dist/core/item/group-item.d.ts

@@ -0,0 +1,51 @@
+import { type GroupItemProperty, type GroupItemSchema } from '../types';
+import { ArtisItemType, type GroupItemOptions } from './types';
+import { BaseItem } from './base-item';
+/**
+ * 空节点/组 ArtisItem 类
+ * 支持属性扩展
+ */
+export declare class GroupItem extends BaseItem {
+    /**
+     * 元素类型
+     */
+    readonly type = ArtisItemType.GROUP;
+    /**
+     * 元素属性
+     */
+    property: GroupItemProperty;
+    constructor(options: GroupItemOptions);
+    /** 位置 */
+    get position(): [number, number];
+    /** 设置位置
+     * @param value 位置坐标 [x, y]
+     */
+    set position(value: [number, number]);
+    /** 缩放 */
+    get scale(): [number, number];
+    /** 设置缩放
+     * @param value 缩放比例 [x, y]
+     */
+    set scale(value: [number, number]);
+    /** 旋转（二维旋转角度） */
+    get rotation(): number;
+    /** 设置旋转角度（二维，写入 rotation[2]）
+     * @param value 旋转角度
+     */
+    set rotation(value: number);
+    /**
+     * 转换为 GroupItemSchema
+     * @param withParent 是否包含父节点ID
+     * @returns GroupItemSchema 数据快照
+     */
+    toSchema(withParent?: boolean): GroupItemSchema;
+    /**
+     * 克隆 ArtisItem
+     * @returns 新的 GroupItem 实例（带新 ID，深拷贝属性与扩展）
+     */
+    clone(): GroupItem;
+}
+/**
+ * 类型守卫：检查是否是 GroupItem
+ */
+export declare function isGroupItem(obj: any): obj is GroupItem;

package/dist/core/item/index.d.ts

@@ -0,0 +1,25 @@
+export type { ArtisItemOptions, SpriteItemOptions, TextItemOptions, VideoItemOptions, GroupItemOptions, GeneratorItemOptions, EffectsItemOptions, FrameItemOptions, CardItemOptions, } from './types';
+export { ArtisItemType } from './types';
+export { BaseItem, isBaseItem } from './base-item';
+export { SpriteItem, isSpriteItem } from './sprite-item';
+export { TextItem, isTextItem } from './text-item';
+export { VideoItem, isVideoItem } from './video-item';
+export { GroupItem, isGroupItem } from './group-item';
+export { GeneratorItem, isGeneratorItem } from './generator-item';
+export { EffectsItem, isEffectsItem } from './effects-item';
+export { FrameItem, isFrameItem } from './frame-item';
+export { CardItem, isCardItem } from './card-item';
+export { buildItemSchemaByCreateType } from './default-item-schema';
+import { SpriteItem } from './sprite-item';
+import { GroupItem } from './group-item';
+import { TextItem } from './text-item';
+import { VideoItem } from './video-item';
+import { GeneratorItem } from './generator-item';
+import { EffectsItem } from './effects-item';
+import type { FrameItem } from './frame-item';
+import type { CardItem } from './card-item';
+/**
+ * ArtisItem 类型联合
+ * 用于替换原来的 ArtisItem type
+ */
+export type ArtisItem = SpriteItem | TextItem | VideoItem | GroupItem | GeneratorItem | EffectsItem | FrameItem | CardItem;

package/dist/core/item/sprite-item.d.ts

@@ -0,0 +1,80 @@
+import { type SpriteItemProperty, type SpriteItemSchema } from '../types';
+import { ArtisItemType, type SpriteItemOptions } from './types';
+import { BaseItem } from './base-item';
+/**
+ * 图片元素 ArtisItem 类
+ * 支持属性扩展
+ */
+export declare class SpriteItem extends BaseItem {
+    /**
+     * 元素类型
+     */
+    readonly type = ArtisItemType.SPRITE;
+    /**
+     * 元素属性
+     */
+    property: SpriteItemProperty;
+    constructor(options: SpriteItemOptions);
+    /**
+     * 尺寸模式：'auto'=随资源自适应，'fixed'=尺寸定死。auto→fixed 由 ItemService 在显式设尺寸时翻转。
+     */
+    get sizeMode(): 'auto' | 'fixed';
+    /**
+     * 图片地址
+     */
+    get image(): string;
+    /**
+     * 设置图片地址
+     * @param value 图片地址
+     */
+    set image(value: string);
+    /**
+     * 位置
+     */
+    get position(): [number, number];
+    /**
+     * 设置位置
+     * @param value 位置坐标 [x, y]
+     */
+    set position(value: [number, number]);
+    /** 宽度 */
+    get width(): number;
+    /**
+     * 设置宽度
+     * @param value 宽度
+     */
+    set width(value: number);
+    /** 高度 */
+    get height(): number;
+    /**
+     * 设置高度
+     * @param value 高度
+     */
+    set height(value: number);
+    /**
+     * 旋转（二维旋转角度）
+     */
+    get rotation(): number;
+    /**
+     * 设置旋转角度（二维）
+     * @param value 旋转角度
+     */
+    set rotation(value: number);
+    /**
+     * 转换为 SpriteItemSchema
+     * @param withParent 是否包含父节点ID
+     * @returns SpriteItemSchema 对象
+     */
+    toSchema(withParent?: boolean): SpriteItemSchema;
+    /**
+     * 克隆 ArtisItem
+     * @returns 新的 SpriteItem 实例
+     */
+    clone(): SpriteItem;
+}
+/**
+ * 类型守卫：检查是否是 SpriteItem
+ * @param obj 待检查对象
+ * @returns 是否是 SpriteItem 实例
+ */
+export declare function isSpriteItem(obj: any): obj is SpriteItem;

package/dist/core/item/text-item.d.ts

@@ -0,0 +1,171 @@
+import { type TextItemProperty, type TextItemSchema } from '../types';
+import { spec } from '../../shared';
+import { ArtisItemType, type TextItemOptions } from './types';
+import { BaseItem } from './base-item';
+/**
+ * 文本元素 ArtisItem 类
+ * 支持属性扩展
+ */
+export declare class TextItem extends BaseItem {
+    /**
+     * 元素类型
+     */
+    readonly type = ArtisItemType.TEXT;
+    /**
+     * 元素属性
+     */
+    property: TextItemProperty;
+    constructor(options: TextItemOptions);
+    /**
+     * 文本内容
+     */
+    get text(): string;
+    /**
+     * 设置文本内容
+     * @param value 文本内容
+     */
+    set text(value: string);
+    /**
+     * 字体名称
+     */
+    get fontFamily(): string;
+    /**
+     * 设置字体名称
+     * @param value 字体名称
+     */
+    set fontFamily(value: string);
+    /**
+     * 字号
+     */
+    get fontSize(): number;
+    /**
+     * 设置字号
+     * @param value 字号
+     */
+    set fontSize(value: number);
+    /**
+     * 字重
+     */
+    get fontWeight(): spec.TextWeight;
+    /**
+     * 设置字重
+     * @param value 字重
+     */
+    set fontWeight(value: spec.TextWeight);
+    /**
+     * 字体样式
+     */
+    get fontStyle(): spec.FontStyle;
+    /**
+     * 设置字体样式
+     * @param value 字体样式
+     */
+    set fontStyle(value: spec.FontStyle);
+    /**
+     * 文本对齐方式
+     */
+    get textAlign(): spec.TextAlignment;
+    /**
+     * 设置文本对齐方式
+     * @param value 文本对齐方式
+     */
+    set textAlign(value: spec.TextAlignment);
+    /**
+     * 文本颜色 [r, g, b, a]
+     */
+    get color(): [number, number, number, number];
+    /**
+     * 设置文本颜色
+     * @param value 颜色 [r, g, b, a]
+     */
+    set color(value: [number, number, number, number]);
+    /**
+     * 文本宽度
+     */
+    get width(): number;
+    /**
+     * 设置文本宽度
+     * @param value 宽度
+     */
+    set width(value: number);
+    /**
+     * 行高
+     */
+    get lineHeight(): number;
+    /**
+     * 设置行高
+     * @param value 行高
+     */
+    set lineHeight(value: number);
+    /**
+     * 文本高度
+     */
+    get height(): number;
+    /**
+     * 设置文本高度
+     * @param value 高度
+     */
+    set height(value: number);
+    /**
+     * 描边颜色
+     */
+    get outlineColor(): spec.vec4 | undefined;
+    /**
+     * 设置描边颜色
+     * @param value 描边颜色
+     */
+    set outlineColor(value: spec.vec4 | undefined);
+    /**
+     * 描边宽度
+     */
+    get outlineWidth(): number | undefined;
+    /**
+     * 设置描边宽度
+     * @param value 描边宽度
+     */
+    set outlineWidth(value: number | undefined);
+    /**
+     * 描边开关
+     */
+    get outlineEnabled(): boolean;
+    /**
+     * 设置描边开关
+     * @param value 是否启用描边
+     */
+    set outlineEnabled(value: boolean);
+    /**
+     * 位置
+     */
+    get position(): [number, number];
+    /**
+     * 设置位置
+     * @param value 位置坐标 [x, y]
+     */
+    set position(value: [number, number]);
+    /**
+     * 旋转（二维旋转角度）
+     */
+    get rotation(): number;
+    /**
+     * 设置旋转角度（二维）
+     * @param value 旋转角度
+     */
+    set rotation(value: number);
+    /**
+     * 转换为 TextItemSchema
+     * @param withParent 是否包含父节点ID
+     * @returns TextItemSchema 对象
+     */
+    toSchema(withParent?: boolean): TextItemSchema;
+    /**
+     * 克隆 ArtisItem
+     * @returns 新的 TextItem 实例
+     */
+    clone(): TextItem;
+}
+/**
+ * 类型守卫：检查是否是 TextItem
+ * @param obj 待检查对象
+ * @returns 是否是 TextItem 实例
+ */
+export declare function isTextItem(obj: any): obj is TextItem;