alexpete
79 lines
2.9 KiB
C++
79 lines
2.9 KiB
C++
/*
|
|
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
|
* its licensors.
|
|
*
|
|
* For complete copyright and license terms please see the LICENSE at the root of this
|
|
* distribution (the "License"). All use of this software is governed by the License,
|
|
* or, if provided, by the license below or the license accompanying this file. Do not
|
|
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
*
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <AzCore/EBus/EBus.h>
|
|
#include <AzCore/Component/EntityId.h>
|
|
#include <AzCore/Component/ComponentBus.h>
|
|
#include <AzToolsFramework/ToolsComponents/EditorSelectionAccentSystemComponent.h>
|
|
|
|
class CEntityObject;
|
|
|
|
namespace AzToolsFramework
|
|
{
|
|
/**
|
|
* Bus for querying about sandbox data associated with a given Entity.
|
|
*/
|
|
class ComponentEntityEditorRequests
|
|
: public AZ::ComponentBus
|
|
{
|
|
public:
|
|
virtual ~ComponentEntityEditorRequests() {}
|
|
|
|
/// Retrieve sandbox object associated with the entity.
|
|
virtual CEntityObject* GetSandboxObject() = 0;
|
|
|
|
/// Returns true if the object is highlighted.
|
|
virtual bool IsSandboxObjectHighlighted() = 0;
|
|
|
|
// Sets accent for the component entity
|
|
virtual void SetSandboxObjectAccent(EntityAccentType accent) = 0;
|
|
|
|
// Set the component entity's isolation flag when the editor is in Isolation Mode
|
|
virtual void SetSandBoxObjectIsolated(bool isIsolated) = 0;
|
|
|
|
// Returns if the component entity is isolated when the editor is in Isolation Mode
|
|
virtual bool IsSandBoxObjectIsolated() = 0;
|
|
|
|
/// Updates the entity to match the visibility and lock state of its hierarchy.
|
|
/// Necessary because ancestors that are layers can override the current entity's visibility and lock state.
|
|
virtual void RefreshVisibilityAndLock() = 0;
|
|
};
|
|
|
|
using ComponentEntityEditorRequestBus = AZ::EBus < ComponentEntityEditorRequests >;
|
|
|
|
class ComponentEntityObjectRequests
|
|
: public AZ::EBusTraits
|
|
{
|
|
public:
|
|
|
|
//////////////////////////////////////////////////////////////////////////
|
|
// EBusTraits overrides
|
|
static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single;
|
|
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::ById;
|
|
typedef void* BusIdType; // ID'd on CComponentEntityObject pointer.
|
|
//////////////////////////////////////////////////////////////////////////
|
|
|
|
virtual ~ComponentEntityObjectRequests() {}
|
|
|
|
/// Retrieve AZ Entity Id associated with this sandbox object.
|
|
virtual AZ::EntityId GetAssociatedEntityId() = 0;
|
|
|
|
/// Updates the undo cache for this sandbox object
|
|
virtual void UpdatePreemptiveUndoCache() = 0;
|
|
};
|
|
|
|
using ComponentEntityObjectRequestBus = AZ::EBus < ComponentEntityObjectRequests >;
|
|
} // namespace AzToolsFramework
|
|
|