o3de/Gems/Vegetation/Code/Source/Editor/EditorMeshBlockerComponent.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 <AzCore/Module/Module.h>
#include <AzToolsFramework/ToolsComponents/EditorComponentBase.h>
#include <AzToolsFramework/ToolsComponents/EditorVisibilityBus.h>
#include <Components/MeshBlockerComponent.h>
#include <AzFramework/Entity/EntityDebugDisplayBus.h>
#include <Vegetation/Editor/EditorAreaComponentBase.h>

namespace Vegetation
{
    class EditorMeshBlockerComponent
        : public EditorAreaComponentBase<MeshBlockerComponent, MeshBlockerConfig>
        , private AzFramework::EntityDebugDisplayEventBus::Handler
    {
    public:
        using DerivedClassType = EditorMeshBlockerComponent;
        using BaseClassType = EditorAreaComponentBase<MeshBlockerComponent, MeshBlockerConfig>;
        AZ_EDITOR_COMPONENT(EditorMeshBlockerComponent, EditorMeshBlockerComponentTypeId, BaseClassType);
        static void Reflect(AZ::ReflectContext* context);

        //////////////////////////////////////////////////////////////////////////
        // AZ::Component interface implementation
        void Activate() override;
        void Deactivate() override;

        //////////////////////////////////////////////////////////////////////////
        // AzFramework::EntityDebugDisplayEventBus
        void DisplayEntityViewport(const AzFramework::ViewportInfo& viewportInfo, AzFramework::DebugDisplayRequests& debugDisplay) override;

        static constexpr const char* const s_categoryName = "Vegetation";
        static constexpr const char* const s_componentName = "Vegetation Layer Blocker (Mesh)";
        static constexpr const char* const s_componentDescription = "Prevents vegetation from being placed in the mesh";
        static constexpr const char* const s_icon = "Editor/Icons/Components/Vegetation.svg";
        static constexpr const char* const s_viewportIcon = "Editor/Icons/Components/Viewport/Vegetation.svg";
        static constexpr const char* const s_helpUrl = "https://www.o3de.org/docs/user-guide/components/reference/vegetation/vegetation-layer-blocker-mesh/";

    private:
        bool m_drawDebugBounds = false;
    };
}