QBI Helper v1 (#654)

Author: paulbalaji

CHANGELOG.md

@@ -10,6 +10,10 @@
 
 - Added a static helper in the `EntityTemplate` class to construct worker access attributes.
 - Added an optional callback as an argument to the `RequestPlayerCreation` method in `SendCreatePlayerRequestSystem`. This callback is invoked upon receiving a response to a player creation request.
+- Added a new Query-based interest helper module, `com.improbable.gdk.querybasedinteresthelper`.
+    - `InterestTemplate` provides functionality to ergonomically add, replace and clear queries from an Interest component.
+    - `InterestQuery` reduces boilerplate code required to construct interest queries.
+    - `Constraint` contains static methods to easily create constraints for an interest query.
 
 ### Changed
 

test-project/Assets/EditmodeTests/Improbable.Gdk.EditModeTests.asmdef

@@ -1,6 +1,7 @@
 {
     "name": "Improbable.Gdk.EditModeTests",
     "references": [
+        "Improbable.Gdk.QueryBasedInterestHelper",
         "Improbable.Gdk.Generated",
         "Improbable.Gdk.Core",
         "Unity.Entities",

test-project/Assets/EditmodeTests/Utility/ConstraintTests.cs

@@ -0,0 +1,172 @@
+using System;
+using System.Collections.Generic;
+using Improbable.Gdk.Core;
+using Improbable.Gdk.QueryBasedInterest;
+using NUnit.Framework;
+
+namespace Improbable.Gdk.EditmodeTests.Utility
+{
+    [TestFixture]
+    public class ConstraintTests
+    {
+        private const double Distance = 10;
+
+        private static Constraint BasicConstraint => Constraint.Component<Position.Component>();
+
+        [Test]
+        public void All_constraint_throws_if_enumerable_empty()
+        {
+            Assert.Throws<ArgumentException>(() => Constraint.All(new List<Constraint>()));
+        }
+
+        [Test]
+        public void Any_constraint_throws_if_enumerable_empty()
+        {
+            Assert.Throws<ArgumentException>(() => Constraint.Any(new List<Constraint>()));
+        }
+
+        [Test]
+        public void All_constraint_param_sets_OrConstraint_to_empty_list()
+        {
+            var constraint = Constraint.All(BasicConstraint);
+            Assert.AreEqual(constraint.AsQueryConstraint().AndConstraint.Count, 1);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().OrConstraint.Count);
+        }
+
+        [Test]
+        public void All_constraint_params_sets_OrConstraint_to_empty_list()
+        {
+            var constraint = Constraint.All(BasicConstraint, BasicConstraint, BasicConstraint);
+            Assert.AreEqual(constraint.AsQueryConstraint().AndConstraint.Count, 3);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().OrConstraint.Count);
+        }
+
+        [Test]
+        public void All_constraint_enumerable_sets_OrConstraint_to_empty_list()
+        {
+            var constraint = Constraint.All(new List<Constraint> { BasicConstraint });
+            Assert.AreEqual(constraint.AsQueryConstraint().AndConstraint.Count, 1);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().OrConstraint.Count);
+        }
+
+        [Test]
+        public void Any_constraint_param_sets_AndConstraint_to_empty_list()
+        {
+            var constraint = Constraint.Any(BasicConstraint);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().AndConstraint.Count);
+            Assert.AreEqual(constraint.AsQueryConstraint().OrConstraint.Count, 1);
+        }
+
+        [Test]
+        public void Any_constraint_params_sets_AndConstraint_to_empty_list()
+        {
+            var constraint = Constraint.Any(BasicConstraint, BasicConstraint, BasicConstraint);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().AndConstraint.Count);
+            Assert.AreEqual(constraint.AsQueryConstraint().OrConstraint.Count, 3);
+        }
+
+        [Test]
+        public void Any_constraint_enumerable_sets_AndConstraint_to_empty_list()
+        {
+            var constraint = Constraint.Any(new List<Constraint> { BasicConstraint });
+            Assert.AreEqual(0, constraint.AsQueryConstraint().AndConstraint.Count);
+            Assert.AreEqual(constraint.AsQueryConstraint().OrConstraint.Count, 1);
+        }
+
+        [Test]
+        public void Sphere_constraint_sets_AndOr_constraints_to_empty_list()
+        {
+            var constraint = Constraint.Sphere(Distance, Coordinates.Zero);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().AndConstraint.Count);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().OrConstraint.Count);
+        }
+
+        [Test]
+        public void Sphere_constraint_xyz_sets_AndOr_constraints_to_empty_list()
+        {
+            var constraint = Constraint.Sphere(Distance, 0, 0, 0);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().AndConstraint.Count);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().OrConstraint.Count);
+        }
+
+        [Test]
+        public void Cylinder_constraint_sets_AndOr_constraints_to_empty_list()
+        {
+            var constraint = Constraint.Cylinder(Distance, Coordinates.Zero);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().AndConstraint.Count);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().OrConstraint.Count);
+        }
+
+        [Test]
+        public void Cylinder_constraint_xyz_sets_AndOr_constraints_to_empty_list()
+        {
+            var constraint = Constraint.Cylinder(Distance, 0, 0, 0);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().AndConstraint.Count);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().OrConstraint.Count);
+        }
+
+        [Test]
+        public void Box_constraint_sets_AndOr_constraints_to_empty_list()
+        {
+            var constraint = Constraint.Box(Distance, Distance, Distance, Coordinates.Zero);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().AndConstraint.Count);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().OrConstraint.Count);
+        }
+
+        [Test]
+        public void Box_constraint__xyz_sets_AndOr_constraints_to_empty_list()
+        {
+            var constraint = Constraint.Box(Distance, Distance, Distance, 0, 0, 0);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().AndConstraint.Count);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().OrConstraint.Count);
+        }
+
+        [Test]
+        public void RelativeSphere_constraint_sets_AndOr_constraints_to_empty_list()
+        {
+            var constraint = Constraint.RelativeSphere(Distance);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().AndConstraint.Count);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().OrConstraint.Count);
+        }
+
+        [Test]
+        public void RelativeCylinder_constraint_sets_AndOr_constraints_to_empty_list()
+        {
+            var constraint = Constraint.RelativeCylinder(Distance);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().AndConstraint.Count);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().OrConstraint.Count);
+        }
+
+        [Test]
+        public void RelativeBox_constraint_sets_AndOr_constraints_to_empty_list()
+        {
+            var constraint = Constraint.RelativeBox(Distance, Distance, Distance);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().AndConstraint.Count);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().OrConstraint.Count);
+        }
+
+        [Test]
+        public void EntityId_constraint_sets_AndOr_constraints_to_empty_list()
+        {
+            var constraint = Constraint.EntityId(new EntityId(10));
+            Assert.AreEqual(0, constraint.AsQueryConstraint().AndConstraint.Count);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().OrConstraint.Count);
+        }
+
+        [Test]
+        public void Component_constraint_sets_AndOr_constraints_to_empty_list()
+        {
+            var constraint = Constraint.Component(Position.ComponentId);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().AndConstraint.Count);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().OrConstraint.Count);
+        }
+
+        [Test]
+        public void Component_T_constraint_sets_AndOr_constraints_to_empty_list()
+        {
+            var constraint = Constraint.Component<Position.Component>();
+            Assert.AreEqual(0, constraint.AsQueryConstraint().AndConstraint.Count);
+            Assert.AreEqual(0, constraint.AsQueryConstraint().OrConstraint.Count);
+        }
+    }
+}

