@woosh/meep-engine 3.11.2 → 3.12.0

package/src/engine/graphics/ecs/mesh-v2/ShadedGeometry.js

@@ -1,428 +1,428 @@
-import { m4_invert } from "../../../../core/geom/3d/mat4/m4_invert.js";
-import { assert } from "../../../../core/assert.js";
-import { array_copy } from "../../../../core/collection/array/array_copy.js";
-import { BvhClient } from "../../../../core/bvh2/bvh3/BvhClient.js";
-import { AABB3 } from "../../../../core/geom/3d/aabb/AABB3.js";
-import { aabb3_matrix4_project } from "../../../../core/geom/3d/aabb/aabb3_matrix4_project.js";
-import { ray3_array_apply_matrix4 } from "../../../../core/geom/3d/ray/ray3_array_apply_matrix4.js";
-import { GeometrySpatialQueryAccelerator } from "../../geometry/buffered/query/GeometrySpatialQueryAccelerator.js";
-import { DrawMode } from "./DrawMode.js";
-import { ShadedGeometryFlags } from "./ShadedGeometryFlags.js";
-
-/**
- * @readonly
- * @type {Float32Array}
- */
-const scratch_aabb3_array = new Float32Array(6);
-
-const DEFAULT_FLAGS = ShadedGeometryFlags.CastShadow
-    | ShadedGeometryFlags.ReceiveShadow
-    | ShadedGeometryFlags.Visible
-;
-
-const FLAG_SET_EQUALITY = ShadedGeometryFlags.CastShadow
-    | ShadedGeometryFlags.ReceiveShadow
-    | ShadedGeometryFlags.DrawMethodLocked
-    | ShadedGeometryFlags.Visible
-;
-
-/**
- *
- * @type {Float32Array|mat4}
- */
-const scratch_m4 = new Float32Array(16);
-
-/**
- * @readonly
- * @type {Float32Array}
- */
-const scratch_ray_0 = new Float32Array(6);
-
-/**
- * Represents a primitive 3d object, a combination of a material and geometry
- * This is roughly equivalent to single draw call, note that his is not a hierarchical data structure, if you want that - you will need to combine multiple entities, each with a `ShadedGeometry` component
- */
-export class ShadedGeometry {
-    /**
-     * Set when a transform change has been observed but the bounding box and the BVH have
-     * not been brought up to date yet. Only ever set under
-     * {@link ShadedGeometryFlags.DeferredBoundsUpdate}, and doubles as the "already queued"
-     * bit for {@link #bounds_queue}.
-     * @type {boolean}
-     */
-    #bounds_dirty = false;
-
-    /**
-     * Transient, assigned in the system. Where this component parks itself when its bounds
-     * go stale under {@link ShadedGeometryFlags.DeferredBoundsUpdate}.
-     * @type {DeferredBoundsQueue|null}
-     */
-    #bounds_queue = null;
-
-    /**
-     * Whatever the running renderer draws geometry from — a `MeshletGeometry` under Shade, and a
-     * `Geometry` where the primitive was built rather than loaded.
-     * @type {MeshletGeometry|Geometry|BufferGeometry|null}
-     */
-    geometry = null;
-
-    /**
-     *
-     * @type {ShadeMaterial|Material|null}
-     */
-    material = null;
-
-    /**
-     * Optional extra material used for shadowmaps
-     * @type {ShadeMaterial|Material|null}
-     */
-    depth_material = null;
-
-    __bvh_leaf = new BvhClient();
-
-    /**
-     * Transient, assigned in the system
-     * @type {number}
-     * @private
-     */
-    __entity = -1;
-
-    /**
-     * Transient, cached for convenience. Associated transform component from the same entity
-     * @type {Transform|null}
-     * @private
-     */
-    __c_transform = null;
-
-    /**
-     * The row a renderer put this primitive in, or `null` while it is in none.
-     *
-     * **Written by whichever system placed it, and read by whoever needs to know where it ended
-     * up** — `MeshSystem3` combining the bounds of an expanded model, for one. Same arrangement v1
-     * made with `Mesh.mesh`: a component that carries the renderer's own geometry may as well carry
-     * the renderer's own handle to it, and one renderer runs at a time.
-     *
-     * @transient
-     * @type {Mesh|null}
-     */
-    node = null;
-
-    /**
-     *
-     * @type {DrawMode|number}
-     */
-    mode = DrawMode.Triangles;
-
-    /**
-     * Transient property signifying how to render object, such as using INSTANCED draw
-     * @type {number}
-     */
-    draw_method = 0;
-
-    /**
-     *
-     * @type {number}
-     */
-    flags = DEFAULT_FLAGS;
-
-    /**
-     *
-     * @param {number|ShadedGeometryFlags} flag
-     * @returns {void}
-     */
-    setFlag(flag) {
-        this.flags |= flag;
-    }
-
-    /**
-     *
-     * @param {number|ShadedGeometryFlags} flag
-     * @returns {void}
-     */
-    clearFlag(flag) {
-        this.flags &= ~flag;
-    }
-
-    /**
-     *
-     * @param {number|ShadedGeometryFlags} flag
-     * @param {boolean} value
-     */
-    writeFlag(flag, value) {
-        if (value) {
-            this.setFlag(flag);
-        } else {
-            this.clearFlag(flag);
-        }
-    }
-
-    /**
-     *
-     * @param {number|ShadedGeometryFlags} flag
-     * @returns {boolean}
-     */
-    getFlag(flag) {
-        return (this.flags & flag) === flag;
-    }
-
-    /**
-     *
-     * @return {number}
-     */
-    hash() {
-        return this.geometry.id
-            ^ this.material.id
-            ^ (this.flags & FLAG_SET_EQUALITY)
-            ^ (this.draw_method << 16)
-            ^ (this.mode << 12)
-            ;
-    }
-
-    /**
-     *
-     * @param {ShadedGeometry} other
-     * @returns {boolean}
-     */
-    equals(other) {
-        return this.geometry.id === other.geometry.id
-            && this.material.id === other.material.id
-            && this.draw_method === other.draw_method
-            && this.mode === other.mode
-            && (this.flags & FLAG_SET_EQUALITY) === (other.flags & FLAG_SET_EQUALITY)
-            && this.depth_material === other.depth_material
-            ;
-    }
-
-    /**
-     *
-     * @param {ShadedGeometry} other
-     */
-    copy(other) {
-        this.geometry = other.geometry;
-        this.material = other.material;
-        this.depth_material = other.depth_material;
-        this.draw_method = other.draw_method;
-        this.mode = other.mode;
-        this.flags = other.flags;
-    }
-
-    /**
-     *
-     * @returns {ShadedGeometry}
-     */
-    clone() {
-        const r = new ShadedGeometry();
-
-        r.copy(this);
-
-        return r;
-    }
-
-    /**
-     * Current cached entity that this component is attached to
-     * @return {number}
-     */
-    get entity() {
-        return this.__entity;
-    }
-
-    /**
-     * Global transform matrix
-     * 4x4 matrix
-     * @return {null|number[]}
-     */
-    get transform() {
-        return this.__c_transform.matrix;
-    }
-
-    /**
-     * Attach this component to the queue that collects deferred bounds updates.
-     * Called by the system when the component enters the BVH.
-     * @param {DeferredBoundsQueue} queue
-     * @returns {void}
-     */
-    bindBoundsQueue(queue) {
-        assert.defined(queue, 'queue');
-
-        this.#bounds_queue = queue;
-    }
-
-    /**
-     * Called by the system when the component leaves the BVH. Any update parked in the
-     * queue is abandoned — the entry is left in place and becomes inert, so unlinking
-     * stays O(1).
-     * @returns {void}
-     */
-    unbindBoundsQueue() {
-        this.#bounds_dirty = false;
-        this.#bounds_queue = null;
-    }
-
-    /**
-     * Recompute the bounding box and push it into the BVH, if a deferred update is pending.
-     *
-     * This is the single point where a parked update lands; it is driven both by
-     * {@link DeferredBoundsQueue.flush} and by any read of the bounding box.
-     * @returns {boolean} whether an update was actually pending
-     */
-    applyDeferredBoundsUpdate() {
-        if (!this.#bounds_dirty) {
-            return false;
-        }
-
-        this.#bounds_dirty = false;
-
-        this.update_bounds();
-
-        this.__bvh_leaf.write_bounds();
-
-        return true;
-    }
-
-    /**
-     *
-     * @param {AABB3} destination
-     */
-    getBoundingBox(destination) {
-        const node = this.node;
-
-        if (node !== null) {
-            /*
-             Placed in a renderer that keeps a world box per row and refreshes it as part of placing
-             it. Reading that is not an optimization — the deferred path below computes its box from
-             the geometry's own, and only a three `BufferGeometry` has one of those.
-            */
-            destination.readFromArray(node.bounding_box);
-
-            return;
-        }
-
-        // settle a pending deferred update, so a read never observes a stale box
-        this.applyDeferredBoundsUpdate();
-
-        const aabb = this.__bvh_leaf.bounds;
-
-        destination.readFromArray(aabb);
-    }
-
-    /**
-     *
-     * @param {MeshletGeometry|BufferGeometry} geometry
-     * @param {ShadeMaterial|Material} material
-     * @param {DrawMode} [draw_mode]
-     */
-    from(geometry, material, draw_mode = DrawMode.Triangles) {
-        this.geometry = geometry;
-        this.material = material;
-        this.mode = draw_mode;
-    }
-
-    /**
-     *
-     * @param {MeshletGeometry|BufferGeometry} geometry
-     * @param {ShadeMaterial|Material} material
-     * @param {DrawMode} [draw_mode]
-     * @return {ShadedGeometry}
-     */
-    static from(geometry, material, draw_mode) {
-        const r = new ShadedGeometry();
-
-        r.from(geometry, material, draw_mode);
-
-        return r;
-    }
-
-    /**
-     * Change handler subscribed to the entity's {@link Transform} while the component is
-     * linked; see {@link ShadedGeometrySystem.link}.
-     * @returns {void}
-     */
-    updateTransform() {
-        if (this.getFlag(ShadedGeometryFlags.DeferredBoundsUpdate)) {
-            if (!this.#bounds_dirty) {
-                this.#bounds_dirty = true;
-
-                this.#bounds_queue.add(this);
-            }
-
-            return;
-        }
-
-        this.update_bounds();
-
-        this.__bvh_leaf.write_bounds();
-    }
-
-    update_bounds() {
-        const geometry = this.geometry;
-
-        /*
-         The box comes off the geometry's own, which is why this is only reachable for a `Geometry`:
-         it computes one on demand and remembers it, which is the whole of what
-         `GeometryFlags.BoundsNeedUpdate` is for. A `MeshletGeometry` carries its box from the build
-         and is read through {@link #node} instead — see `getBoundingBox`.
-        */
-        geometry.ensureBounds();
-
-        array_copy(geometry.bounding_box, 0, scratch_aabb3_array, 0, 6);
-
-        // transform
-        aabb3_matrix4_project(this.__bvh_leaf.bounds, scratch_aabb3_array, this.transform);
-    }
-
-    /**
-     * Raycast this primitive's own triangles on the CPU.
-     *
-     * **Requires a {@link Geometry}** — the vertex arrays themselves. A `MeshletGeometry` keeps its
-     * triangles quantized inside meshlet pages, so a `ShadedGeometry` placed by
-     * `shade_node_to_entity_composition` cannot be asked this; `geometry_build_from_meshlet_geometry`
-     * decodes one, and holding that decode is the caller's business rather than this method's.
-     * Picking a whole scene goes through the renderer's own `pick` instead (I-9) — this answers with
-     * a surface point on one primitive.
-     *
-     * @param {SurfacePoint3} contact if found, contact is written here
-     * @param {ArrayLike<number>|number[]|Float32Array} ray 6-tuple: [origin_x, origin_y, origin_z, direction_x, direction_y, direction_z]
-     * @param {ArrayLike<number>|number[]|Float32Array} transform_matrix4 transform applied to the geometry
-     * @returns {boolean}
-     */
-    query_raycast_nearest(contact, ray, transform_matrix4) {
-
-        // get transform in local space
-        m4_invert(scratch_m4, transform_matrix4);
-
-        // transform ray to local space
-        if (!ray3_array_apply_matrix4(scratch_ray_0, 0, ray, 0, scratch_m4)) {
-            // invalid transform matrix
-            return false;
-        }
-
-        const hit_found = GeometrySpatialQueryAccelerator.INSTANCE.queryRaycastNearest_array(
-            contact,
-            this.geometry,
-            scratch_ray_0
-        );
-
-        if (!hit_found) {
-            return false;
-        }
-
-        // transform hit contact into global space
-        contact.applyMatrix4(transform_matrix4);
-
-        return true;
-
-    }
-}
-
-/**
- * @readonly
- * @type {string}
- */
-ShadedGeometry.typeName = 'ShadedGeometry';
-
-/**
- * TODO add serialization support
- * @readonly
- * @type {boolean}
- */
-ShadedGeometry.serializable = false;
+import { m4_invert } from "../../../../core/geom/3d/mat4/m4_invert.js";
+import { assert } from "../../../../core/assert.js";
+import { array_copy } from "../../../../core/collection/array/array_copy.js";
+import { BvhClient } from "../../../../core/bvh2/bvh3/BvhClient.js";
+import { AABB3 } from "../../../../core/geom/3d/aabb/AABB3.js";
+import { aabb3_matrix4_project } from "../../../../core/geom/3d/aabb/aabb3_matrix4_project.js";
+import { ray3_array_apply_matrix4 } from "../../../../core/geom/3d/ray/ray3_array_apply_matrix4.js";
+import { GeometrySpatialQueryAccelerator } from "../../geometry/buffered/query/GeometrySpatialQueryAccelerator.js";
+import { DrawMode } from "./DrawMode.js";
+import { ShadedGeometryFlags } from "./ShadedGeometryFlags.js";
+
+/**
+ * @readonly
+ * @type {Float32Array}
+ */
+const scratch_aabb3_array = new Float32Array(6);
+
+const DEFAULT_FLAGS = ShadedGeometryFlags.CastShadow
+    | ShadedGeometryFlags.ReceiveShadow
+    | ShadedGeometryFlags.Visible
+;
+
+const FLAG_SET_EQUALITY = ShadedGeometryFlags.CastShadow
+    | ShadedGeometryFlags.ReceiveShadow
+    | ShadedGeometryFlags.DrawMethodLocked
+    | ShadedGeometryFlags.Visible
+;
+
+/**
+ *
+ * @type {Float32Array|mat4}
+ */
+const scratch_m4 = new Float32Array(16);
+
+/**
+ * @readonly
+ * @type {Float32Array}
+ */
+const scratch_ray_0 = new Float32Array(6);
+
+/**
+ * Represents a primitive 3d object, a combination of a material and geometry
+ * This is roughly equivalent to single draw call, note that his is not a hierarchical data structure, if you want that - you will need to combine multiple entities, each with a `ShadedGeometry` component
+ */
+export class ShadedGeometry {
+    /**
+     * Set when a transform change has been observed but the bounding box and the BVH have
+     * not been brought up to date yet. Only ever set under
+     * {@link ShadedGeometryFlags.DeferredBoundsUpdate}, and doubles as the "already queued"
+     * bit for {@link #bounds_queue}.
+     * @type {boolean}
+     */
+    #bounds_dirty = false;
+
+    /**
+     * Transient, assigned in the system. Where this component parks itself when its bounds
+     * go stale under {@link ShadedGeometryFlags.DeferredBoundsUpdate}.
+     * @type {DeferredBoundsQueue|null}
+     */
+    #bounds_queue = null;
+
+    /**
+     * Whatever the running renderer draws geometry from — a `MeshletGeometry` under Shade, and a
+     * `Geometry` where the primitive was built rather than loaded.
+     * @type {MeshletGeometry|Geometry|BufferGeometry|null}
+     */
+    geometry = null;
+
+    /**
+     *
+     * @type {ShadeMaterial|Material|null}
+     */
+    material = null;
+
+    /**
+     * Optional extra material used for shadowmaps
+     * @type {ShadeMaterial|Material|null}
+     */
+    depth_material = null;
+
+    __bvh_leaf = new BvhClient();
+
+    /**
+     * Transient, assigned in the system
+     * @type {number}
+     * @private
+     */
+    __entity = -1;
+
+    /**
+     * Transient, cached for convenience. Associated transform component from the same entity
+     * @type {Transform|null}
+     * @private
+     */
+    __c_transform = null;
+
+    /**
+     * The row a renderer put this primitive in, or `null` while it is in none.
+     *
+     * **Written by whichever system placed it, and read by whoever needs to know where it ended
+     * up** — `MeshSystem` combining the bounds of an expanded model, for one. Same arrangement v1
+     * made with `Mesh.mesh`: a component that carries the renderer's own geometry may as well carry
+     * the renderer's own handle to it, and one renderer runs at a time.
+     *
+     * @transient
+     * @type {Mesh|null}
+     */
+    node = null;
+
+    /**
+     *
+     * @type {DrawMode|number}
+     */
+    mode = DrawMode.Triangles;
+
+    /**
+     * Transient property signifying how to render object, such as using INSTANCED draw
+     * @type {number}
+     */
+    draw_method = 0;
+
+    /**
+     *
+     * @type {number}
+     */
+    flags = DEFAULT_FLAGS;
+
+    /**
+     *
+     * @param {number|ShadedGeometryFlags} flag
+     * @returns {void}
+     */
+    setFlag(flag) {
+        this.flags |= flag;
+    }
+
+    /**
+     *
+     * @param {number|ShadedGeometryFlags} flag
+     * @returns {void}
+     */
+    clearFlag(flag) {
+        this.flags &= ~flag;
+    }
+
+    /**
+     *
+     * @param {number|ShadedGeometryFlags} flag
+     * @param {boolean} value
+     */
+    writeFlag(flag, value) {
+        if (value) {
+            this.setFlag(flag);
+        } else {
+            this.clearFlag(flag);
+        }
+    }
+
+    /**
+     *
+     * @param {number|ShadedGeometryFlags} flag
+     * @returns {boolean}
+     */
+    getFlag(flag) {
+        return (this.flags & flag) === flag;
+    }
+
+    /**
+     *
+     * @return {number}
+     */
+    hash() {
+        return this.geometry.id
+            ^ this.material.id
+            ^ (this.flags & FLAG_SET_EQUALITY)
+            ^ (this.draw_method << 16)
+            ^ (this.mode << 12)
+            ;
+    }
+
+    /**
+     *
+     * @param {ShadedGeometry} other
+     * @returns {boolean}
+     */
+    equals(other) {
+        return this.geometry.id === other.geometry.id
+            && this.material.id === other.material.id
+            && this.draw_method === other.draw_method
+            && this.mode === other.mode
+            && (this.flags & FLAG_SET_EQUALITY) === (other.flags & FLAG_SET_EQUALITY)
+            && this.depth_material === other.depth_material
+            ;
+    }
+
+    /**
+     *
+     * @param {ShadedGeometry} other
+     */
+    copy(other) {
+        this.geometry = other.geometry;
+        this.material = other.material;
+        this.depth_material = other.depth_material;
+        this.draw_method = other.draw_method;
+        this.mode = other.mode;
+        this.flags = other.flags;
+    }
+
+    /**
+     *
+     * @returns {ShadedGeometry}
+     */
+    clone() {
+        const r = new ShadedGeometry();
+
+        r.copy(this);
+
+        return r;
+    }
+
+    /**
+     * Current cached entity that this component is attached to
+     * @return {number}
+     */
+    get entity() {
+        return this.__entity;
+    }
+
+    /**
+     * Global transform matrix
+     * 4x4 matrix
+     * @return {null|number[]}
+     */
+    get transform() {
+        return this.__c_transform.matrix;
+    }
+
+    /**
+     * Attach this component to the queue that collects deferred bounds updates.
+     * Called by the system when the component enters the BVH.
+     * @param {DeferredBoundsQueue} queue
+     * @returns {void}
+     */
+    bindBoundsQueue(queue) {
+        assert.defined(queue, 'queue');
+
+        this.#bounds_queue = queue;
+    }
+
+    /**
+     * Called by the system when the component leaves the BVH. Any update parked in the
+     * queue is abandoned — the entry is left in place and becomes inert, so unlinking
+     * stays O(1).
+     * @returns {void}
+     */
+    unbindBoundsQueue() {
+        this.#bounds_dirty = false;
+        this.#bounds_queue = null;
+    }
+
+    /**
+     * Recompute the bounding box and push it into the BVH, if a deferred update is pending.
+     *
+     * This is the single point where a parked update lands; it is driven both by
+     * {@link DeferredBoundsQueue.flush} and by any read of the bounding box.
+     * @returns {boolean} whether an update was actually pending
+     */
+    applyDeferredBoundsUpdate() {
+        if (!this.#bounds_dirty) {
+            return false;
+        }
+
+        this.#bounds_dirty = false;
+
+        this.update_bounds();
+
+        this.__bvh_leaf.write_bounds();
+
+        return true;
+    }
+
+    /**
+     *
+     * @param {AABB3} destination
+     */
+    getBoundingBox(destination) {
+        const node = this.node;
+
+        if (node !== null) {
+            /*
+             Placed in a renderer that keeps a world box per row and refreshes it as part of placing
+             it. Reading that is not an optimization — the deferred path below computes its box from
+             the geometry's own, and only a three `BufferGeometry` has one of those.
+            */
+            destination.readFromArray(node.bounding_box);
+
+            return;
+        }
+
+        // settle a pending deferred update, so a read never observes a stale box
+        this.applyDeferredBoundsUpdate();
+
+        const aabb = this.__bvh_leaf.bounds;
+
+        destination.readFromArray(aabb);
+    }
+
+    /**
+     *
+     * @param {MeshletGeometry|BufferGeometry} geometry
+     * @param {ShadeMaterial|Material} material
+     * @param {DrawMode} [draw_mode]
+     */
+    from(geometry, material, draw_mode = DrawMode.Triangles) {
+        this.geometry = geometry;
+        this.material = material;
+        this.mode = draw_mode;
+    }
+
+    /**
+     *
+     * @param {MeshletGeometry|BufferGeometry} geometry
+     * @param {ShadeMaterial|Material} material
+     * @param {DrawMode} [draw_mode]
+     * @return {ShadedGeometry}
+     */
+    static from(geometry, material, draw_mode) {
+        const r = new ShadedGeometry();
+
+        r.from(geometry, material, draw_mode);
+
+        return r;
+    }
+
+    /**
+     * Change handler subscribed to the entity's {@link Transform} while the component is
+     * linked; see {@link ShadedGeometrySystem.link}.
+     * @returns {void}
+     */
+    updateTransform() {
+        if (this.getFlag(ShadedGeometryFlags.DeferredBoundsUpdate)) {
+            if (!this.#bounds_dirty) {
+                this.#bounds_dirty = true;
+
+                this.#bounds_queue.add(this);
+            }
+
+            return;
+        }
+
+        this.update_bounds();
+
+        this.__bvh_leaf.write_bounds();
+    }
+
+    update_bounds() {
+        const geometry = this.geometry;
+
+        /*
+         The box comes off the geometry's own, which is why this is only reachable for a `Geometry`:
+         it computes one on demand and remembers it, which is the whole of what
+         `GeometryFlags.BoundsNeedUpdate` is for. A `MeshletGeometry` carries its box from the build
+         and is read through {@link #node} instead — see `getBoundingBox`.
+        */
+        geometry.ensureBounds();
+
+        array_copy(geometry.bounding_box, 0, scratch_aabb3_array, 0, 6);
+
+        // transform
+        aabb3_matrix4_project(this.__bvh_leaf.bounds, scratch_aabb3_array, this.transform);
+    }
+
+    /**
+     * Raycast this primitive's own triangles on the CPU.
+     *
+     * **Requires a {@link Geometry}** — the vertex arrays themselves. A `MeshletGeometry` keeps its
+     * triangles quantized inside meshlet pages, so a `ShadedGeometry` placed by
+     * `shade_node_to_entity_composition` cannot be asked this; `geometry_build_from_meshlet_geometry`
+     * decodes one, and holding that decode is the caller's business rather than this method's.
+     * Picking a whole scene goes through the renderer's own `pick` instead (I-9) — this answers with
+     * a surface point on one primitive.
+     *
+     * @param {SurfacePoint3} contact if found, contact is written here
+     * @param {ArrayLike<number>|number[]|Float32Array} ray 6-tuple: [origin_x, origin_y, origin_z, direction_x, direction_y, direction_z]
+     * @param {ArrayLike<number>|number[]|Float32Array} transform_matrix4 transform applied to the geometry
+     * @returns {boolean}
+     */
+    query_raycast_nearest(contact, ray, transform_matrix4) {
+
+        // get transform in local space
+        m4_invert(scratch_m4, transform_matrix4);
+
+        // transform ray to local space
+        if (!ray3_array_apply_matrix4(scratch_ray_0, 0, ray, 0, scratch_m4)) {
+            // invalid transform matrix
+            return false;
+        }
+
+        const hit_found = GeometrySpatialQueryAccelerator.INSTANCE.queryRaycastNearest_array(
+            contact,
+            this.geometry,
+            scratch_ray_0
+        );
+
+        if (!hit_found) {
+            return false;
+        }
+
+        // transform hit contact into global space
+        contact.applyMatrix4(transform_matrix4);
+
+        return true;
+
+    }
+}
+
+/**
+ * @readonly
+ * @type {string}
+ */
+ShadedGeometry.typeName = 'ShadedGeometry';
+
+/**
+ * TODO add serialization support
+ * @readonly
+ * @type {boolean}
+ */
+ShadedGeometry.serializable = false;