@woosh/meep-engine 2.84.9 → 2.84.10

package/README.md

@@ -15,14 +15,24 @@ To help get you started, various samples are provided under `/samples` folder. F
 
 ## Features
 
-* Automatic instancing. This will minimize the number of draw calls and improve performance.
-* Decals. Decals in meep are done on the GPU, and as a result you can have a lot of them in your scene. The most I tested in a single scene is 1,000,000 which works quite well. Decals are useful for bullet holes, blood splatter and various scene decorations such as signs and scuff marks.
-* Deferred lights. Meep implements clustered lighting technique which allows you to have a pretty much an unlimited number of point lights in your scene. All the other light types are supported as well, but only point lights are clustered for now. Point lights are useful for various effects, like muzzle flashes, grenade explosions, torches, etc.
-* Particle engine. Meep's particle engine ("Particular") is optimized for game development needs, this means supporting complex effects and being able to spawn/destroy many particle systems every frame. There are a lot of particle engines out there, but they tend to have costly spawning routines, take up a lot of draw calls and not manage memory well, which leads to pretty poor performance in games. My particle engine supports full particle lighting as well, and soft particles. On top of that - all particles are automatically atlassed in the background and are compiled with just 4 shaders. This means that no matter how many particle effects you have - there will be no shader switching and no texture switching, and there will be no delays associated with shader compilation. Particles are culled, so particle systems that are off-screen are not rendered and simulation for them can be paused to save CPU resources (this is automatic behavior)
-* Sound engine. Meep has a custom sound engine which is culled and has custom attenuation, this allows scenes to have 1000s of positional audio sources without any extra cost in terms of performance
-* Asset streaming. Meep in general is a web-first engine, all assets are streamed, meaning that the engine is up and running even before any models/texture are loaded, and you're free to decide when to let the player see your level, wait until everything is loaded or drop them in as soon as you can. There is a pre-loader module in case you want to load some assets in bulk before starting the game.
-* Terrain engine. The terrain engine is chunk-based, which means that terrain is split into rectangular pieces internally, and they are built on-the-fly inside a web-worker based on camera position. Terrain is automatically culled based on camera position, so you're only drawing the chunks that are in view. Terrain supports layers just like Unity, but unlike Unity - Meep supports up to 256 layers of terrain instead of 4.
-* AI tools, including
+### Automatic instancing
+This will minimize the number of draw calls and improve performance.
+### Decals
+Decals in meep are done on the GPU, and as a result you can have a lot of them in your scene. The most I tested in a single scene is 1,000,000 which works quite well. Decals are useful for bullet holes, blood splatter and various scene decorations such as signs and scuff marks.
+### Clustered lighting, aka Forward+
+Meep implements clustered lighting technique which allows you to have a pretty much an unlimited number of point lights in your scene. All the other light types are supported as well, but only point lights are clustered for now. Point lights are useful for various effects, like muzzle flashes, grenade explosions, torches, etc.
+### Particles
+Meep's particle engine ("Particular") is optimized for game development needs, this means supporting complex effects and being able to spawn/destroy many particle systems every frame. There are a lot of particle engines out there, but they tend to have costly spawning routines, take up a lot of draw calls and not manage memory well, which leads to pretty poor performance in games. My particle engine supports full particle lighting as well, and soft particles. On top of that - all particles are automatically atlassed in the background and are compiled with just 4 shaders. This means that no matter how many particle effects you have - there will be no shader switching and no texture switching, and there will be no delays associated with shader compilation. Particles are culled, so particle systems that are off-screen are not rendered and simulation for them can be paused to save CPU resources (this is automatic behavior)
+### Trails
+Meep implements a fairly complex trail system, where a trail can be attached to an entity, and it will create a trail behind.
+### Terrain
+The terrain engine is chunk-based, which means that terrain is split into rectangular pieces internally, and they are built on-the-fly inside a web-worker based on camera position. Terrain is automatically culled based on camera position, so you're only drawing the chunks that are in view. Terrain supports layers just like Unity, but unlike Unity - Meep supports up to 256 layers of terrain instead of 4.
+### Sound engine
+Meep has a custom sound engine which is culled and has custom attenuation, this allows scenes to have 1000s of positional audio sources without any extra cost in terms of performance
+### Asset streaming
+Meep in general is a web-first engine, all assets are streamed, meaning that the engine is up and running even before any models/texture are loaded, and you're free to decide when to let the player see your level, wait until everything is loaded or drop them in as soon as you can. There is a pre-loader module in case you want to load some assets in bulk before starting the game.
+### AI tools
+including, but not limited to:
   * full-fledged Behavior trees
   * Blackboard (took for recording information useful for AI to read/write relevant world state, very commonly used with Behavior Trees)
   * monte-carlo tree search (same as Google's AlphaGo, useful for decision-making)
@@ -30,11 +40,15 @@ To help get you started, various samples are provided under `/samples` folder. F
   * grid-based path finding (optimized for 10,000s of queries per second)
   * resource allocation solver (useful for planning, given certain resources such as bullets/grenades/money/health - plan what actions to take to optimize your chances of winning)
   * and a number of other useful tools to complement AI development.
-* Inverse kinematics. Meep has 2 very useful IK solvers to fix foot position for characters on uneven terrain or stairs, aligning both the position and orientation of character feet. This works for hands as well if you want and is not limited to bipeds, the system works just as well for, say, spiders.
-* Extremely compact serialization system. You can save/load your scenes from files. This serialization system supports format changes, so as you develop your game - old saves will be supported and the system will automatically upgrade them to the most recent version, so the player doesn't have to lose any data.
-* Achievements. Achievements work with Blackboard components and are very easy to define. There is an abstraction system that helps connect your achievements to various platforms such as Steam or XBox (you'd have to implement that binding yourself though), by default it comes with a browser backend, storing data in IndexedDB. I also have bindings for Steam and NewGrounds that I can share.
-* UI system. You're free to use it or not, the engine works just fine without it. The system is written for speed, and it offers a few commonly used tools, such as popup windows, notifications and pages. The UI system is optimized for speed, so it generates no garbage, but again - if you want to use, say React - you can ignore this system or integrate it with the system.
-* Trails. Meep implements a fairly complex trail system, where a trail can be attached to an entity, and it will create a trail behind.
+### Inverse kinematics
+Meep has 2 very useful IK solvers to fix foot position for characters on uneven terrain or stairs, aligning both the position and orientation of character feet. This works for hands as well if you want and is not limited to bipeds, the system works just as well for, say, spiders.
+### High-performance serialization
+Extremely compact serialization system. You can save/load your scenes from files. This serialization system supports format changes, so as you develop your game - old saves will be supported and the system will automatically upgrade them to the most recent version, so the player doesn't have to lose any data.
+### Achievements
+Achievements work with Blackboard components and are very easy to define. There is an abstraction system that helps connect your achievements to various platforms such as Steam or XBox (you'd have to implement that binding yourself though), by default it comes with a browser backend, storing data in IndexedDB. I also have bindings for Steam and NewGrounds that I can share.
+### UI system
+You're free to use it or not, the engine works just fine without it. The system is written for speed, and it offers a few commonly used tools, such as popup windows, notifications and pages. The UI system is optimized for speed, so it generates no garbage, but again - if you want to use, say React - you can ignore this system or integrate it with the system.
+
 
 For more information, please refer to the documentation
 

package/build/meep.cjs

@@ -60580,6 +60580,12 @@ class CacheElement {
          */
         this.value = null;
 
+        /**
+         *
+         * @type {number}
+         */
+        this.weight = 0;
+
         /**
          * Link to next element (implements linked list)
          * @type {CacheElement<Key,Value>|null}
@@ -60768,14 +60774,56 @@ class Cache {
     recomputeWeight() {
         let result = 0;
 
-        for (let [key, value] of this.data) {
-            result += this.keyWeigher(key);
-            result += this.valueWeigher(value);
+        for (let [key, record] of this.data) {
+
+            const weight = this.computeElementWeight(key, record.value);
+            record.weight = weight;
+
+            result += weight;
         }
 
         this.weight = result;
     }
 
+    /**
+     * Useful when working with wrapped value types, where contents can change and affect overall weight
+     * Instead of re-inserting element, we can just update weights
+     * NOTE: this method may trigger eviction
+     * @param {Key} key
+     * @returns {boolean} true when weight successfully updated, false if element was not found in cache
+     */
+    updateElementWeight(key) {
+        const record = this.data.get(key);
+
+        if (record === undefined) {
+            return false;
+        }
+
+        const old_weight = record.weight;
+
+        const new_weight = this.computeElementWeight(key, record.value);
+
+        if (new_weight === old_weight) {
+            // we're done, no change
+            return true;
+        }
+
+        record.weight = new_weight;
+
+        const delta_weight = new_weight - old_weight;
+
+        this.weight += delta_weight;
+
+        if (
+            this.weight > this.maxWeight
+            && new_weight >= this.maxWeight //make it less likely to drop entire cache
+        ) {
+            this.evictUntilWeight(this.maxWeight);
+        }
+
+        return true;
+    }
+
     /**
      * @private
      * @param {Key} key
@@ -60783,7 +60831,11 @@ class Cache {
      * @returns {number}
      */
     computeElementWeight(key, value) {
-        return this.keyWeigher(key) + this.valueWeigher(value);
+        const key_weight = this.keyWeigher(key);
+
+        const value_weight = this.valueWeigher(value);
+
+        return key_weight + value_weight;
     }
 
     /**
@@ -60856,6 +60908,9 @@ class Cache {
             //compute weight
             const elementWeight = this.computeElementWeight(key, value);
 
+            element.weight = elementWeight;
+
+
             /**
              * It's possible that element being added is larger than cache's capacity,
              * in which case entire cache will be evicted, but there still won't be enough space
@@ -60949,7 +61004,7 @@ class Cache {
      * @private
      */
     __removeElement(element) {
-        const value = element.value;
+        element.value;
 
         // remove from the queue
         if (element === this.__first) {
@@ -60964,14 +61019,11 @@ class Cache {
 
         const key = element.key;
 
-        //compute weight
-        const elementWeight = this.computeElementWeight(key, value);
-
         //remove from cache
         this.data.delete(key);
 
         //update weight
-        this.weight -= elementWeight;
+        this.weight -= element.weight;
     }
 
     /**
@@ -66277,7 +66329,14 @@ const ShadedGeometryFlags = {
     /**
      * If set to false will not render
      */
-    Visible:16
+    Visible: 16,
+
+    /**
+     * Bounds are updated whenever transforms change, we can defer this until next frame render request
+     * This lets us back updated and do less work overall
+     * TODO implement, currently it's ignored
+     */
+    DeferredBoundsUpdate: 32,
 };
 
 /**
@@ -68369,6 +68428,7 @@ function plane3_compute_ray_intersection(
         const t = -p / denom;
 
         if (t < 0) {
+            // ray starts and points behind the plane
             return false;
         }
 
@@ -68381,9 +68441,10 @@ function plane3_compute_ray_intersection(
         return true;
 
     } else {
+        // ray direction is perpendicular to the plane normal. In other words ray runs parallel to the plane
 
         if (p === 0) {
-
+            // ray origin lies on the plane
             out.set(originX, originY, originZ);
 
             return true;
@@ -73586,6 +73647,39 @@ function assetTypeByPath(url) {
     }
 }
 
+class Name extends ObservedString {
+    constructor(value = "") {
+        super(value);
+    }
+
+    /**
+     *
+     * @returns {string}
+     */
+    getLocalizationKey() {
+        return `component.name.${this.getValue()}`;
+    }
+
+    /**
+     *
+     * @param {Localization} localization
+     * @returns {string}
+     */
+    getLocalizedValue(localization) {
+        return localization.getString(this.getLocalizationKey());
+    }
+
+    clone() {
+        const clone = new Name();
+
+        clone.copy(this);
+
+        return clone;
+    }
+}
+
+Name.typeName = "Name";
+
 /**
  *
  * @param {Transform} transform
@@ -73622,6 +73716,7 @@ function three_object_to_entity_composition(root) {
     transform.fromMatrix4(root.matrixWorld.elements);
 
     entity.add(transform);
+    entity.add(new Name(root.name));
 
     if (root.isMesh) {
         if (root.isSkinnedMesh) ;
@@ -79745,6 +79840,22 @@ function m3_cm_compose_transform(
  */
 const FLT_EPSILON_32 = 1.192092896E-7;
 
+/**
+ *
+ * @param {HTMLElement} domElement
+ * @param {boolean} visibility
+ */
+function setElementVisibility(domElement, visibility) {
+    const style = domElement.style;
+
+    if (!visibility) {
+        style.display = 'none';
+    } else {
+        // remove display property, this allows style re-flow whereby previous display type is assumed
+        style.removeProperty('display');
+    }
+}
+
 /**
  *
  * @param {Float32Array} m3
@@ -79778,21 +79889,6 @@ function writeCssTransformMatrix(m3, domElement) {
  */
 
 
-/**
- *
- * @param {HTMLElement} domElement
- * @param {boolean} visibility
- */
-function setElementVisibility(domElement, visibility) {
-    const style = domElement.style;
-
-    if (!visibility) {
-        style.display = 'none';
-    } else {
-        // remove display property, this allows style re-flow whereby previous display type is assumed
-        style.removeProperty('display');
-    }
-}
 
 /**
  *
@@ -79815,84 +79911,86 @@ const INITIAL_FLAGS = ViewFlags.Visible;
  * @class
  */
 class View {
-    #transform_written = new Float32Array(9);
-    #transform_current = new Float32Array(9);
 
     /**
-     * @constructor
+     * Signal bindings, these will be linked and unlinked along with the view
+     * @private
+     * @type {SignalBinding[]}
      */
-    constructor() {
-        /**
-         *
-         * @type {Element|NodeDescription|null}
-         */
-        this.el = null;
+    bindings = [];
 
-        /**
-         * Signal bindings, these will be linked and unlinked along with the view
-         * @private
-         * @type {SignalBinding[]}
-         */
-        this.bindings = [];
+    /**
+     *
+     * @type {ViewFlags|number}
+     */
+    flags = INITIAL_FLAGS;
 
-        /**
-         *
-         * @type {ViewFlags|number}
-         */
-        this.flags = INITIAL_FLAGS;
+    /**
+     * @readonly
+     * @type {Vector2}
+     */
+    position = new Vector2(0, 0);
 
-        /**
-         * @readonly
-         * @type {Vector2}
-         */
-        const position = this.position = new Vector2(0, 0);
+    /**
+     * @readonly
+     * @type {Vector1}
+     */
+    rotation = new Vector1(0);
 
-        /**
-         * @readonly
-         * @type {Vector1}
-         */
-        const rotation = this.rotation = new Vector1(0);
+    /**
+     * @readonly
+     * @type {Vector2}
+     */
+    scale = new Vector2(1, 1);
 
-        /**
-         * @readonly
-         * @type {Vector2}
-         */
-        const scale = this.scale = new Vector2(1, 1);
+    /**
+     * @readonly
+     * @type {Vector2}
+     */
+    size = new Vector2(0, 0);
 
-        /**
-         * @readonly
-         * @type {Vector2}
-         */
-        const size = this.size = new Vector2(0, 0);
+    /**
+     * Origin from which rotation and scaling is applied
+     * @readonly
+     * @type {Vector2}
+     */
+    transformOrigin = new Vector2(0.5, 0.5);
 
-        /**
-         * Origin from which rotation and scaling is applied
-         * @readonly
-         * @type {Vector2}
-         */
-        this.transformOrigin = new Vector2(0.5, 0.5);
+    on = {
+        linked: new Signal(),
+        unlinked: new Signal()
+    };
 
-        this.on = {
-            linked: new Signal(),
-            unlinked: new Signal()
-        };
+    /**
+     *
+     * @type {View[]}
+     */
+    children = [];
 
-        /**
-         *
-         * @type {View[]}
-         */
-        this.children = [];
+    /**
+     *
+     * @type {View|null}
+     */
+    parent = null;
 
+
+    #transform_written = new Float32Array(9);
+    #transform_current = new Float32Array(9);
+
+    /**
+     * @constructor
+     */
+    constructor() {
         /**
          *
-         * @type {View|null}
+         * @type {Element|NodeDescription|null}
          */
-        this.parent = null;
+        this.el = null;
 
-        position.onChanged.add(this.__updateTransform, this);
-        scale.onChanged.add(this.__updateTransform, this);
-        rotation.onChanged.add(this.__updateTransform, this);
-        size.onChanged.add(this.__setDimensions, this);
+        this.position.onChanged.add(this.__updateTransform, this);
+        this.scale.onChanged.add(this.__updateTransform, this);
+        this.rotation.onChanged.add(this.__updateTransform, this);
+        this.size.onChanged.add(this.__setDimensions, this);
 
         this.transformOrigin.onChanged.add(this.__setTransformOrigin, this);
     }