Changeset 25071

Timestamp:

Mar 17, 2021, 6:04:51 PM (3 years ago)

Author:

wraitii

Message:

Implement a Motion Manager around UnitMotion.

This new MotionManager handles movement for UnitMotion components (not UnitMotionFlying).
This is a first step towards unit pushing, by giving a central place for the relevant units to collide.

One important side-effect is that movement is effectively synchronous - the positions are not actually updated until all units have moved for a turn (refs rP24798).

As a side-effect, it's an optimisation: fewer messages are being sent overall, which leads to a slight speedup (negligible without a lot of units though).

This is a first step - ideally, the movement functions called from UnitMotionManager would actually be moved there.

Differential Revision: ​https://code.wildfiregames.com/D3509

Location:

ps/trunk/source/simulation2

Files:

• TypeList.h (modified) (2 diffs)
• components/CCmpUnitMotion.cpp (modified) (12 diffs)
• components/CCmpUnitMotionManager.cpp (added)
• components/ICmpUnitMotion.cpp (modified) (1 diff)
• components/ICmpUnitMotion.h (modified) (2 diffs)
• components/ICmpUnitMotionManager.cpp (added)
• components/ICmpUnitMotionManager.h (added)
• system/ComponentManager.cpp (modified) (1 diff)

ps/trunk/source/simulation2/TypeList.h

@@ -1 @@
-/* Copyright (C) 2020 Wildfire Games.
+/* Copyright (C) 202 Wildfire Games.
  * This file is part of 0 A.D.
  *
@@ -197 +197 @@
 COMPONENT(UnitMotionScripted)
 
+
+
+
 INTERFACE(UnitRenderer)
 COMPONENT(UnitRenderer)

ps/trunk/source/simulation2/components/CCmpUnitMotion.cpp

@@ -120 +120 @@
     static void ClassInit(CComponentManager& componentManager)
     {
-        componentManager.SubscribeToMessageType(MT_TurnStart);
-        componentManager.SubscribeToMessageType(MT_Update_MotionFormation);
-        componentManager.SubscribeToMessageType(MT_Update_MotionUnit);
+        componentManager.SubscribeToMessageType(MT_Create);
+        componentManager.SubscribeToMessageType(MT_Destroy);
         componentManager.SubscribeToMessageType(MT_PathResult);
         componentManager.SubscribeToMessageType(MT_OwnershipChanged);
@@ -207 +206 @@
     WaypointPath m_LongPath;
     WaypointPath m_ShortPath;
-
-    // Hack - units move one-at-a-time, so they may need to interplate their target position.
-    // However, some computations are not doing during the motion messages, and those shouldn't (e.g. turn start).
-    // This is true if and only if the calls take place during handling of the entity's MT_Motion* messages.
-    // NB: this won't be true if we end up in UnitMotion because of another entity's motion messages,
-    // but I think it fixes the issue of interpolating target position OK for current needs,
-    // without having to add parameters everywhere.
-    // No need for serialisation, it's just a transient boolean.
-    bool m_InMotionMessage = false;
 
     static std::string GetSchema()
@@ -322 +312 @@
         switch (msg.GetType())
         {
-        case MT_TurnStart:
-        {
-            TurnStart();
-            break;
-        }
-        case MT_Update_MotionFormation:
-        {
-            if (m_FormationController)
-            {
-                m_InMotionMessage = true;
-                fixed dt = static_cast<const CMessageUpdate_MotionFormation&> (msg).turnLength;
-                Move(dt);
-                m_InMotionMessage = false;
-            }
-            break;
-        }
-        case MT_Update_MotionUnit:
-        {
-            if (!m_FormationController)
-            {
-                m_InMotionMessage = true;
-                fixed dt = static_cast<const CMessageUpdate_MotionUnit&> (msg).turnLength;
-                Move(dt);
-                m_InMotionMessage = false;
-            }
-            break;
-        }
         case MT_RenderSubmit:
         {
@@ -362 +325 @@
             break;
         }
+
+
+
+
+
+
+
+
+
+
+
+
         case MT_ValueModification:
         {
@@ -370 +345 @@
         }
         case MT_OwnershipChanged:
+
+
+
+
         case MT_Deserialized:
         {
-            CmpPtr<ICmpValueModificationManager> cmpValueModificationManager(GetSystemEntity());
-            if (!cmpValueModificationManager)
-                break;
-
-            m_WalkSpeed = cmpValueModificationManager->ApplyModifications(L"UnitMotion/WalkSpeed", m_TemplateWalkSpeed, GetEntityId());
-            m_RunMultiplier = cmpValueModificationManager->ApplyModifications(L"UnitMotion/RunMultiplier", m_TemplateRunMultiplier, GetEntityId());
-
-            // For MT_Deserialize compute m_Speed from the serialized m_SpeedMultiplier.
-            // For MT_ValueModification and MT_OwnershipChanged, adjust m_SpeedMultiplier if needed
-            // (in case then new m_RunMultiplier value is lower than the old).
-            SetSpeedMultiplier(m_SpeedMultiplier);
-
+            OnValueModification();
+            if (!ENTITY_IS_LOCAL(GetEntityId()))
+                CmpPtr<ICmpUnitMotionManager>(GetSystemEntity())->Register(GetEntityId(), m_FormationController);
             break;
         }
@@ -652 +622 @@
     void PathResult(u32 ticket, const WaypointPath& path);
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
     /**
      * Check if we are at destination early in the turn, this both lets units react faster
@@ -657 +642 @@
      * (otherwise they won't be commutative).
      */
