zone_filler_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) 2014 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Maciej Suminski <[email protected]>
 *
 * 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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef ZONE_FILLER_TOOL_H
#define ZONE_FILLER_TOOL_H
 
#include <tools/pcb_tool_base.h>
#include <zone.h>
 
 
class PCB_EDIT_FRAME;
class PROGRESS_REPORTER;
class WX_PROGRESS_REPORTER;
class ZONE_FILLER;
class PCB_GENERATOR;
class BOARD_COMMIT;
 
#define ZONE_FILLER_TOOL_NAME "pcbnew.ZoneFiller"

class ZONE_FILLER_TOOL : public PCB_TOOL_BASE
{
public:
    ZONE_FILLER_TOOL();
    ~ZONE_FILLER_TOOL();

    void Reset( RESET_REASON aReason ) override;
 
    void CheckAllZones( wxWindow* aCaller, PROGRESS_REPORTER* aReporter = nullptr );
    void FillAllZones( wxWindow* aCaller, PROGRESS_REPORTER* aReporter = nullptr, bool aHeadless = false );

    void PostFillRefresh( bool aHeadless = false );
 
    int ZoneFill( const TOOL_EVENT& aEvent );
    int ZoneFillAll( const TOOL_EVENT& aEvent );
    int ZoneFillDirty( const TOOL_EVENT& aEvent );
    int ZoneUnfill( const TOOL_EVENT& aEvent );
    int ZoneUnfillAll( const TOOL_EVENT& aEvent );
 
    bool IsBusy() { return m_fillInProgress; }
 
    PROGRESS_REPORTER* GetProgressReporter();
 
    void DirtyZone( ZONE* aZone )
    {
        m_dirtyZoneIDs.insert( aZone->m_Uuid );
    }
 
    static bool IsZoneFillAction( const TOOL_EVENT* aEvent );
 
private:
    void singleShotRefocus( wxIdleEvent& );
 
    void rebuildConnectivity( bool aHeadless = false );
    void refresh();

    std::vector<PCB_GENERATOR*> regenerateDirtyGenerators( BOARD_COMMIT& aCommit );

    void refillAroundGenerators( const std::vector<PCB_GENERATOR*>& aRegenerated );

    void setTransitions() override;
 
private:
    std::unique_ptr<ZONE_FILLER> m_filler;
    bool                         m_fillInProgress;
 
    std::set<KIID>               m_dirtyZoneIDs;
};
 
#endif