0.7.4: Add collisionGroupsMask, deprecate collisionGroup

rafern · Feb 29, 2024 · c3cc468 · c3cc468
1 parent 7238985
commit c3cc468
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 24 deletions.
diff --git a/example-project/js/index.js b/example-project/js/index.js
@@ -26,18 +26,23 @@ import {CursorTarget} from '@wonderlandengine/components';
 import {loadRuntime} from '@wonderlandengine/api';
 
 /* wle:auto-constants:start */
-const RuntimeOptions = {
-    physx: false,
-    loader: false,
-    xrFramebufferScaleFactor: 1,
-    canvas: 'canvas',
-};
 const Constants = {
     ProjectName: 'lazy-widgets-wle-example-project',
     RuntimeBaseName: 'WonderlandRuntime',
     WebXRRequiredFeatures: ['local',],
     WebXROptionalFeatures: ['local','hand-tracking','hit-test',],
 };
+const RuntimeOptions = {
+    physx: false,
+    loader: false,
+    xrFramebufferScaleFactor: 1,
+    xrOfferSession: {
+        mode: 'auto',
+        features: Constants.WebXRRequiredFeatures,
+        optionalFeatures: Constants.WebXROptionalFeatures,
+    },
+    canvas: 'canvas',
+};
 /* wle:auto-constants:end */
 
 const engine = await loadRuntime(Constants.RuntimeBaseName, RuntimeOptions);

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "lazy-widgets-wle",
-  "version": "0.7.3",
+  "version": "0.7.4",
   "description": "Typescript retained mode GUI for the HTML canvas API - Wonderland Engine integration",
   "wonderlandengine": {},
   "main": "dist/index.js",

diff --git a/src/components/NoDriverPropsBaseLazyWidgetsComponent.ts b/src/components/NoDriverPropsBaseLazyWidgetsComponent.ts
@@ -23,9 +23,16 @@ export abstract class NoDriverPropsBaseLazyWidgetsComponent<WLRootType extends W
     /**
      * The collision group that this root's collider will belong to. If
      * negative, collider and cursor-target will not be added.
+     * @deprecated Use {@link NoDriverPropsBaseLazyWidgetsComponent#collisionGroupsMask} instead
      */
     @property.int(WLRoot.defaultCollisionGroup)
     collisionGroup!: number;
+    /**
+     * The collision groups that this root's collider will belong to. If 0,
+     * collider and cursor-target will not be added.
+     */
+    @property.int(WLRoot.defaultCollisionGroupsMask)
+    collisionGroupsMask!: number;
     /**
      * Should the material used for the Root be cloned? If false, then the
      * actual material will be used, which will lead to issues if the material
@@ -275,6 +282,7 @@ export abstract class NoDriverPropsBaseLazyWidgetsComponent<WLRootType extends W
         return {
             unitsPerPixel: this.unitsPerPixel,
             collisionGroup: this.collisionGroup,
+            collisionGroupsMask: this.collisionGroupsMask,
             cloneMaterial: this.cloneMaterial,
             textureUniformName: this.textureUniformName,
             cursorStyleManager: this.cursorStyleManagerObject?.getComponent(this.cursorStyleManagerName),

diff --git a/src/core/WLRoot.ts b/src/core/WLRoot.ts
@@ -43,11 +43,17 @@ export interface WLRootProperties extends RootProperties {
     /**
      * The collision group that this root's collider will belong to. If null,
      * collider and cursor-target will not be added.
+     * @deprecated Use {@link WLRootProperties#collisionGroupsMask} instead
      */
     collisionGroup?: number,
     /**
-     * Register the default pointer driver to this root? If collisionGroup is
-     * null, this is forced to false.
+     * The collision groups that this root's collider will belong to. If 0,
+     * collider and cursor-target will not be added.
+     */
+    collisionGroupsMask?: number,
+    /**
+     * Register the default pointer driver to this root? If collisionGroupsMask
+     * is 0, this is forced to false.
      */
     registerPointerDriver?: boolean,
     /** Register the default keyboard driver to this root? */
@@ -117,8 +123,13 @@ export interface WLRootProperties extends RootProperties {
 export class WLRoot extends Root {
     /** Default units-per-pixel */
     static readonly defaultUnitsPerPixel = 0.01;
-    /** Default collision group */
+    /**
+     * Default collision group
+     * @deprecated Use {@link WLRoot.defaultCollisionGroupsMask} instead
+     */
     static readonly defaultCollisionGroup = 1;
+    /** Default collision groups, as a bitmask */
+    static readonly defaultCollisionGroupsMask = 0;
     /** Are materials cloned by default? */
     static readonly defaultCloneMaterial = true;
     /** Are pointer drivers auto-registered by default? */
@@ -300,11 +311,8 @@ export class WLRoot extends Root {
             this.hasPasteEvents = true;
         }
 
-        let collisionGroup: number | null = properties.collisionGroup ?? WLRoot.defaultCollisionGroup;
-        if (collisionGroup < 0) {
-            collisionGroup = null;
-        }
-
+        // TODO remove collisionGroup in next major
+        const collisionGroupsMask: number = (properties?.collisionGroupsMask ?? WLRoot.defaultCollisionGroupsMask) | (1 << (properties?.collisionGroup ?? WLRoot.defaultCollisionGroup));
         const registerPointerDriver = properties.registerPointerDriver ?? WLRoot.defaultRegisterPointerDriver;
         const registerKeyboardDriver = properties.registerKeyboardDriver ?? WLRoot.defaultRegisterKeyboardDriver;
         this.unitsPerPixel = properties.unitsPerPixel ?? WLRoot.defaultUnitsPerPixel;
@@ -327,7 +335,7 @@ export class WLRoot extends Root {
         this.meshObject.active = false;
 
         // Setup drivers
-        if(collisionGroup !== null && registerPointerDriver) {
+        if(collisionGroupsMask !== 0 && registerPointerDriver) {
             this.registerDriver(WLRoot.pointerDriver);
         }
 
@@ -372,11 +380,11 @@ export class WLRoot extends Root {
         this._setupMesh(0, 1, 1, 0);
 
         // Setup mouse pointer input
-        if(collisionGroup !== null) {
+        if(collisionGroupsMask !== 0) {
             this.collision = this.meshObject.addComponent('collision', {
                 collider: Collider.Box,
                 extents: [1, 1, 0.01],
-                group: 1 << collisionGroup,
+                group: collisionGroupsMask,
             });
 
             if (this.collision === null) {
@@ -836,7 +844,7 @@ export class WLRoot extends Root {
 
     /**
      * Get the collision component used for detecting cursor input. Will be null
-     * if a {@link WLRootProperties#collisionGroup} is not provided when
+     * if a {@link WLRootProperties#collisionGroupsMask} is not provided when
      * creating this WLRoot.
      */
     getCollider() {