@galacean/effects-specification 0.0.1

package/dist/src/item/camera-item.d.ts

@@ -0,0 +1,69 @@
+import type { BaseItem, ItemEndBehavior } from './base-item';
+import type { ItemType, RotationOverLifetime } from '../type';
+import type { FixedNumberExpression, FixedVec3Expression } from '../numberExpression';
+import type { CameraClipMode } from '../composition';
+export interface CameraItem extends BaseItem {
+    /**
+     * 元素类型[指定为model]
+     */
+    type: ItemType.camera;
+    /**
+     * 相机元素渲染信息
+     */
+    content: CameraContent;
+    endBehavior: ItemEndBehavior;
+}
+export interface CameraContent {
+    /**
+     * 相机元素基本属性
+     */
+    options: {
+        /**
+         * 视角属性
+         */
+        fov: number;
+        /**
+         * 相机远平面
+         */
+        far: number;
+        /**
+         * 相机近平面
+         */
+        near: number;
+        /**
+         * 相机剪裁模式
+         */
+        clipMode?: CameraClipMode;
+        /**
+         * 默认不提供，等于canvas width/height
+         */
+        aspect?: number;
+    };
+    /**
+     * 相机元素旋转变化属性
+     */
+    rotationOverLifetime?: RotationOverLifetime;
+    /**
+     * 相机元素位置变化属性
+     */
+    positionOverLifetime?: CameraPositionOverLifetime;
+}
+export interface CameraPositionOverLifetime {
+    /**
+     * x轴位置变化信息
+     */
+    linearX?: FixedNumberExpression;
+    /**
+     * y轴位置变化信息
+     */
+    linearY?: FixedNumberExpression;
+    /**
+     * z轴位置变化信息
+     */
+    linearZ?: FixedNumberExpression;
+    /**
+     * 路径
+     * @default [0,0,0]
+     */
+    path?: FixedVec3Expression;
+}

package/dist/src/item/composition-item.d.ts

@@ -0,0 +1,56 @@
+import type { BaseItem, ItemEndBehavior } from './base-item';
+import type { SizeOverLifetime, RotationOverLifetime, ColorOverLifetime, ItemType } from '../type';
+import type { RGBAColorValue, vec3 } from '../numberExpression';
+import type { PositionOverLifetime } from '../type';
+/**
+ * 预合成元素
+ */
+export interface CompositionItem extends BaseItem {
+    /**
+     * 元素类型[指定为composition]
+     */
+    type: ItemType.composition;
+    /**
+     * 预合成元素渲染信息
+     */
+    content: CompositionContent;
+    endBehavior: ItemEndBehavior;
+}
+/**
+ * 预合成元素
+ */
+export interface CompositionContent {
+    /**
+     * 预合成元素基础属性
+     */
+    options: {
+        /**
+         * 引用的合成id
+         */
+        refId: string;
+        /**
+         * 预合成元素宽高
+         */
+        size?: vec3;
+        /**
+         * 预合成元素基础颜色
+         */
+        startColor?: RGBAColorValue;
+    };
+    /**
+     * 预合成元素大小变化属性
+     */
+    sizeOverLifetime?: SizeOverLifetime;
+    /**
+     * 预合成元素旋转变化属性
+     */
+    rotationOverLifetime?: RotationOverLifetime;
+    /**
+     * 预合成元素位置变化属性
+     */
+    positionOverLifetime?: PositionOverLifetime;
+    /**
+     * 预合成元素色彩变化属性
+     */
+    colorOverLifetime?: ColorOverLifetime;
+}

package/dist/src/item/filter-item.d.ts