-    void TurnStart();
-
-    /**
-     * Do the per-turn movement and other updates.
-     */
-    void Move(fixed dt);
+    virtual void OnTurnStart();
+
+    virtual void PreMove(ICmpUnitMotionManager::MotionState& state);
+
+    virtual void Move(ICmpUnitMotionManager::MotionState& state, fixed dt);
+
+    virtual void PostMove(ICmpUnitMotionManager::MotionState& state, fixed dt);
 
     /**
@@ -909 +895 @@
 }
 
-void CCmpUnitMotion::TurnStart()
+void CCmpUnitMotion::TurnStart()
 {
     if (PossiblyAtDestination())
@@ -927 +913 @@
 }
 
-void CCmpUnitMotion::Move(fixed dt)
+void CCmpUnitMotion::PreMove(ICmpUnitMotionManager::MotionState& state)
+{
+    // If we were idle and will still be, no need for an update.
+    state.needUpdate = m_CurSpeed != fixed::Zero() || m_MoveRequest.m_Type != MoveRequest::NONE;
+}
+
+void CCmpUnitMotion::Move(ICmpUnitMotionManager::MotionState& state, fixed dt)
 {
     PROFILE("Move");
-
-    // If we were idle and will still be, we can return.
-    // TODO: this will need to be removed if pushing is implemented.
-    if (m_CurSpeed == fixed::Zero() && m_MoveRequest.m_Type == MoveRequest::NONE)
-        return;
-
-    CmpPtr<ICmpPosition> cmpPosition(GetEntityHandle());
-    if (!cmpPosition || !cmpPosition->IsInWorld())
-        return;
-
-    CFixedVector2D initialPos = cmpPosition->GetPosition2D();
-    entity_angle_t initialAngle = cmpPosition->GetRotation().Y;
-
-    // Keep track of the current unit's position and rotation during the update.
-    CFixedVector2D pos = initialPos;
-    entity_angle_t angle = initialAngle;
 
     // If we're chasing a potentially-moving unit and are currently close
     // enough to its current position, and we can head in a straight line
-    // to it, then throw away our current path and go straight to it
-    bool wentStraight = TryGoingStraightToTarget(initialPos);
-
-    bool wasObstructed = PerformMove(dt, cmpPosition->GetTurnRate(), m_ShortPath, m_LongPath, pos, angle);
-
+    // to it, then throw away our current path and go straight to it.
+    state.wentStraight = TryGoingStraightToTarget(state.initialPos);
+
+    state.wasObstructed = PerformMove(dt, state.cmpPosition->GetTurnRate(), m_ShortPath, m_LongPath, state.pos, state.angle);
+}
+
+void CCmpUnitMotion::PostMove(ICmpUnitMotionManager::MotionState& state, fixed dt)
+{
     // Update our speed over this turn so that the visual actor shows the correct animation.
-    if (pos == initialPos)
-    {
-        if (angle != initialAngle)
-            cmpPosition->TurnTo(angle);
+    if (initialPos)
+    {
+        if (initialAngle)
+            angle);
         UpdateMovementState(fixed::Zero());
     }
@@ -965 +944 @@
         // Update the Position component after our movement (if we actually moved anywhere)
         // When moving always set the angle in the direction of the movement.
-        CFixedVector2D offset = pos - initialPos;
-        angle = atan2_approx(offset.X, offset.Y);
-        cmpPosition->MoveAndTurnTo(pos.X, pos.Y, angle);
+        CFixedVector2D offset = initialPos;
+        angle = atan2_approx(offset.X, offset.Y);
+        angle);
 
         // Calculate the mean speed over this past turn.
@@ -973 +952 @@
     }
 
-    if (wasObstructed && HandleObstructedMove(pos != initialPos))
+    if (initialPos))
         return;
-    else if (!wasObstructed && pos != initialPos)
+    else if (!initialPos)
         m_FailedMovements = 0;
 
     // We may need to recompute our path sometimes (e.g. if our target moves).
     // Since we request paths asynchronously anyways, this does not need to be done before moving.
-    if (!wentStraight && PathingUpdateNeeded(pos))
+    if (!pos))
     {
         PathGoal goal;
         if (ComputeGoal(goal, m_MoveRequest))
-            ComputePathToGoal(pos, goal);
+            ComputePathToGoal(pos, goal);
     }
     else if (m_FollowKnownImperfectPathCountdown > 0)
@@ -1277 +1256 @@
         // TODO: This does not really aim many turns in advance, with orthogonal trajectories it probably should.
         CmpPtr<ICmpUnitMotion> cmpUnitMotion(GetSimContext(), moveRequest.m_Entity);
-        bool needInterpolation = cmpUnitMotion && cmpUnitMotion->IsMoveRequested() && m_InMotionMessage;
+        CmpPtr<ICmpUnitMotionManager> cmpUnitMotionManager(GetSystemEntity());
+        bool needInterpolation = cmpUnitMotion && cmpUnitMotion->IsMoveRequested() && cmpUnitMotionManager->ComputingMotion();
         if (needInterpolation && GetEntityId() < moveRequest.m_Entity)
         {

ps/trunk/source/simulation2/components/ICmpUnitMotion.cpp

@@ -48 +48 @@
 public:
     DEFAULT_SCRIPT_WRAPPER(UnitMotionScripted)
+
+
+
+
+
+
+
+
 
     virtual bool MoveToPointRange(entity_pos_t x, entity_pos_t z, entity_pos_t minRange, entity_pos_t maxRange)

ps/trunk/source/simulation2/components/ICmpUnitMotion.h

@@ -23 +23 @@
 #include "simulation2/components/ICmpPathfinder.h" // for pass_class_t
 #include "simulation2/components/ICmpPosition.h" // for entity_pos_t
+
+
+
 
 /**
@@ -34 +37 @@
 class ICmpUnitMotion : public IComponent
 {
+
+
+
+
+
+
+
+
+
+
+
 public:
 

ps/trunk/source/simulation2/system/ComponentManager.cpp

@@ -678 +678 @@
     AddComponent(m_SystemEntity, CID_Terrain, noParam);
     AddComponent(m_SystemEntity, CID_TerritoryManager, noParam);
+
     AddComponent(m_SystemEntity, CID_UnitRenderer, noParam);
     AddComponent(m_SystemEntity, CID_WaterManager, noParam);