Улучшение читабельности кода

Canvas.h

@@ -14,18 +14,25 @@
 #include "GCS/GCS.h"
 using namespace GCS;
 
+// ===================================================================
+// Типы и перечисления
+// ===================================================================
+
+/// Режимы работы с холстом
 enum class Mode : int
 {
-    None = 0,
+    None = 0,         ///< Режим отсутствия действия
-    DrawingLine = 1,
+    DrawingLine = 1,  ///< Режим рисования линии
-    Parallel = 2,
+    Parallel = 2,     ///< Режим задания параллельности
-    Coincedent = 3,
+    Coincedent = 3,   ///< Режим задания совпадения точек
-    Horizontal = 4,
+    Horizontal = 4,   ///< Режим задания горизонтальности
-    Vertical = 5
+    Vertical = 5      ///< Режим задания вертикальности
 };
 
-// Удобный тип для хранения пары параллельных линий (порядок не важен)
+/// Удобный тип для хранения пары параллельных линий (порядок не важен)
 using LinePair = std::pair<Line*, Line*>;
+
+/// Удобный тип для хранения пары точек (порядок не важен)
 using PointPair = std::pair<Point*, Point*>;
 
 // ===================================================================
@@ -40,54 +47,89 @@ public:
     explicit Canvas(QWidget* parent = nullptr);
     ~Canvas() override;
 
+    /// Изменить текущий режим работы
     void changeMode(Mode newMode);
 
 protected:
+    // Обработчики событий Qt
     void mousePressEvent(QMouseEvent* event) override;
     void mouseMoveEvent(QMouseEvent* event) override;
     void mouseReleaseEvent(QMouseEvent* event) override;
     void paintEvent(QPaintEvent* event) override;
 
 private:
-    // ====================== Поиск и выбор ======================
+    // ====================== Методы поиска и выбора ======================
-    Line* findAt(QPointF&);                    // ищет линию под курсором
-    Point* findPointAt(QPointF, qreal tolerance = 5.0);
-    bool areCoincident(Point*, Point*);
-    bool areHorizontalVertical(Point*, Point*, bool);
-    bool isLineHorizontal(Line* line);           // проверяет, горизонтальна ли линия
-    bool isLineVertical(Line* line);             // проверяет, вертикальна ли линия
-    // ====================== Параллельность ======================
-    bool areAlreadyParallel(Line* l1, Line* l2);           // проверка на дубликат
 
-    // ====================== Перемещение ======================
+    /// Найти линию под указанной позицией
-    Point* draggedPoint{ nullptr };
+    Line* findAt(QPointF& position);
-    Line* draggedLine{ nullptr };
-    QPointF dragOffset;
 
-    // ====================== Работа с парами ограничений ======================
+    /// Найти точку в указанной позиции с заданной точностью
+    Point* findPointAt(QPointF position, qreal tolerance = 5.0);
+
+    /// Проверить, совпадают ли две точки (ограничение P2P)
+    bool areCoincident(Point* point1, Point* point2);
+
+    /// Проверить горизонтальность или вертикальность между двумя точками
+    /// @param mode: false - горизонтальность, true - вертикальность
+    bool areHorizontalVertical(Point* point1, Point* point2, bool mode);
+
+    /// Проверить, является ли линия горизонтальной
+    bool isLineHorizontal(Line* line);
+
+    /// Проверить, является ли линия вертикальной
+    bool isLineVertical(Line* line);
+
+    /// Проверить, являются ли две линии уже параллельными (дубликат ограничения)
+    bool areAlreadyParallel(Line* line1, Line* line2);
+
+    // ====================== Методы работы с ограничениями ======================
+
+    /// Удалить последние добавленные ограничения при ошибке солвера
     void remove_constraints();
-    // ====================== Данные сцены ======================
-    System               sys;                     // геометрический солвер
-    QVector<Line*>       lines;                   // завершённые линии
-    QVector<Point*>       points;                  // все точки (для удобного доступа)
-    std::vector<double*> params;                  // все параметры, передаваемые в солвер
 
-    std::set<LinePair> parallelPairs;           // уже запараллеленные пары (защита от дублей)
+    // ====================== Данные для перемещения объектов ======================
-    std::set<PointPair> P2Ppairs;
-    std::set<PointPair> HORIZ_pairs;
-    std::set<PointPair> VERT_pairs;
 
-    Line* current_line{ nullptr };
+    Point* draggedPoint{ nullptr };  ///< Точка, которую перемещают
-    Point* firstPoint{ nullptr };
+    Line* draggedLine{ nullptr };    ///< Линия, которую перемещают
-    Mode mode{ Mode::None };
+    QPointF dragOffset;              ///< Смещение при начале перемещения
-    bool after_constraint{ false };
 
-    int obj_count{ 0 };            // тег для новых объектов
+    // ====================== Данные геометрической системы ======================
-    int constraints_count{ 0 };   // тег для новых ограничений
 
+    System sys;                      ///< Геометрический солвер
+    QVector<Line*> lines;            ///< Завершённые линии
+    QVector<Point*> points;          ///< Все точки сцены
+    std::vector<double*> params;     ///< Все параметры, передаваемые в солвер
+
+    // ====================== Коллекции ограничений ======================
+
+    std::set<LinePair> parallelPairs;   ///< Пары параллельных линий
+    std::set<PointPair> P2Ppairs;       ///< Пары совпадающих точек
+    std::set<PointPair> HORIZ_pairs;    ///< Пары точек горизонтальных линий
+    std::set<PointPair> VERT_pairs;     ///< Пары точек вертикальных линий
+
+    // ====================== Временные данные для режимов ======================
+
+    Line* current_line{ nullptr };   ///< Текущая линия в режимах рисования/параллельности
+    Point* firstPoint{ nullptr };    ///< Первая точка в режиме совпадения
+    Mode mode{ Mode::None };         ///< Текущий режим работы
+
+    // ====================== Флаги состояния ======================
+
+    bool after_constraint{ false };  ///< Флаг, что только что добавлено ограничение
+
+    // ====================== Счётчики ======================
+
+    int obj_count{ 0 };             ///< Счётчик объектов (для тегов)
+    int constraints_count{ 0 };     ///< Счётчик ограничений (для тегов)
+
+    // ====================== Информация о последнем ограничении ======================
+
+    /// Структура для хранения информации о последнем добавленном ограничении
+    /// (используется для отката при ошибке солвера)
     struct LastConstraint {
-        Mode mode{ Mode::None };
+        Mode mode{ Mode::None };                     ///< Тип последнего ограничения
-        std::variant<LinePair, PointPair> data;
+        std::variant<LinePair, PointPair> data;      ///< Данные ограничения
     };
-    LastConstraint lastConstraint;
+
+    LastConstraint lastConstraint;  ///< Информация о последнем добавленном ограничении
 };