Wc/snap to terrain - CsvSpawner: Make "snap to terrain" based on collision layer. (#74)

w-czerski · michalpelka · patrykantosz · web-flow · commit 2624b33126b4 · 2024-11-12T13:55:22.000+01:00
CsvSpawner snap to object based on a collision layer

---------

Signed-off-by: Michał Pełka &lt;michal.pelka@robotec.ai&gt;
Signed-off-by: Wojciech Czerski &lt;wojciech.czerski@robotec.ai&gt;
Signed-off-by: Patryk Antosz &lt;patryk.antosz@robotec.ai&gt;
Co-authored-by: Michał Pełka &lt;michal.pelka@robotec.ai&gt;
Co-authored-by: Patryk Antosz &lt;patryk.antosz@robotec.ai&gt;
diff --git a/Gems/CsvSpawner/Code/Source/CsvSpawner/CsvSpawnerComponent.cpp b/Gems/CsvSpawner/Code/Source/CsvSpawner/CsvSpawnerComponent.cpp
@@ -47,14 +47,19 @@ namespace CsvSpawner
         AZ::TickBus ::Handler::BusDisconnect();
     }
 
+    int CsvSpawnerComponent::GetTickOrder()
+    {
+        return AZ::TICK_LAST;
+    }
+
     void CsvSpawnerComponent::Activate()
     {
-        AZ::TickBus ::Handler::BusConnect();
+        AZ::TickBus::Handler::BusConnect();
     }
 
     void CsvSpawnerComponent::Deactivate()
     {
-        AZ::TickBus ::Handler::BusDisconnect();
+        AZ::TickBus::Handler::BusDisconnect();
     }
 
 } // namespace CsvSpawner
diff --git a/Gems/CsvSpawner/Code/Source/CsvSpawner/CsvSpawnerComponent.h b/Gems/CsvSpawner/Code/Source/CsvSpawner/CsvSpawnerComponent.h
@@ -48,6 +48,7 @@ namespace CsvSpawner
     private:
         // AZ::TickBus::Handler overrides
         void OnTick(float deltaTime, AZ::ScriptTimePoint time) override;
+        int GetTickOrder() override;
 
         AZStd::unordered_map<AZStd::string, CsvSpawnableAssetConfiguration> m_spawnableAssetConfigurations; //!< List of assets to spawn
         AZStd::vector<CsvSpawnableEntityInfo> m_spawnableEntityInfo; //!< List of entities to spawn
diff --git a/Gems/CsvSpawner/Code/Source/CsvSpawner/CsvSpawnerEditorComponent.cpp b/Gems/CsvSpawner/Code/Source/CsvSpawner/CsvSpawnerEditorComponent.cpp
@@ -13,12 +13,14 @@
 #include "CsvSpawnerComponent.h"
 #include "CsvSpawnerCsvParser.h"
 #include "CsvSpawnerUtils.h"
+
 #include <AzCore/Component/TransformBus.h>
 #include <AzCore/IO/Path/Path.h>
 #include <AzCore/Serialization/EditContext.h>
 #include <AzFramework/Physics/Common/PhysicsTypes.h>
 #include <AzToolsFramework/API/EditorAssetSystemAPI.h>
 #include <AzToolsFramework/Viewport/ViewportMessages.h>
+#include <thread>
 
 namespace CsvSpawner
 {
@@ -83,18 +85,15 @@ namespace CsvSpawner
             AzFramework::ViewportDebugDisplayEventBus::Handler::BusConnect(AzToolsFramework::GetEntityContextId());
         }
 
-        AZ::TickBus::QueueFunction(
-            [this]()
-            {
-                SpawnEntities();
-            });
+        AZ::TickBus::Handler::BusConnect();
     }
 
     void CsvSpawnerEditorComponent::Deactivate()
     {
         m_spawnedTickets.clear();
 
         AzFramework::ViewportDebugDisplayEventBus::Handler::BusDisconnect();
+        AZ::TickBus::Handler::BusDisconnect();
         AzToolsFramework::Components::EditorComponentBase::Deactivate();
     }
 
