@argila/core 0.0.0-alpha-20250607064138

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Eduardo Lopes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/Argila.d.ts

@@ -0,0 +1,24 @@
+import { CreateCanvasConfig } from "./Canvas";
+import Event from "./Event";
+export interface IArgilaConfig {
+    container: string | HTMLElement;
+    debug?: boolean;
+    createCanvas?: boolean;
+    canvasList?: CreateCanvasConfig[];
+}
+export default class Argila {
+    tickFunc: string;
+    rAFid: number | undefined;
+    dt: number | undefined;
+    last: number | undefined;
+    now: number | undefined;
+    time: number | undefined;
+    debug: boolean;
+    container: string | HTMLElement;
+    beforeTickEvent: Event<number>;
+    afterTickEvent: Event<number>;
+    constructor(options: IArgilaConfig);
+    tick(dt: number): void;
+    destroy(): void;
+}
+//# sourceMappingURL=Argila.d.ts.map

package/dist/Argila.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Argila.d.ts","sourceRoot":"","sources":["../src/Argila.ts"],"names":[],"mappings":"AAEA,OAAe,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAKtD,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,MAAM,GAAG,WAAW,CAAC;IAChC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,UAAU,CAAC,EAAE,kBAAkB,EAAE,CAAC;CACnC;AACD,MAAM,CAAC,OAAO,OAAO,MAAM;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,EAAE,EAAE,MAAM,GAAG,SAAS,CAAC;IACvB,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,KAAK,EAAE,OAAO,CAAC;IACf,SAAS,EAAE,MAAM,GAAG,WAAW,CAAC;IAEhC,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC/B,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;gBAElB,OAAO,EAAE,aAAa;IAkClC,IAAI,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAWtB,OAAO,IAAI,IAAI;CAUhB"}

package/dist/Argila.js

@@ -0,0 +1,62 @@
+"use strict";
+import Entity from "./systems/Entity";
+import Canvas from "./Canvas";
+import World from "./systems/World";
+import Shape from "./systems/Shape";
+import Vector3 from "./Vector3";
+import Loop from "./systems/Loop";
+import Event from "./Event";
+export default class Argila {
+  tickFunc;
+  rAFid;
+  dt;
+  last;
+  now;
+  time;
+  debug;
+  container;
+  beforeTickEvent;
+  afterTickEvent;
+  constructor(options) {
+    this.debug = options.debug ?? false;
+    this.container = options.container;
+    if (options.canvasList && options.canvasList?.length > 0) {
+      options.canvasList.forEach((canvas) => {
+        Canvas.create({
+          ...canvas
+        });
+      });
+    }
+    this.beforeTickEvent = new Event("before-tick");
+    this.afterTickEvent = new Event("after-tick");
+    if ((!options.canvasList || options.canvasList.length === 0) && options.createCanvas) {
+      const mainCanvas = Canvas.create({
+        id: "main",
+        width: 800,
+        height: 800,
+        autoWidth: true,
+        autoHeight: true
+      });
+      Canvas.append(mainCanvas.id, options.container);
+    }
+    this.tickFunc = Loop.create("main", this.tick.bind(this));
+  }
+  tick(dt) {
+    Canvas.clear();
+    this.beforeTickEvent.fire(dt);
+    World.forEach((world) => {
+      World.tick(dt, world);
+    });
+    this.afterTickEvent.fire(dt);
+  }
+  destroy() {
+    Loop.clear();
+    this.beforeTickEvent.destroy();
+    this.afterTickEvent.destroy();
+    Entity.clear();
+    World.clear();
+    Shape.clear();
+    Vector3.clear();
+    Canvas.destroyAll();
+  }
+}

package/dist/Argila.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Argila.test.d.ts.map

package/dist/Argila.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Argila.test.d.ts","sourceRoot":"","sources":["../src/Argila.test.ts"],"names":[],"mappings":""}

package/dist/Argila.test.js

