@cjhd/cj-ecs 1.0.0 → 1.0.1

package/assets/common/component/MoveComponent.d.ts

@@ -0,0 +1,141 @@
+import { Vec2 } from 'cc';
+import { EcsComponent } from '../../ecs/EcsComponent';
+import { IEntity } from '../../lib/EcsObject';
+import { NodeComponent } from './NodeComponent';
+interface IOptions {
+    /**
+     * 允许旋转
+     * - 当rotate为true时，angle属性才会同步到NodeComponent
+     * @description 默认值: false
+     */
+    rotate: boolean;
+    /**
+     * 最小速度
+     * @description 单位: 像素/秒
+     * @description 默认值: -Infinity
+     * @description 取值范围: (-oo, +oo)
+     */
+    minSpeed: number;
+    /**
+     * 最大速度
+     * @description 单位: 像素/秒
+     * @description 默认值: Infinity
+     * @description 取值范围: (-oo, +oo)
+     */
+    maxSpeed: number;
+    /**
+     * 加速度
+     * @description 单位: 像素/秒
+     * @description 默认值: 0
+     * @description 取值范围: (-oo, +oo)
+     */
+    acceleratedVelocity: number;
+    /**
+     * 角速度(0表示无穷大)
+     * @description 单位: 度/秒
+     * @description 默认值: 0
+     * @description 取值范围: [0, +oo)
+     */
+    angleVelocity: number;
+}
+export interface IMoveComponent {
+    /**
+     * 选项参数
+     */
+    options: IOptions;
+    /**
+     * 最终的目标
+     * - taget与toward二选一, 且必须设置一个
+     * @description 默认值: null
+     */
+    target: NodeComponent;
+    /**
+     * 最终的角度
+     * - taget与toward二选一, 且必须设置一个
+     * @description 单位: 度
+     * @description 默认值: 0
+     * @description 取值范围: (-180, 180]
+     */
+    toward: number;
+    /**
+     * 当前速度
+     * @description 单位: 像素/秒
+     * @description 默认值: 0
+     * @description 取值范围: (-oo, +oo)
+     */
+    speed: number;
+    /**
+     * 当前角度
+     * @description 单位: 度
+     * @description 默认值: 0
+     * @description 取值范围: (-180, 180]
+     */
+    angle: number;
+    /**
+     * 总移动距离
+     * @description 单位: 像素
+     * @description 默认值: 0
+     * @description 取值范围: [0, +oo)
+     */
+    distance: number;
+}
+/**
+ * 移动方向(只给出了常用的方向)
+ * @description 单位: 度
+ * @description 取值范围: (-180, 180]
+ */
+export declare enum MoveTowardType {
+    Right = 0,
+    RightUp = 45,
+    Up = 90,
+    LeftUp = 135,
+    Left = 180,
+    LeftDown = -135,
+    Down = -90,
+    RightDown = -45
+}
+export declare class MoveComponent<T extends IEntity = IEntity> extends EcsComponent<T> implements IMoveComponent {
+    static allowRecycling: boolean;
+    protected onRemove(): void;
+    reset(): void;
+    private _options;
+    get options(): IOptions;
+    set options(value: IOptions);
+    private _distance;
+    get distance(): number;
+    private set distance(value);
+    private _targetUUID;
+    private _target;
+    get target(): NodeComponent;
+    set target(value: NodeComponent);
+    private _toward;
+    get toward(): number;
+    set toward(value: number);
+    private _angle;
+    get angle(): number;
+    set angle(value: number);
+    private _speed;
+    get speed(): number;
+    set speed(value: number);
+    /**
+     * 获取self朝向other的角度
+     */
+    static getTowardAngle(self: NodeComponent, other: NodeComponent): number;
+    /**
+     * 修正到(-180, 180]
+     */
+    static getAngleFromNeg180to180(angle: number): number;
+    /**
+     * 修正到[0, 360)
+     */
+    static getAngleFrom0To360(angle: number): number;
+    /**
+     * 修正到(-360, 0]
+     */
+    static getAngleFromNeg360To0(angle: number): number;
+    /**
+     * 根据速度二维分量获取toward值
+     */
+    static getTowardByVelocity(velocity: Vec2): number;
+}
+export {};

