You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
92 lines
4.6 KiB
C++
92 lines
4.6 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/Interface/Interface.h>
|
|
#include <AzCore/std/containers/set.h>
|
|
#include <AzCore/std/smart_ptr/unique_ptr.h>
|
|
#include <AzToolsFramework/Prefab/Instance/Instance.h>
|
|
#include <AzToolsFramework/Prefab/Link/Link.h>
|
|
#include <AzToolsFramework/Prefab/PrefabIdTypes.h>
|
|
#include <AzToolsFramework/Prefab/Template/Template.h>
|
|
|
|
namespace AzToolsFramework
|
|
{
|
|
namespace Prefab
|
|
{
|
|
/*!
|
|
* PrefabSystemComponentInterface
|
|
* Interface serviced by the Prefab System Component.
|
|
*/
|
|
class PrefabSystemComponentInterface
|
|
{
|
|
public:
|
|
|
|
using InstantiatedEntitiesCallback = AZStd::function<void(AZStd::vector<AZ::Entity*>&)>;
|
|
|
|
AZ_RTTI(PrefabSystemComponentInterface, "{8E95A029-67F9-4F74-895F-DDBFE29516A0}");
|
|
|
|
virtual TemplateReference FindTemplate(TemplateId id) = 0;
|
|
virtual LinkReference FindLink(const LinkId& id) = 0;
|
|
|
|
virtual TemplateId AddTemplate(const AZ::IO::Path& filePath, PrefabDom prefabDom) = 0;
|
|
virtual void UpdateTemplateFilePath(TemplateId templateId, const AZ::IO::PathView& filePath) = 0;
|
|
virtual void RemoveTemplate(TemplateId templateId) = 0;
|
|
virtual void RemoveAllTemplates() = 0;
|
|
|
|
virtual LinkId AddLink(TemplateId sourceTemplateId, TemplateId targetTemplateId,
|
|
PrefabDomValue::MemberIterator& instanceIterator, InstanceOptionalReference instance) = 0;
|
|
|
|
//creates a new Link
|
|
virtual LinkId CreateLink(
|
|
TemplateId linkTargetId, TemplateId linkSourceId, const InstanceAlias& instanceAlias,
|
|
const PrefabDomConstReference linkPatches, const LinkId& linkId = InvalidLinkId) = 0;
|
|
|
|
virtual void RemoveLink(const LinkId& linkId) = 0;
|
|
|
|
virtual TemplateId GetTemplateIdFromFilePath(AZ::IO::PathView filePath) const = 0;
|
|
|
|
virtual bool IsTemplateDirty(TemplateId templateId) = 0;
|
|
virtual void SetTemplateDirtyFlag(TemplateId templateId, bool dirty) = 0;
|
|
|
|
//! Recursive function to check if the template is dirty or if any dirty templates are presents in the links of the template.
|
|
//! @param rootTemplateId The id of the template provided as the beginning template to check the outgoing links.
|
|
virtual bool AreDirtyTemplatesPresent(TemplateId rootTemplateId) = 0;
|
|
|
|
//! Recursive function to save if the template is dirty and save all the dirty templates in the links of the template.
|
|
//! @param rootTemplateId The id of the template provided as the beginning template to check the outgoing links.
|
|
virtual void SaveAllDirtyTemplates(TemplateId rootTemplateId) = 0;
|
|
|
|
//! Recursive function that fetches the set of dirty templates given a starting template to check for outgoing links.
|
|
//! @param rootTemplateId The id of the template provided as the beginning template to check the outgoing links.
|
|
//! @return The set of dirty template paths populated.
|
|
virtual AZStd::set<AZ::IO::PathView> GetDirtyTemplatePaths(TemplateId rootTemplateId) = 0;
|
|
|
|
virtual PrefabDom& FindTemplateDom(TemplateId templateId) = 0;
|
|
virtual void UpdatePrefabTemplate(TemplateId templateId, const PrefabDom& updatedDom) = 0;
|
|
virtual void PropagateTemplateChanges(TemplateId templateId, InstanceOptionalConstReference instanceToExclude = AZStd::nullopt) = 0;
|
|
|
|
virtual AZStd::unique_ptr<Instance> InstantiatePrefab(
|
|
AZ::IO::PathView filePath,
|
|
InstanceOptionalReference parent = AZStd::nullopt,
|
|
const InstantiatedEntitiesCallback& instantiatedEntitiesCallback = {}) = 0;
|
|
virtual AZStd::unique_ptr<Instance> InstantiatePrefab(
|
|
TemplateId templateId,
|
|
InstanceOptionalReference parent = AZStd::nullopt,
|
|
const InstantiatedEntitiesCallback& instantiatedEntitiesCallback = {}) = 0;
|
|
virtual AZStd::unique_ptr<Instance> CreatePrefab(const AZStd::vector<AZ::Entity*>& entities,
|
|
AZStd::vector<AZStd::unique_ptr<Instance>>&& instancesToConsume, AZ::IO::PathView filePath,
|
|
AZStd::unique_ptr<AZ::Entity> containerEntity = nullptr, InstanceOptionalReference parent = AZStd::nullopt,
|
|
bool shouldCreateLinks = true) = 0;
|
|
};
|
|
|
|
} // namespace Prefab
|
|
} // namespace AzToolsFramework
|
|
|