@galacean/effects-specification 2.1.0-alpha.4 → 2.1.0-alpha.5

package/es/index.d.ts

@@ -29,6 +29,7 @@ export * from './text';
 export * from './components';
 export * from './vfx-item-data';
 export * from './buitin-object-guid';
+export * from './shape';
 export * from './timeline';
 export * from './assets';
 export * from './render-settings';

package/es/index.js

@@ -29,6 +29,7 @@ export * from './text';
 export * from './components';
 export * from './vfx-item-data';
 export * from './buitin-object-guid';
+export * from './shape';
 export * from './timeline';
 export * from './assets';
 export * from './render-settings';

package/es/shape/custom-shape-data.d.ts

@@ -0,0 +1,73 @@
+import type { TransformData } from '../item/base-item';
+import type { Vector2Data } from '../math';
+import type { ShapeComponentData } from './shape-component-data';
+import type { ShapeFillParam } from './shape-fill-param';
+import type { ShapePrimitiveType } from './shape-primitive-type';
+import type { ShapeStrokeParam } from './shape-stroke-param';
+/**
+ * 自定义形状点
+ */
+export interface CustomShapePoint {
+    /**
+     * 顶点索引
+     */
+    point: number;
+    /**
+     * 入射点索引
+     */
+    easingIn: number;
+    /**
+     * 出射点索引
+     */
+    easingOut: number;
+}
+/**
+ * 自定义形状参数
+ */
+export interface CustomShape {
+    /**
+     * 点索引 - 用于构成闭合图形
+     */
+    indexes: CustomShapePoint[];
+    /**
+     * 是否为闭合图形 - 用于Stroke
+     */
+    close: boolean;
+    /**
+     * 填充属性
+     */
+    fill?: ShapeFillParam;
+    /**
+     * 描边属性
+     */
+    stroke?: ShapeStrokeParam;
+    /**
+     * 空间变换
+     */
+    transform?: TransformData;
+}
+/**
+ * 自定义图形组件
+ */
+export interface CustomShapeData extends ShapeComponentData {
+    /**
+     * 矢量类型 - 形状
+     */
+    type: ShapePrimitiveType.Custom;
+    /**
+     * 路径点
+     */
+    points: Vector2Data[];
+    /**
+     * 入射控制点
+     */
+    easingIns: Vector2Data[];
+    /**
+     * 入射控制点
+     */
+    easingOuts: Vector2Data[];
+    /**
+     * 自定义形状
+     */
+    shapes: CustomShape[];
+}

package/es/shape/custom-shape-data.js

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

package/es/shape/ellipse-data.d.ts

@@ -0,0 +1,33 @@
+import type { TransformData } from '../item/base-item';
+import type { ShapeComponentData } from './shape-component-data';
+import type { ShapeFillParam } from './shape-fill-param';
+import type { ShapePrimitiveType } from './shape-primitive-type';
+import type { ShapeStrokeParam } from './shape-stroke-param';
+/**
+ * 椭圆组件参数
+ */
+export interface EllipseData extends ShapeComponentData {
+    type: ShapePrimitiveType.Ellipse;
+    /**
+     * x 轴半径
+     * -- TODO 后续完善类型
+     * -- TODO 可以看一下用xRadius/yRadius 还是 width/height
+     */
+    xRadius: number;
+    /**
+     * y 轴半径
+     */
+    yRadius: number;
+    /**
+     * 填充属性
+     */
+    fill?: ShapeFillParam;
+    /**
+     * 描边属性
+     */
+    stroke?: ShapeStrokeParam;
+    /**
+     * 空间变换
+     */
+    transform?: TransformData;
+}

package/es/shape/ellipse-data.js

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

package/es/shape/index.d.ts

@@ -0,0 +1,9 @@
+export * from './custom-shape-data';
+export * from './ellipse-data';
+export * from './polygon-data';
+export * from './rectangle-data';
+export * from './shape-component-data';
+export * from './shape-fill-param';
+export * from './shape-primitive-type';
+export * from './shape-stroke-param';
+export * from './star-data';

package/es/shape/index.js

@@ -0,0 +1,9 @@
+export * from './custom-shape-data';
+export * from './ellipse-data';
+export * from './polygon-data';
+export * from './rectangle-data';
+export * from './shape-component-data';
+export * from './shape-fill-param';
+export * from './shape-primitive-type';
+export * from './shape-stroke-param';
+export * from './star-data';

package/es/shape/polygon-data.d.ts

@@ -0,0 +1,33 @@
+import type { TransformData } from '../item/base-item';
+import type { ShapeComponentData } from './shape-component-data';
+import type { ShapeFillParam } from './shape-fill-param';
+import type { ShapeStrokeParam } from './shape-stroke-param';
+/**
+ * 多边形参数
+ */
+export interface PolygonData extends ShapeComponentData {
+    /**
+     * 顶点数
+     */
+    pointCount: number;
+    /**
+     * 外切圆半径
+     */
+    radius: number;
+    /**
+     * 角点圆度
+     */
+    roundness: number;
+    /**
+     * 填充属性
+     */
+    fill?: ShapeFillParam;
+    /**
+     * 描边属性
+     */
+    stroke?: ShapeStrokeParam;
+    /**
+     * 空间变换
+     */
+    transform?: TransformData;
+}

package/es/shape/polygon-data.js

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

package/es/shape/rectangle-data.d.ts

