edit_constraints.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 (C) 2020-2022 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, 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 EDIT_CONSTRAINTS_H_
#define EDIT_CONSTRAINTS_H_
 
#include <math/vector2d.h>
#include <tool/grid_helper.h>
#include <functional>
 
class EDIT_POINT;
class EDIT_LINE;
class EDIT_POINTS;
 
 
enum GRID_CONSTRAINT_TYPE
{
    IGNORE_GRID,
    SNAP_TO_GRID,
    SNAP_BY_GRID    // Keep it on grid if it started on grid (treat x and y independently)
};
 
 
enum SNAP_CONSTRAINT_TYPE
{
    IGNORE_SNAPS,
    OBJECT_LAYERS,
    ALL_LAYERS
};
 
 
template<class EDIT_TYPE>
class EDIT_CONSTRAINT
{
public:
    EDIT_CONSTRAINT( EDIT_TYPE& aConstrained ) :
            m_constrained( aConstrained )
    {};
 
    virtual ~EDIT_CONSTRAINT() {};
 
    virtual void Apply( EDIT_TYPE& aHandle, const GRID_HELPER& aGrid ) = 0;
 
    void Apply( const GRID_HELPER& aGrid )
    {
        Apply( m_constrained, aGrid );
    }
 
protected:
    EDIT_TYPE& m_constrained;      
};
 
 
class EC_VERTICAL : public EDIT_CONSTRAINT<EDIT_POINT>
{
public:
    EC_VERTICAL( EDIT_POINT& aConstrained, const EDIT_POINT& aConstrainer ) :
            EDIT_CONSTRAINT<EDIT_POINT>( aConstrained ),
            m_constrainer( aConstrainer )
    {}
 
    virtual void Apply( EDIT_POINT& aHandle, const GRID_HELPER& aGrid ) override;
 
private:
    const EDIT_POINT& m_constrainer;      
};
 
 
class EC_HORIZONTAL : public EDIT_CONSTRAINT<EDIT_POINT>
{
public:
    EC_HORIZONTAL( EDIT_POINT& aConstrained, const EDIT_POINT& aConstrainer ) :
            EDIT_CONSTRAINT<EDIT_POINT>( aConstrained ),
            m_constrainer( aConstrainer )
    {}
 
    virtual void Apply( EDIT_POINT& aHandle, const GRID_HELPER& aGrid ) override;
 
private:
    const EDIT_POINT& m_constrainer;    
};
 
 
class EC_45DEGREE : public EDIT_CONSTRAINT<EDIT_POINT>
{
public:
    EC_45DEGREE( EDIT_POINT& aConstrained, const EDIT_POINT& aConstrainer ) :
            EDIT_CONSTRAINT<EDIT_POINT>( aConstrained ),
            m_constrainer( aConstrainer )
    {}
 
    virtual void Apply( EDIT_POINT& aHandle, const GRID_HELPER& aGrid ) override;
 
private:
    const EDIT_POINT& m_constrainer;    
};
 
 
class EC_LINE : public EDIT_CONSTRAINT<EDIT_POINT>
{
public:
    EC_LINE( EDIT_POINT& aConstrained, const EDIT_POINT& aConstrainer );
 
    virtual void Apply( EDIT_POINT& aHandle, const GRID_HELPER& aGrid ) override;
 
private:
    const EDIT_POINT& m_constrainer;    
    VECTOR2I m_line;                    
};
 
 
class EC_CIRCLE : public EDIT_CONSTRAINT<EDIT_POINT>
{
public:
    EC_CIRCLE( EDIT_POINT& aConstrained, const EDIT_POINT& aCenter, const EDIT_POINT& aEnd ) :
            EDIT_CONSTRAINT<EDIT_POINT>( aConstrained ),
            m_center( aCenter ),
            m_end( aEnd )
    {}
 
    virtual void Apply( EDIT_POINT& aHandle, const GRID_HELPER& aGrid ) override;
 
private:
    const EDIT_POINT& m_center;
 
    const EDIT_POINT& m_end;
};
 
 
class EC_CONVERGING : public EDIT_CONSTRAINT<EDIT_LINE>
{
public:
    EC_CONVERGING( EDIT_LINE& aLine, EDIT_POINTS& aPoints );
 
    virtual ~EC_CONVERGING();
 
    virtual void Apply( EDIT_LINE& aHandle, const GRID_HELPER& aGrid ) override;
 
private:
    EDIT_CONSTRAINT<EDIT_POINT>* m_originSideConstraint;
 
    EDIT_CONSTRAINT<EDIT_POINT>* m_endSideConstraint;
 
    EDIT_CONSTRAINT<EDIT_POINT>* m_colinearConstraint;
 
    EDIT_POINTS& m_editPoints;
 
    VECTOR2I m_draggedVector;
 
    bool m_originCollinear;
    bool m_endCollinear;
};
 
 
class EC_PERPLINE : public EDIT_CONSTRAINT<EDIT_LINE>
{
public:
 
    EC_PERPLINE( EDIT_LINE& aLine );
 
    virtual ~EC_PERPLINE()
    {}
 
    virtual void Apply( EDIT_LINE& aHandle, const GRID_HELPER& aGrid ) override;
 
private:
    VECTOR2I m_mid;
    VECTOR2I m_line;
};
 
#endif /* EDIT_CONSTRAINTS_H_ */