feat: sdk other players transform propagation

Explorer/Assets/DCL/AvatarRendering/AvatarShape/UnityInterface/AvatarBase.cs

@@ -101,6 +101,9 @@ private void Awake()
             overrideController.ApplyOverrides(animationOverrides);
         }
 
+        public Vector3 Position => transform.position;
+        public Quaternion Rotation => transform.rotation;
+
         public Transform GetTransform() =>
             transform;
 
@@ -152,6 +155,10 @@ public void ReplaceEmoteAnimation(AnimationClip animationClip)
 
     public interface IAvatarView
     {
+        Vector3 Position { get; }
+
+        Quaternion Rotation { get; }
+
         Transform GetTransform();
 
         void SetAnimatorFloat(int hash, float value);
@@ -173,5 +180,62 @@ public interface IAvatarView
         int GetAnimatorCurrentStateTag();
 
         void ResetTrigger(int hash);
+
+        class Fake : IAvatarView
+        {
+            public Vector3 Position { get; }
+            public Quaternion Rotation { get; }
+
+            public Fake(Vector3 position, Quaternion rotation)
+            {
+                Position = position;
+                Rotation = rotation;
+            }
+
+            public Transform GetTransform() =>
+                throw new NotImplementedException();
+
+            public void SetAnimatorFloat(int hash, float value)
+            {
+                throw new NotImplementedException();
+            }
+
+            public void SetAnimatorInt(int hash, int value)
+            {
+                throw new NotImplementedException();
+            }
+
+            public void SetAnimatorTrigger(int hash)
+            {
+                throw new NotImplementedException();
+            }
+
+            public void SetAnimatorBool(int hash, bool value)
+            {
+                throw new NotImplementedException();
+            }
+
+            public bool GetAnimatorBool(int hash) =>
+                throw new NotImplementedException();
+
+            public void ReplaceEmoteAnimation(AnimationClip animationClip)
+            {
+                throw new NotImplementedException();
+            }
+
+            public float GetAnimatorFloat(int hash) =>
+                throw new NotImplementedException();
+
+            public bool IsAnimatorInTag(int hashTag) =>
+                throw new NotImplementedException();
+
+            public int GetAnimatorCurrentStateTag() =>
+                throw new NotImplementedException();
+
+            public void ResetTrigger(int hash)
+            {
+                throw new NotImplementedException();
+            }
+        }
     }
 }

Explorer/Assets/DCL/Character/CharacterMotion/Systems/WritePlayerTransformSystem.cs → Explorer/Assets/DCL/Character/CharacterMotion/Systems/WriteMainPlayerTransformSystem.cs

@@ -19,7 +19,7 @@ namespace DCL.CharacterMotion.Systems
     ///     Executes on the scene level to propagate the shared transform data to the SDK Scene
     /// </summary>
     [UpdateInGroup(typeof(SyncedInitializationSystemGroup))]
