sch_line_wire_bus_tool.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2019 CERN
 * Copyright (C) 2019-2023 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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 2
 * 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */
 
#ifndef SCH_LINE_WIRE_BUS_TOOL_H
#define SCH_LINE_WIRE_BUS_TOOL_H
 
#include <wx/string.h>
#include <string>
#include <vector>
 
#include <math/vector2d.h>
#include <sch_edit_frame.h>
#include <sch_line.h>
 
#include <ee_tool_base.h>
 
class TOOL_EVENT;
 
class SCH_BUS_WIRE_ENTRY;
class SCH_LABEL;
class SCH_EDIT_FRAME;
class EE_SELECTION_TOOL;
 
 
struct BUS_UNFOLDING_T
{
    bool in_progress;   
    bool flipX;         
    bool flipY;         
    bool label_placed;  
 
    VECTOR2I origin;   
    wxString net_name;  
 
    SCH_BUS_WIRE_ENTRY* entry;
    SCH_LABEL* label;
};
 
 
struct DRAW_SEGMENT_EVENT_PARAMS
{
    SCH_LAYER_ID layer;
    bool         quitOnDraw;
    SCH_LINE*    sourceSegment;
};
 
class SCH_LINE_WIRE_BUS_TOOL : public EE_TOOL_BASE<SCH_EDIT_FRAME>
{
public:
    SCH_LINE_WIRE_BUS_TOOL();
    ~SCH_LINE_WIRE_BUS_TOOL();
 
    bool Init() override;
 
    int DrawSegments( const TOOL_EVENT& aEvent );
    int UnfoldBus( const TOOL_EVENT& aEvent );
 
    // SELECTION_CONDITIONs:
    static bool IsDrawingLineWireOrBus( const SELECTION& aSelection );
 
    int AddJunctionsIfNeeded( SCH_COMMIT* aCommit, EE_SELECTION* aSelection );
 
    int TrimOverLappingWires( SCH_COMMIT* aCommit, EE_SELECTION* aSelection );
 
private:
    int doDrawSegments( const TOOL_EVENT& aTool, int aType, bool aQuitOnDraw );
 
    SCH_LINE* startSegments( int aType, const VECTOR2D& aPos, SCH_LINE* aSegment = nullptr );
 
    SCH_LINE* getBusForUnfolding();
 
    SCH_LINE* doUnfoldBus( const wxString&                aNet,
                           const std::optional<VECTOR2I>& aPos = std::nullopt );
 
    void finishSegments();
 
    void simplifyWireList();
 
    void setTransitions() override;
 
    const SCH_SHEET_PIN* getSheetPin( const VECTOR2I& aPosition );
 
    void computeBreakPoint( const std::pair<SCH_LINE*, SCH_LINE*>& aSegments, VECTOR2I& aPosition,
                            LINE_MODE mode, bool posture );
 
private:
    bool                    m_inDrawingTool;   // Reentrancy guard
 
    BUS_UNFOLDING_T         m_busUnfold;
    std::vector<SCH_LINE*>  m_wires;           // Lines being drawn
};
 
#endif /* SCH_LINE_WIRE_BUS_TOOL_H */