@@ -0,0 +1,33 @@
+import type { TransformData } from '../item/base-item';
+import type { ShapeComponentData } from './shape-component-data';
+import type { ShapeFillParam } from './shape-fill-param';
+import type { ShapeStrokeParam } from './shape-stroke-param';
+/**
+ * 矩形参数
+ */
+export interface RectangleData extends ShapeComponentData {
+    /**
+     * 宽度
+     */
+    width: number;
+    /**
+     * 高度
+     */
+    height: number;
+    /**
+     * 角点元素
+     */
+    roundness: number;
+    /**
+     * 填充属性
+     */
+    fill?: ShapeFillParam;
+    /**
+     * 描边属性
+     */
+    stroke?: ShapeStrokeParam;
+    /**
+     * 空间变换
+     */
+    transform?: TransformData;
+}

package/es/shape/rectangle-data.js

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

package/es/shape/shape-component-data.d.ts

@@ -0,0 +1,11 @@
+import type { ComponentData } from '../components/component-data';
+import type { ShapePrimitiveType } from './shape-primitive-type';
+/**
+ * 矢量图形组件
+ */
+export interface ShapeComponentData extends ComponentData {
+    /**
+     * 矢量类型
+     */
+    type: ShapePrimitiveType;
+}

package/es/shape/shape-component-data.js

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

package/es/shape/shape-fill-param.d.ts

@@ -0,0 +1,10 @@
+import type { ColorData } from '../math/color-data';
+/**
+ * 矢量填充参数
+ */
+export interface ShapeFillParam {
+    /**
+     * 填充颜色
+     */
+    color: ColorData;
+}

package/es/shape/shape-fill-param.js

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

package/es/shape/shape-primitive-type.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 矢量图形类型
+ */
+export declare enum ShapePrimitiveType {
+    /**
+     * 自定义图形
+     */
+    Custom = 0,
+    /**
+     * 矩形
+     */
+    Rectangle = 1,
+    /**
+     * 椭圆
+     */
+    Ellipse = 2,
+    /**
+     * 多边形
+     */
+    Polygon = 3,
+    /**
+     * 星形
+     */
+    Star = 4
+}

package/es/shape/shape-primitive-type.js

@@ -0,0 +1,26 @@
+/**
+ * 矢量图形类型
+ */
+export var ShapePrimitiveType;
+(function (ShapePrimitiveType) {
+    /**
+     * 自定义图形
+     */
+    ShapePrimitiveType[ShapePrimitiveType["Custom"] = 0] = "Custom";
+    /**
+     * 矩形
+     */
+    ShapePrimitiveType[ShapePrimitiveType["Rectangle"] = 1] = "Rectangle";
+    /**
+     * 椭圆
+     */
+    ShapePrimitiveType[ShapePrimitiveType["Ellipse"] = 2] = "Ellipse";
+    /**
+     * 多边形
+     */
+    ShapePrimitiveType[ShapePrimitiveType["Polygon"] = 3] = "Polygon";
+    /**
+     * 星形
+     */
+    ShapePrimitiveType[ShapePrimitiveType["Star"] = 4] = "Star";
+})(ShapePrimitiveType || (ShapePrimitiveType = {}));

package/es/shape/shape-stroke-param.d.ts

@@ -0,0 +1,26 @@
+import type { ColorData } from '../math/color-data';
+export declare enum ShapeConnectType {
+}
+export declare enum ShapePointType {
+}
+/**
+ * 矢量描边参数
+ */
+export interface ShapeStrokeParam {
+    /**
+     * 线宽
+     */
+    width: number;
+    /**
+     * 线颜色
+     */
+    color: ColorData;
+    /**
+     * 连接类型
+     */
+    connectType: ShapeConnectType;
+    /**
+     * 点类型
+     */
+    pointType: ShapePointType;
+}

package/es/shape/shape-stroke-param.js

@@ -0,0 +1,8 @@
+// 本期无该功能 待补充
+export var ShapeConnectType;
+(function (ShapeConnectType) {
+})(ShapeConnectType || (ShapeConnectType = {}));
+// @待补充
+export var ShapePointType;
+(function (ShapePointType) {
+})(ShapePointType || (ShapePointType = {}));

package/es/shape/star-data.d.ts

@@ -0,0 +1,41 @@
+import type { TransformData } from '../item/base-item';
+import type { ShapeComponentData } from './shape-component-data';
+import type { ShapeFillParam } from './shape-fill-param';
+import type { ShapeStrokeParam } from './shape-stroke-param';
+/**
+ * 星形参数
+ */
+export interface StarData extends ShapeComponentData {
+    /**
+     * 顶点数 - 内外顶点同数
+     */
+    pointCount: number;
+    /**
+     * 内径
+     */
+    innerRadius: number;
+    /**
+     * 外径
+     */
+    outerRadius: number;
+    /**
+     * 内径点圆度
+     */
+    innerRoundness: number;
+    /**
+     * 外径点圆度
+     */
+    outerRoundness: number;
+    /**
+     * 填充属性
+     */
+    fill?: ShapeFillParam;
+    /**
+     * 描边属性
+     */
+    stroke?: ShapeStrokeParam;
+    /**
+     * 空间变换
+     */
+    transform?: TransformData;
+}

package/es/shape/star-data.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/effects-specification",
-  "version": "2.1.0-alpha.4",
+  "version": "2.1.0-alpha.5",
   "description": "Galacean Effects JSON Specification",
   "module": "./es/index.js",
   "main": "./es/index.js",