@galacean/effects-core 1.1.2 → 1.1.4

package/dist/transform.d.ts

@@ -0,0 +1,221 @@
+import type * as spec from '@galacean/effects-specification';
+import { Vector3, Matrix4, Quaternion, Euler } from '@galacean/effects-math/es/core/index';
+import type { Disposable } from './utils';
+export interface TransformProps {
+    position?: spec.vec3 | Vector3;
+    rotation?: spec.vec3 | Euler;
+    quat?: spec.vec4 | Quaternion;
+    scale?: spec.vec3 | Vector3;
+    name?: string;
+    anchor?: spec.vec2 | spec.vec3 | Vector3;
+    valid?: boolean;
+}
+export declare class Transform implements Disposable {
+    /**
+     * 转换右手坐标系左手螺旋对应的四元数到对应的旋转角
+     * @param quat - 四元数
+     * @param out - 欧拉角
+     * @returns
+     */
+    static getRotation(quat: Quaternion, out: Euler): Euler;
+    name: string;
+    /**
+     * 自身位移
+     */
+    readonly position: Vector3;
+    /**
+     * 自身旋转对应的四元数，右手坐标系，旋转正方向左手螺旋（轴向的顺时针），旋转欧拉角的顺序为 ZYX
+     */
+    readonly quat: Quaternion;
+    /**
+     * 自身旋转角度
+     */
+    readonly rotation: Euler;
+    /**
+     * 自身缩放
+     */
+    readonly scale: Vector3;
+    /**
+     * 自身锚点
+     */
+    readonly anchor: Vector3;
+    /**
+     * 子变换，可以有多个
+     */
+    private children;
+    /**
+     * 父变换，只能有一个
+     */
+    private parent;
+    /**
+     * 所有父变换对应的联合矩阵
+     */
+    private parentMatrix;
+    /**
+     * 包含父变换的最终模型矩阵
+     */
+    private worldMatrix;
+    /**
+     * 仅包含自身变换的模型矩阵
+     */
+    private localMatrix;
+    /**
+     * 变换是否需要生效，不生效返回的模型矩阵为单位矩阵，需要随元素生命周期改变
+     */
+    private valid;
+    /**
+     * 数据变化标志位
+     */
+    private dirtyFlags;
+    /**
+     * 最终模型矩阵对应变换的缓存，当自身矩阵或父矩阵有修改时需要更新
+     */
+    private readonly worldTRSCache;
+    constructor(props?: TransformProps, parent?: Transform);
+    set parentTransform(transform: Transform | null);
+    get parentTransform(): Transform | null;
+    set parentMatrixDirty(val: boolean);
+    get parentMatrixDirty(): boolean;
+    /**
+     * 设置位置
+     * @param x
+     * @param y
+     * @param z
+     */
+    setPosition(x: number, y: number, z: number): void;
+    /**
+     * 在当前位置的基础上添加位置偏移
+     * @param x
+     * @param y
+     * @param z
+     */
+    translate(x: number, y: number, z: number): void;
+    /**
+     * 设置旋转
+     * @param x
+     * @param y
+     * @param z
+     */
+    setRotation(x: number, y: number, z: number): void;
+    /**
+     * 设置四元数
+     * @param x
+     * @param y
+     * @param z
+     * @param w
+     * @private
+     */
+    setQuaternion(x: number, y: number, z: number, w: number): void;
+    /**
+     * 设置缩放
+     * @param x
+     * @param y
+     * @param z
+     */
+    setScale(x: number, y: number, z: number): void;
+    /**
+     * 在当前旋转的基础上使用四元素添加旋转
+     * @param quat
+     */
+    rotateByQuat(quat: Quaternion): void;
+    /**
+     * 在当前缩放基础上设置缩放系数
+     * @param x
+     * @param y
+     * @param z
+     */
+    scaleBy(x: number, y: number, z: number): void;
+    /**
+     * 设置锚点
+     * @param x
+     * @param y
+     * @param z
+     */
+    setAnchor(x: number, y: number, z: number): void;
+    /**
+     * 批量设置 transform 属性
+     * @param props - 要设置的属性
+     * @param reverseEuler - 设置 rotation时，欧拉角是否需要取负值
+     */
+    setTransform(props: TransformProps, reverseEuler?: boolean): void;
+    /**
+     * 添加子变换
+     * @param child - 要添加的子变换
+     */
+    addChild(child: Transform): void;
+    /**
+     * 移除子变换
+     */
+    removeChild(child: Transform): void;
+    /**
+     * 获取当前的旋转量
+     * @returns
+     */
+    getRotation(): Euler;
+    /**
+     * 获取当前的四元数
+     * @returns
+     */
+    getQuaternion(): Quaternion;
+    /**
+     * 更新元素自身变换矩阵
+     */
+    updateLocalMatrix(): void;
+    /**
+     * 获取自身变换对应的模型矩阵
+     * 数据修改且需要生效时更新自身矩阵
+     * 当变换不需要生效时返回单位矩阵
+     * @returns
+     */
+    getMatrix(): Matrix4;
+    /**
+     * 获取父矩阵，如果有多级父节点，返回整体变换
+     * @returns
+     */
+    getParentMatrix(): Matrix4 | undefined;
+    /**
+     * 获取包含自身变换和父变换的模型变换矩阵
+     * @returns
+     */
+    getWorldMatrix(): Matrix4;
+    /**
+     * 获取联合变换后的最终缩放因子
+     * @returns
+     */
+    getWorldScale(): Vector3;
+    /**
+     * 获取联合变换后的最终位置
+     * @returns
+     */
+    getWorldPosition(): Vector3;
+    /**
+     * 获取联合变换后的最终旋转量
+     * @returns
+     */
+    getWorldRotation(): Euler;
+    /**
+     * 根据世界变换矩阵计算位移、旋转、缩放向量
+     * @param  position
+     * @param  quat
+     * @param  scale
+     */
+    assignWorldTRS(position?: Vector3, quat?: Quaternion, scale?: Vector3): void;
+    /**
+     * 拆解并复制指定矩阵到自身变换
+     * @param m4
+     * @param scale
+     * @returns
+     */
+    cloneFromMatrix(m4: Matrix4, scale?: Vector3): void;
+    /**
+     * 设置 Transform 生效 / 失效， 默认元素生命周期开始后生效，结束后失效
+     */
+    setValid(val: boolean): void;
+    /**
+     * 获取 Transform 是否生效
+     */
+    getValid(): boolean;
+    dispose(): void;
+    private updateTRSCache;
+    private dispatchValueChange;
+}

