srikappa-amzn
4dd9e94bc3
* Added tests for deleting entity under level and other prefabs Signed-off-by: srikappa-amzn <82230713+srikappa-amzn@users.noreply.github.com> * Added class comments and improved variable names Signed-off-by: srikappa-amzn <82230713+srikappa-amzn@users.noreply.github.com> * Called the reflect function of PrefabFocusHandler from PrefabSystemComponent Signed-off-by: srikappa-amzn <82230713+srikappa-amzn@users.noreply.github.com> * Added function comments and made an if statement to be one line Signed-off-by: srikappa-amzn <82230713+srikappa-amzn@users.noreply.github.com>
76 lines
3.7 KiB
C++
76 lines
3.7 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/Serialization/SerializeContext.h>
|
|
|
|
#include <AzFramework/Entity/EntityContext.h>
|
|
|
|
#include <AzToolsFramework/Prefab/Instance/Instance.h>
|
|
#include <AzToolsFramework/Prefab/Template/Template.h>
|
|
|
|
namespace AzToolsFramework::Prefab
|
|
{
|
|
using PrefabFocusOperationResult = AZ::Outcome<void, AZStd::string>;
|
|
|
|
//! Public Interface for external systems to utilize the Prefab Focus system.
|
|
class PrefabFocusPublicInterface
|
|
{
|
|
public:
|
|
AZ_RTTI(PrefabFocusPublicInterface, "{53EE1D18-A41F-4DB1-9B73-9448F425722E}");
|
|
|
|
//! Set the focused prefab instance to the owning instance of the entityId provided. Supports undo/redo.
|
|
//! @param entityId The entityId of the entity whose owning instance we want the prefab system to focus on.
|
|
virtual PrefabFocusOperationResult FocusOnOwningPrefab(AZ::EntityId entityId) = 0;
|
|
|
|
//! Set the focused prefab instance to the parent of the currently focused prefab instance. Supports undo/redo.
|
|
virtual PrefabFocusOperationResult FocusOnParentOfFocusedPrefab(AzFramework::EntityContextId entityContextId) = 0;
|
|
|
|
//! Set the focused prefab instance to the instance at position index of the current path. Supports undo/redo.
|
|
//! @param index The index of the instance in the current path that we want the prefab system to focus on.
|
|
virtual PrefabFocusOperationResult FocusOnPathIndex(AzFramework::EntityContextId entityContextId, int index) = 0;
|
|
|
|
//! Returns the entity id of the container entity for the instance the prefab system is focusing on.
|
|
virtual AZ::EntityId GetFocusedPrefabContainerEntityId(AzFramework::EntityContextId entityContextId) const = 0;
|
|
|
|
//! Returns whether the entity belongs to the instance that is being focused on.
|
|
//! @param entityId The entityId of the queried entity.
|
|
//! @return true if the entity belongs to the focused instance, false otherwise.
|
|
virtual bool IsOwningPrefabBeingFocused(AZ::EntityId entityId) const = 0;
|
|
|
|
//! Returns whether the entity belongs to the instance that is being focused on, or one of its descendants.
|
|
//! @param entityId The entityId of the queried entity.
|
|
//! @return true if the entity belongs to the focused instance or one of its descendants, false otherwise.
|
|
virtual bool IsOwningPrefabInFocusHierarchy(AZ::EntityId entityId) const = 0;
|
|
|
|
//! Returns the path from the root instance to the currently focused instance.
|
|
//! @return A path composed from the names of the container entities for the instance path.
|
|
virtual const AZ::IO::Path& GetPrefabFocusPath(AzFramework::EntityContextId entityContextId) const = 0;
|
|
|
|
//! Returns the size of the path to the currently focused instance.
|
|
virtual const int GetPrefabFocusPathLength(AzFramework::EntityContextId entityContextId) const = 0;
|
|
};
|
|
|
|
/**
|
|
* The primary purpose of this bus is to facilitate writing automated tests for prefab focus mode.
|
|
* If you would like to integrate prefabs focus mode into your system, please call PrefabFocusPublicInterface
|
|
* for better performance.
|
|
*/
|
|
class PrefabFocusPublicRequests
|
|
: public AZ::EBusTraits
|
|
{
|
|
public:
|
|
static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single;
|
|
};
|
|
|
|
using PrefabFocusPublicRequestBus = AZ::EBus<PrefabFocusPublicInterface, PrefabFocusPublicRequests>;
|
|
|
|
} // namespace AzToolsFramework::Prefab
|