o3de/Gems/WhiteBox/Code/Source/Viewport/WhiteBoxEdgeTranslationModifier.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 "Viewport/WhiteBoxViewportConstants.h"

#include <AzCore/std/smart_ptr/shared_ptr.h>
#include <AzCore/Component/ComponentBus.h>
#include <WhiteBox/WhiteBoxToolApi.h>

namespace AzToolsFramework
{
    class PlanarManipulator;

    namespace ViewportInteraction
    {
        struct MouseInteraction;
    }
} // namespace AzToolsFramework

namespace WhiteBox
{
    class ManipulatorViewEdge;

    //! EdgeTranslationModifier provides the ability to select and draw an edge in the viewport.
    class EdgeTranslationModifier
    {
    public:
        AZ_CLASS_ALLOCATOR_DECL

        using HandleType = Api::EdgeHandle;

        EdgeTranslationModifier(
            const AZ::EntityComponentIdPair& entityComponentIdPair, Api::EdgeHandle edgeHandle,
            const AZ::Vector3& intersectionPoint);
        ~EdgeTranslationModifier();

        bool MouseOver() const;
        void ForwardMouseOverEvent(const AzToolsFramework::ViewportInteraction::MouseInteraction& interaction);

        Api::EdgeHandle GetHandle() const; //!< Return the currently hovered edge (generic context version).
        Api::EdgeHandle GetEdgeHandle() const; //!< Return the currently hovered edge.
        Api::EdgeHandles::const_iterator EdgeHandlesBegin() const; //!< Return begin iterator to edge handles.
        Api::EdgeHandles::const_iterator EdgeHandlesEnd() const; //!< Return end iterator to edge handles.
        void SetEdgeHandle(Api::EdgeHandle edgeHandle);

        void SetColors(const AZ::Color& color, const AZ::Color& hoverColor);
        void SetWidths(float width, float hoverWidth);

        void Refresh();
        void CreateView();
        bool PerformingAction() const;

    private:
        void CreateManipulator();
        void DestroyManipulator();

        Api::EdgeHandles m_edgeHandles; //!< The edge handles this modifier is currently associated with (edge group).
        Api::EdgeHandle m_hoveredEdgeHandle; //!< The edge handle the mouse is currently over.
        //! The entity and component id this modifier is associated with.
        AZ::EntityComponentIdPair m_entityComponentIdPair;
        //! Manipulators for performing edge translations.
        AZStd::shared_ptr<AzToolsFramework::PlanarManipulator> m_translationManipulator;
        //! Manipulator views used to represent mesh edges for translation.
        AZStd::vector<AZStd::shared_ptr<ManipulatorViewEdge>> m_edgeViews;
        AZ::Color m_color = ed_whiteBoxEdgeDefault; //!< The color to use for the regular edge.
        AZ::Color m_hoverColor = ed_whiteBoxOutlineHover; //!< The color to use for the selected/highlighted edge.
        float m_width = cl_whiteBoxEdgeVisualWidth; //!< The width to use for the regular edge.
        //! The visible width to use for the selected/highlighted edge.
        float m_hoverWidth = cl_whiteBoxSelectedEdgeVisualWidth;
    };

    AZStd::array<AZ::Vector3, 2> GetEdgeNormalAxes(const AZ::Vector3& start, const AZ::Vector3& end);

    inline Api::EdgeHandle EdgeTranslationModifier::GetHandle() const
    {
        return GetEdgeHandle();
    }

    inline Api::EdgeHandle EdgeTranslationModifier::GetEdgeHandle() const
    {
        return m_hoveredEdgeHandle;
    }

    inline Api::EdgeHandles::const_iterator EdgeTranslationModifier::EdgeHandlesBegin() const
    {
        return m_edgeHandles.cbegin();
    }

    inline Api::EdgeHandles::const_iterator EdgeTranslationModifier::EdgeHandlesEnd() const
    {
        return m_edgeHandles.cend();
    }

    inline void EdgeTranslationModifier::SetEdgeHandle(const Api::EdgeHandle edgeHandle)
    {
        m_hoveredEdgeHandle = edgeHandle;
    }
} // namespace WhiteBox