Add inverted group mask

packages/functional-tests/src/tests/user-mask-test.ts

@@ -28,6 +28,11 @@ export default class UserMaskTest extends Test {
 		const red = this.assets.createMaterial('redMat', {
 			color: { r: .854, g: 0.132, b: 0.132 }
 		});
+		const not = this.assets.createMaterial('notMat', {
+			color: MRE.Color3.Gray()
+		});
+		const box = this.assets.createBoxMesh('box', 0.5, 0.5, 0.5);
+		const sphere = this.assets.createSphereMesh('sphere', 0.3);
 
 		// create team labels
 		const textDef = {
@@ -63,7 +68,7 @@ export default class UserMaskTest extends Test {
 				parentId: root.id,
 				appearance: {
 					enabled: new MRE.GroupMask(this.app.context, ['red', 'default']),
-					meshId: this.assets.createBoxMesh('box', 0.5, 0.5, 0.5).id,
+					meshId: box.id,
 					materialId: red.id
 				},
 				collider: { geometry: { shape: MRE.ColliderType.Auto } },
@@ -73,13 +78,31 @@ export default class UserMaskTest extends Test {
 			}
 		});
 
+		MRE.Actor.Create(this.app.context, {
+			actor: {
+				name: 'notRedIcon',
+				parentId: root.id,
+				appearance: {
+					enabled: new MRE.InvertedGroupMask(this.app.context, ['red', 'default']),
+					meshId: box.id,
+					materialId: not.id
+				},
+				transform: {
+					local: {
+						position: { y: 0.35 },
+						scale: { x: 0.5, y: 0.5, z: 0.5 }
+					}
+				}
+			}
+		});
+
 		const blueIcon = MRE.Actor.Create(this.app.context, {
 			actor: {
 				name: 'blueIcon',
 				parentId: root.id,
 				appearance: {
 					enabled: new MRE.GroupMask(this.app.context, ['blue', 'default']),
-					meshId: this.assets.createSphereMesh('sphere', 0.3).id,
+					meshId: sphere.id,
 					materialId: blue.id
 				},
 				collider: { geometry: { shape: MRE.ColliderType.Auto } },
@@ -89,6 +112,24 @@ export default class UserMaskTest extends Test {
 			}
 		});
 
+		MRE.Actor.Create(this.app.context, {
+			actor: {
+				name: 'notBlueIcon',
+				parentId: root.id,
+				appearance: {
+					enabled: new MRE.InvertedGroupMask(this.app.context, ['blue', 'default']),
+					meshId: sphere.id,
+					materialId: not.id
+				},
+				transform: {
+					local: {
+						position: { y: 0.35 },
+						scale: { x: 0.5, y: 0.5, z: 0.5 }
+					}
+				}
+			}
+		});
+
 		// blink the icons for unaffiliated users
 		this.interval = setInterval(() => {
 			if (redIcon.appearance.enabledFor.has('default')) {

packages/sdk/src/user/groupMask.ts

@@ -2,7 +2,7 @@
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License.
  */
-import { Context } from '..';
+import { Context, InvertedGroupMask } from '..';
 
 /**
  * A set of user group IDs. User groups are used to selectively enable several different
@@ -26,7 +26,7 @@ export class GroupMask extends Set<string> implements Iterable<string> {
 	 * @param context An active MRE app context
 	 * @param initialContents A list of group names to be added to this GroupMask
 	 */
-	constructor(private context: Context, initialContents: Iterable<string> = null) {
+	constructor(protected context: Context, initialContents: Iterable<string> = null) {
 		super();
 		if (initialContents) {
 			for (const group of initialContents) {
@@ -48,9 +48,16 @@ export class GroupMask extends Set<string> implements Iterable<string> {
 
 	/** @hidden */
 	public static FromPacked(context: Context, value: number): GroupMask {
-		const group = new GroupMask(context);
-		group.setPacked(value);
-		return group;
+		const largerThanBiggestGroup = Object.keys(context.internal.userGroupMapping).length;
+		if (value >= (1 << largerThanBiggestGroup)) {
+			const igroup = new InvertedGroupMask(context);
+			igroup.setPacked(value);
+			return igroup;
+		} else {
+			const group = new GroupMask(context);
+			group.setPacked(value);
+			return group;
+		}
 	}
 
 	/** @hidden */
@@ -70,7 +77,8 @@ export class GroupMask extends Set<string> implements Iterable<string> {
 		return this.packed();
 	}
 
-	private getOrAddMapping(name: string): number {
+	/** @hidden */
+	protected getOrAddMapping(name: string): number {
 		const mapping = this.context.internal.userGroupMapping;
 		if (!mapping[name]) {
 			const lastIndex = Object.keys(mapping).length;
@@ -89,7 +97,7 @@ export class GroupMask extends Set<string> implements Iterable<string> {
 	 * Observable considerations
 	 */
 
-	private changedCallback: (gm: GroupMask) => void;
+	protected changedCallback: (gm: GroupMask) => void;
 
 	/** @hidden */
 	public onChanged(callback: (gm: GroupMask) => void) {
@@ -189,4 +197,9 @@ export class GroupMask extends Set<string> implements Iterable<string> {
 	public has(item: string) {
 		return super.has(item);
 	}
+
+	/** Convert this from a mask containing only these groups to a mask containing everything but these groups. */
+	public invert() {
+		return new InvertedGroupMask(this.context, this);
+	}
 }

packages/sdk/src/user/index.ts

@@ -4,4 +4,5 @@
  */
 
 export * from './groupMask';
+export * from './invertedGroupMask';
 export * from './user';

packages/sdk/src/user/invertedGroupMask.ts

@@ -0,0 +1,39 @@
+/*!
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { GroupMask } from './groupMask';
+
+/**
+ * A collection of user group IDs. Unlike in [[GroupMask]], users in these groups are **excluded** from this mask
+ * instead of included.
+ */
+export class InvertedGroupMask extends GroupMask {
+	/** @hidden */
+	public packed() {
+		return ~super.packed();
+	}
+
+	/** @hidden */
+	public setPacked(value: number) {
+		super.clear();
+		const mapping = this.context.internal.userGroupMapping;
+
+		if (!this.allowDefault) {
+			value = value & ~this.getOrAddMapping('default');
+		}
+		for (const name of Object.keys(mapping)) {
+			if ((value & this.getOrAddMapping(name)) === 0) {
+				super.add(name);
+			}
+		}
+		if (this.changedCallback) {
+			this.changedCallback(this);
+		}
+	}
+
+	/** Convert this from a mask containing everything but these groups to a mask containing only these groups. */
+	public invert() {
+		return new GroupMask(this.context, this);
+	}
+}