@@ -0,0 +1,99 @@
+import type { BaseItem, ColorOverLifetime, FixedNumberExpression, FixedVec3Expression, FunctionExpression, ItemEndBehavior, ItemType, MaskMode, NumberExpression, RenderMode, RotationOverLifetime, ShapeGeometry, SideMode, SizeOverLifetime, SpriteContentOptions, vec2, vec3 } from '../index';
+export interface FilterItem extends BaseItem {
+    type: ItemType.filter;
+    content: FilterContent;
+    endBehavior: ItemEndBehavior;
+}
+export declare type FilterParams = NoneFilterParams | GaussianFilterParams | BloomFilterPrams | DelayFilterPrams | DistortionFilterParams | CameraMoveFilterParams | AlphaMaskFilterParams | AlphaFrameFilterParams;
+export interface FilterContent {
+    options: SpriteContentOptions;
+    filter: FilterParams;
+    renderer?: FilterContentRenderer;
+    colorOverLifetime?: ColorOverLifetime;
+    /**
+     * 图层元素大小变化属性
+     */
+    sizeOverLifetime?: SizeOverLifetime;
+    /**
+     * 图层元素旋转变化属性
+     */
+    rotationOverLifetime?: RotationOverLifetime;
+    /**
+     * 图层元素位置变化属性
+     */
+    positionOverLifetime?: FilterPositionOverLifetime;
+}
+export interface FilterPositionOverLifetime {
+    path: FixedVec3Expression;
+}
+export interface BaseFilterParams {
+    name: string;
+    /**
+     * 边缘透明度
+     * @default 1
+     */
+    feather?: FunctionExpression;
+}
+export interface NoneFilterParams extends BaseFilterParams {
+    name: 'none';
+}
+export interface GaussianFilterParams extends BaseFilterParams {
+    name: 'gaussian';
+    radius: number;
+}
+export interface DelayFilterPrams extends BaseFilterParams {
+    name: 'delay';
+}
+export interface BloomFilterPrams extends BaseFilterParams {
+    name: 'bloom';
+    colorThreshold?: vec3;
+    bloomAddon?: FixedNumberExpression;
+    colorAddon?: FixedNumberExpression;
+    radius?: number;
+}
+export interface DistortionFilterParams extends BaseFilterParams {
+    name: 'distortion';
+    center?: vec2;
+    direction?: vec2;
+    period: NumberExpression;
+    waveMovement: NumberExpression;
+    strength: NumberExpression;
+}
+export interface CameraMoveFilterParams extends BaseFilterParams {
+    name: 'cameraMove';
+    position?: FixedVec3Expression;
+}
+export interface AlphaMaskFilterParams extends BaseFilterParams {
+    name: 'alphaMask';
+    xOpacity: FixedNumberExpression;
+    yOpacity: FixedNumberExpression;
+}
+export interface AlphaFrameFilterParams extends BaseFilterParams {
+    name: 'alphaFrame';
+    colorRange?: [x: number, y: number];
+    alphaRange?: [x: number, y: number];
+}
+export declare const BloomFilterThresholdAvgColor = 0;
+export interface FilterContentRenderer {
+    /**
+     * 渲染模式
+     */
+    renderMode?: RenderMode;
+    /**
+     * 锚点信息
+     */
+    anchor?: vec2;
+    /**
+     * 单双面模式
+     */
+    side?: SideMode;
+    /**
+     * 蒙版模式
+     * @default none
+     */
+    maskMode?: MaskMode;
+    /**
+     * 形状
+     */
+    shape?: number | ShapeGeometry;
+}

package/dist/src/item/interact-item.d.ts

