Merge branch 'main' into wc/fps_profiler

Author: w-czerski

Gems/CsvSpawner/Code/Include/CsvSpawner/CsvSpawnerTypeIds.h

@@ -18,6 +18,7 @@ namespace CsvSpawner
     inline constexpr const char* CsvSpawnableEntityInfoTypeId = "{6acce47e-9cac-4a6e-8726-ea614fb2d30d}";
     inline constexpr const char* CsvSpawnableAssetConfigurationTypeId = "{d04ea4de-b4dc-4e76-b742-c1d77203bc3e}";
     inline constexpr const char* CsvSpawnerEditorComponentTypeId = "{8b016a40-c585-48a1-a3e5-2814f599418c}";
+    inline constexpr const char* CsvSpawnerEditorTerrainSettingsConfigTypeId = "{589B418A-A2A5-4DDE-9722-2952F79037B0}";
     inline constexpr const char* CsvSpawnerComponentTypeId = "{59b31372-1f3c-4733-b61b-0fe94b5a8f3e}";
 
     // Interface TypeIds

Gems/CsvSpawner/Code/Source/CsvSpawner/CsvSpawnerComponent.cpp

@@ -40,26 +40,48 @@ namespace CsvSpawner
     {
     }
 
-    void CsvSpawnerComponent::OnTick([[maybe_unused]] float deltaTime, [[maybe_unused]] AZ::ScriptTimePoint time)
+    void CsvSpawnerComponent::Activate()
     {
-        m_spawnedTickets = CsvSpawnerUtils::SpawnEntities(
-            m_spawnableEntityInfo, m_spawnableAssetConfigurations, m_defaultSeed, AzPhysics::DefaultPhysicsSceneName, this->GetEntityId());
-        AZ::TickBus ::Handler::BusDisconnect();
+        if (IsTerrainAvailable())
+        {
+            AzFramework::Terrain::TerrainDataNotificationBus::Handler::BusConnect();
+        }
+        else
+        {
+            OnTerrainDataCreateEnd();
+        }
     }
 
-    int CsvSpawnerComponent::GetTickOrder()
+    void CsvSpawnerComponent::Deactivate()
     {
-        return AZ::TICK_LAST;
+        OnTerrainDataDestroyBegin();
     }
 
-    void CsvSpawnerComponent::Activate()
+    void CsvSpawnerComponent::OnTerrainDataCreateEnd()
     {
-        AZ::TickBus::Handler::BusConnect();
+        if (m_terrainCreatedOnlyOnce)
+        {
+            return;
+        }
+
+        AZ::TickBus::QueueFunction(
+            [this]()
+            {
+                m_spawnedTickets = CsvSpawnerUtils::SpawnEntities(
+                    m_spawnableEntityInfo,
+                    m_spawnableAssetConfigurations,
+                    m_defaultSeed,
+                    AzPhysics::DefaultPhysicsSceneName,
+                    this->GetEntityId());
+            });
+
+        // Init only once, even if level have multiple terrains
+        m_terrainCreatedOnlyOnce = true;
     }
 
-    void CsvSpawnerComponent::Deactivate()
+    void CsvSpawnerComponent::OnTerrainDataDestroyBegin()
     {
-        AZ::TickBus::Handler::BusDisconnect();
+        m_terrainCreatedOnlyOnce = false;
+        AzFramework::Terrain::TerrainDataNotificationBus::Handler::BusDisconnect();
     }
-
 } // namespace CsvSpawner

Gems/CsvSpawner/Code/Source/CsvSpawner/CsvSpawnerComponent.h

@@ -10,6 +10,7 @@
 
 #pragma once
 
+#include "AzFramework/Terrain/TerrainDataRequestBus.h"
 #include "CsvSpawnerUtils.h"
 
 #include <AzCore/Component/Component.h>
@@ -25,7 +26,7 @@ namespace CsvSpawner
     //! dependent on a CSV file).
     class CsvSpawnerComponent
         : public AZ::Component
-        , private AZ::TickBus::Handler
+        , protected AzFramework::Terrain::TerrainDataNotificationBus::Handler
     {
     public:
         AZ_COMPONENT(CsvSpawnerComponent, CsvSpawnerComponentTypeId);
@@ -37,23 +38,26 @@ namespace CsvSpawner
             const AZStd::vector<CsvSpawnableEntityInfo>& spawnableEntityInfo,
             AZ::u64 defaultSeed);
 
