@galacean/effects-specification 2.1.0-alpha.1 → 2.1.0-alpha.2

package/es/item/spine-item.d.ts

@@ -1,5 +1,6 @@
 import type { BinaryPointer } from '../binary';
-import type { ComponentData, DataPath, DataType } from '../components';
+import type { ComponentData, DataPath } from '../components';
+import type { DataType } from '../data-type';
 import type { SizeOverLifetime, RotationOverLifetime, PositionOverLifetime, ColorOverLifetime, RendererOptions, ItemType } from '../type';
 import type { BaseItem, EndBehavior } from './base-item';
 /**

package/es/item/sprite-item.d.ts

@@ -73,47 +73,5 @@ export interface SpriteContent {
 /**
  * 图层组件属性
  */
-export interface SpriteComponentData extends ComponentData {
-    /**
-     * added by loader
-     * @default null
-     */
-    splits?: SplitParameter[];
-    /**
-     * 图层元素基础属性
-     */
-    options: SpriteContentOptions;
-    /**
-     * 图层元素材质渲染属性
-     */
-    renderer: RendererOptions;
-    /**
-     * 图层元素大小变化属性
-     */
-    sizeOverLifetime?: SizeOverLifetime;
-    /**
-     * 图层元素旋转变化属性
-     */
-    rotationOverLifetime?: RotationOverLifetime;
-    /**
-     * 图层元素位置变化属性
-     */
-    positionOverLifetime?: PositionOverLifetime;
-    /**
-     * 图层元素色彩变化属性
-     */
-    colorOverLifetime?: ColorOverLifetime;
-    /**
-     * 图层元素贴图变化属性
-     */
-    textureSheetAnimation?: TextureSheetAnimation;
-    /**
-     * 图层交互
-     */
-    interaction?: {
-        /**
-         * 交互行为
-         */
-        behavior: InteractBehavior;
-    };
+export interface SpriteComponentData extends ComponentData, SpriteContent {
 }

package/es/item/text-item.d.ts

@@ -17,7 +17,40 @@ export interface TextItem extends BaseItem {
     content: TextContent;
     endBehavior: EndBehavior;
 }
-export interface TextContentOptions {
+export interface TextContentOptions extends BaseTextContentOptions {
+    /**
+     * 文本间隔
+     * @default 0
+     */
+    letterSpace?: number;
+    /**
+     * 文本固定宽度（和自适应宽高冲突）
+     * @default 31
+     */
+    textWidth?: number;
+    /**
+     * 文本行高
+     * @default 31
+     */
+    lineHeight?: number;
+    /**
+     * 文本高度
+     * @default 31
+     */
+    textHeight?: number;
+    /**
+     * 自适应宽高开关（和文本固定宽度冲突）
+     * @default false
+     */
+    autoWidth?: boolean;
+    /**
+     * 当文字超过最大宽度时，文字的表现行为
+     * 仅当设置文字最大宽度后生效
+     * @default TextOverflow.display
+     */
+    textOverflow?: TextOverflow;
+}
+export interface BaseTextContentOptions {
     /**
      * 文本内容
      */
@@ -37,11 +70,6 @@ export interface TextContentOptions {
      * @default 'Arial'
      */
     fontFamily?: string;
-    /**
-     * 文本间隔
-     * @default 0
-     */
-    letterSpace?: number;
     /**
      * 上下对齐方式
      * @default TextBaseline.middle
@@ -52,26 +80,6 @@ export interface TextContentOptions {
      * @default TextAlignment.left
      */
     textAlign?: TextAlignment;
-    /**
-     * 文本固定宽度（和自适应宽高冲突）
-     * @default 31
-     */
-    textWidth?: number;
-    /**
-     * 文本行高
-     * @default 31
-     */
-    lineHeight?: number;
-    /**
-     * 文本高度
-     * @default 31
-     */
-    textHeight?: number;
-    /**
-     * 自适应宽高开关（和文本固定宽度冲突）
-     * @default false
-     */
-    autoWidth?: boolean;
     /**
      * 文本字重
      * @default TextWeight.normal
@@ -174,42 +182,5 @@ export interface TextContent {
 /**
  * 文本元素渲染属性
  */
-export interface TextComponentData extends ComponentData {
-    /**
-     * 文本元素基础属性
-     */
-    options: TextContentOptions;
-    /**
-     * 文本元素材质渲染属性
-     */
-    renderer: RendererOptions;
-    /**
-     * 文本元素大小变化属性
-     */
-    sizeOverLifetime?: SizeOverLifetime;
-    /**
-     * 文本元素旋转变化属性
-     */
-    rotationOverLifetime?: RotationOverLifetime;
-    /**
-     * 文本元素位置变化属性
-     */
-    positionOverLifetime?: PositionOverLifetime;
-    /**
-     * 文本元素色彩变化属性
-     */
-    colorOverLifetime?: ColorOverLifetime;
-    /**
-     * 文本元素贴图变化属性
-     */
-    textureSheetAnimation?: TextureSheetAnimation;
-    /**
-     * 图层交互
-     */
-    interaction?: {
-        /**
-         * 交互行为
-         */
-        behavior: InteractBehavior;
-    };
+export interface TextComponentData extends ComponentData, TextContent {
 }

package/es/item.d.ts

@@ -10,7 +10,8 @@ import type { CompositionItem } from './item/composition-item';
 import type { TextItem } from './item/text-item';
 import type { VideoItem } from './item/video-item';
 import type { AudioItem } from './item/audio-item';
+import type { RichTextItem } from './item/rich-text-item';
 /**
  * Item 基类，无对应元素
  */
-export type Item = SpriteItem | ParticleItem | NullItem | PluginItem | InteractItem | CameraItem | TextItem | VideoItem | AudioItem | ModelMeshItem<'json'> | ModelSkyboxItem<'json'> | ModelTreeItem<'json'> | ModelLightItem | ModelCameraItem | SpineItem | CompositionItem | ModelMeshItem<'studio'> | ModelSkyboxItem<'studio'> | ModelTreeItem<'studio'>;
+export type Item = SpriteItem | ParticleItem | NullItem | PluginItem | InteractItem | CameraItem | TextItem | RichTextItem | VideoItem | AudioItem | ModelMeshItem<'json'> | ModelSkyboxItem<'json'> | ModelTreeItem<'json'> | ModelLightItem | ModelCameraItem | SpineItem | CompositionItem | ModelMeshItem<'studio'> | ModelSkyboxItem<'studio'> | ModelTreeItem<'studio'>;

package/es/material-data.d.ts

@@ -0,0 +1,21 @@
+import type { DataPath } from './components';
+import type { EffectsObjectData } from './effects-object-data';
+import type { Vector4Data, ColorData, Vector2Data } from './math';
+export interface MaterialTextureProperty {
+    texture: DataPath;
+    offset?: Vector2Data;
+    scale?: Vector2Data;
+}
+export interface MaterialData extends EffectsObjectData {
+    shader: DataPath;
+    blending?: boolean;
+    zWrite?: boolean;
+    zTest?: boolean;
+    stringTags: Record<string, string>;
+    macros: string[];
+    ints: Record<string, number>;
+    floats: Record<string, number>;
+    vector4s: Record<string, Vector4Data>;
+    colors: Record<string, ColorData>;
+    textures: Record<string, MaterialTextureProperty>;
+}

package/es/material-data.js

@@ -0,0 +1 @@
+export {};

package/es/math/color-data.d.ts

@@ -0,0 +1,6 @@
+export interface ColorData {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+}

package/es/math/color-data.js

@@ -0,0 +1 @@
+export {};

package/es/math/index.d.ts

@@ -0,0 +1,2 @@
+export * from './color-data';
+export * from './vector-data';

package/es/math/index.js

@@ -0,0 +1,2 @@
+export * from './color-data';
+export * from './vector-data';

package/es/math/vector-data.d.ts

@@ -0,0 +1,15 @@
+export interface Vector4Data {
+    x: number;
+    y: number;
+    z: number;
+    w: number;
+}
+export interface Vector3Data {
+    x: number;
+    y: number;
+    z: number;
+}
+export interface Vector2Data {
+    x: number;
+    y: number;
+}

package/es/math/vector-data.js

@@ -0,0 +1 @@
+export {};

package/es/scene.d.ts

@@ -4,11 +4,15 @@ import type { PlayerVersion, ShapeGeometry } from './type';
 import type { TextureDefine } from './texture';
 import type { FontBase, FontDefine } from './text';
 import type { BinaryFile } from './binary';
-import type { ComponentData, EffectsObjectData, GeometryData, MaterialData, ShaderData } from './components';
+import type { ComponentData } from './components';
 import type { VFXItemData } from './vfx-item-data';
 import type { AnimationClipData } from './animation-clip-data';
 import type { AssetBase, ImageSource } from './assets';
 import type { RenderSettings } from './render-settings';
+import type { EffectsObjectData } from './effects-object-data';
+import type { MaterialData } from './material-data';
+import type { GeometryData } from './geometry-data';
+import type { ShaderData } from './shader-data';
 /**
  * runtime 2.0 之前的场景信息
  * 素材信息存放于统一数据结构中

package/es/shader-data.d.ts

@@ -0,0 +1,6 @@
+import type { EffectsObjectData } from './effects-object-data';
+export interface ShaderData extends EffectsObjectData {
+    vertex: string;
+    fragment: string;
+    properties?: string;
+}

package/es/shader-data.js

@@ -0,0 +1 @@
+export {};

package/es/texture.d.ts

@@ -1,5 +1,5 @@
 import type { BinaryPointer } from './binary';
-import type { DataType } from './components';
+import type { DataType } from './data-type';
 export interface TextureFormatOptions {
     format?: GLenum;
     internalFormat?: GLenum;

package/es/timeline/playables/sprite-color-playable-asset-data.d.ts

@@ -1,6 +1,7 @@
-import type { DataType, EffectsObjectData } from '../../components';
 import type { RGBAColorValue } from '../../number-expression';
 import type { ColorOverLifetime } from '../../type';
+import type { DataType } from '../../data-type';
+import type { EffectsObjectData } from '../../effects-object-data';
 export interface SpriteColorPlayableAssetData extends EffectsObjectData {
     dataType: DataType.SpriteColorPlayableAsset;
     colorOverLifetime?: ColorOverLifetime;

package/es/timeline/playables/transform-playable-asset-data.d.ts

@@ -1,5 +1,6 @@
-import type { DataType, EffectsObjectData } from '../../components';
+import type { EffectsObjectData } from '../../effects-object-data';
 import type { SizeOverLifetime, RotationOverLifetime, PositionOverLifetime } from '../../type';
+import type { DataType } from '../../data-type';
 export interface TransformPlayableAssetData extends EffectsObjectData {
     dataType: DataType.TransformPlayableAsset;
     /**

package/es/timeline/timeline-asset-data.d.ts

@@ -1,4 +1,6 @@
-import type { EffectsObjectData, DataPath, DataType } from '../components';
+import type { DataPath } from '../components';
+import type { DataType } from '../data-type';
+import type { EffectsObjectData } from '../effects-object-data';
 export interface TimelineAssetData extends EffectsObjectData {
     dataType: DataType.TimelineAsset;
     /**

package/es/timeline/track/track-asset-data.d.ts

@@ -1,5 +1,6 @@
-import type { DataPath, EffectsObjectData } from '../../components';
+import type { DataPath } from '../../components';
 import type { TimelineClipData } from '../timeline-clip-data';
+import type { EffectsObjectData } from '../../effects-object-data';
 export interface TrackAssetData extends EffectsObjectData {
     /**
      * 子轨道数据（TrackAssetData）

package/es/type.d.ts

@@ -528,6 +528,14 @@ export declare enum ItemType {
      * 特效元素
      */
     effect = "effect",
+    /**
+     * 形状元素
+     */
+    shape = "shape",
+    /**
+     * 后处理元素
+     */
+    postProcessVolume = "postProcessVolume",
     /**
      * 节点元素
      */
@@ -539,7 +547,11 @@ export declare enum ItemType {
     /**
      * 音频元素
      */
-    audio = "audio"
+    audio = "audio",
+    /**
+     * 富文本元素
+     */
+    richtext = "richtext"
 }
 /**
  * 渲染模式

package/es/type.js

@@ -260,6 +260,14 @@ export var ItemType;
      * 特效元素
      */
     ItemType["effect"] = "effect";
+    /**
+     * 形状元素
+     */
+    ItemType["shape"] = "shape";
+    /**
+     * 后处理元素
+     */
+    ItemType["postProcessVolume"] = "postProcessVolume";
     /**
      * 节点元素
      */
@@ -272,6 +280,10 @@ export var ItemType;
      * 音频元素
      */
     ItemType["audio"] = "audio";
+    /**
+     * 富文本元素
+     */
+    ItemType["richtext"] = "richtext";
 })(ItemType || (ItemType = {}));
 /**
  * 渲染模式

package/es/vfx-item-data.d.ts

@@ -1,4 +1,5 @@
-import type { DataPath, EffectsObjectData } from './components';
+import type { DataPath } from './components';
+import type { EffectsObjectData } from './effects-object-data';
 import type { EndBehavior, BaseContent, TransformData } from './item/base-item';
 import type { ItemType, RenderLevel } from './type';
 export interface VFXItemData extends EffectsObjectData {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/effects-specification",
-  "version": "2.1.0-alpha.1",
+  "version": "2.1.0-alpha.2",
   "description": "Galacean Effects JSON Specification",
   "module": "./es/index.js",
   "main": "./es/index.js",
@@ -39,13 +39,12 @@
     "registry": "https://registry.npmjs.org"
   },
   "scripts": {
-    "prebuild": "npm run clean:all",
-    "build": "npm run build:lib",
+    "prebuild": "pnpm clean",
+    "build": "pnpm build:lib",
     "build:lib": "tsc -b tsconfig.build.json",
     "lint": "eslint src --ext .ts,.mjs",
     "lint:fix": "eslint src --fix --quiet --ext .ts,.mjs",
     "check:ts": "tsc -b tsconfig.check.json",
-    "clean:all": "npm run clean:lib",
-    "clean:lib": "rimraf es/**"
+    "clean": "rimraf es/**"
   }
 }

package/es/components.d.ts

@@ -1,210 +0,0 @@
-import type { Vector2Data } from './item/base-item';
-export declare enum DataType {
-    VFXItemData = "VFXItemData",
-    EffectComponent = "EffectComponent",
-    Material = "Material",
-    Shader = "Shader",
-    SpriteComponent = "SpriteComponent",
-    ParticleSystem = "ParticleSystem",
-    InteractComponent = "InteractComponent",
-    CameraController = "CameraController",
-    Geometry = "Geometry",
-    Texture = "Texture",
-    AnimationClip = "AnimationClip",
-    TextComponent = "TextComponent",
-    BinaryAsset = "BinaryAsset",
-    TrackAsset = "TrackAsset",
-    TimelineAsset = "TimelineAsset",
-    ObjectBindingTrack = "ObjectBindingTrack",
-    TransformTrack = "TransformTrack",
-    SpriteColorTrack = "SpriteColorTrack",
-    ActivationTrack = "ActivationTrack",
-    SubCompositionTrack = "SubCompositionTrack",
-    FloatPropertyTrack = "FloatPropertyTrack",
-    ColorPropertyTrack = "ColorPropertyTrack",
-    Vector4PropertyTrack = "Vector4PropertyTrack",
-    TransformPlayableAsset = "TransformPlayableAsset",
-    SpriteColorPlayableAsset = "SpriteColorPlayableAsset",
-    ActivationPlayableAsset = "ActivationPlayableAsset",
-    SubCompositionPlayableAsset = "SubCompositionPlayableAsset",
-    FloatPropertyPlayableAsset = "FloatPropertyPlayableAsset",
-    ColorPropertyPlayableAsset = "ColorPropertyPlayableAsset",
-    MeshComponent = "MeshComponent",
-    SkyboxComponent = "SkyboxComponent",
-    LightComponent = "LightComponent",
-    CameraComponent = "CameraComponent",
-    ModelPluginComponent = "ModelPluginComponent",
-    TreeComponent = "TreeComponent",
-    AnimationComponent = "AnimationComponent",
-    SpineComponent = "SpineComponent",
-    VideoComponent = "VideoComponent",
-    AudioComponent = "AudioComponent",
-    TimelineClip = "TimelineClip"
-}
-export interface DataPath {
-    id: string;
-}
-export interface EffectsObjectData {
-    id: string;
-    name?: string;
-    dataType: DataType;
-}
-export interface ComponentData extends EffectsObjectData {
-    item: DataPath;
-}
-export interface ColorData {
-    r: number;
-    g: number;
-    b: number;
-    a: number;
-}
-export interface Vector4Data {
-    x: number;
-    y: number;
-    z: number;
-    w: number;
-}
-export interface MaterialTextureProperty {
-    texture: DataPath;
-    offset?: Vector2Data;
-    scale?: Vector2Data;
-}
-export interface MaterialData extends EffectsObjectData {
-    shader: DataPath;
-    blending?: boolean;
-    zWrite?: boolean;
-    zTest?: boolean;
-    stringTags: Record<string, string>;
-    macros: string[];
-    ints: Record<string, number>;
-    floats: Record<string, number>;
-    vector4s: Record<string, Vector4Data>;
-    colors: Record<string, ColorData>;
-    textures: Record<string, MaterialTextureProperty>;
-}
-export interface GeometryData extends EffectsObjectData {
-    vertexData: VertexData;
-    indexFormat: IndexFormatType;
-    indexOffset: number;
-    subMeshes: SubMesh[];
-    /**
-     * 模型绘制模式，默认为 GeometryType.TRIANGLES（三角形）
-     * @default GeometryType.TRIANGLES
-     */
-    mode: GeometryType;
-    /**
-     * 存放 position, uv, normal, indices 的打包数据
-     */
-    buffer?: string;
-    /**
-     * 存放 position, uv, normal, indices 的二进制数据，用于序列化二进制数据
-     */
-    binaryData?: Uint8Array;
-    /**
-     * 所有的骨骼名称
-     */
-    boneNames?: string[];
-    rootBoneName?: string;
-    inverseBindMatrices?: number[];
-}
-export interface SubMesh {
-    offset: number;
-    indexCount?: number;
-    vertexCount: number;
-}
-export declare enum GeometryType {
-    /**
-     * Draw single points.
-     */
-    POINTS = 0,
-    /**
-     * Draw lines. Each vertex connects to the one after it.
-     */
-    LINES = 1,
-    /**
-     * Draw lines. Each set of two vertices is treated as a separate line segment.
-     */
-    LINE_LOOP = 2,
-    /**
-     * Draw a connected group of line segments from the first vertex to the last.
-     */
-    LINE_STRIP = 3,
-    /**
-     * Draw triangles. Each set of three vertices creates a separate triangle.
-     */
-    TRIANGLES = 4,
-    /**
-     * Draw a connected strip of triangles.
-     */
-    TRIANGLE_STRIP = 5,
-    /**
-     * Draw a connected group of triangles. Each vertex connects to the previous and the first vertex in the fan.
-     */
-    TRIANGLE_FAN = 6
-}
-export interface VertexData {
-    vertexCount: number;
-    channels: VertexChannel[];
-}
-export declare enum VertexFormatType {
-    Float16 = 0,
-    Float32 = 1,
-    Int8 = 2,
-    Int16 = 3,
-    Int32 = 4,
-    UInt8 = 5,
-    UInt16 = 6,
-    UInt32 = 7
-}
-export declare enum IndexFormatType {
-    None = -1,
-    UInt8 = 0,
-    UInt16 = 1,
-    UInt32 = 2
-}
-export interface VertexChannel {
-    semantic: string;
-    offset: number;
-    format: VertexFormatType;
-    dimension: number;
-    normalize?: boolean;
-}
-export declare enum VertexBufferSemantic {
-    Position = "POSITION",
-    Uv = "TEXCOORD0",
-    Uv2 = "TEXCOORD1",
-    Normal = "NORMAL",
-    Tangent = "TANGENT",
-    Color = "COLOR",
-    Joints = "JOINTS",
-    Weights = "WEIGHTS",
-    PositionBS0 = "POSITION_BS0",
-    PositionBS1 = "POSITION_BS1",
-    PositionBS2 = "POSITION_BS2",
-    PositionBS3 = "POSITION_BS3",
-    PositionBS4 = "POSITION_BS4",
-    PositionBS5 = "POSITION_BS5",
-    PositionBS6 = "POSITION_BS6",
-    PositionBS7 = "POSITION_BS7",
-    NormalBS0 = "NORMAL_BS0",
-    NormalBS1 = "NORMAL_BS1",
-    NormalBS2 = "NORMAL_BS2",
-    NormalBS3 = "NORMAL_BS3",
-    TangentBS0 = "TANGENT_BS0",
-    TangentBS1 = "TANGENT_BS1",
-    TangentBS2 = "TANGENT_BS2",
-    TangentBS3 = "TANGENT_BS3"
-}
-export interface ShaderData extends EffectsObjectData {
-    vertex: string;
-    fragment: string;
-    properties?: string;
-}
-export interface EffectsPackageData {
-    fileSummary: FileSummary;
-    exportObjects: EffectsObjectData[];
-}
-export interface FileSummary {
-    guid: string;
-    assetType: string;
-}