Doc / name nitpicks for parallelism with Unreal

CHANGES.md

@@ -3,7 +3,8 @@
 ### ? - ?
 
 ##### Additions :tada:
-- `CesiumOriginShift` now allows specifying an activation distance instead of updating the origin every frame.
+
+- Added a `distance` property to `CesiumOriginShift`, which specifies the maximum allowed distance from the current origin before it is shifted.
 
 ### v1.7.1 - 2023-12-14
 

Runtime/CesiumOriginShift.cs

@@ -30,17 +30,28 @@ namespace CesiumForUnity
     public class CesiumOriginShift : MonoBehaviour
     {
         /// <summary>
-        /// Specifies the minimum distance in meters from the old origin to the current origin before the 
-        /// origin of the parent <see cref="CesiumGeoreference"/> will be shifted.
+        /// The maximum distance between the origin of the Unity coordinate system and
+        /// the game object to which this component is attached. When this distance is
+        /// exceeded, the <see cref="CesiumGeoreference"/> origin is shifted to bring it
+        /// close to the game object.
         /// </summary>
-        public double activationDistance
+        /// <remarks>
+        /// When the value of this property is 0.0, the origin is shifted continuously.
+        /// </remarks>
+        public double distance
         {
-            get => _activationDistance;
-            set => _activationDistance = value;
+            get => _distance;
+            set => _distance = value;
         }
 
         [SerializeField]
-        private double _activationDistance = 0.0;
+        [Min(0)]
+        [Tooltip("The maximum distance between the origin of the Unity coordinate system and " +
+                 "the game object to which this component is attached. When this distance is" +
+                 "exceeded, the CesiumGeoreference origin is shifted to bring it close to the " +
+                 "game object.\n\n" +
+                 "When the value of this property is 0.0, the origin is shifted continuously.")]
+        private double _distance = 0.0;
 
         void LateUpdate()
         {
@@ -112,7 +123,7 @@ private void UpdateFromEcef(CesiumGeoreference georeference, double3 ecef)
 
                 double distance = math.length(new double3(georeference.ecefX, georeference.ecefY, georeference.ecefZ) - ecef);
 
-                if (distance >= this._activationDistance)
+                if (distance >= this._distance)
                 {
                     // Update the origin if we've surpassed the distance threshold.
                     georeference.SetOriginEarthCenteredEarthFixed(ecef.x, ecef.y, ecef.z);

Tests/TestCesiumOriginShift.cs

@@ -100,7 +100,7 @@ public IEnumerator UsesGeoreferenceTransformForActivationCheck()
     }
 
     [UnityTest]
-    public IEnumerator UsesActivationDistanceProperty()
+    public IEnumerator UsesDistanceProperty()
     {
         double3 baseEcef = new double3(-2694019.41, -4297353.83809221, 3854717.9087824);
 
@@ -115,7 +115,7 @@ public IEnumerator UsesActivationDistanceProperty()
         CesiumGlobeAnchor globeAnchor = goOriginShift.AddComponent<CesiumGlobeAnchor>();
 
         CesiumOriginShift originShift = goOriginShift.AddComponent<CesiumOriginShift>();
-        originShift.activationDistance = 5000;
+        originShift.distance = 5000;
 
         yield return null;
 
@@ -154,7 +154,7 @@ public IEnumerator ShiftsOriginWithCharacterController()
         CesiumGlobeAnchor globeAnchor = goOriginShift.AddComponent<CesiumGlobeAnchor>();
 
         CesiumOriginShift originShift = goOriginShift.AddComponent<CesiumOriginShift>();
-        originShift.activationDistance = 5000;
+        originShift.distance = 5000;
 
         CharacterController controller = goOriginShift.AddComponent<CharacterController>();
         controller.radius = 1.0f;