boardeditorstate_drawtrace.h

Go to the documentation of this file.

/*
 * LibrePCB - Professional EDA for everyone!
 * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
 * https://librepcb.org/
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef LIBREPCB_EDITOR_BOARDEDITORSTATE_DRAWTRACE_H
#define LIBREPCB_EDITOR_BOARDEDITORSTATE_DRAWTRACE_H
 
/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include "boardeditorstate.h"
 
#include <librepcb/core/geometry/via.h>
#include <librepcb/core/project/circuit/netclass.h>
 
#include <QtCore>
 
/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {
 
class BI_NetLine;
class BI_NetLineAnchor;
class BI_NetPoint;
class BI_NetSegment;
class BI_Pad;
class BI_Via;
class Layer;
class NetSignal;
 
namespace editor {
 
/*******************************************************************************
 *  Class BoardEditorState_DrawTrace
 ******************************************************************************/
 
class BoardEditorState_DrawTrace final : public BoardEditorState {
  Q_OBJECT
 
public:
  enum class WireMode {
    HV,  
    VH,  
    Deg9045,  
    Deg4590,  
    Straight,  
    _COUNT,
  };
 
  // Constructors / Destructor
  BoardEditorState_DrawTrace() = delete;
  BoardEditorState_DrawTrace(const BoardEditorState_DrawTrace& other) = delete;
  explicit BoardEditorState_DrawTrace(const Context& context) noexcept;
  virtual ~BoardEditorState_DrawTrace() noexcept;
 
  // General Methods
  virtual bool entry() noexcept override;
  virtual bool exit() noexcept override;
 
  // Event Handlers
  virtual bool processAbortCommand() noexcept override;
  virtual bool processKeyPressed(
      const GraphicsSceneKeyEvent& e) noexcept override;
  virtual bool processKeyReleased(
      const GraphicsSceneKeyEvent& e) noexcept override;
  virtual bool processGraphicsSceneMouseMoved(
      const GraphicsSceneMouseEvent& e) noexcept override;
  virtual bool processGraphicsSceneLeftMouseButtonPressed(
      const GraphicsSceneMouseEvent& e) noexcept override;
  virtual bool processGraphicsSceneLeftMouseButtonDoubleClicked(
      const GraphicsSceneMouseEvent& e) noexcept override;
  virtual bool processGraphicsSceneRightMouseButtonReleased(
      const GraphicsSceneMouseEvent& e) noexcept override;
 
  // Connection to UI
  NetClass* getNetClass() const noexcept { return mCurrentNetClass; }
  WireMode getWireMode() const noexcept { return mCurrentWireMode; }
  void setWireMode(WireMode mode) noexcept;
  QSet<const Layer*> getAvailableLayers() noexcept;
  const Layer& getLayer() const noexcept { return *mCurrentLayer; }
  void setLayer(const Layer& layer) noexcept;
  bool getAutoWidth() const noexcept { return mCurrentAutoWidth; }
  void setAutoWidth(bool autoWidth) noexcept;
  const PositiveLength& getWidth() const noexcept { return mCurrentWidth; }
  void setWidth(const PositiveLength& width) noexcept;
  void saveWidthInBoard() noexcept;
  void saveWidthInNetClass() noexcept;
  bool getViaAutoDrillDiameter() const noexcept {
    return !mCurrentViaProperties.getDrillDiameter().has_value();
  }
  PositiveLength getViaDrillDiameter() const noexcept;
  void setViaDrillDiameter(
      const std::optional<PositiveLength>& diameter) noexcept;
  void saveViaDrillDiameterInBoard() noexcept;
  void saveViaDrillDiameterInNetClass() noexcept;
  bool getAutoViaSize() const noexcept {
    return !mCurrentViaProperties.getSize().has_value();
  }
  PositiveLength getViaSize() const noexcept;
  void setViaSize(const std::optional<PositiveLength>& size) noexcept;
 
  // Operator Overloadings
  BoardEditorState_DrawTrace& operator=(const BoardEditorState_DrawTrace& rhs) =
      delete;
 
signals:
  void netClassChanged(NetClass* nc);
  void wireModeChanged(WireMode mode);
  void layerChanged(const Layer& layer);
  void autoWidthChanged(bool autoWidth);
  void widthChanged(const PositiveLength& width);
  void viaDrillDiameterChanged(bool autoSize, const PositiveLength& diameter);
  void viaSizeChanged(bool autoSize, const PositiveLength& size);
 
private:
  enum SubState {
    SubState_Idle,  
    SubState_Initializing,  
    SubState_PositioningNetPoint  
  };
 
  bool startPositioning(Board& board, const Point& pos,
                        bool autoWidthFromExistingTraces = true,
                        BI_NetPoint* fixedPoint = nullptr,
                        BI_Via* fixedVia = nullptr,
                        BI_Pad* fixedPad = nullptr) noexcept;
 
  bool addNextNetPoint(BoardGraphicsScene& scene) noexcept;
 
  bool abortPositioning(bool showErrMsgBox, bool simplifySegment) noexcept;
 
  void updateNetpointPositions() noexcept;
 
  void showVia(bool isVisible) noexcept;
 
  BI_NetLineAnchor* combineAnchors(BI_NetLineAnchor& a, BI_NetLineAnchor& b);
 
  Point calcMiddlePointPos(const Point& p1, const Point p2,
                           WireMode mode) const noexcept;
 
  void updateNetClass() noexcept;
 
  // State
  SubState mSubState;  
  QPointer<NetClass> mCurrentNetClass;  
  WireMode mCurrentWireMode;  
  const Layer* mCurrentLayer;  
  bool mAddVia;  
  BI_Via* mTempVia;
  Via mCurrentViaProperties;  
  const Layer* mViaLayer;  
  Point mTargetPos;  
 
  Point mCursorPos;  
  PositiveLength mCurrentWidth;  
  bool mCurrentAutoWidth;  
  bool mCurrentSnapActive;  
  BI_NetLineAnchor* mFixedStartAnchor;  
  BI_NetSegment* mCurrentNetSegment;  
  BI_NetLine* mPositioningNetLine1;  
  BI_NetPoint* mPositioningNetPoint1;  
  BI_NetLine* mPositioningNetLine2;  
  BI_NetPoint* mPositioningNetPoint2;  
};
 
/*******************************************************************************
 *  End of File
 ******************************************************************************/
 
}  // namespace editor
}  // namespace librepcb
 
#endif