[ROS2] Add helper IsAutonomousOrNonMultiplayer

Added a new function "IsAutonomousOrNonMultiplayer" to the
"ROS2GemUtilities" to help components determine if they are attached
to an entity that is Networked.
This is preliminary work to allow components to be activated
selectively in the future, avoiding duplicated work for the ROS2
multiplayer architecture.

Signed-off-by: Lars Gleim <[email protected]>

Author: lgleim

Gems/ROS2/Code/CMakeLists.txt

@@ -38,11 +38,15 @@ ly_add_target(
         PUBLIC
             AZ::AzCore
             AZ::AzFramework
+            # AZ::AzNetworking
             Gem::Atom_RPI.Public
             Gem::Atom_Feature_Common.Static
             Gem::Atom_Component_DebugCamera.Static
             Gem::StartingPointInput
+            Gem::Multiplayer
             Gem::PhysX.Static
+        PRIVATE
+            Gem::Multiplayer.Unified.Static
 )
 
 target_depends_on_ros2_packages(${gem_name}.Static rclcpp builtin_interfaces std_msgs sensor_msgs nav_msgs tf2_ros ackermann_msgs gazebo_msgs)
@@ -71,6 +75,7 @@ ly_add_target(
             Source
     BUILD_DEPENDENCIES
         PRIVATE
+            Gem::Multiplayer.Unified.Static
             Gem::${gem_name}.Static
             Gem::Atom_Feature_Common.Static
 )

Gems/ROS2/Code/Include/ROS2/ROS2GemUtilities.h

@@ -9,9 +9,12 @@
 
 #include <AzCore/Component/ComponentBus.h>
 #include <AzCore/Component/Entity.h>
+#include <AzFramework/Components/TransformComponent.h>
 #ifdef ROS2_EDITOR
 #include <AzToolsFramework/ToolsComponents/GenericComponentWrapper.h>
 #endif
+#include <Multiplayer/Components/NetBindComponent.h>
+
 namespace ROS2
 {
     namespace Utils
@@ -43,5 +46,13 @@ namespace ROS2
             return component;
         }
 
+        /// Checks if the entity or an ancestor is a multiplayer entity (i.e. has the NetBindComponent).
+        /// If yes, 
+        /// @param entity 
+        /// @return 
+        Multiplayer::NetBindComponent* GetEntityOrAncestorNetBind(const AZ::Entity* entity);
+
+        bool IsAutonomousOrNonMultiplayer(const AZ::Entity* entity);
+
     } // namespace Utils
 } // namespace ROS2

Gems/ROS2/Code/Source/ROS2GemUtilities.cpp

@@ -38,4 +38,40 @@ namespace ROS2
         return AZ::InvalidComponentId;
     }
 
+    Multiplayer::NetBindComponent* Utils::GetEntityOrAncestorNetBind(const AZ::Entity* entity)
+        {
+            if(auto* component = GetGameOrEditorComponent<Multiplayer::NetBindComponent>(entity))
+            {
+                return component; // Found it!
+            }
+
+            // Entity has no NetBindComponent. Let's check its ancestor
+            auto* entityTransformInterface = GetGameOrEditorComponent<AzFramework::TransformComponent>(entity);
+            if (!entityTransformInterface)
+            {
+                AZ_Error("GetEntityOrAncestorNetBind", false, "Invalid transform interface!");
+                return nullptr;
+            }
+
+            AZ::EntityId parentEntityId = entityTransformInterface->GetParentId();
+            if (!parentEntityId.IsValid())
+            { // We have reached the top level, there is no parent entity
+                return nullptr;
+            }
+
+            AZ::Entity* parentEntity = nullptr;
+            AZ::ComponentApplicationBus::BroadcastResult(parentEntity, &AZ::ComponentApplicationRequests::FindEntity, parentEntityId);
+            AZ_Assert(parentEntity, "No parent entity id : %s", parentEntityId.ToString().c_str());
+
+            return GetEntityOrAncestorNetBind(parentEntity);
+        }
+
+        bool Utils::IsAutonomousOrNonMultiplayer(const AZ::Entity* entity) {
+            if(Multiplayer::NetBindComponent* nbc = GetEntityOrAncestorNetBind(entity))
+            {
+                return nbc->IsNetEntityRoleAutonomous();
+            }
+            return true; // Non-multiplayer: No NetBindComponent, so no multiplayer entity in the hierarchy           
+        }
+
 } // namespace ROS2