chiyenteng
7e5cbdab1e
Adds a new ebus for prefab apis and refactored the apis Removed an empty test level Auto delete tmp level when teardown tests Add Base test level in Prefab folder Removed unused comments Checked if absolute path as an input of Create Prefab functions Changed created prefab file path to support all platfroms Added missing includes Signed-off-by: chiyteng <chiyteng@amazon.com>
198 lines
12 KiB
C++
198 lines
12 KiB
C++
/*
|
|
* 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/Math/Vector3.h>
|
|
#include <AzCore/Memory/SystemAllocator.h>
|
|
#include <AzCore/std/string/string_view.h>
|
|
|
|
#include <AzToolsFramework/Prefab/Instance/Instance.h>
|
|
#include <AzToolsFramework/Prefab/PrefabPublicInterface.h>
|
|
#include <AzToolsFramework/Prefab/PrefabSystemComponentInterface.h>
|
|
#include <AzToolsFramework/Prefab/PrefabUndoCache.h>
|
|
|
|
class QString;
|
|
|
|
namespace AzToolsFramework
|
|
{
|
|
using EntityList = AZStd::vector<AZ::Entity*>;
|
|
|
|
namespace Prefab
|
|
{
|
|
class Instance;
|
|
class InstanceEntityMapperInterface;
|
|
class InstanceToTemplateInterface;
|
|
class PrefabLoaderInterface;
|
|
class PrefabSystemComponentInterface;
|
|
|
|
class PrefabPublicHandler final
|
|
: public PrefabPublicInterface
|
|
{
|
|
public:
|
|
AZ_CLASS_ALLOCATOR(PrefabPublicHandler, AZ::SystemAllocator, 0);
|
|
AZ_RTTI(PrefabPublicHandler, "{35802943-6B60-430F-9DED-075E3A576A25}", PrefabPublicInterface);
|
|
|
|
void RegisterPrefabPublicHandlerInterface();
|
|
void UnregisterPrefabPublicHandlerInterface();
|
|
|
|
// PrefabPublicInterface...
|
|
PrefabOperationResult CreatePrefabInDisk(
|
|
const AZStd::vector<AZ::EntityId>& entityIds, AZ::IO::PathView filePath) override;
|
|
PrefabOperationResult CreatePrefabInMemory(
|
|
const AZStd::vector<AZ::EntityId>& entityIds, AZ::IO::PathView filePath) override;
|
|
InstantiatePrefabResult InstantiatePrefab(AZStd::string_view filePath, AZ::EntityId parent, const AZ::Vector3& position) override;
|
|
PrefabOperationResult SavePrefab(AZ::IO::Path filePath) override;
|
|
PrefabEntityResult CreateEntity(AZ::EntityId parentId, const AZ::Vector3& position) override;
|
|
|
|
PrefabOperationResult GenerateUndoNodesForEntityChangeAndUpdateCache(AZ::EntityId entityId, UndoSystem::URSequencePoint* parentUndoBatch) override;
|
|
|
|
bool IsInstanceContainerEntity(AZ::EntityId entityId) const override;
|
|
bool IsLevelInstanceContainerEntity(AZ::EntityId entityId) const override;
|
|
AZ::EntityId GetInstanceContainerEntityId(AZ::EntityId entityId) const override;
|
|
AZ::EntityId GetLevelInstanceContainerEntityId() const override;
|
|
AZ::IO::Path GetOwningInstancePrefabPath(AZ::EntityId entityId) const override;
|
|
PrefabRequestResult HasUnsavedChanges(AZ::IO::Path prefabFilePath) const override;
|
|
|
|
PrefabOperationResult DeleteEntitiesInInstance(const EntityIdList& entityIds) override;
|
|
PrefabOperationResult DeleteEntitiesAndAllDescendantsInInstance(const EntityIdList& entityIds) override;
|
|
PrefabOperationResult DuplicateEntitiesInInstance(const EntityIdList& entityIds) override;
|
|
|
|
PrefabOperationResult DetachPrefab(const AZ::EntityId& containerEntityId) override;
|
|
|
|
private:
|
|
PrefabOperationResult DeleteFromInstance(const EntityIdList& entityIds, bool deleteDescendants);
|
|
PrefabOperationResult RetrieveAndSortPrefabEntitiesAndInstances(
|
|
const EntityList& inputEntities,
|
|
Instance& commonRootEntityOwningInstance,
|
|
EntityList& outEntities,
|
|
AZStd::vector<Instance*>& outInstances) const;
|
|
EntityIdList GenerateEntityIdListWithoutLevelInstance(const EntityIdList& entityIds) const;
|
|
|
|
InstanceOptionalReference GetOwnerInstanceByEntityId(AZ::EntityId entityId) const;
|
|
bool EntitiesBelongToSameInstance(const EntityIdList& entityIds) const;
|
|
|
|
/**
|
|
* Duplicate a list of entities owned by a common owning instance by directly
|
|
* copying/modifying their entries in the instance DOM
|
|
*
|
|
* \param commonOwningInstance The common owning instance of all the entities being duplicated.
|
|
* \param entities The list of Entities that will be duplicated.
|
|
* \param domToAddDuplicatedEntitiesUnder The DOM of the common owning instance where the duplicated
|
|
* entity DOM values will be added to.
|
|
* \param duplicatedEntityIds A list of EntityIds corresponding to the entities that were duplicated.
|
|
*/
|
|
void DuplicateNestedEntitiesInInstance(Instance& commonOwningInstance,
|
|
const AZStd::vector<AZ::Entity*>& entities, PrefabDom& domToAddDuplicatedEntitiesUnder,
|
|
EntityIdList& duplicatedEntityIds, AZStd::unordered_map<EntityAlias, EntityAlias>& oldAliasToNewAliasMap);
|
|
/**
|
|
* Duplicate a list of instances owned by a common owning instance by directly
|
|
* copying/modifying their entries in the instance DOM
|
|
*
|
|
* \param commonOwningInstance The common owning instance of all the instances being duplicated.
|
|
* \param entities The list of Instances that will be duplicated.
|
|
* \param domToAddDuplicatedInstancesUnder The DOM of the common owning instance where the duplicated
|
|
* instance DOM values will be added to.
|
|
* \param duplicatedEntityIds A list of EntityIds corresponding to the instances that were duplicated.
|
|
*/
|
|
void DuplicateNestedInstancesInInstance(Instance& commonOwningInstance,
|
|
const AZStd::vector<Instance*>& instances, PrefabDom& domToAddDuplicatedInstancesUnder,
|
|
EntityIdList& duplicatedEntityIds, AZStd::unordered_map<InstanceAlias, Instance*>& newInstanceAliasToOldInstanceMap);
|
|
|
|
/**
|
|
* Applies the correct transform changes to the container entity based on the parent and child entities provided, and returns an appropriate patch.
|
|
* The container will be parented to parentId, moved to the average transform of the future direct children and its cache will be updated.
|
|
* This helper function won't support undo/redo, update the templates or create any links. All that needs to be done by the caller.
|
|
*
|
|
* \param containerEntityId The container to apply the changes to.
|
|
* \param parentEntityId The id of the entity the container should be parented to.
|
|
* \param childEntities A list of entities that will subsequently be parented to this container.
|
|
* \return The PrefabDom containing the patches that should be stored in the parent link.
|
|
*/
|
|
PrefabDom ApplyContainerTransformAndGeneratePatch(
|
|
AZ::EntityId containerEntityId, AZ::EntityId parentEntityId, const EntityList& childEntities);
|
|
|
|
/**
|
|
* Creates a link between the templates of an instance and its parent.
|
|
*
|
|
* \param sourceInstance The instance that corresponds to the source template of the link (child).
|
|
* \param targetInstance The id of the target template (parent).
|
|
* \param undoBatch The undo batch to set as parent for this create link action.
|
|
* \param patch The patch to store in the newly created link dom.
|
|
* \param isUndoRedoSupportNeeded The flag indicating whether the link should be created with undo/redo support or not.
|
|
*/
|
|
void CreateLink(
|
|
Instance& sourceInstance, TemplateId targetTemplateId, UndoSystem::URSequencePoint* undoBatch,
|
|
PrefabDom patch, const bool isUndoRedoSupportNeeded = true);
|
|
|
|
/**
|
|
* Removes the link between template of the sourceInstance and the template corresponding to targetTemplateId.
|
|
*
|
|
* \param sourceInstance The instance corresponding to the source template of the link to be removed.
|
|
* \param targetTemplateId The id of the target template of the link to be removed.
|
|
* \param undoBatch The undo batch to set as parent for this remove link action.
|
|
*/
|
|
void RemoveLink(
|
|
AZStd::unique_ptr<Instance>& sourceInstance, TemplateId targetTemplateId, UndoSystem::URSequencePoint* undoBatch);
|
|
|
|
/**
|
|
* Given a list of entityIds, finds the prefab instance that owns the common root entity of the entityIds.
|
|
*
|
|
* \param entityIds The list of entity ids.
|
|
* \param inputEntityList The list of entities corresponding to the entity ids.
|
|
* \param topLevelEntities The list of entities that are immediate children of the common root entity.
|
|
* \param commonRootEntityId The entity id of the common root entity of all the entityIds.
|
|
* \param commonRootEntityOwningInstance The owning instance of the common root entity.
|
|
* \return PrefabOperationResult indicating whether the action was successful or not.
|
|
*/
|
|
PrefabOperationResult FindCommonRootOwningInstance(
|
|
const AZStd::vector<AZ::EntityId>& entityIds, EntityList& inputEntityList, EntityList& topLevelEntities,
|
|
AZ::EntityId& commonRootEntityId, InstanceOptionalReference& commonRootEntityOwningInstance);
|
|
|
|
/* Checks whether the template source path of any of the ancestors in the instance hierarchy matches with one of the
|
|
* paths provided in a set.
|
|
*
|
|
* \param instance The instance whose ancestor hierarchy the provided set of template source paths will be tested against.
|
|
* \param templateSourcePaths The template source paths provided to be checked against the instance ancestor hierarchy.
|
|
* \return true if any of the template source paths could be found in the ancestor hierarchy of instance, false otherwise.
|
|
*/
|
|
bool IsCyclicalDependencyFound(
|
|
InstanceOptionalConstReference instance, const AZStd::unordered_set<AZ::IO::Path>& templateSourcePaths);
|
|
|
|
static void Internal_HandleContainerOverride(
|
|
UndoSystem::URSequencePoint* undoBatch, AZ::EntityId entityId, const PrefabDom& patch,
|
|
const LinkId linkId, InstanceOptionalReference parentInstance = AZStd::nullopt);
|
|
static void Internal_HandleEntityChange(
|
|
UndoSystem::URSequencePoint* undoBatch, AZ::EntityId entityId, PrefabDom& beforeState,
|
|
PrefabDom& afterState, InstanceOptionalReference instance = AZStd::nullopt);
|
|
void Internal_HandleInstanceChange(UndoSystem::URSequencePoint* undoBatch, AZ::Entity* entity, AZ::EntityId beforeParentId, AZ::EntityId afterParentId);
|
|
|
|
void UpdateLinkPatchesWithNewEntityAliases(
|
|
PrefabDom& linkPatch,
|
|
const AZStd::unordered_map<AZ::EntityId, AZStd::string>& oldEntityAliases,
|
|
Instance& newParent);
|
|
|
|
static void ReplaceOldAliases(QString& stringToReplace, AZStd::string_view oldAlias, AZStd::string_view newAlias);
|
|
|
|
static Instance* GetParentInstance(Instance* instance);
|
|
static Instance* GetAncestorOfInstanceThatIsChildOfRoot(const Instance* ancestor, Instance* descendant);
|
|
static void GenerateContainerEntityTransform(const EntityList& topLevelEntities, AZ::Vector3& translation, AZ::Quaternion& rotation);
|
|
|
|
InstanceEntityMapperInterface* m_instanceEntityMapperInterface = nullptr;
|
|
InstanceToTemplateInterface* m_instanceToTemplateInterface = nullptr;
|
|
PrefabLoaderInterface* m_prefabLoaderInterface = nullptr;
|
|
PrefabSystemComponentInterface* m_prefabSystemComponentInterface = nullptr;
|
|
|
|
// Caches entity states for undo/redo purposes
|
|
PrefabUndoCache m_prefabUndoCache;
|
|
|
|
uint64_t m_newEntityCounter = 1;
|
|
};
|
|
} // namespace Prefab
|
|
} // namespace AzToolsFramework
|