create/src/Mod/Part/Gui/PatternParametersWidget.h

// SPDX-License-Identifier: LGPL-2.1-or-later
/****************************************************************************
 *                                                                          *
 *   Copyright (c) 2025 AstoCAD                  <hello@astocad.com>        *
 *                                                                          *
 *   This file is part of FreeCAD.                                          *
 *                                                                          *
 *   FreeCAD is free software: you can redistribute it and/or modify it     *
 *   under the terms of the GNU Lesser General Public License as            *
 *   published by the Free Software Foundation, either version 2.1 of the   *
 *   License, or (at your option) any later version.                        *
 *                                                                          *
 *   FreeCAD is distributed in the hope that it will be useful, but         *
 *   WITHOUT ANY WARRANTY; without even the implied warranty of             *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU       *
 *   Lesser General Public License for more details.                        *
 *                                                                          *
 *   You should have received a copy of the GNU Lesser General Public       *
 *   License along with FreeCAD. If not, see                                *
 *   <https://www.gnu.org/licenses/>.                                       *
 *                                                                          *
 ***************************************************************************/


#ifndef PARTGUI_PATTERNPARAMETERSWIDGET_H
#define PARTGUI_PATTERNPARAMETERSWIDGET_H

#include <QWidget>
#include <App/PropertyStandard.h> // For Property types
#include <App/PropertyLinks.h>    // For PropertyLinkSub
#include <Gui/ComboLinks.h>

#include <Mod/Part/PartGlobal.h>

class Ui_PatternParametersWidget;

namespace App {
    class PropertyLinkSub;
    class PropertyBool;
    class PropertyEnumeration;
    class PropertyQuantity;
    class PropertyFloatList;
    class PropertyIntegerConstraint;
    class DocumentObject;
}
namespace Gui {
    class QuantitySpinBox;
}
class QToolButton;

namespace PartGui {

    enum class PatternType {
        Linear,
        Polar
    };

    enum class PatternMode {
        Extent,
        Spacing
    };

    /**
     * @brief A widget to configure the parameters for a single direction of a linear pattern.
     *
     * This widget encapsulates the UI and logic for Direction, Reverse, Mode,
     * Length/Spacing (including dynamic spacing), and Occurrences. It binds directly
     * to the corresponding properties of a Feature.
     */
    class PartGuiExport PatternParametersWidget : public QWidget
    {
        Q_OBJECT

    public:
        explicit PatternParametersWidget(PatternType type, QWidget* parent = nullptr);
        ~PatternParametersWidget() override;

        /**
         * @brief Binds the widget's UI elements to the properties of a DocumentObject.
         *
         * This must be called after creating the widget to link its controls
         * to the underlying feature's data.
         *
         * @param directionProp Reference to the Direction property (PropertyLinkSub).
         * @param reversedProp Reference to the Reversed property (PropertyBool).
         * @param modeProp Reference to the Mode property (PropertyEnumeration).
         * @param lengthProp Reference to the Length property (PropertyQuantity).
         * @param offsetProp Reference to the Offset property (PropertyQuantity).
         * @param spacingPatternProp Reference to the SpacingPattern property (PropertyFloatList).
         * @param occurrencesProp Reference to the Occurrences property (PropertyIntegerConstraint).
         * @param feature The feature object itself, needed for context (e.g., units).
         */
        void bindProperties(App::PropertyLinkSub* directionProp,
            App::PropertyBool* reversedProp,
            App::PropertyEnumeration* modeProp,
            App::PropertyQuantity* lengthProp,
            App::PropertyQuantity* offsetProp,
            App::PropertyFloatList* spacingPatternProp,
            App::PropertyIntegerConstraint* occurrencesProp,
            App::DocumentObject* feature); // Pass feature for context


        /**
         * @brief Adds a custom direction option to the Direction combo box.
         *
         * Used by consuming tools (like PartDesign tasks) to add context-specific
         * directions (e.g., Sketch axes).
         *
         * @param link The PropertyLinkSub representing the custom direction.
         * @param text The user-visible text for the combo box item.
         */
        void addDirection(App::DocumentObject* linkObj, const std::string& linkSubname, const QString& itemText, int userData = -1);

        /**
         * @brief Updates the UI elements to reflect the current values of the bound properties.
         */
        void updateUI();

        /**
          * @brief Returns the currently selected direction link from the combo box.
          * Returns an empty link if "Select reference..." is chosen.
          */
        const App::PropertyLinkSub& getCurrentDirectionLink() const;

        /**
          * @brief Checks if the "Select reference..." item is currently selected.
          */
        bool isSelectReferenceMode() const;

        void getAxis(App::DocumentObject*& obj, std::vector<std::string>& sub) const;
        bool getReverse() const;
        int getMode() const;
        double getExtent() const;
        double getSpacing() const;
        unsigned getOccurrences() const;
        std::string getSpacingPatternsAsString() const;

        void setTitle(const QString& title);
        void setCheckable(bool on);
        void setChecked(bool on);

        void applyQuantitySpinboxes() const;

        Gui::ComboLinks dirLinks;

    Q_SIGNALS:
        /**
         * @brief Emitted when the user selects the "Select reference..." option
         *        in the direction combo box, indicating the need to enter selection mode.
         */
        void requestReferenceSelection();

        /**
         * @brief Emitted when any parameter value controlled by this widget changes
         *        that requires a recompute of the feature.
         */
        void parametersChanged();


    private Q_SLOTS:
        // Slots connected to UI elements
        void onDirectionChanged(int index);
        void onReversePressed();
        void onModeChanged(int index);
        // Note: Spinbox value changes are often handled by direct binding,
        // but we might need slots if extra logic (like updating SpacingPattern[0]) is needed.
        void onLengthChanged(double value);
        void onOffsetChanged(double value);
        void onOccurrencesChanged(unsigned int value);

        // Slots for dynamic spacing
        void onAddSpacingButtonClicked();
        void onDynamicSpacingChanged(); // Simplified slot
        void onRemoveSpacingButtonClicked(QWidget* rowWidget);

    private:
        // Initialization and setup
        void setupUiElements();
        void connectSignals();

        // UI Update and state management
        void adaptVisibilityToMode();

        // Dynamic spacing helpers
        void addSpacingRow(double value);
        void clearDynamicSpacingRows();
        void rebuildDynamicSpacingUI();
        void updateSpacingPatternProperty(); // Updates the property from the UI

        std::unique_ptr<Ui_PatternParametersWidget> ui;

        // Pointers to bound properties (raw pointers, lifetime managed externally)
        App::PropertyLinkSub* m_directionProp = nullptr;
        App::PropertyBool* m_reversedProp = nullptr;
        App::PropertyEnumeration* m_modeProp = nullptr;
        App::PropertyQuantity* m_extentProp = nullptr;
        App::PropertyQuantity* m_spacingProp = nullptr;
        App::PropertyFloatList* m_spacingPatternProp = nullptr;
        App::PropertyIntegerConstraint* m_occurrencesProp = nullptr;
        App::DocumentObject* m_feature = nullptr; // Store feature for context

        bool blockUpdate = false; // Prevents signal loops

        // Store pointers to dynamically created widgets for removal and access
        QList<QWidget*> dynamicSpacingRows;
        QList<Gui::QuantitySpinBox*> dynamicSpacingSpinBoxes;

        PatternType type;
    };

} // namespace PartGui

#endif // PARTGUI_PATTERNPARAMETERSWIDGET_H