@@ -0,0 +1,150 @@
+"use strict";
+import { describe, it, expect, beforeEach, afterEach, vi } from "vitest";
+import Argila from "./Argila";
+import Canvas from "./Canvas";
+import Loop from "./systems/Loop";
+import Event from "./Event";
+import Entity from "./systems/Entity";
+import World from "./systems/World";
+import Shape from "./systems/Shape";
+import Vector3 from "./Vector3";
+describe("Argila", () => {
+  let argila;
+  let config;
+  beforeEach(() => {
+    config = {
+      container: "test-container",
+      debug: true,
+      createCanvas: true,
+      canvasList: [
+        {
+          id: "test-canvas",
+          width: 500,
+          height: 500,
+          autoWidth: false,
+          autoHeight: false
+        }
+      ]
+    };
+    argila = new Argila(config);
+  });
+  afterEach(() => {
+    argila.destroy();
+  });
+  it("should initialize with the correct configuration", () => {
+    expect(argila.debug).toBe(true);
+    expect(argila.container).toBe("test-container");
+    expect(argila.beforeTickEvent).toBeInstanceOf(Event);
+    expect(argila.afterTickEvent).toBeInstanceOf(Event);
+  });
+  it("should create canvases based on the configuration", () => {
+    expect(Canvas.get("test-canvas")).toBeDefined();
+    expect(Canvas.get("main")).toBeUndefined();
+  });
+  it("should create the main canvas if canvasList is empty and createCanvas is true", () => {
+    config.canvasList = [];
+    config.createCanvas = true;
+    argila = new Argila(config);
+    expect(Canvas.get("main")).toBeDefined();
+  });
+  it("should not create the main canvas if canvasList is not empty", () => {
+    expect(Canvas.get("main")).toBeUndefined();
+  });
+  it("should not create the main canvas if createCanvas is false", () => {
+    config.createCanvas = false;
+    config.canvasList = [];
+    argila = new Argila(config);
+    expect(Canvas.get("main")).toBeUndefined();
+  });
+  it("should initialize with default debug value as false", () => {
+    config.debug = void 0;
+    argila = new Argila({
+      ...config,
+      canvasList: [
+        {
+          id: "test-canvas-2",
+          width: 500,
+          height: 500,
+          autoWidth: false,
+          autoHeight: false
+        }
+      ]
+    });
+    expect(argila.debug).toBe(false);
+  });
+  it("should append the main canvas to the container if created", () => {
+    config.canvasList = [];
+    config.createCanvas = true;
+    argila = new Argila(config);
+    const mainCanvas = Canvas.get("main");
+    expect(mainCanvas).toBeDefined();
+    expect(mainCanvas?.element.parentElement).toBeDefined();
+  });
+  it("should call tick function and fire events", () => {
+    const beforeTickSpy = vi.spyOn(argila.beforeTickEvent, "fire");
+    const afterTickSpy = vi.spyOn(argila.afterTickEvent, "fire");
+    argila.tick(16);
+    expect(beforeTickSpy).toHaveBeenCalledWith(16);
+    expect(afterTickSpy).toHaveBeenCalledWith(16);
+  });
+  it("should call tick function and fire events for multiple worlds", () => {
+    const beforeTickSpy = vi.spyOn(argila.beforeTickEvent, "fire");
+    const afterTickSpy = vi.spyOn(argila.afterTickEvent, "fire");
+    const world1 = { id: "world1" };
+    const world2 = { id: "world2" };
+    vi.spyOn(World, "forEach").mockImplementation((callback) => {
+      callback(world1.id);
+      callback(world2.id);
+    });
+    const worldTickSpy = vi.spyOn(World, "tick");
+    argila.tick(16);
+    expect(beforeTickSpy).toHaveBeenCalledWith(16);
+    expect(afterTickSpy).toHaveBeenCalledWith(16);
+    expect(worldTickSpy).toHaveBeenCalledTimes(2);
+    expect(worldTickSpy).toHaveBeenCalledWith(16, world1.id);
+    expect(worldTickSpy).toHaveBeenCalledWith(16, world2.id);
+  });
+  it("should destroy all systems and clear resources", () => {
+    const loopClearSpy = vi.spyOn(Loop, "clear");
+    const entityClearSpy = vi.spyOn(Entity, "clear");
+    const worldClearSpy = vi.spyOn(World, "clear");
+    const shapeClearSpy = vi.spyOn(Shape, "clear");
+    const vector3ClearSpy = vi.spyOn(Vector3, "clear");
+    const canvasDestroyAllSpy = vi.spyOn(Canvas, "destroyAll");
+    argila.destroy();
+    expect(loopClearSpy).toHaveBeenCalled();
+    expect(entityClearSpy).toHaveBeenCalled();
+    expect(worldClearSpy).toHaveBeenCalled();
+    expect(shapeClearSpy).toHaveBeenCalled();
+    expect(vector3ClearSpy).toHaveBeenCalled();
+    expect(canvasDestroyAllSpy).toHaveBeenCalled();
+  });
+  it("should call tick function multiple times and fire events each time", () => {
+    const beforeTickSpy = vi.spyOn(argila.beforeTickEvent, "fire");
+    const afterTickSpy = vi.spyOn(argila.afterTickEvent, "fire");
+    argila.tick(16);
+    argila.tick(32);
+    expect(beforeTickSpy).toHaveBeenCalledTimes(2);
+    expect(afterTickSpy).toHaveBeenCalledTimes(2);
+    expect(beforeTickSpy).toHaveBeenCalledWith(16);
+    expect(afterTickSpy).toHaveBeenCalledWith(16);
+    expect(beforeTickSpy).toHaveBeenCalledWith(32);
+    expect(afterTickSpy).toHaveBeenCalledWith(32);
+  });
+  it("should handle destroy being called multiple times gracefully", () => {
+    const loopClearSpy = vi.spyOn(Loop, "clear");
+    const entityClearSpy = vi.spyOn(Entity, "clear");
+    const worldClearSpy = vi.spyOn(World, "clear");
+    const shapeClearSpy = vi.spyOn(Shape, "clear");
+    const vector3ClearSpy = vi.spyOn(Vector3, "clear");
+    const canvasDestroyAllSpy = vi.spyOn(Canvas, "destroyAll");
+    argila.destroy();
+    argila.destroy();
+    expect(loopClearSpy).toHaveBeenCalledTimes(2);
+    expect(entityClearSpy).toHaveBeenCalledTimes(2);
+    expect(worldClearSpy).toHaveBeenCalledTimes(2);
+    expect(shapeClearSpy).toHaveBeenCalledTimes(2);
+    expect(vector3ClearSpy).toHaveBeenCalledTimes(2);
+    expect(canvasDestroyAllSpy).toHaveBeenCalledTimes(2);
+  });
+});

