@onerjs/addons 8.27.0 → 8.27.2

package/navigation/generator/generator.worker.d.ts

@@ -0,0 +1,29 @@
+/**
+ * IMPORTANT!
+ * This file is still under construction and will change in the future.
+ * Workers are not yet supported.
+ * For more info visit: https://forum.babylonjs.com/t/replacing-recastjs-with-recast-navigation-js/56003/46
+ */
+import type { NavMeshQuery, NavMesh, TileCache } from "@recast-navigation/core";
+import type { Mesh } from "@onerjs/core/Meshes/mesh.js";
+import type { INavMeshParametersV2 } from "../types.js";
+/**
+ * Builds a NavMesh and NavMeshQuery from meshes using provided parameters.
+ * @param meshes The array of meshes used to create the NavMesh.
+ * @param parameters The parameters used to configure the NavMesh generation.
+ * @param workerOptions Options for the worker, including a completion callback and the worker instance.
+ * @throws Error if the NavMesh data is invalid or cannot be deserialized.
+ */
+export declare function GenerateNavMeshWithWorker(meshes: Array<Mesh>, parameters: INavMeshParametersV2, workerOptions: {
+    /**
+     * Completion callback that is called when the NavMesh generation is complete.
+     * @param navMesh The generated NavMesh.
+     * @param navMeshQuery The NavMeshQuery associated with the generated NavMesh.
+     * @param tileCache Optional TileCache if tile cache generation was used.
+     */
+    completion: (navMesh: NavMesh, navMeshQuery: NavMeshQuery, tileCache?: TileCache) => void;
+    /**
+     *  Worker instance used for asynchronous NavMesh generation.
+     */
+    worker: Worker;
+}): void;

package/navigation/generator/generator.worker.js

@@ -0,0 +1,47 @@
+import { GetPositionsAndIndices } from "../common/getters.js";
+import { BuildFromNavmeshData, BuildFromTileCacheData } from "./generator.common.js";
+import { CreateDefaultTileCacheMeshProcess } from "../common/tile-cache.js";
+/**
+ * Builds a NavMesh and NavMeshQuery from meshes using provided parameters.
+ * @param meshes The array of meshes used to create the NavMesh.
+ * @param parameters The parameters used to configure the NavMesh generation.
+ * @param workerOptions Options for the worker, including a completion callback and the worker instance.
+ * @throws Error if the NavMesh data is invalid or cannot be deserialized.
+ */
+export function GenerateNavMeshWithWorker(meshes, parameters, workerOptions) {
+    if (meshes.length === 0) {
+        throw new Error("At least one mesh is needed to create the nav mesh.");
+    }
+    // callback function to process the message from the worker
+    workerOptions.worker.onmessage = (e) => {
+        if (e.data?.success === false) {
+            throw new Error(`Unable to generate navMesh: ${e}`);
+        }
+        else {
+            const { navMesh, tileCache } = e.data;
+            if (tileCache) {
+                // if tileCache is present, the binary data contains the navmesh and the tilecache as well
+                const tileCacheArray = new Uint8Array(tileCache);
+                const navMeshData = BuildFromTileCacheData(tileCacheArray, CreateDefaultTileCacheMeshProcess());
+                workerOptions.completion(navMeshData.navMesh, navMeshData.navMeshQuery, navMeshData.tileCache);
+                return;
+            }
+            else {
+                if (navMesh) {
+                    // deserialize the navmesh only (no tilecache present)
+                    const navMeshArray = new Uint8Array(navMesh);
+                    const navMeshData = BuildFromNavmeshData(navMeshArray);
+                    workerOptions.completion(navMeshData.navMesh, navMeshData.navMeshQuery, undefined);
+                    return;
+                }
+            }
+            throw new Error(`Unable to generate navMesh/tileCache: ${e}`);
+        }
+    };
+    // send message to worker
+    const [positions, indices] = GetPositionsAndIndices(meshes);
+    const positionsCopy = new Float32Array(positions);
+    const indicesCopy = new Uint32Array(indices);
+    workerOptions.worker.postMessage({ positions: positionsCopy, indices: indicesCopy, parameters }, [positionsCopy.buffer, indicesCopy.buffer]);
+}
+//# sourceMappingURL=generator.worker.js.map