package/assets/common/component/NodeComponent.d.ts

@@ -0,0 +1,98 @@
+import { Quat, Rect, Size, Vec2, Vec3 } from 'cc';
+import { EcsComponent } from '../../ecs/EcsComponent';
+import { IEntity } from '../../lib/EcsObject';
+interface ILikeSize {
+    readonly width: number;
+    readonly height: number;
+}
+interface ILikeV2 {
+    readonly x: number;
+    readonly y: number;
+}
+interface ILikeV3 {
+    readonly x: number;
+    readonly y: number;
+    readonly z: number;
+}
+export declare class NodeComponent<T extends IEntity = IEntity> extends EcsComponent<T> {
+    static allowRecycling: boolean;
+    protected onRemove(): void;
+    reset(): void;
+    /**是否需要更新BoundingBox */
+    protected isBoundingBoxDirty: boolean;
+    protected $position: Vec3;
+    /**坐标 */
+    get position(): Readonly<ILikeV3>;
+    /**x坐标 */
+    get x(): number;
+    set x(value: number);
+    /**y坐标 */
+    get y(): number;
+    set y(value: number);
+    /**z坐标 */
+    get z(): number;
+    set z(value: number);
+    protected $scale: Vec3;
+    /**缩放 */
+    get scale(): Readonly<ILikeV3>;
+    /**缩放x */
+    get scaleX(): number;
+    set scaleX(value: number);
+    /**缩放y */
+    get scaleY(): number;
+    set scaleY(value: number);
+    /**缩放z */
+    get scaleZ(): number;
+    set scaleZ(value: number);
+    protected $anchorPoint: Vec2;
+    /**锚点 */
+    get anchorPoint(): Readonly<ILikeV2>;
+    /**锚点x */
+    get anchorX(): number;
+    set anchorX(value: number);
+    /**锚点y */
+    get anchorY(): number;
+    set anchorY(value: number);
+    protected $contentSize: Size;
+    /**尺寸 */
+    get contentSize(): Readonly<ILikeSize>;
+    /**宽 */
+    get width(): number;
+    set width(value: number);
+    /**高 */
+    get height(): number;
+    set height(value: number);
+    protected $lrot: Quat;
+    /**本地坐标系下的旋转，用四元数表示 */
+    get rotation(): Readonly<Quat>;
+    set rotation(val: Readonly<Quat>);
+    protected $euler: Vec3;
+    /**本地坐标系下的旋转，用欧拉角表示 */
+    get eulerAngles(): Readonly<Vec3>;
+    set eulerAngles(val: Readonly<Vec3>);
+    /**本地坐标系下的旋转，用欧拉角表示，但是限定在 z 轴上 */
+    get angle(): number;
+    set angle(value: number);
+    private _boundingBox;
+    private _boundingBoxOut;
+    /**轴对称包围盒 */
+    get boundingBox(): Rect;
+    protected _updateBoundingBox(): void;
+    /**最小x坐标 */
+    get minX(): number;
+    /**最小y坐标 */
+    get minY(): number;
+    /**最大x坐标 */
+    get maxX(): number;
+    /**最大y坐标 */
+    get maxY(): number;
+    setPosition(x: number, y: number, z?: number): this;
+    addPosition(x: number, y: number, z?: number): this;
+    setScale(x: number, y: number, z?: number): this;
+    addScale(x: number, y: number, z?: number): this;
+    setAngle(angle: number): this;
+    addAngle(angle: number): this;
+    setContentSize(width: number, height: number): this;
+    setAnchorPoints(x: number, y: number): this;
+}
+export {};

package/assets/common/system/MoveSystem.d.ts

@@ -0,0 +1,17 @@
+import { EcsSystem } from '../../ecs/EcsSystem';
+/**
+ * 负责驱动move组件
+ */
+export declare class MoveSystem extends EcsSystem {
+    private filter;
+    protected execute(dt?: number): void;
+    /**
+     * 处理
+     * @param move
+     * @param entity
+     * @param dt
+     */
+    private handle;
+    private run;
+    private rotate;
+}