package/dist/Canvas.d.ts

@@ -0,0 +1,117 @@
+import type { SetOptional } from "type-fest";
+/**
+ * Configuration interface for Canvas objects
+ */
+export interface CanvasConfig {
+    element: HTMLCanvasElement;
+    ctx: CanvasRenderingContext2D;
+    id: string;
+    width: number;
+    height: number;
+    autoWidth: boolean;
+    autoHeight: boolean;
+    dpr: number;
+    lastWidth: number;
+    lastHeight: number;
+    clear: boolean;
+    clearColor: string;
+    windowResizeCallback: () => void;
+    onResize?: () => void;
+    contextLostCallback?: (event: Event) => void;
+    contextRestoredCallback?: (event: Event) => void;
+    isVisible?: boolean;
+}
+type InternalCanvasConfigProps = "ctx" | "dpr" | "resizeCallback" | "lastWidth" | "lastHeight" | "windowResizeCallback";
+type OptionalCanvasConfigProps = "clear" | "clearColor" | "width" | "height" | "autoWidth" | "autoHeight" | "element";
+export type CreateCanvasConfig = SetOptional<Omit<CanvasConfig, InternalCanvasConfigProps>, OptionalCanvasConfigProps>;
+/**
+ * Canvas utility class for managing HTML5 canvases
+ */
+export default class Canvas {
+    static id: string;
+    static list: Map<string, CanvasConfig>;
+    private static resizeObserver;
+    /**
+     * Creates a new canvas configuration
+     * @param options Canvas configuration options
+     * @returns The created canvas configuration
+     * @throws Error if a canvas with the same ID already exists
+     */
+    static create(options: CreateCanvasConfig): CanvasConfig;
+    /**
+     * Retrieves a canvas configuration by its ID
+     * @param id The canvas ID
+     * @returns The canvas configuration or undefined if not found
+     */
+    static get(id: string): CanvasConfig | undefined;
+    /**
+     * Updates canvas properties
+     * @param id The canvas ID
+     * @param options Options to update
+     */
+    static set(id: string, options: Partial<Omit<CanvasConfig, "ctx" | "element" | "dpr">>): void;
+    /**
+     * Sets the clear color for a canvas
+     * @param id The canvas ID
+     * @param clearColor The color to set
+     */
+    static setClearColor(id: string, clearColor: string): void;
+    /**
+     * Executes a callback for each canvas
+     * @param callback Function to execute for each canvas
+     */
+    static forEach(callback: (canvas: CanvasConfig) => void): void;
+    /**
+     * Automatically resizes a canvas based on its parent element or window
+     * @param id The canvas ID
+     */
+    static autoResize(id: string): void;
+    /**
+     * Appends a canvas to a container
+     * @param id The canvas ID
+     * @param containerId The container ID or element
+     */
+    static append(id: string, containerId: string | HTMLElement): void;
+    /**
+     * Fixes the device pixel ratio for a canvas
+     * @param id The canvas ID
+     */
+    static fixDPI(id: string): void;
+    /**
+     * Handles canvas resize events
+     * @param id The canvas ID
+     */
+    static onResize(id: string): void;
+    /**
+     * Destroys a canvas
+     * @param id The canvas ID
+     */
+    static destroy(id: string): void;
+    /**
+     * Clears all canvases
+     */
+    static clear(): void;
+    /**
+     * Destroys all canvases
+     */
+    static destroyAll(): void;
+    /**
+     * Checks if a canvas is visible in the viewport
+     * @param id The canvas ID
+     * @returns True if the canvas is visible
+     */
+    static isVisible(id: string): boolean;
+    /**
+     * Updates visibility status for all canvases
+     */
+    static updateVisibility(): void;
+    /**
+     * Resizes a canvas to specific dimensions
+     * @param id The canvas ID
+     * @param width New width
+     * @param height New height
+     */
+    static resize(id: string, width: number, height: number): void;
+}
+export {};
+//# sourceMappingURL=Canvas.d.ts.map

