zone_create_helper.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The 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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef TOOLS_ZONE_CREATE_HELPER__H_
#define TOOLS_ZONE_CREATE_HELPER__H_
 
#include <preview_items/polygon_geom_manager.h>
#include <preview_items/polygon_item.h>
 
#include <tools/drawing_tool.h>
 
namespace KIGFX
{
class VIEW;
}

class ZONE_CREATE_HELPER : public POLYGON_GEOM_MANAGER::CLIENT
{
public:
    struct PARAMS
    {
        bool m_keepout;

        bool m_thieving = false;

        PCB_LAYER_ID m_layer;

        ZONE_MODE m_mode;

        ZONE* m_sourceZone;

        LEADER_MODE m_leaderMode;
    };

    ZONE_CREATE_HELPER( DRAWING_TOOL& aTool, PARAMS& aParams );
 
    virtual ~ZONE_CREATE_HELPER();
 
    ZONE* GetZone() const { return m_zone.get(); }
 
    /*
     * Interface for receiving #POLYGON_GEOM_MANAGER update
     */
    void OnGeometryChange( const POLYGON_GEOM_MANAGER& aMgr ) override;
 
    bool OnFirstPoint( POLYGON_GEOM_MANAGER& aMgr ) override;
 
    void OnComplete( const POLYGON_GEOM_MANAGER& aMgr ) override;

    std::unique_ptr<ZONE> createNewZone( bool aKeepout );

    std::unique_ptr<ZONE> createZoneFromExisting( const ZONE& aSrcZone );

    void performZoneCutout( ZONE& aZone, const ZONE& aCutout );

    void commitZone( std::unique_ptr<ZONE> aZone );
 
private:

    void setUniquePriority( ZONE_SETTINGS& aZoneInfo );
 
    DRAWING_TOOL& m_tool;

    PARAMS& m_params;

    KIGFX::PREVIEW::POLYGON_ITEM m_previewItem;

    KIGFX::VIEW& m_parentView;

    std::unique_ptr<ZONE> m_zone;
};
 
#endif // TOOLS_ZONE_CREATE_HELPER__H_