@@ -0,0 +1,85 @@
+import type { InteractBehavior, InteractType, ItemType } from '../type';
+import type { RGBAColor } from '../numberExpression';
+import type { BaseItem, ItemEndBehavior } from './base-item';
+/**
+ * 交互元素
+ */
+export interface InteractItem extends BaseItem {
+    /**
+     * 元素类型[指定为interact]
+     */
+    type: ItemType.interact;
+    /**
+     * 交互元素渲染信息
+     */
+    content: InteractContent;
+    endBehavior: ItemEndBehavior;
+}
+/**
+ * 交互元素渲染属性
+ */
+export interface InteractContent {
+    /**
+     * 交互元素基础属性
+     */
+    options: InteractOption;
+}
+/**
+ * 交互元素基础属性
+ */
+export declare type InteractOption = ClickInteractOption | MessageInteractOption | DragInteractOption;
+/**
+ * 点击交互元素基础属性
+ */
+export interface ClickInteractOption {
+    /**
+     * 交互元素类型
+     */
+    type: InteractType;
+    /**
+     * 面板展示开关
+     */
+    showPreview: boolean;
+    /**
+     * 预览颜色属性
+     */
+    previewColor: RGBAColor;
+    /**
+     * 交互触发行为
+     */
+    behavior: InteractBehavior;
+}
+/**
+ * 拖拽交互元素基础属性
+ */
+export interface MessageInteractOption {
+    /**
+     * 交互元素类型
+     */
+    type: InteractType;
+}
+/**
+ * 拖拽交互元素基础属性
+ */
+export interface DragInteractOption {
+    /**
+     * 交互元素类型
+     */
+    type: InteractType;
+    /**
+     * 在编辑器中启用
+     */
+    enableInEditor: boolean;
+    /**
+     * x轴拖拽范围
+     */
+    dxRange?: [min: number, max: number];
+    /**
+     * y轴拖拽范围
+     */
+    dyRange?: [min: number, max: number];
+    /**
+     * 目标
+     */
+    target: string;
+}

package/dist/src/item/model/binary.d.ts

@@ -0,0 +1,85 @@
+import type { Binary, BinaryEnv, BinaryPointer, TypedArray } from '../../binary';
+import type { BufferType } from './mesh';
+/**
+ * Attribute binding information
+ * size: attribute size. the size attribute of vec4|vec3|vec2 is 4|3|2
+ * stride: used for interleaved attributes, 2 vec4 stride is 4 * 2 * Float32Array.BYTES_PER_ELEMENTS
+ * offset: offset for interleaved attributes, 1 vec4 offset is 4 * Float32Array.BYTES_PER_ELEMENTS
+ * normalize: attributed should be normalized
+ *
+ * Attribute 的绑定信息
+ * size：向量的大小，vec4|vec3|vec2 的大小分别为 4|3|2
+ * stride：如果使用交错存储顶点，2个 vec4 的 stride 为 2 * 4 * Float32Array.BYTES_PER_ELEMENTS
+ * offset：交错顶点的数据偏移，1个 vec4 的偏移为 4 * Float32Array.BYTES_PER_ELEMENTS
+ */
+export interface AttributeBase {
+    size: number;
+    stride?: number;
+    offset?: number;
+    instanceDivisor?: number;
+    normalize?: boolean;
+}
+export interface AttributeWithDataSource extends AttributeBase {
+    /**
+     * 如果使用 interleaved attribute，此字段表示数据共享的 attribute
+     */
+    dataSource: string;
+    /**
+     * use FLOAT by default
+     */
+    type?: BufferType;
+}
+/**
+ * if data provided, type can be inferred from its data
+ * if data not provided, type will be FLOAT by default
+ * releasable is false by default,
+ * if releasable set true, geometry.getAttributeData will return null after data send to gpu buffer
+ *
+ * 如果有 data 字段，type 会根据数据进行推断
+ * 如果没有 data 字段，type 默认为 FLOAT
+ * releasable 默认为 false，如果为 true，在数据被提交到 GPU buffer 后 geometry.getAttributeData 方法返回 null
+ */
+export interface AttributeWithData extends AttributeBase {
+    data?: TypedArray;
+    releasable?: boolean;
+    type?: BufferType;
+}
+export interface AttributeWithDataPointer extends AttributeBase {
+    data: BinaryPointer;
+    releasable?: boolean;
+    type?: BufferType;
+}
+export interface AttributeWithType extends AttributeBase {
+    /**
+     * 如果使用interleaved attribute，此字段表示数据共享的attribute
+     */
+    dataSource: string;
+    type: BufferType;
+}
+export declare type AttributeJSON = AttributeWithDataPointer | AttributeWithType | AttributeWithDataSource;
+export interface GeometryOptionsJSON {
+    name?: string;
+    attributes: Record<string, AttributeJSON>;
+    indices?: {
+        data: BinaryPointer;
+        releasable?: boolean;
+    };
+    mode?: GLenum;
+    drawCount?: number;
+    drawStart?: number;
+    instanceCount?: number;
+    bufferUsage?: GLenum;
+    /**
+     * 粒子最大数量，适用于无法更新 GPU 缓存长度的引擎接入
+     */
+    maxVertex?: number;
+}
+export declare type GeometryPointer<T extends BinaryEnv> = T extends 'studio' ? any : GeometryOptionsJSON;
+/**
+ * studio 中是 `Texture` 对象
+ * json 中是 `GLTFTexture<'json'>` 类型，`imageFileId` 是二进制指针
+ * runtime 中是 `scene.textures` 数组的 `index`，`textures` 的创建由 Player 负责
+ */
+export declare type TexturePointer<T extends BinaryEnv> = T extends 'studio' ? any : number;
+export declare type SkyboxCubeTexturePointer<T extends BinaryEnv> = T extends 'studio' ? any : number;
+export declare type ModelAnimationTrackDataPointer<T extends BinaryEnv> = Binary<Float32Array, Float32Array, T>;