package/dist/Canvas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Canvas.d.ts","sourceRoot":"","sources":["../src/Canvas.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAI7C;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,iBAAiB,CAAC;IAC3B,GAAG,EAAE,wBAAwB,CAAC;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,oBAAoB,EAAE,MAAM,IAAI,CAAC;IACjC,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;IACtB,mBAAmB,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAC7C,uBAAuB,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IACjD,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,KAAK,yBAAyB,GAC1B,KAAK,GACL,KAAK,GACL,gBAAgB,GAChB,WAAW,GACX,YAAY,GACZ,sBAAsB,CAAC;AAC3B,KAAK,yBAAyB,GAC1B,OAAO,GACP,YAAY,GACZ,OAAO,GACP,QAAQ,GACR,WAAW,GACX,YAAY,GACZ,SAAS,CAAC;AAEd,MAAM,MAAM,kBAAkB,GAAG,WAAW,CAC1C,IAAI,CAAC,YAAY,EAAE,yBAAyB,CAAC,EAC7C,yBAAyB,CAC1B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM;IACzB,MAAM,CAAC,EAAE,EAAE,MAAM,CAAY;IAE7B,OAAc,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAa;IAC1D,OAAO,CAAC,MAAM,CAAC,cAAc,CAA+B;IAE5D;;;;;OAKG;WACW,MAAM,CAAC,OAAO,EAAE,kBAAkB,GAAG,YAAY;IAmF/D;;;;OAIG;WACW,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAIvD;;;;OAIG;WACW,GAAG,CACf,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,KAAK,GAAG,SAAS,GAAG,KAAK,CAAC,CAAC,GAC9D,IAAI;IAYP;;;;OAIG;WACW,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,IAAI;IAOjE;;;OAGG;WACW,OAAO,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,GAAG,IAAI;IAMrE;;;OAGG;WACW,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAqD1C;;;;OAIG;WACW,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI;IAwBzE;;;OAGG;WACW,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAyBtC;;;OAGG;WACW,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAoBxC;;;OAGG;WACW,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAwBvC;;OAEG;WACW,KAAK,IAAI,IAAI;IAa3B;;OAEG;WACW,UAAU,IAAI,IAAI;IAahC;;;;OAIG;WACW,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAgB5C;;OAEG;WACW,gBAAgB,IAAI,IAAI;IAMtC;;;;;OAKG;WACW,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;CAYtE"}