-        ~CsvSpawnerComponent() = default;
+        ~CsvSpawnerComponent() override = default;
 
         static void Reflect(AZ::ReflectContext* context);
 
         // AZ::Component overrides
         void Activate() override;
         void Deactivate() override;
 
-    private:
-        // AZ::TickBus::Handler overrides
-        void OnTick(float deltaTime, AZ::ScriptTimePoint time) override;
-        int GetTickOrder() override;
+        // AzFramework::Terrain::TerrainDataNotificationBus::Handler overrides
+        void OnTerrainDataCreateEnd() override;
+        void OnTerrainDataDestroyBegin() override;
 
+    private:
         AZStd::unordered_map<AZStd::string, CsvSpawnableAssetConfiguration> m_spawnableAssetConfigurations; //!< List of assets to spawn
         AZStd::vector<CsvSpawnableEntityInfo> m_spawnableEntityInfo; //!< List of entities to spawn
         AZ::u64 m_defaultSeed{ 0 }; //!< Default seed value
 
         AZStd::unordered_map<int, AzFramework::EntitySpawnTicket> m_spawnedTickets;
+
+        // Terrain notify
+        bool m_terrainCreatedOnlyOnce{ false }; //!< Is terrain fully generated once
     };
 } // namespace CsvSpawner

Gems/CsvSpawner/Code/Source/CsvSpawner/CsvSpawnerEditorComponent.cpp

@@ -9,34 +9,36 @@
  */
 
 #include "CsvSpawnerEditorComponent.h"
-#include "AzCore/Debug/Trace.h"
 #include "CsvSpawnerComponent.h"
 #include "CsvSpawnerCsvParser.h"
 #include "CsvSpawnerUtils.h"
 
 #include <AzCore/Component/TransformBus.h>
+#include <AzCore/Debug/Trace.h>
 #include <AzCore/IO/Path/Path.h>
 #include <AzCore/Serialization/EditContext.h>
 #include <AzFramework/Physics/Common/PhysicsTypes.h>
+#include <AzFramework/Physics/PhysicsScene.h>
 #include <AzToolsFramework/API/EditorAssetSystemAPI.h>
 #include <AzToolsFramework/Viewport/ViewportMessages.h>
-#include <thread>
 
 namespace CsvSpawner
 {
-
     void CsvSpawnerEditorComponent::Reflect(AZ::ReflectContext* context)
     {
         AZ::SerializeContext* serializeContext = azrtti_cast<AZ::SerializeContext*>(context);
         if (serializeContext)
         {
-            serializeContext->Class<CsvSpawnerEditorComponent, AzToolsFramework::Components::EditorComponentBase>()
+            CsvSpawnerEditorTerrainSettingsConfig::Reflect(context);
+
+            serializeContext->Class<CsvSpawnerEditorComponent, EditorComponentBase>()
                 ->Version(2)
                 ->Field("CsvAssetId", &CsvSpawnerEditorComponent::m_csvAssetId)
                 ->Field("NumberOfEntries", &CsvSpawnerEditorComponent::m_numberOfEntries)
                 ->Field("SpawnableAssetConfigurations", &CsvSpawnerEditorComponent::m_spawnableAssetConfigurations)
                 ->Field("DefaultSeed", &CsvSpawnerEditorComponent::m_defaultSeed)
-                ->Field("ShowLabels", &CsvSpawnerEditorComponent::m_showLabels);
+                ->Field("ShowLabels", &CsvSpawnerEditorComponent::m_showLabels)
+                ->Field("TerrainSettingsConfig", &CsvSpawnerEditorComponent::m_terrainSettingsConfig);
 
             AZ::EditContext* editContext = serializeContext->GetEditContext();
             if (editContext)
@@ -45,12 +47,12 @@ namespace CsvSpawner
                     ->ClassElement(AZ::Edit::ClassElements::EditorData, "CsvSpawnerEditorComponent")
                     ->Attribute(AZ::Edit::Attributes::AppearsInAddComponentMenu, AZ_CRC_CE("Game"))
                     ->Attribute(AZ::Edit::Attributes::Category, "CsvSpawner")
-                    ->Attribute(AZ::Edit::Attributes::AutoExpand, true)
                     ->DataElement(
                         AZ::Edit::UIHandlers::Default,
                         &CsvSpawnerEditorComponent::m_spawnableAssetConfigurations,
                         "Asset Config",
                         "Asset configuration")
+                    ->Attribute(AZ::Edit::Attributes::AutoExpand, false)
                     ->DataElement(AZ::Edit::UIHandlers::Default, &CsvSpawnerEditorComponent::m_csvAssetId, "CSV Asset", "CSV asset")
                     ->UIElement(AZ::Edit::UIHandlers::Button, "Reload Csv", "Reload Csv")
                     ->Attribute(AZ::Edit::Attributes::NameLabelOverride, "")
@@ -60,47 +62,56 @@ namespace CsvSpawner
                     ->Attribute(AZ::Edit::Attributes::ReadOnly, true)
                     ->DataElement(AZ::Edit::UIHandlers::Default, &CsvSpawnerEditorComponent::m_defaultSeed, "Default seed", "")
                     ->DataElement(AZ::Edit::UIHandlers::Default, &CsvSpawnerEditorComponent::m_showLabels, "Show labels in Editor", "")
-                    ->Attribute(AZ::Edit::Attributes::ChangeNotify, &CsvSpawnerEditorComponent::OnOnShowLabelsChanged);
+                    ->Attribute(AZ::Edit::Attributes::ChangeNotify, &CsvSpawnerEditorComponent::OnShowLabelsChanged)
+                    ->DataElement(
+                        AZ::Edit::UIHandlers::Default,
+                        &CsvSpawnerEditorComponent::m_terrainSettingsConfig,
+                        "Spawn Behaviour Settings",
+                        "Settings to configure spawn behaviour in editor.");
             }
         }
     }
 
