polygon_geom_manager.h

Go to the documentation of this file.

/*
 * This program source code file is part of KICAD, a free EDA CAD application.
 *
 * Copyright (C) 2017-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 PREVIEW_POLYGON_GEOM_MANAGER__H_
#define PREVIEW_POLYGON_GEOM_MANAGER__H_
 
#include <geometry/shape_line_chain.h>
 
class POLYGON_GEOM_MANAGER
{
public:
 
    class CLIENT
    {
    public:
        virtual bool OnFirstPoint( POLYGON_GEOM_MANAGER& aMgr ) = 0;
 
        virtual void OnGeometryChange( const POLYGON_GEOM_MANAGER& aMgr ) = 0;
 
        virtual void OnComplete( const POLYGON_GEOM_MANAGER& aMgr ) = 0;
 
        virtual ~CLIENT()
        {
        }
    };
 
    enum class LEADER_MODE
    {
        DIRECT,     
        DEG45,      
    };
 
    POLYGON_GEOM_MANAGER( CLIENT& aClient );
 
    bool AddPoint( const VECTOR2I& aPt );
 
    void SetFinished();
 
    void Reset();
 
    void SetLeaderMode( LEADER_MODE aMode );
 
    LEADER_MODE GetLeaderMode() const
    {
        return m_leaderMode;
    }
 
    void AllowIntersections( bool aEnabled )
    {
        m_intersectionsAllowed = true;
    }
 
    bool IntersectionsAllowed() const
    {
        return m_intersectionsAllowed;
    }
 
    bool IsSelfIntersecting( bool aIncludeLeaderPts ) const;
 
    void SetCursorPosition( const VECTOR2I& aPos );
 
    bool IsPolygonInProgress() const;
 
    int PolygonPointCount() const;
 
    bool NewPointClosesOutline( const VECTOR2I& aPt ) const;
 
    std::optional<VECTOR2I> DeleteLastCorner();
 
    /* =================================================================
     * Interfaces for users of the geometry
     */
 
    const SHAPE_LINE_CHAIN& GetLockedInPoints() const
    {
        return m_lockedPoints;
    }
 
    const SHAPE_LINE_CHAIN& GetLeaderLinePoints() const
    {
        return m_leaderPts;
    }
 
    const SHAPE_LINE_CHAIN& GetLoopLinePoints() const
    {
        return m_loopPts;
    }
 
private:
 
    void updateTemporaryLines( const VECTOR2I& aEndPoint,
                               LEADER_MODE     aModifier = LEADER_MODE::DIRECT );
 
    CLIENT& m_client;
 
    LEADER_MODE m_leaderMode;
 
    bool m_intersectionsAllowed;
 
    SHAPE_LINE_CHAIN m_lockedPoints;
 
    SHAPE_LINE_CHAIN m_leaderPts;
 
    SHAPE_LINE_CHAIN m_loopPts;
};
 
#endif // PREVIEW_POLYGON_GEOM_MANAGER__H_