-    public partial class WritePlayerTransformSystem : BaseUnityLoopSystem
+    public partial class WriteMainPlayerTransformSystem : BaseUnityLoopSystem
     {
         private readonly IECSToCRDTWriter ecsToCrdtWriter;
         private readonly ISceneData sceneData;
@@ -29,7 +29,7 @@ public partial class WritePlayerTransformSystem : BaseUnityLoopSystem
         private IComponentPool<SDKTransform> sdkTransformPool;
         private readonly Entity playerEntity;
 
-        internal WritePlayerTransformSystem(World world, IECSToCRDTWriter ecsToCrdtWriter, ISceneData sceneData, IExposedTransform exposedTransform, IPartitionComponent scenePartition,
+        internal WriteMainPlayerTransformSystem(World world, IECSToCRDTWriter ecsToCrdtWriter, ISceneData sceneData, IExposedTransform exposedTransform, IPartitionComponent scenePartition,
             byte bucketThreshold, IComponentPool<SDKTransform> sdkTransformPool, Entity playerEntity) : base(world)
         {
             this.ecsToCrdtWriter = ecsToCrdtWriter;

Explorer/Assets/DCL/Character/Plugin/CharacterContainer.cs

@@ -119,7 +119,7 @@ public WorldPlugin(ExposedTransform exposedTransform, IExposedCameraData exposed
 
             public void InjectToWorld(ref ArchSystemsWorldBuilder<World> builder, in ECSWorldInstanceSharedDependencies sharedDependencies, in PersistentEntities persistentEntities, List<IFinalizeWorldSystem> finalizeWorldSystems, List<ISceneIsCurrentListener> sceneIsCurrentListeners)
             {
-                WritePlayerTransformSystem.InjectToWorld(ref builder, sharedDependencies.EcsToCRDTWriter, sharedDependencies.SceneData,
+                WriteMainPlayerTransformSystem.InjectToWorld(ref builder, sharedDependencies.EcsToCRDTWriter, sharedDependencies.SceneData,
                     exposedTransform, sharedDependencies.ScenePartition, bucketPropagationLimit, sdkTransformPool, persistentEntities.Player);
 
                 WriteCameraComponentsSystem.InjectToWorld(ref builder, sharedDependencies.EcsToCRDTWriter, exposedCameraData, sharedDependencies.SceneData,

Explorer/Assets/DCL/Multiplayer/SDK/Systems/GlobalWorld/PlayerProfileDataPropagationSystem.cs

@@ -28,20 +28,20 @@ protected override void Update(float t)
 
         [Query]
         [None(typeof(DeleteEntityIntention))]
-        private void PropagateProfileToScene(Profile profile, PlayerCRDTEntity playerCRDTEntity)
+        private void PropagateProfileToScene(ref Profile profile, ref PlayerCRDTEntity playerCRDTEntity)
         {
             if (playerCRDTEntity.IsDirty)
             {
-                SetSceneProfile(profile, playerCRDTEntity);
+                PropagateComponent(ref profile, ref playerCRDTEntity);
                 return;
             }
 
             if (!profile.IsDirty) return;
 
-            SetSceneProfile(profile, playerCRDTEntity);
+            PropagateComponent(ref profile, ref playerCRDTEntity);
         }
 
-        private void SetSceneProfile(Profile profile, PlayerCRDTEntity playerCRDTEntity)
+        private void PropagateComponent(ref Profile profile, ref PlayerCRDTEntity playerCRDTEntity)
         {
             SceneEcsExecutor sceneEcsExecutor = playerCRDTEntity.SceneFacade.EcsExecutor;
 

Explorer/Assets/DCL/Multiplayer/SDK/Systems/GlobalWorld/PlayerTransformPropagationSystem.cs

@@ -0,0 +1,52 @@
+using Arch.Core;
+using Arch.System;
+using Arch.SystemGroups;
+using CrdtEcsBridge.Components;
+using CrdtEcsBridge.Components.Transform;
+using DCL.AvatarRendering.AvatarShape.UnityInterface;
+using DCL.Diagnostics;
+using DCL.Multiplayer.SDK.Components;
+using ECS.Abstract;
+using ECS.Groups;
+using ECS.LifeCycle.Components;
+
+namespace DCL.Multiplayer.SDK.Systems.GlobalWorld
+{
+    [UpdateInGroup(typeof(SyncedPreRenderingSystemGroup))]
+    [LogCategory(ReportCategory.MULTIPLAYER_SDK_PLAYER_TRANSFORM_DATA)]
+    public partial class PlayerTransformPropagationSystem : BaseUnityLoopSystem
+    {
+        public PlayerTransformPropagationSystem(World world) : base(world) { }
+
+        protected override void Update(float t)
+        {
+            PropagateTransformToSceneQuery(World!);
+        }
+
+        [Query]
+        [None(typeof(DeleteEntityIntention))]
+        private void PropagateTransformToScene(ref IAvatarView avatarView, ref PlayerCRDTEntity playerCRDTEntity)
+        {
+            // Main player Transform is handled by 'WriteMainPlayerTransformSystem'
+            if (playerCRDTEntity.CRDTEntity.Id == SpecialEntitiesID.PLAYER_ENTITY) return;
+
+            PropagateComponent(ref avatarView, ref playerCRDTEntity);
+        }
+
+        private static void PropagateComponent(ref IAvatarView avatarBase, ref PlayerCRDTEntity playerCRDTEntity)
+        {
+            World sceneEcsWorld = playerCRDTEntity.SceneFacade.EcsExecutor.World;
+
+            var sdkTransform = new SDKTransform
+            {
+                Position = avatarBase.Position, // updated to scene-relative on the writer system
+                Rotation = avatarBase.Rotation,
+            };
+
+            if (sceneEcsWorld.Has<SDKTransform>(playerCRDTEntity.SceneWorldEntity))
+                sceneEcsWorld.Set(playerCRDTEntity.SceneWorldEntity, sdkTransform);
+            else
+                sceneEcsWorld.Add(playerCRDTEntity.SceneWorldEntity, sdkTransform);
+        }
+    }
+}

Explorer/Assets/DCL/Multiplayer/SDK/Systems/SceneWorld/WritePlayerTransformSystem.cs

@@ -0,0 +1,61 @@
+using Arch.Core;
+using Arch.System;
+using Arch.SystemGroups;
+using CrdtEcsBridge.Components;
+using CrdtEcsBridge.Components.Transform;
+using CrdtEcsBridge.ECSToCRDTWriter;
+using DCL.Multiplayer.SDK.Components;
+using ECS.Abstract;
+using ECS.Groups;
+using ECS.LifeCycle.Components;
+using ECS.Prioritization.Components;
+using SceneRunner.Scene;
+using Utility;
+
+namespace DCL.Multiplayer.SDK.Systems.SceneWorld
+{
+    [UpdateInGroup(typeof(SyncedPreRenderingSystemGroup))]
+    // [UpdateBefore(typeof(CleanUpGroup))]
+    // [LogCategory(ReportCategory.PLAYER_AVATAR_BASE)]
+    public partial class WritePlayerTransformSystem : BaseUnityLoopSystem
+    {
+        private readonly IECSToCRDTWriter ecsToCRDTWriter;
+        private readonly ISceneData sceneData;
+
+        public WritePlayerTransformSystem(World world, IECSToCRDTWriter ecsToCRDTWriter, ISceneData sceneData) : base(world)
+        {
+            this.ecsToCRDTWriter = ecsToCRDTWriter;
+            this.sceneData = sceneData;
+        }
+
+        protected override void Update(float t)
+        {
+            HandleComponentRemovalQuery(World);
+            UpdateSDKTransformQuery(World);
+        }
+
+        [Query]
+        [None(typeof(DeleteEntityIntention))]
+        private void UpdateSDKTransform(ref PlayerCRDTEntity playerCRDTEntity, ref SDKTransform sdkTransform)
+        {
+            // Main player Transform is handled by 'WriteMainPlayerTransformSystem'
+            if (playerCRDTEntity.CRDTEntity.Id == SpecialEntitiesID.PLAYER_ENTITY) return;
+
+            // Patch position to be scene-relative
+            sdkTransform.Position = ParcelMathHelper.GetSceneRelativePosition(sdkTransform.Position, sceneData.Geometry.BaseParcelPosition);
+
+            ecsToCRDTWriter.PutMessage<SDKTransform, SDKTransform>(static (pbComponent, transform) =>
+            {
+                pbComponent.Position = transform.Position;
+                pbComponent.Rotation = transform.Rotation;
+            }, playerCRDTEntity.CRDTEntity, sdkTransform);
+        }
+
+        [Query]
+        [All(typeof(DeleteEntityIntention))]
+        private void HandleComponentRemoval(ref PlayerCRDTEntity playerCRDTEntity)
+        {
+            ecsToCRDTWriter.DeleteMessage<SDKTransform>(playerCRDTEntity.CRDTEntity);
+        }
+    }
+}

Explorer/Assets/DCL/Multiplayer/SDK/Tests/PropagateTransformTest.cs

@@ -0,0 +1,109 @@
+#nullable enable
+
+using Arch.Core;
+using CRDT;
+using CrdtEcsBridge.Components.Transform;
+using CrdtEcsBridge.ECSToCRDTWriter;
+using DCL.AvatarRendering.AvatarShape.UnityInterface;
+using DCL.Diagnostics;
+using DCL.Multiplayer.SDK.Components;
+using DCL.Multiplayer.SDK.Systems.GlobalWorld;
+using DCL.Multiplayer.SDK.Systems.SceneWorld;
+using Google.Protobuf;
+using NUnit.Framework;
+using SceneRunner.Scene;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using UnityEngine;
+
+namespace DCL.Multiplayer.SDK.Tests
+{
+    public class PropagateTransformTest
+    {
+        [Test]
+        public void PropagateTransform()
+        {
+            const int CRDT_ID = 100;
+
+            var world = World.Create();
+            var ecsWorld = World.Create();
+
+            var writer = new FakeECSToCRDTWriter();
+            var sceneData = new ISceneData.Fake();
+
+            var propagationSystem = new PlayerTransformPropagationSystem(world);
+            var writeSystem = new WritePlayerTransformSystem(ecsWorld, writer, sceneData);
+
+            var sceneWorldEntity = ecsWorld.Create();
+
+            var playerCRDTEntity = new PlayerCRDTEntity(
+                new CRDTEntity(CRDT_ID),
+                new ISceneFacade.Fake(
+                    new SceneShortInfo(Vector2Int.zero, string.Empty),
+                    new SceneStateProvider(),
+                    new SceneEcsExecutor(ecsWorld),
+                    false
+                ),
+                sceneWorldEntity
+            );
+
+            world.Create(
+                new IAvatarView.Fake(Vector3.zero, Quaternion.identity) as IAvatarView,
+                playerCRDTEntity
+            );
+
+            ecsWorld.Add(sceneWorldEntity, playerCRDTEntity);
+
+            propagationSystem.Update(0);
+            writeSystem.Update(0);
+
+
+            Assert.AreEqual(1, writer.Messages.Count);
+
+            var message = writer.Messages.First();
+
+            Assert.AreEqual(typeof(SDKTransform), message.MessageType);
+            Assert.AreEqual(typeof(SDKTransform), message.Data.GetType());
+            Assert.AreEqual(CRDT_ID, message.Entity.Id);
+        }
+
+        private class FakeECSToCRDTWriter : IECSToCRDTWriter
+        {
+            public readonly struct Message
+            {
+                public readonly CRDTEntity Entity;
+                public readonly Type MessageType;
+                public readonly object Data;
+
+                public Message(CRDTEntity entity, Type messageType, object data)
+                {
+                    Entity = entity;
+                    MessageType = messageType;
+                    Data = data;
+                }
+            }
+
+            public readonly List<Message> Messages = new ();
+
+            public TMessage PutMessage<TMessage, TData>(Action<TMessage, TData> prepareMessage, CRDTEntity entity, TData data) where TMessage: class, IMessage
+            {
+                Messages.Add(new Message(entity, typeof(TMessage), data));
+                return null;
+            }
+
+            public void PutMessage<TMessage>(TMessage message, CRDTEntity entity) where TMessage: class, IMessage
+            {
+                throw new NotImplementedException();
+            }
+
+            public TMessage AppendMessage<TMessage, TData>(Action<TMessage, TData> prepareMessage, CRDTEntity entity, int timestamp, TData data) where TMessage: class, IMessage =>
+                throw new NotImplementedException();
+
+            public void DeleteMessage<T>(CRDTEntity crdtID) where T: class, IMessage
+            {
+                throw new NotImplementedException();
+            }
+        }
+    }
+}

Explorer/Assets/DCL/PerformanceAndDiagnostics/Diagnostics/ReportsHandling/ReportCategory.cs

@@ -218,6 +218,11 @@ public static class ReportCategory
         /// </summary>
         public const string MULTIPLAYER_SDK_EMOTE_COMMAND_DATA = nameof(MULTIPLAYER_SDK_EMOTE_COMMAND_DATA);
 
+        /// <summary>
+        ///     Multiplayer SDK other players Transform component propagator
+        /// </summary>
+        public const string MULTIPLAYER_SDK_PLAYER_TRANSFORM_DATA = nameof(MULTIPLAYER_SDK_PLAYER_TRANSFORM_DATA);
+
         /// <summary>
         ///     PBPlayerIdentityData component writer
         /// </summary>