o3de/Gems/AtomLyIntegration/EditorModeFeedback/Code/Source/Pass/State/FocusedEntityState.h

/*
 * 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 <Pass/State/EditorStateBase.h>

#include <AzToolsFramework/API/ViewportEditorModeTrackerNotificationBus.h>

namespace AZ::Render
{
    //! Class for the Focused Entity editor state effect.
    class FocusedEntityState
        : public EditorStateBase
        , private AzToolsFramework::ViewportEditorModeNotificationsBus::Handler
    {
    public:
        FocusedEntityState();
        ~FocusedEntityState();

        // ViewportEditorModeNotificationsBus overrides ...
        void OnEditorModeActivated(
            const AzToolsFramework::ViewportEditorModesInterface& editorModeState, AzToolsFramework::ViewportEditorMode mode) override;
        void OnEditorModeDeactivated(
            const AzToolsFramework::ViewportEditorModesInterface& editorModeState, AzToolsFramework::ViewportEditorMode mode) override;

        // EditorStateBase overrides ...
        bool IsEnabled() const override;
        AzToolsFramework::EntityIdList GetMaskedEntities() const override;

    private:
        bool m_inFocusMode = false; //!< True if Focus Mode is active, otherwise false.
    };
} // namespace AZ::Render