Danilo Aimini
618777f8d4
* Enable closing prefab by double-clicking it when it's in focus. Signed-off-by: Danilo Aimini <82231674+AMZN-daimini@users.noreply.github.com> * Enable double clicking on level prefab to close focus mode and return to editing the level. Signed-off-by: Danilo Aimini <82231674+AMZN-daimini@users.noreply.github.com> * Introduce API function to go up one level in the Prefab Focus Mode hierarchy. Signed-off-by: Danilo Aimini <82231674+AMZN-daimini@users.noreply.github.com> * Enable keyboard shortcuts to more easily navigate the prefab hierarchy. Signed-off-by: Danilo Aimini <82231674+AMZN-daimini@users.noreply.github.com> * Tie the "Open/Edit Prefab" action to the = key on top of +. This allows users with compact US keyboards to use either key, preventing them from having to press Shift and =. Signed-off-by: Danilo Aimini <82231674+AMZN-daimini@users.noreply.github.com> * Replace the behavior of the "Up one level" button in the breadcrumbs with the new function that serves the same purpose. Also show the - shortcut in the tooltip. Signed-off-by: Danilo Aimini <82231674+AMZN-daimini@users.noreply.github.com> * Fix FocusOnParentOfFocusedPrefab to require the entity context id (to conform with the other functions in the API that don't pass entityIds). Expand its usage to other functions that did the same operation manually. Signed-off-by: Danilo Aimini <82231674+AMZN-daimini@users.noreply.github.com> * Include fix for non-unity builds Signed-off-by: Danilo Aimini <82231674+AMZN-daimini@users.noreply.github.com>
62 lines
3.1 KiB
C++
62 lines
3.1 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;
|
|
};
|
|
|
|
} // namespace AzToolsFramework::Prefab
|