package/dist/utils/array.d.ts

@@ -0,0 +1,19 @@
+import type { TypedArray } from '@galacean/effects-specification';
+export declare function addItem<T>(arr: T[], value: T): T[];
+/**
+ * 性能测试：https://blog.mutoe.com/2019/compare-filter-vs-splice-in-javascript/
+ * @param arr
+ * @param value
+ * @returns
+ */
+export declare function removeItem<T>(arr: T[], value: T): T[];
+/**
+ * 原 arrAddWithOrder 根据property的大小在arr中插入item
+ * @param arr
+ * @param item
+ * @param property
+ * @param descending
+ * @returns
+ */
+export declare function addItemWithOrder<T extends Record<string, any>>(arr: T[], item: T, property: string, descending?: boolean): void;
+export declare function enlargeBuffer<T extends TypedArray>(typeArray: T, length: number, increase: number | undefined, maxSize: number): T;

package/dist/utils/asserts.d.ts

@@ -0,0 +1,2 @@
+export declare function assertExist<T>(item: T | void | undefined | null, msg?: string): asserts item is T;
+export declare function asserts(condition: any, msg?: string): asserts condition;

package/dist/utils/color.d.ts

@@ -0,0 +1,10 @@
+export type color = [r: number, g: number, b: number, a: number];
+export interface ColorStop {
+    stop: number;
+    color: color | number[];
+}
+export declare function colorToArr(hex: string | number[], normalized?: boolean): color;
+export declare function getColorFromGradientStops(stops: ColorStop[], key: number, normalize?: boolean): color | number[];
+export declare function colorStopsFromGradient(gradient: number[][] | Record<string, string | number[]>): ColorStop[];
+export declare function interpolateColor(a: color | number[], b: color | number[], s: number, origin?: boolean): color;
+export declare function parsePercent(c: string): number;

package/dist/utils/device.d.ts

@@ -0,0 +1,4 @@
+export declare function getPixelRatio(): number;
+export declare function isIOS(): boolean;
+export declare function isAndroid(): boolean;
+export declare function isSimulatorCellPhone(): boolean;

package/dist/utils/image-data.d.ts

@@ -0,0 +1,10 @@
+export declare function imageDataFromColor(value: string | number[]): {
+    width: number;
+    height: number;
+    data: Uint8Array;
+};
+export declare function imageDataFromGradient(gradient: number[][] | Record<string, string | number[]>): {
+    width: number;
+    height: number;
+    data: Uint8Array;
+};

package/dist/utils/index.d.ts