@@ -122,6 +121,23 @@ namespace CsvSpawner
         m_spawnedTickets.clear();
     }
 
+    void CsvSpawnerEditorComponent::OnTick(float deltaTime, AZ::ScriptTimePoint time)
+    {
+        ++m_frameCounter;
+
+        if (m_frameCounter == 2)
+        {
+            SpawnEntities();
+            AZ::TickBus::Handler::BusDisconnect();
+            m_frameCounter = 0;
+        }
+    }
+
+    int CsvSpawnerEditorComponent::GetTickOrder()
+    {
+        return AZ::TICK_LAST;
+    }
+
     void CsvSpawnerEditorComponent::SpawnEntities()
     {
         if (m_csvAssetId.IsValid() == false)
diff --git a/Gems/CsvSpawner/Code/Source/CsvSpawner/CsvSpawnerEditorComponent.h b/Gems/CsvSpawner/Code/Source/CsvSpawner/CsvSpawnerEditorComponent.h
@@ -10,7 +10,9 @@
 
 #pragma once
 
+#include "API/ToolsApplicationAPI.h"
 #include "CsvSpawnerUtils.h"
+
 #include <AzCore/Asset/AssetCommon.h>
 #include <AzCore/Component/TickBus.h>
 #include <AzFramework/Entity/EntityContextBus.h>
@@ -28,6 +30,7 @@ namespace CsvSpawner
     class CsvSpawnerEditorComponent
         : public AzToolsFramework::Components::EditorComponentBase
         , protected AzFramework::ViewportDebugDisplayEventBus::Handler
+        , protected AZ::TickBus::Handler
     {
     public:
         AZ_EDITOR_COMPONENT(CsvSpawnerEditorComponent, CsvSpawnerEditorComponentTypeId);
@@ -40,6 +43,8 @@ namespace CsvSpawner
         void Activate() override;
         void Deactivate() override;
         void BuildGameEntity(AZ::Entity* gameEntity) override;
+        void OnTick(float deltaTime, AZ::ScriptTimePoint time) override;
+        int GetTickOrder() override;
 
     private:
         // EntityDebugDisplayEventBus::Handler overrides
@@ -50,6 +55,7 @@ namespace CsvSpawner
         void OnOnShowLabelsChanged();
 
         void SpawnEntities();
+        int m_frameCounter;
 
         AZStd::vector<CsvSpawnerUtils::CsvSpawnableAssetConfiguration>
             m_spawnableAssetConfigurations; //!< List of spawnable "types" (e.g. pineCsv, oakTre, mapleCsv, etc.)
diff --git a/Gems/CsvSpawner/Code/Source/CsvSpawner/CsvSpawnerUtils.cpp b/Gems/CsvSpawner/Code/Source/CsvSpawner/CsvSpawnerUtils.cpp
@@ -3,12 +3,16 @@
  *
  * This source code is protected under international copyright law.  All rights
  * reserved and protected by the copyright holders.
- * This file is confidential and only available to authorized individuals with the
- * permission of the copyright holders.  If you encounter this file and do not have
- * permission, please contact the copyright holders and delete this file.
+ * This file is confidential and only available to authorized individuals with
+ * the permission of the copyright holders.  If you encounter this file and do
+ * not have permission, please contact the copyright holders and delete this
+ * file.
  */
 
 #include "CsvSpawnerUtils.h"
+
+#include "AzFramework/Physics/CollisionBus.h"
+
 #include <AzCore/Asset/AssetSerializer.h>
 #include <AzCore/Serialization/EditContext.h>
 #include <AzCore/Serialization/SerializeContext.h>
@@ -49,7 +53,8 @@ namespace CsvSpawner::CsvSpawnerUtils
                 ->Field("PositionStdDev", &CsvSpawnableAssetConfiguration::m_positionStdDev)
                 ->Field("RotationStdDev", &CsvSpawnableAssetConfiguration::m_rotationStdDev)
                 ->Field("ScaleStdDev", &CsvSpawnableAssetConfiguration::m_scaleStdDev)
-                ->Field("PlaceOnTerrain", &CsvSpawnableAssetConfiguration::m_placeOnTerrain);
+                ->Field("PlaceOnTerrain", &CsvSpawnableAssetConfiguration::m_placeOnTerrain)
+                ->Field("CollisionGroup", &CsvSpawnableAssetConfiguration::m_selectedCollisionGroup);
 
             if (auto* editContext = serializeContext->GetEditContext())
             {
@@ -78,15 +83,32 @@ namespace CsvSpawner::CsvSpawnerUtils
                         &CsvSpawnableAssetConfiguration::m_placeOnTerrain,
                         "Place on Terrain",
                         "Perform scene query raytrace to place on terrain")
+                    ->Attribute(AZ::Edit::Attributes::ChangeNotify, &CsvSpawnableAssetConfiguration::OnPlaceOnTerrainChanged)
                     ->DataElement(
                         AZ::Edit::UIHandlers::Default,
                         &CsvSpawnableAssetConfiguration::m_scaleStdDev,
                         "Scale Std. Dev.",
-                        "Scale standard deviation, in meters");
+                        "Scale standard deviation, in meters")
+                    ->DataElement(
+                        AZ::Edit::UIHandlers::Default,
+                        &CsvSpawnableAssetConfiguration::m_selectedCollisionGroup,
+                        "Collision Group",
+                        "To which collision group this target will be attached")
+                    ->Attribute(AZ::Edit::Attributes::ReadOnly, &CsvSpawnableAssetConfiguration::IsCollisionLayerEnabled);
             }
         }
     }
 