-    void CsvSpawnerEditorComponent::OnOnShowLabelsChanged()
+    void CsvSpawnerEditorComponent::Activate()
     {
+        EditorComponentBase::Activate();
+        AzFramework::Terrain::TerrainDataNotificationBus::Handler::BusConnect();
+
         if (m_showLabels)
         {
             AzFramework::ViewportDebugDisplayEventBus::Handler::BusConnect(AzToolsFramework::GetEntityContextId());
         }
-        else
-        {
-            AzFramework::ViewportDebugDisplayEventBus::Handler::BusDisconnect();
-        }
-    }
 
-    void CsvSpawnerEditorComponent::Activate()
-    {
-        AzToolsFramework::Components::EditorComponentBase::Activate();
-        if (m_showLabels)
+        if (m_terrainSettingsConfig.m_spawnOnComponentActivated && !m_terrainSettingsConfig.m_flagSpawnEntitiesOnStartOnce)
         {
-            AzFramework::ViewportDebugDisplayEventBus::Handler::BusConnect(AzToolsFramework::GetEntityContextId());
+            AZ::TickBus::QueueFunction(
+                [this]()
+                {
+                    // If there is no Terrain handlers (which means no active terrain in this level), just spawn entities on next available
+                    // tick. Since terrain is initiated on tick, IsTerrainAvailable will return real information when used inside tick.
+                    if (!IsTerrainAvailable() && !m_terrainSettingsConfig.m_spawnOnTerrainUpdate)
+                    {
+                        m_terrainSettingsConfig.m_flagSpawnEntitiesOnStartOnce = true;
+                        SpawnEntities();
+                    }
+                });
         }
-
-        AZ::TickBus::Handler::BusConnect();
     }
 
     void CsvSpawnerEditorComponent::Deactivate()
     {
         m_spawnedTickets.clear();
+        m_terrainSettingsConfig.m_flagSpawnEntitiesOnStartOnce = false;
 
+        AzFramework::Terrain::TerrainDataNotificationBus::Handler::BusDisconnect();
         AzFramework::ViewportDebugDisplayEventBus::Handler::BusDisconnect();
-        AZ::TickBus::Handler::BusDisconnect();
-        AzToolsFramework::Components::EditorComponentBase::Deactivate();
+        EditorComponentBase::Deactivate();
     }
 
     void CsvSpawnerEditorComponent::BuildGameEntity(AZ::Entity* gameEntity)
     {
         // Create Game component
-        const auto config = CsvSpawnerUtils::GetSpawnableAssetFromVector(m_spawnableAssetConfigurations);
+        const auto config = GetSpawnableAssetFromVector(m_spawnableAssetConfigurations);
 
         using AssetSysReqBus = AzToolsFramework::AssetSystemRequestBus;
         AZ::Data::AssetInfo sourceAssetInfo;
@@ -114,28 +125,33 @@ namespace CsvSpawner
 
         AZ_Printf("CsvSpawnerEditorComponent", "Source of CSV file path: %s", sourcePath.c_str());
 
-        auto spawnableEntityInfo = CsvSpawner::CsvSpawnerUtils::GetSpawnableEntityInfoFromCSV(sourcePath.String());
+        auto spawnableEntityInfo = GetSpawnableEntityInfoFromCSV(sourcePath.String());
 
         gameEntity->CreateComponent<CsvSpawnerComponent>(config, spawnableEntityInfo, m_defaultSeed);
+
         // Destroy Editor's spawned entities
         m_spawnedTickets.clear();
     }
 