test-project/Assets/EditmodeTests/Utility/ConstraintTests.cs.meta

@@ -0,0 +1,39 @@
+using Improbable.Gdk.QueryBasedInterest;
+using NUnit.Framework;
+
+namespace Improbable.Gdk.EditmodeTests.Utility
+{
+    [TestFixture]
+    public class InterestQueryTests
+    {
+        private static InterestQuery BasicQuery => InterestQuery.Query(Constraint.Component(Position.ComponentId));
+
+        [Test]
+        public void Query_sets_FullSnapshotResult_to_true()
+        {
+            InterestQuery query = BasicQuery;
+            Assert.True(query.AsComponentInterestQuery().FullSnapshotResult);
+        }
+
+        [Test]
+        public void Query_sets_ResultComponentId_to_empty_list()
+        {
+            InterestQuery query = BasicQuery;
+            Assert.AreEqual(0, query.AsComponentInterestQuery().ResultComponentId.Count);
+        }
+
+        [Test]
+        public void Frequency_null_if_MaxFrequencyHz_never_called()
+        {
+            InterestQuery query = BasicQuery;
+            Assert.IsNull(query.AsComponentInterestQuery().Frequency);
+        }
+
+        [Test]
+        public void Filter_with_components_implies_FullSnapshotResult_is_null()
+        {
+            var query = BasicQuery.FilterResults(Position.ComponentId);
+            Assert.IsNull(query.AsComponentInterestQuery().FullSnapshotResult);
+        }
+    }
+}