package/navigation/generator/generator.worker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.worker.js","sourceRoot":"","sources":["../../../../../dev/addons/src/navigation/generator/generator.worker.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAClF,OAAO,EAAE,iCAAiC,EAAE,MAAM,sBAAsB,CAAC;AAEzE;;;;;;GAMG;AACH,MAAM,UAAU,yBAAyB,CACrC,MAAmB,EACnB,UAAgC,EAChC,aAYC;IAED,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;IAC3E,CAAC;IAED,2DAA2D;IAC3D,aAAa,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,EAAE,EAAE;QACnC,IAAK,CAAS,CAAC,IAAI,EAAE,OAAO,KAAK,KAAK,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,EAAE,CAAC,CAAC;QACxD,CAAC;aAAM,CAAC;YACJ,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC;YACtC,IAAI,SAAS,EAAE,CAAC;gBACZ,0FAA0F;gBAC1F,MAAM,cAAc,GAAG,IAAI,UAAU,CAAC,SAAS,CAAC,CAAC;gBACjD,MAAM,WAAW,GAAG,sBAAsB,CAAC,cAAc,EAAE,iCAAiC,EAAE,CAAC,CAAC;gBAChG,aAAa,CAAC,UAAU,CAAC,WAAW,CAAC,OAAO,EAAE,WAAW,CAAC,YAAY,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;gBAC/F,OAAO;YACX,CAAC;iBAAM,CAAC;gBACJ,IAAI,OAAO,EAAE,CAAC;oBACV,sDAAsD;oBACtD,MAAM,YAAY,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC;oBAC7C,MAAM,WAAW,GAAG,oBAAoB,CAAC,YAAY,CAAC,CAAC;oBACvD,aAAa,CAAC,UAAU,CAAC,WAAW,CAAC,OAAO,EAAE,WAAW,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;oBACnF,OAAO;gBACX,CAAC;YACL,CAAC;YAED,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,EAAE,CAAC,CAAC;QAClE,CAAC;IACL,CAAC,CAAC;IAEF,yBAAyB;IACzB,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAC5D,MAAM,aAAa,GAAG,IAAI,YAAY,CAAC,SAAS,CAAC,CAAC;IAClD,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;IAC7C,aAAa,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,aAAa,EAAE,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;AACjJ,CAAC","sourcesContent":["/**\n * IMPORTANT!\n * This file is still under construction and will change in the future.\n * Workers are not yet supported.\n * For more info visit: https://forum.babylonjs.com/t/replacing-recastjs-with-recast-navigation-js/56003/46\n */\nimport type { NavMeshQuery, NavMesh, TileCache } from \"@recast-navigation/core\";\n\nimport type { Mesh } from \"core/Meshes/mesh\";\n\nimport type { INavMeshParametersV2 } from \"../types\";\nimport { GetPositionsAndIndices } from \"../common/getters\";\nimport { BuildFromNavmeshData, BuildFromTileCacheData } from \"./generator.common\";\nimport { CreateDefaultTileCacheMeshProcess } from \"../common/tile-cache\";\n\n/**\n * Builds a NavMesh and NavMeshQuery from meshes using provided parameters.\n * @param meshes The array of meshes used to create the NavMesh.\n * @param parameters The parameters used to configure the NavMesh generation.\n * @param workerOptions Options for the worker, including a completion callback and the worker instance.\n * @throws Error if the NavMesh data is invalid or cannot be deserialized.\n */\nexport function GenerateNavMeshWithWorker(\n    meshes: Array<Mesh>,\n    parameters: INavMeshParametersV2,\n    workerOptions: {\n        /**\n         * Completion callback that is called when the NavMesh generation is complete.\n         * @param navMesh The generated NavMesh.\n         * @param navMeshQuery The NavMeshQuery associated with the generated NavMesh.\n         * @param tileCache Optional TileCache if tile cache generation was used.\n         */\n        completion: (navMesh: NavMesh, navMeshQuery: NavMeshQuery, tileCache?: TileCache) => void;\n        /**\n         *  Worker instance used for asynchronous NavMesh generation.\n         */\n        worker: Worker;\n    }\n) {\n    if (meshes.length === 0) {\n        throw new Error(\"At least one mesh is needed to create the nav mesh.\");\n    }\n\n    // callback function to process the message from the worker\n    workerOptions.worker.onmessage = (e) => {\n        if ((e as any).data?.success === false) {\n            throw new Error(`Unable to generate navMesh: ${e}`);\n        } else {\n            const { navMesh, tileCache } = e.data;\n            if (tileCache) {\n                // if tileCache is present, the binary data contains the navmesh and the tilecache as well\n                const tileCacheArray = new Uint8Array(tileCache);\n                const navMeshData = BuildFromTileCacheData(tileCacheArray, CreateDefaultTileCacheMeshProcess());\n                workerOptions.completion(navMeshData.navMesh, navMeshData.navMeshQuery, navMeshData.tileCache);\n                return;\n            } else {\n                if (navMesh) {\n                    // deserialize the navmesh only (no tilecache present)\n                    const navMeshArray = new Uint8Array(navMesh);\n                    const navMeshData = BuildFromNavmeshData(navMeshArray);\n                    workerOptions.completion(navMeshData.navMesh, navMeshData.navMeshQuery, undefined);\n                    return;\n                }\n            }\n\n            throw new Error(`Unable to generate navMesh/tileCache: ${e}`);\n        }\n    };\n\n    // send message to worker\n    const [positions, indices] = GetPositionsAndIndices(meshes);\n    const positionsCopy = new Float32Array(positions);\n    const indicesCopy = new Uint32Array(indices);\n    workerOptions.worker.postMessage({ positions: positionsCopy, indices: indicesCopy, parameters }, [positionsCopy.buffer, indicesCopy.buffer]);\n}\n"]}