package/dist/src/item/model/camera.d.ts

@@ -0,0 +1,33 @@
+import type { BaseItem, ItemEndBehavior } from '../base-item';
+import type { CameraOptions } from '../../composition';
+import type { RotationOverLifetime, PositionOverLifetime } from '../../type';
+export interface ModelCameraOptions extends CameraOptions {
+    parent?: number;
+    /**
+     * 默认不提供，等于 canvas 的 `width/height`
+     */
+    aspect?: number;
+}
+export interface ModelCameraContent {
+    /**
+     * 3D相机元素基础属性
+     */
+    options: ModelCameraOptions;
+    /**
+     * 3D相机元素旋转变化属性
+     */
+    rotationOverLifetime?: RotationOverLifetime;
+    /**
+     * 3D相机元素位置变化属性
+     */
+    positionOverLifetime?: PositionOverLifetime;
+}
+/**
+ * 3D相机元素
+ */
+export interface ModelCameraItem extends BaseItem {
+    type: 'camera';
+    pluginName: 'model';
+    content: ModelCameraContent;
+    endBehavior: ItemEndBehavior;
+}

package/dist/src/item/model/index.d.ts

@@ -0,0 +1,35 @@
+export * from './skybox';
+export * from './light';
+export * from './mesh';
+export * from './tree';
+export * from './camera';
+export * from './material';
+export * from './binary';
+export * from './render';
+/***
+ * 一个 meshItem 打包出来的 json 案例：
+ *
+ * {
+ *   type:'mesh',
+ *   pluginName:'model',
+ *   content:{
+ *     options:{
+ *       skins:{},
+ *       primitives:[
+ *         {
+ *           material:{
+ *           baseColorFactor:[0,0.5,1,1],
+ *           baseColorTexture: {
+ *              magFilter:33071,
+ *              imageFileId:[0,556,1342]
+ *            }
+ *           },
+ *           geometry:[0,0,556]
+ *         }
+ *       ]
+ *     }
+ *
+ *   }
+ * }
+ * bins:[{url:'https://to/some/bin'}]
+ */

package/dist/src/item/model/light.d.ts