@@ -0,0 +1,67 @@
+export * from './array';
+export * from './color';
+export * from './device';
+export * from './image-data';
+export * from './sortable';
+export * from './asserts';
+export * from './timeline-component';
+export type Immutable<O> = O extends Record<any, any> ? {
+    readonly [key in keyof O]: Immutable<O[key]>;
+} : O extends Array<infer X> ? ReadonlyArray<X> : O;
+export declare enum DestroyOptions {
+    destroy = 0,
+    keep = 1,
+    force = 0
+}
+/**
+ *
+ */
+export interface Disposable {
+    dispose(): void;
+}
+export interface RestoreHandler {
+    restore(): void;
+}
+export interface LostHandler {
+    lost(e: Event): void;
+}
+export declare function noop(): void;
+/**
+ * 判断对象是否是`String`类型
+ *
+ * @static
+ * @function isString
+ * @param {object} obj - 要判断的对象
+ * @return {boolean}
+ */
+export declare function isString(obj: any): boolean;
+/**
+ * 判断对象是否是`Array`类型
+ *
+ * @static
+ * @function isArray
+ * @param {object} obj - 要判断的对象
+ * @return {boolean}
+ */
+export declare const isArray: (arg: any) => arg is any[];
+/**
+ * 判断对象是否是函数类型
+ *
+ * @static
+ * @function isFunction
+ * @param {object} obj - 要判断的对象
+ * @return {boolean}
+ */
+export declare function isFunction(obj: any): boolean;
+/**
+ * 判断对象是否是`Object`类型
+ *
+ * @static
+ * @function isObject
+ * @param {object} obj - 要判断的对象
+ * @return {boolean}
+ */
+export declare function isObject(obj: any): boolean;
+export declare function deepClone(obj: any): any;
+export declare function random(min: number, max: number): number;
+export declare function throwDestroyedError(): void;

package/dist/utils/sortable.d.ts

@@ -0,0 +1,23 @@
+export interface Sortable {
+    readonly priority: number;
+}
+export declare enum OrderType {
+    none = 1,
+    ascending = 2,
+    descending = 3
+}
+/**
+ * 按照指定排序方式对数组排序
+ * @param arr - 要排序的数组
+ * @param order - 排序方式
+ * @returns
+ */
+export declare function sortByOrder<T extends Sortable>(arr: T[], order?: OrderType): T[];
+/**
+ * 按照指定排序方式往Sortable数组中添加成员
+ * @param arr - 被添加的数组
+ * @param item - 要添加的成员
+ * @param order - 排序方式
+ * @returns
+ */
+export declare function addByOrder<T extends Sortable>(arr: T[], item: T, order?: OrderType): T[];

package/dist/utils/timeline-component.d.ts

@@ -0,0 +1,39 @@
+import * as spec from '@galacean/effects-specification';
+import type { ValueGetter } from '../math';
+import type { Transform } from '../transform';
+import type { VFXItem } from '../vfx-item';
+import type { SpriteItemOptions, ItemBasicTransform, ItemLinearVelOverLifetime, SpriteRenderData } from '../plugins';
+export interface TimelineComponentOptions {
+    sizeOverLifetime?: spec.SizeOverLifetime;
+    rotationOverLifetime?: spec.RotationOverLifetime;
+    positionOverLifetime?: spec.PositionOverLifetime;
+}
+export declare class TimelineComponent {
+    options: Omit<SpriteItemOptions, 'delay'>;
+    sizeSeparateAxes: boolean;
+    speedOverLifetime?: ValueGetter<number>;
+    basicTransform: ItemBasicTransform;
+    gravityModifier: ValueGetter<number>;
+    readonly transform: Transform;
+    readonly linearVelOverLifetime: ItemLinearVelOverLifetime;
+    readonly orbitalVelOverLifetime: {
+        x?: ValueGetter<number>;
+        y?: ValueGetter<number>;
+        z?: ValueGetter<number>;
+        center: [x: number, y: number, z: number];
+        asRotation?: boolean;
+        enabled?: boolean;
+    };
+    private velocity;
+    private readonly rotationOverLifetime;
+    private readonly sizeXOverLifetime;
+    private readonly sizeYOverLifetime;
+    private readonly sizeZOverLifetime;
+    private readonly positionOverLifetime;
+    constructor(options: TimelineComponentOptions, ownerItem: VFXItem<any>);
+    private getVelocity;
+    private willTranslate;
+    updatePosition(x: number, y: number, z: number): void;
+    updateRotation(x: number, y: number, z: number): void;
+    getRenderData(_time: number, init?: boolean): SpriteRenderData;
+}