package/assets/ecs/EcsComponent.d.ts

@@ -0,0 +1,89 @@
+import { EcsBaseComponent, IComponent, IEntity } from '../lib/EcsObject';
+import type { EcsDirtyMask, IEcsComponentDirtySink } from './EcsDirty';
+export declare class EcsComponent<E extends IEntity = IEntity> extends EcsBaseComponent implements IComponent {
+    static readonly Fields: Record<string, any>;
+    /**内部函数 */
+    static updateEnable(comp: EcsComponent): void;
+    /** 内部函数：ECS/observed runtime 用它把 dirty sink 绑定到组件实例。 */
+    static bindDirtySink(comp: EcsComponent, sink: IEcsComponentDirtySink | null): void;
+    /**内部函数 */
+    static beforeRemove(comp: EcsComponent): void;
+    /**内部函数 */
+    static onAdd(comp: EcsComponent, entity: IEntity): void;
+    /**内部函数 */
+    static onRemove(comp: EcsComponent): void;
+    /**正在初始化中 */
+    private _initing;
+    /**正在移除中 */
+    private _removing;
+    /** 当前组件累积的 dirty bit。未安装 observed 时也会维护这个本地状态。 */
+    private _dirtyMask;
+    /** 每次 dirtyMask 从“未包含某 bit”变为“包含某 bit”时递增，方便调试或增量同步判断。 */
+    private _dirtyVersion;
+    /** 可选扩展 sink。只有 observed runtime install 后才会非空。 */
+    private _dirtySink;
+    /**是否有效 */
+    private _isValid;
+    get isValid(): boolean;
+    private set isValid(value);
+    get isStrictValid(): boolean;
+    /**是否生效 */
+    private _enabled;
+    get enabled(): boolean;
+    set enabled(value: boolean);
+    /**当前组件所在的实体 */
+    private _entity;
+    get entity(): E;
+    private set entity(value);
+    /**表示该组件是否被启用并且所在的实体也处于启用状态(为false代表不会被查询到) */
+    get enabledInHierarchy(): boolean;
+    private __enabled;
+    private updateEnable;
+    get dirty(): boolean;
+    /**
+     * 兼容旧式 boolean dirty 用法。
+     * 设置 true 等价于 markDirty(1)，设置 false 会清掉全部 dirty bit。
+     */
+    set dirty(value: boolean);
+    get dirtyMask(): EcsDirtyMask;
+    get dirtyVersion(): number;
+    /** 判断当前组件是否包含指定 dirty bit。 */
+    hasDirty(mask: EcsDirtyMask): boolean;
+    /**
+     * 标记组件 dirty。
+     *
+     * 业务组件的写屏障应该调用它，例如 position.setXYRaw 后标记 PositionDirtyBits.Spatial。
+     * 如果 observed runtime 已安装，会同步入队；未安装时只更新本地 dirtyMask/version。
+     */
+    markDirty(mask?: EcsDirtyMask): void;
+    /**
+     * 清理组件 dirty。
+     * drain 默认会调用它清理 matched bit；业务也可以在重置组件状态时主动调用。
+     */
+    clearDirty(mask?: EcsDirtyMask): void;
+    /**
+     * 静默清理本地 dirtyMask，不通知 sink。
+     * 只用于组件移除/回收这类生命周期收尾，普通业务不要用它代替 clearDirty。
+     */
+    clearDirtySilent(): void;
+    /**
+     * 组件被添加(内部调用)
+     */
+    private innerAdd;
+    /**
+     * 组件被移除前(内部调用)
+     */
+    private innerBeforeRemove;
+    /**
+     * 组件被移除(内部调用)
+     */
+    private innerRemove;
+    protected onAdd(): void;
+    protected onEnable(): void;
+    protected onDisable(): void;
+    protected onRemove(): void;
+    destroy(): boolean;
+    protected log(...args: any[]): void;
+    protected warn(...args: any[]): void;
+    protected error(...args: any[]): void;
+}