@@ -0,0 +1,72 @@
+import type { RGBAColorValue } from '../../numberExpression';
+import type { BaseItem, ItemEndBehavior } from '../base-item';
+import type { RotationOverLifetime, PositionOverLifetime, ItemType } from '../../type';
+export interface ModelLightBaseOptions {
+    /**
+     * 挂靠的父节点
+     */
+    parent?: number;
+    /**
+     * 灯光颜色，线性空间
+     * @default [255,255,255]
+     */
+    color: RGBAColorValue;
+    /**
+     * 灯光强度
+     * @default 1
+     */
+    intensity: number;
+}
+export interface ModelLightPointOptions extends ModelLightBaseOptions {
+    lightType: 'point';
+    /**
+     * @default Infinity
+     */
+    range: number;
+}
+export interface ModelLightSpotOptions extends ModelLightBaseOptions {
+    lightType: 'spot';
+    /**
+     * @default Infinity
+     */
+    range: number;
+    /**
+     * @default 0
+     */
+    innerConeAngle: number;
+    /**
+     * 默认值45度，PI/4
+     * @default 45
+     */
+    outerConeAngle: number;
+}
+export interface ModelLightDirOptions extends ModelLightBaseOptions {
+    lightType: 'directional';
+}
+export interface ModelAmbientLightOptions extends ModelLightBaseOptions {
+    lightType: 'ambient';
+}
+export declare type ModelLightOptions = ModelLightPointOptions | ModelLightDirOptions | ModelLightSpotOptions | ModelAmbientLightOptions;
+export interface ModelLightContent {
+    /**
+     * 灯光元素基础属性
+     */
+    options: ModelLightOptions;
+    /**
+     * 灯光元素旋转变化属性
+     */
+    rotationOverLifetime?: RotationOverLifetime;
+    /**
+     * 灯光元素位置变化属性
+     */
+    positionOverLifetime?: PositionOverLifetime;
+}
+/**
+ * 灯光元素
+ */
+export interface ModelLightItem extends BaseItem {
+    type: ItemType.light;
+    pluginName: 'model';
+    content: ModelLightContent;
+    endBehavior: ItemEndBehavior;
+}

package/dist/src/item/model/material.d.ts

@@ -0,0 +1,84 @@
+import type { RGBAColorValue, vec2 } from '../../numberExpression';
+import type { BinaryEnv } from '../../binary';
+import type { SideMode } from '../../type';
+import type { TexturePointer } from './binary';
+export interface ModelTextureTransform {
+    offset?: vec2;
+    rotation?: number;
+    scale?: vec2;
+}
+export declare enum MaterialType {
+    unlit = "unlit",
+    pbr = "pbr",
+    hair = "hair"
+}
+export declare enum MaterialBlending {
+    opaque = 100,
+    masked = 101,
+    translucent = 102,
+    additive = 103
+}
+export declare type MaterialOptions<T extends BinaryEnv> = MaterialUnlitOptions<T> | MaterialPBROptions<T>;
+export interface MaterialUnlitOptions<T extends BinaryEnv> {
+    name: string;
+    type: MaterialType.unlit;
+    baseColorFactor: RGBAColorValue;
+    baseColorTexture?: TexturePointer<T>;
+    baseColorTextureTransform?: ModelTextureTransform;
+    baseColorTextureCoordinate?: number;
+    depthMask?: boolean;
+    blending?: MaterialBlending;
+    side?: SideMode;
+    alphaCutOff?: number;
+}
+export interface MaterialPBRBaseOptions<T extends BinaryEnv> {
+    name: string;
+    baseColorFactor: RGBAColorValue;
+    baseColorTexture?: TexturePointer<T>;
+    baseColorTextureTransform?: ModelTextureTransform;
+    baseColorTextureCoordinate?: number;
+    useSpecularAA?: boolean;
+    metallicFactor: number;
+    roughnessFactor: number;
+    metallicRoughnessTexture?: TexturePointer<T>;
+    metallicRoughnessTextureTransform?: ModelTextureTransform;
+    metallicRoughnessTextureCoordinate?: number;
+    normalTexture?: TexturePointer<T>;
+    normalTextureScale?: number;
+    normalTextureTransform?: ModelTextureTransform;
+    normalTextureCoordinate?: number;
+    occlusionTexture?: TexturePointer<T>;
+    occlusionTextureStrength?: number;
+    occlusionTextureTransform?: ModelTextureTransform;
+    occlusionTextureCoordinate?: number;
+    emissiveFactor: RGBAColorValue;
+    emissiveIntensity: number;
+    emissiveTexture?: TexturePointer<T>;
+    emissiveTextureTransform?: ModelTextureTransform;
+    emissiveTextureCoordinate?: number;
+    depthMask?: boolean;
+    blending?: MaterialBlending;
+    side?: SideMode;
+    alphaCutOff?: number;
+    enableShadow?: boolean;
+}
+export interface MaterialPBROptions<T extends BinaryEnv> extends MaterialPBRBaseOptions<T> {
+    /**
+     * 增加 pbr 类型参数
+     */
+    type: MaterialType.pbr;
+}
+export interface MaterialHairOptions<T extends BinaryEnv> extends MaterialPBRBaseOptions<T> {
+    /**
+     * 增加头发相关参数
+     */
+    type: MaterialType.hair;
+    specularShiftTexture?: TexturePointer<T>;
+    specularPower?: number;
+    specularScale?: number;
+    specularWidth?: number;
+    primaryColor?: RGBAColorValue;
+    primaryShift?: number;
+    secondaryColor?: RGBAColorValue;
+    secondaryShift?: number;
+}