+    bool CsvSpawnableAssetConfiguration::IsCollisionLayerEnabled() const
+    {
+        return !m_placeOnTerrain;
+    }
+
+    AZ::Crc32 CsvSpawnableAssetConfiguration::OnPlaceOnTerrainChanged()
+    {
+        return AZ::Edit::PropertyRefreshLevels::EntireTree;
+    }
+
     AZStd::unordered_map<AZStd::string, CsvSpawnableAssetConfiguration> GetSpawnableAssetFromVector(
         AZStd::vector<CsvSpawnableAssetConfiguration> spawnableAssetConfigurations)
     {
@@ -127,10 +149,15 @@ namespace CsvSpawner::CsvSpawnerUtils
     }
 
     AZStd::optional<AZ::Vector3> RaytraceTerrain(
-        const AZ::Vector3& location, const AzPhysics::SceneHandle sceneHandle, const AZ::Vector3& gravityDirection, float maxDistance)
+        const AZ::Vector3& location,
+        const AzPhysics::SceneHandle sceneHandle,
+        const AZ::Vector3& gravityDirection,
+        float maxDistance,
+        const AzPhysics::CollisionGroup& collisionGroup)
     {
         AZStd::optional<AZ::Vector3> hitPosition = AZStd::nullopt;
 
+        AZ_Assert(sceneHandle == AzPhysics::InvalidSceneHandle, "Unable to get  scene handle");
         if (sceneHandle == AzPhysics::InvalidSceneHandle)
         {
             return hitPosition;
@@ -150,6 +177,7 @@ namespace CsvSpawner::CsvSpawnerUtils
         request.m_start = location;
         request.m_direction = gravityDirection;
         request.m_distance = maxDistance;
+        request.m_collisionGroup = collisionGroup;
 
         AzPhysics::SceneQueryHits result = sceneInterface->QueryScene(sceneHandle, &request);
 
@@ -211,21 +239,29 @@ namespace CsvSpawner::CsvSpawnerUtils
 
             if (spawnConfig.m_placeOnTerrain)
             {
+                // Get collision group chosen from editor
+                AzPhysics::CollisionGroup collisionGroup;
+                Physics::CollisionRequestBus::BroadcastResult(
+                    collisionGroup, &Physics::CollisionRequests::GetCollisionGroupById, spawnConfig.m_selectedCollisionGroup);
+
                 const AZStd::optional<AZ::Vector3> hitPosition =
-                    RaytraceTerrain(transform.GetTranslation(), sceneHandle, -AZ::Vector3::CreateAxisZ(), 1000.0f);
+                    RaytraceTerrain(transform.GetTranslation(), sceneHandle, -AZ::Vector3::CreateAxisZ(), 1000.0f, collisionGroup);
+
                 if (hitPosition.has_value())
                 {
                     transform.SetTranslation(hitPosition.value());
                 }
                 else
                 {
-                    continue; // Skip this entity if we can't find a valid position and place on terrain is enabled.
+                    continue; // Skip this entity if we can't find a valid position and
+                              // place on terrain is enabled.
                 }
             }
             AZ_Assert(spawner, "Unable to get spawnable entities definition");
             AzFramework::SpawnAllEntitiesOptionalArgs optionalArgs;
             AzFramework::EntitySpawnTicket ticket(spawnable);
-            // Set the pre-spawn callback to set the name of the root entity to the name of the spawnable
+            // Set the pre-spawn callback to set the name of the root entity to the name
+            // of the spawnable
             optionalArgs.m_preInsertionCallback = [transform](auto id, auto view)
             {
                 if (view.empty())
diff --git a/Gems/CsvSpawner/Code/Source/CsvSpawner/CsvSpawnerUtils.h b/Gems/CsvSpawner/Code/Source/CsvSpawner/CsvSpawnerUtils.h
@@ -3,13 +3,16 @@
  *
  * This source code is protected under international copyright law.  All rights
  * reserved and protected by the copyright holders.
- * This file is confidential and only available to authorized individuals with the
- * permission of the copyright holders.  If you encounter this file and do not have
- * permission, please contact the copyright holders and delete this file.
+ * This file is confidential and only available to authorized individuals with
+ * the permission of the copyright holders.  If you encounter this file and do
+ * not have permission, please contact the copyright holders and delete this
+ * file.
  */
 
 #pragma once
 
+#include "AzFramework/Physics/Collision/CollisionGroups.h"
+#include "AzFramework/Physics/Collision/CollisionLayers.h"
 #include "CsvSpawner/CsvSpawnerTypeIds.h"
 
 #include <AzCore/Asset/AssetCommon.h>
@@ -24,8 +27,8 @@ namespace CsvSpawner::CsvSpawnerUtils
 
     //! Information about a locations to spawn an entity.
     //! This information is generated from CSV file and is used to spawn the entity.
-    //! @param m_name is the name of the spawnable entity configuration and should be identical to name in @class
-    //! SpawnableAssetConfiguration.
+    //! @param m_name is the name of the spawnable entity configuration and should
+    //! be identical to name in @class SpawnableAssetConfiguration.
     class CsvSpawnableEntityInfo
     {
     public:
@@ -37,15 +40,18 @@ namespace CsvSpawner::CsvSpawnerUtils
         unsigned int m_id; //!< Optional ID for the entity
         AZ::Transform m_transform; //!< Transform of the entity, mandatory
         AZStd::string m_name; //!< Name of the spawnable entity configuration, mandatory
-        uint64_t m_seed{ 0 }; //!< Optional seed value for randomization, in the context of one spawnable entity configuration, optional
+        uint64_t m_seed{ 0 }; //!< Optional seed value for randomization, in the context
+                              //!< of one spawnable entity configuration, optional
     };
 
     //! Configuration for a spawnable asset
-    //! This configuration is used to configure the spawnable asset before spawning it.
-    //! The @param m_name is used to identify the spawnable asset configuration and should be identical to name given in CSV file.
-    //! The class allows user to specify multiple spawnable assets for a given name and randomization parameters for position, rotation and
-    //! scale. If more then one spawnable asset is specified for a given name, then one of the spawnable assets is randomly selected for
-    //! spawning.
+    //! This configuration is used to configure the spawnable asset before spawning
+    //! it. The @param m_name is used to identify the spawnable asset configuration
+    //! and should be identical to name given in CSV file. The class allows user to
+    //! specify multiple spawnable assets for a given name and randomization
+    //! parameters for position, rotation and scale. If more then one spawnable
+    //! asset is specified for a given name, then one of the spawnable assets is
+    //! randomly selected for spawning.
     class CsvSpawnableAssetConfiguration
     {
     public:
@@ -59,12 +65,21 @@ namespace CsvSpawner::CsvSpawnerUtils
         AZ::Vector3 m_positionStdDev{ 0.f }; //!< Standard deviation for position
         AZ::Vector3 m_rotationStdDev{ 0.f }; //!< Standard deviation for rotation
         float m_scaleStdDev{ 0.1f }; //!< Standard deviation for scale
-        bool m_placeOnTerrain{ false }; //!< Whether to raytrace to terrain and place the entity on the terrain
+        bool m_placeOnTerrain{ false }; //!< Whether to raytrace to terrain and place
+                                        //!< the entity on the terrain
+        AzPhysics::CollisionGroups::Id m_selectedCollisionGroup; //!< To which collision group this target will
+                                                                 //!< be attached
+
+    private:
+        [[nodiscard]] bool IsCollisionLayerEnabled() const;
+        static AZ::Crc32 OnPlaceOnTerrainChanged();
     };
 
-    //! This function create map of spawnable asset configuration from vector of spawnable asset configuration, where
-    //! the key is the name of the spawnable asset configuration
-    //! @param spawnableAssetConfigurations - vector of spawnable asset configuration
+    //! This function create map of spawnable asset configuration from vector of
+    //! spawnable asset configuration, where the key is the name of the spawnable
+    //! asset configuration
+    //! @param spawnableAssetConfigurations - vector of spawnable asset
+    //! configuration
     //! @return map of spawnable asset configuration
     AZStd::unordered_map<AZStd::string, CsvSpawnableAssetConfiguration> GetSpawnableAssetFromVector(
         AZStd::vector<CsvSpawnableAssetConfiguration> spawnableAssetConfigurations);
@@ -74,7 +89,8 @@ namespace CsvSpawner::CsvSpawnerUtils
     //! @param spawnableAssetConfiguration - map of spawnable asset configuration
     //! @param defaultSeed - default seed value
     //! @param parentId - parent entity id to set for new entities
-    //! @param physicsSceneName - physics scene name (AzPhysics::DefaultPhysicsSceneName or AzPhysics::EditorPhysicsSceneName)
+    //! @param physicsSceneName - physics scene name
+    //! (AzPhysics::DefaultPhysicsSceneName or AzPhysics::EditorPhysicsSceneName)
     //! @return map of spawn created tickets
     AZStd::unordered_map<int, AzFramework::EntitySpawnTicket> SpawnEntities(
         const AZStd::vector<CsvSpawnableEntityInfo>& entitiesToSpawn,

Original file line number	Diff line number	Diff line change
`@@ -47,14 +47,19 @@ namespace CsvSpawner`
`47`	`47`	`AZ::TickBus ::Handler::BusDisconnect();`
`48`	`48`	`}`
`49`	`49`
	`50`	`+ int CsvSpawnerComponent::GetTickOrder()`
	`51`	`+ {`
	`52`	`+ return AZ::TICK_LAST;`
	`53`	`+ }`
	`54`	`+`
`50`	`55`	`void CsvSpawnerComponent::Activate()`
`51`	`56`	`{`
`52`		`- AZ::TickBus ::Handler::BusConnect();`
	`57`	`+ AZ::TickBus::Handler::BusConnect();`
`53`	`58`	`}`
`54`	`59`
`55`	`60`	`void CsvSpawnerComponent::Deactivate()`
`56`	`61`	`{`
`57`		`- AZ::TickBus ::Handler::BusDisconnect();`
	`62`	`+ AZ::TickBus::Handler::BusDisconnect();`
`58`	`63`	`}`
`59`	`64`
`60`	`65`	`} // namespace CsvSpawner`