package/navigation/generator/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./generator.common.js";
+export * from "./generator.single-thread.js";
+export * from "./injection.js";

package/navigation/generator/index.js

@@ -0,0 +1,5 @@
+export * from "./generator.common.js";
+export * from "./generator.single-thread.js";
+export * from "./injection.js";
+// export * from "./generator.worker.js";
+//# sourceMappingURL=index.js.map

package/navigation/generator/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../dev/addons/src/navigation/generator/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,aAAa,CAAC;AAC5B,sCAAsC","sourcesContent":["export * from \"./generator.common\";\nexport * from \"./generator.single-thread\";\nexport * from \"./injection\";\n// export * from \"./generator.worker\";\n"]}

package/navigation/generator/injection.d.ts

@@ -0,0 +1,6 @@
+import type { RecastNavigationJSPluginV2 } from "../plugin/RecastNavigationJSPlugin.js";
+/**
+ * Injects the navigation mesh generation methods into the navigation plugin.
+ * @param navigationPlugin The navigation plugin to inject the methods into.
+ */
+export declare function InjectGenerators(navigationPlugin: RecastNavigationJSPluginV2): void;

package/navigation/generator/injection.js

@@ -0,0 +1,16 @@
+import { GenerateNavMesh } from "./generator.single-thread.js";
+/**
+ * Injects the navigation mesh generation methods into the navigation plugin.
+ * @param navigationPlugin The navigation plugin to inject the methods into.
+ */
+export function InjectGenerators(navigationPlugin) {
+    navigationPlugin.createNavMeshImpl = (meshes, parameters) => {
+        return GenerateNavMesh(meshes, parameters);
+    };
+    navigationPlugin.createNavMeshAsyncImpl = async (meshes, parameters) => {
+        return await new Promise((resolve) => {
+            resolve(GenerateNavMesh(meshes, parameters));
+        });
+    };
+}
+//# sourceMappingURL=injection.js.map

package/navigation/generator/injection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"injection.js","sourceRoot":"","sources":["../../../../../dev/addons/src/navigation/generator/injection.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAE5D;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,gBAA4C;IACzE,gBAAgB,CAAC,iBAAiB,GAAG,CAAC,MAAc,EAAE,UAAgC,EAAE,EAAE;QACtF,OAAO,eAAe,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAC/C,CAAC,CAAC;IAEF,gBAAgB,CAAC,sBAAsB,GAAG,KAAK,EAAE,MAAc,EAAE,UAAgC,EAAE,EAAE;QACjG,OAAO,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YACjC,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;AACN,CAAC","sourcesContent":["import type { Mesh } from \"core/Meshes/mesh\";\n\nimport type { RecastNavigationJSPluginV2 } from \"../plugin/RecastNavigationJSPlugin\";\nimport type { INavMeshParametersV2 } from \"../types\";\nimport { GenerateNavMesh } from \"./generator.single-thread\";\n\n/**\n * Injects the navigation mesh generation methods into the navigation plugin.\n * @param navigationPlugin The navigation plugin to inject the methods into.\n */\nexport function InjectGenerators(navigationPlugin: RecastNavigationJSPluginV2) {\n    navigationPlugin.createNavMeshImpl = (meshes: Mesh[], parameters: INavMeshParametersV2) => {\n        return GenerateNavMesh(meshes, parameters);\n    };\n\n    navigationPlugin.createNavMeshAsyncImpl = async (meshes: Mesh[], parameters: INavMeshParametersV2) => {\n        return await new Promise((resolve) => {\n            resolve(GenerateNavMesh(meshes, parameters));\n        });\n    };\n}\n"]}