-    void CsvSpawnerEditorComponent::OnTick(float deltaTime, AZ::ScriptTimePoint time)
+    void CsvSpawnerEditorComponent::OnTerrainDataChanged(
+        [[maybe_unused]] const AZ::Aabb& dirtyRegion, TerrainDataChangedMask dataChangedMask)
     {
-        ++m_frameCounter;
-
-        if (m_frameCounter == 2)
+        // Ignore on update with selected flags
+        if (static_cast<bool>(dataChangedMask & m_terrainSettingsConfig.m_terrainMasksToIgnore))
         {
-            SpawnEntities();
-            AZ::TickBus::Handler::BusDisconnect();
-            m_frameCounter = 0;
+            return;
         }
-    }
 
-    int CsvSpawnerEditorComponent::GetTickOrder()
-    {
-        return AZ::TICK_LAST;
+        if ((m_terrainSettingsConfig.m_spawnOnComponentActivated && !m_terrainSettingsConfig.m_flagSpawnEntitiesOnStartOnce) ||
+            m_terrainSettingsConfig.m_spawnOnTerrainUpdate)
+        {
+            AZ::TickBus::QueueFunction(
+                [this]()
+                {
+                    SpawnEntities();
+                    m_terrainSettingsConfig.m_flagSpawnEntitiesOnStartOnce = true;
+                });
+        }
     }
 
     void CsvSpawnerEditorComponent::SpawnEntities()
@@ -145,6 +161,7 @@ namespace CsvSpawner
             AZ_Error("CsvSpawnerEditorComponent", false, "CSV asset is not set");
             return;
         }
+
         m_spawnedTickets.clear();
         using AssetSysReqBus = AzToolsFramework::AssetSystemRequestBus;
         AZ::Data::AssetInfo sourceAssetInfo;
@@ -158,16 +175,28 @@ namespace CsvSpawner
 
         AZ_Printf("CsvSpawnerEditorComponent", "Source of CSV file path: %s", sourcePath.c_str());
 
-        m_spawnableEntityInfo = CsvSpawner::CsvSpawnerUtils::GetSpawnableEntityInfoFromCSV(sourcePath.String());
+        m_spawnableEntityInfo = GetSpawnableEntityInfoFromCSV(sourcePath.String());
         m_numberOfEntries = m_spawnableEntityInfo.size();
 
         AZ_Printf("CsvSpawnerEditorComponent", "Spawning spawnables, %d", m_numberOfEntries);
 
-        const auto config = CsvSpawnerUtils::GetSpawnableAssetFromVector(m_spawnableAssetConfigurations);
+        const auto config = GetSpawnableAssetFromVector(m_spawnableAssetConfigurations);
         m_spawnedTickets =
             CsvSpawnerUtils::SpawnEntities(m_spawnableEntityInfo, config, m_defaultSeed, AzPhysics::EditorPhysicsSceneName, GetEntityId());
     }
 
+    void CsvSpawnerEditorComponent::OnShowLabelsChanged()
+    {
+        if (m_showLabels)
+        {
+            AzFramework::ViewportDebugDisplayEventBus::Handler::BusConnect(AzToolsFramework::GetEntityContextId());
+        }
+        else
+        {
+            AzFramework::ViewportDebugDisplayEventBus::Handler::BusDisconnect();
+        }
+    }
+
     void CsvSpawnerEditorComponent::OnSpawnButton()
     {
         SpawnEntities();
@@ -196,5 +225,4 @@ namespace CsvSpawner
         debugDisplay.PopMatrix();
         debugDisplay.SetState(stateBefore);
     }
-
 } // namespace CsvSpawner