package/dist/src/item/model/mesh.d.ts

@@ -0,0 +1,69 @@
+import type { BinaryEnv } from '../../binary';
+import type { BaseItem, ItemEndBehavior } from '../base-item';
+import type { MaterialOptions } from './material';
+import type { GeometryPointer } from './binary';
+import type { vec3 } from '../../numberExpression';
+import type { InteractBehavior, ItemType } from '../../type';
+import type { ModelAnimationTrackDataPointer } from './binary';
+export declare type BufferType = WebGLRenderingContext['FLOAT'] | WebGLRenderingContext['INT'] | WebGLRenderingContext['SHORT'] | WebGLRenderingContext['BYTE'] | WebGLRenderingContext['UNSIGNED_INT'] | WebGLRenderingContext['UNSIGNED_SHORT'] | WebGLRenderingContext['UNSIGNED_BYTE'];
+export interface PrimitiveOptions<T extends BinaryEnv> {
+    geometry: GeometryPointer<T>;
+    material: MaterialOptions<T>;
+}
+export interface SkinOptions<T extends BinaryEnv> {
+    name?: string;
+    joints: number[];
+    skeleton?: number;
+    inverseBindMatrices?: ModelAnimationTrackDataPointer<T>;
+}
+export interface ModelMeshOptions<T extends BinaryEnv> {
+    skin?: SkinOptions<T>;
+    primitives: PrimitiveOptions<T>[];
+    weights?: number[];
+    hide?: boolean;
+    parent?: number;
+}
+export declare enum ModelBoundingType {
+    box = 2,
+    sphere = 3
+}
+export interface ModelItemBoundingBox {
+    behavior?: InteractBehavior | number;
+    type: ModelBoundingType.box;
+    /**
+     * 包围形状相对于元素位置的偏移
+     * @default [0,0,0]
+     */
+    center?: vec3;
+    /**
+     * 包围盒的 xyz 长度，当 type 为 box 时生效
+     */
+    size?: vec3;
+}
+export interface ModelItemBoundingSphere {
+    behavior?: InteractBehavior | number;
+    /**
+     * 包围形状相对于元素位置的偏移
+     * @default [0,0,0]
+     */
+    center?: vec3;
+    type: ModelBoundingType.sphere;
+    /**
+     * 包围球的半径，当 type 为 sphere 时生效
+     */
+    radius: number;
+}
+export declare type ModelItemBounding = ModelItemBoundingBox | ModelItemBoundingSphere;
+export interface ModelMeshItemContent<T extends BinaryEnv> {
+    options: ModelMeshOptions<T>;
+    interaction?: ModelItemBounding;
+}
+/**
+ * 模型元素
+ */
+export interface ModelMeshItem<T extends BinaryEnv> extends BaseItem {
+    type: ItemType.mesh;
+    pluginName: 'model';
+    content: ModelMeshItemContent<T>;
+    endBehavior: ItemEndBehavior;
+}