package/navigation/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./plugin/index.js";
+export * from "./factory/index.js";
+export * from "./common/index.js";
+export * from "./generator/index.js";
+export * from "./debug/index.js";

package/navigation/index.js

@@ -0,0 +1,7 @@
+/* eslint-disable @typescript-eslint/no-restricted-imports */
+export * from "./plugin/index.js";
+export * from "./factory/index.js";
+export * from "./common/index.js";
+export * from "./generator/index.js";
+export * from "./debug/index.js";
+//# sourceMappingURL=index.js.map

package/navigation/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../dev/addons/src/navigation/index.ts"],"names":[],"mappings":"AAAA,6DAA6D;AAC7D,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC","sourcesContent":["/* eslint-disable @typescript-eslint/no-restricted-imports */\r\nexport * from \"./plugin/index\";\r\nexport * from \"./factory/index\";\r\nexport * from \"./common/index\";\r\nexport * from \"./generator/index\";\r\nexport * from \"./debug/index\";\r\n"]}

package/navigation/plugin/RecastJSCrowd.d.ts

@@ -0,0 +1,198 @@
+import type { Crowd } from "@recast-navigation/core";
+import type { IVector3Like } from "@onerjs/core/Maths/math.like.js";
+import type { TransformNode } from "@onerjs/core/Meshes/transformNode.js";
+import type { ICrowd } from "@onerjs/core/Navigation/INavigationEngine.js";
+import { Vector3 } from "@onerjs/core/Maths/math.vector.js";
+import { Observable } from "@onerjs/core/Misc/observable.js";
+import type { Scene } from "@onerjs/core/scene.js";
+import type { RecastNavigationJSPluginV2 } from "./RecastNavigationJSPlugin.js";
+import type { IAgentParametersV2 } from "../types.js";
+/**
+ * Recast Detour crowd implementation
+ * This class provides methods to manage a crowd of agents, allowing them to navigate a navigation mesh.
+ * It supports adding agents, updating their parameters, moving them to destinations, and checking their states.
+ * The crowd is updated in the scene's animation loop, and it notifies observers when agents reach their destinations.
+ */
+export declare class RecastJSCrowd implements ICrowd {
+    /**
+     * Recast plugin
+     */
+    get navigationPlugin(): RecastNavigationJSPluginV2;
+    /**
+     * Link to the detour crowd
+     */
+    get recastCrowd(): Crowd;
+    /**
+     * One transform per agent
+     */
+    get transforms(): TransformNode[];
+    /**
+     * All agents created
+     */
+    get agents(): readonly number[];
+    /**
+     * Agents reach radius
+     */
+    get reachRadii(): readonly number[];
+    private _navigationPlugin;
+    private _recastCrowd;
+    private _transforms;
+    private _agents;
+    private _reachRadii;
+    /**
+     * true when a destination is active for an agent and notifier hasn't been notified of reach
+     */
+    private _agentDestinationArmed;
+    /**
+     * agent current target
+     */
+    private _agentDestination;
+    /**
+     * Link to the scene is kept to unregister the crowd from the scene
+     */
+    private _scene;
+    private _engine;
+    /**
+     * Observer for crowd updates
+     */
+    private _onBeforeAnimationsObserver;
+    /**
+     * Fires each time an agent is in reach radius of its destination
+     */
+    onReachTargetObservable: Observable<{
+        /**
+         *
+         */
+        agentIndex: number;
+        /**
+         *
+         */
+        destination: Vector3;
+    }>;
+    /**
+     * Constructor
+     * @param plugin recastJS plugin
+     * @param maxAgents the maximum agent count in the crowd
+     * @param maxAgentRadius the maximum radius an agent can have
+     * @param scene to attach the crowd to
+     * @returns the crowd you can add agents to
+     */
+    constructor(plugin: RecastNavigationJSPluginV2, maxAgents: number, maxAgentRadius: number, scene: Scene);
+    /**
+     * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
+     * You can attach anything to that node. The node position is updated in the scene update tick.
+     * @param pos world position that will be constrained by the navigation mesh
+     * @param parameters agent parameters
+     * @param transform hooked to the agent that will be update by the scene
+     * @returns agent index
+     */
+    addAgent(pos: IVector3Like, parameters: IAgentParametersV2, transform: TransformNode): number;
+    /**
+     * Returns the agent position in world space
+     * @param index agent index returned by addAgent
+     * @returns world space position
+     */
+    getAgentPosition(index: number): Vector3;
+    /**
+     * Returns the agent position result in world space
+     * @param index agent index returned by addAgent
+     * @param result output world space position
+     */
+    getAgentPositionToRef(index: number, result: Vector3): void;
+    /**
+     * Returns the agent velocity in world space
+     * @param index agent index returned by addAgent
+     * @returns world space velocity
+     */
+    getAgentVelocity(index: number): Vector3;
+    /**
+     * Returns the agent velocity result in world space
+     * @param index agent index returned by addAgent
+     * @param result output world space velocity
+     */
+    getAgentVelocityToRef(index: number, result: Vector3): void;
+    /**
+     * Returns the agent next target point on the path
+     * @param index agent index returned by addAgent
+     * @returns world space position
+     */
+    getAgentNextTargetPath(index: number): Vector3;
+    /**
+     * Returns the agent next target point on the path
+     * @param index agent index returned by addAgent
+     * @param result output world space position
+     */
+    getAgentNextTargetPathToRef(index: number, result: Vector3): void;
+    /**
+     * Gets the agent state
+     * @param index agent index returned by addAgent
+     * @returns agent state, 0 = DT_CROWDAGENT_STATE_INVALID, 1 = DT_CROWDAGENT_STATE_WALKING, 2 = DT_CROWDAGENT_STATE_OFFMESH
+     */
+    getAgentState(index: number): number;
+    /**
+     * returns true if the agent in over an off mesh link connection
+     * @param index agent index returned by addAgent
+     * @returns true if over an off mesh link connection
+     */
+    overOffmeshConnection(index: number): boolean;
+    /**
+     * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
+     * @param index agent index returned by addAgent
+     * @param destination targeted world position
+     */
+    agentGoto(index: number, destination: IVector3Like): void;
+    /**
+     * Teleport the agent to a new position
+     * @param index agent index returned by addAgent
+     * @param destination targeted world position
+     */
+    agentTeleport(index: number, destination: IVector3Like): void;
+    /**
+     * Update agent parameters
+     * @param index agent index returned by addAgent
+     * @param parameters agent parameters
+     */
+    updateAgentParameters(index: number, parameters: IAgentParametersV2): void;
+    /**
+     * remove a particular agent previously created
+     * @param index agent index returned by addAgent
+     */
+    removeAgent(index: number): void;
+    /**
+     * get the list of all agents attached to this crowd
+     * @returns list of agent indices
+     */
+    getAgents(): number[];
+    /**
+     * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
+     * @param deltaTime in seconds
+     */
+    update(deltaTime: number): void;
+    /**
+     * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
+     * The queries will try to find a solution within those bounds
+     * default is (1,1,1)
+     * @param extent x,y,z value that define the extent around the queries point of reference
+     */
+    setDefaultQueryExtent(extent: IVector3Like): void;
+    /**
+     * Get the Bounding box extent specified by setDefaultQueryExtent
+     * @returns the box extent values
+     */
+    getDefaultQueryExtent(): Vector3;
+    /**
+     * Get the Bounding box extent result specified by setDefaultQueryExtent
+     * @param result output the box extent values
+     */
+    getDefaultQueryExtentToRef(result: Vector3): void;
+    /**
+     * Get the next corner points composing the path (max 4 points)
+     * @param index agent index returned by addAgent
+     * @returns array containing world position composing the path
+     */
+    getCorners(index: number): Vector3[];
+    /**
+     * Release all resources
+     */
+    dispose(): void;
+}