o3de-extras/Gems/SimulationInterfaces/Code/Source/Clients/SimulationEntitiesManager.h

/*
 * Copyright (c) Contributors to the Open 3D Engine Project.
 * For complete copyright and license terms please see the LICENSE at the root of this distribution.
 *
 * SPDX-License-Identifier: Apache-2.0 OR MIT
 *
 */

#pragma once

#include <AzCore/Component/Component.h>
#include <AzCore/Component/TickBus.h>
#include <AzCore/Outcome/Outcome.h>
#include <AzCore/Script/ScriptTimePoint.h>
#include <AzCore/std/string/string.h>
#include <AzFramework/Entity/EntityContextBus.h>
#include <AzFramework/Physics/PhysicsScene.h>
#include <AzFramework/Spawnable/SpawnableEntitiesInterface.h>
#include <SimulationInterfaces/Result.h>
#include <SimulationInterfaces/SimulationEntityManagerRequestBus.h>

namespace SimulationInterfaces
{
    class SimulationEntitiesManager
        : public AZ::Component
        , protected SimulationEntityManagerRequestBus::Handler
    {
    public:
        AZ_COMPONENT_DECL(SimulationEntitiesManager);

        static void Reflect(AZ::ReflectContext* context);

        static void GetProvidedServices(AZ::ComponentDescriptor::DependencyArrayType& provided);
        static void GetIncompatibleServices(AZ::ComponentDescriptor::DependencyArrayType& incompatible);
        static void GetRequiredServices(AZ::ComponentDescriptor::DependencyArrayType& required);
        static void GetDependentServices(AZ::ComponentDescriptor::DependencyArrayType& dependent);

        SimulationEntitiesManager();
        ~SimulationEntitiesManager();
        // AZ::Component interface implementation
        void Activate() override;
        void Deactivate() override;

    private:
        // SimulationEntityManagerRequestBus interface implementation
        AZ::Outcome<EntityNameList, FailedResult> GetEntities(const EntityFilters& filter) override;
        AZ::Outcome<EntityState, FailedResult> GetEntityState(const AZStd::string& name) override;
        AZ::Outcome<MultipleEntitiesStates, FailedResult> GetEntitiesStates(const EntityFilters& filter) override;
        AZ::Outcome<void, FailedResult> SetEntityState(const AZStd::string& name, const EntityState& state) override;
        void DeleteEntity(const AZStd::string& name, DeletionCompletedCb completedCb) override;
        void DeleteAllEntities(DeletionCompletedCb completedCb) override;
        AZ::Outcome<SpawnableList, FailedResult> GetSpawnables() override;
        void SpawnEntity(
            const AZStd::string& name,
            const AZStd::string& uri,
            const AZStd::string& entityNamespace,
            const AZ::Transform& initialPose,
            const bool allowRename,
            PreInsertionCb preinsertionCb,
            SpawnCompletedCb completedCb) override;
        AZ::Outcome<void, FailedResult> ResetAllEntitiesToInitialState() override;
        AZ::Outcome<AZStd::string, FailedResult> RegisterNewSimulatedBody(
            const AZStd::string& proposedName, const AZ::EntityId& entityId) override;
        AZ::Outcome<void, FailedResult> UnregisterSimulatedBody(const AZStd::string& name) override;
        AZ::Outcome<void, FailedResult> SetEntityInfo(const AZStd::string& name, const EntityInfo& info) override;
        AZ::Outcome<EntityInfo, FailedResult> GetEntityInfo(const AZStd::string& name) override;
        AZ::Outcome<Bounds, FailedResult> GetEntityBounds(const AZStd::string& name) override;
        AZ::Outcome<AZ::EntityId, FailedResult> GetEntityId(const AZStd::string& name) override;
        AZ::Outcome<AZ::EntityId, FailedResult> GetEntityRoot(const AZStd::string& name) override;

        // helper methods to filter entities by different filters
        AZStd::vector<AZStd::string> FilterEntitiesByCategories(
            const AZStd::vector<AZStd::string>& prefilteredEntities, const AZStd::vector<EntityCategory>& categories);
        AZStd::vector<AZStd::string> FilterEntitiesByTag(
            const AZStd::vector<AZStd::string>& prefilteredEntities, const TagFilter& tagFilter);
        AZ::Outcome<AZStd::vector<AZStd::string>, FailedResult> FilterEntitiesByBounds(
            const AZStd::vector<AZStd::string>& prefilteredEntities,
            const AZStd::shared_ptr<Physics::ShapeConfiguration> shape,
            const AZ::Transform& shapePose);
        AZ::Outcome<AZStd::vector<AZStd::string>, FailedResult> FilterEntitiesByRegex(
            const AZStd::vector<AZStd::string>& prefilteredEntities, const AZStd::string& regex);

        //! Registers simulated entity to entity id mapping.
        //! Note that the entityId will be registered under unique name.
        //! \param entityId The entity id to register
        //! \param proposedName Optional user proposed name for the simulated entity
        //! \return returns the simulated entity name
        AZStd::string AddSimulatedEntity(AZ::EntityId entityId, const AZStd::string& proposedName);

        //! Returns the simulated entity name for the given entity id.
        AZStd::string GetSimulatedEntityName(AZ::EntityId entityId, const AZStd::string& proposedName) const;

        //! Set the state of the entity and their descendants.
        void SetEntitiesState(const AZStd::vector<AZ::EntityId>& entityAndDescendants, const EntityState& state);

        //! Removes entity info for entity with given name from the simulation interfaces registry, only if exists
        void RemoveEntityInfoIfNeeded(const AZStd::string& name);

        // Helper method to check if world is loaded
        AZ::Outcome<void, FailedResult> IsWorldLoaded();

        AzPhysics::SceneEvents::OnSimulationBodyAdded::Handler m_simulationBodyAddedHandler;
        AzPhysics::SceneEvents::OnSimulationBodyRemoved::Handler m_simulationBodyRemovedHandler;

        AzPhysics::SystemEvents::OnSceneAddedEvent::Handler m_sceneAddedHandler;
        AzPhysics::SystemEvents::OnSceneRemovedEvent::Handler m_sceneRemovedHandler;
        AzPhysics::SceneHandle m_physicsScenesHandle = AzPhysics::InvalidSceneHandle;

        // simulated entity name to tracked entity
        AZStd::unordered_map<AZStd::string, AZ::EntityId> m_simulatedEntityToEntityIdMap;
        // tracked entity to simulated entity name
        AZStd::unordered_map<AZ::EntityId, AZStd::string> m_entityIdToSimulatedEntityMap;
        AZStd::unordered_map<AZ::EntityId, EntityState> m_entityIdToInitialState;
        // simulated Entity name to prefab root (container entity). Not always equal to tracked entity. Applies only to entities spawned by
        // the simulation Interfaces
        AZStd::unordered_map<AZStd::string, AZ::EntityId> m_simulatedEntityToPrefabRoot;

        // Map holding entityInfo to assigned name
        AZStd::unordered_map<AZStd::string, EntityInfo> m_nameToEntityInfo;
        // Stores category to name which are forced to be unique by the standard, used for quicker lookup during filtering
        AZStd::unordered_map<EntityCategory, AZStd::unordered_set<AZStd::string>> m_categoryToNames;

        AZStd::unordered_map<AzFramework::EntitySpawnTicket::Id, AzFramework::EntitySpawnTicket> m_spawnedTickets;

        struct SpawnCompletedCbData
        {
            AZStd::string m_userProposedName; //! Name proposed by the User in spawn request
            SpawnCompletedCb m_completedCb; //! User callback to be called when the entity is registered
            PreInsertionCb m_preInsertionCb; //! User callback to be called when entity prefab is added but inactive
        };
        AZStd::unordered_map<AzFramework::EntitySpawnTicket::Id, SpawnCompletedCbData> m_spawnCompletedCallbacks;
    };

} // namespace SimulationInterfaces