kicad/include/tool/edit_constraints.h

264 lines
7.6 KiB
C
Raw Normal View History

/*
* 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.
2020-12-27 00:41:04 +00:00
*
* @author Maciej Suminski <maciej.suminski@cern.ch>
*
* 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
};
/**
2020-12-27 00:41:04 +00:00
* Describe constraints between two edit handles.
*
2020-12-27 00:41:04 +00:00
* After the constrained handle is changed, Apply() has to be called to fix its coordinates
* according to the implemented constraint.
*/
template<class EDIT_TYPE>
class EDIT_CONSTRAINT
{
public:
/**
* @param aConstrained is EDIT_POINT to which the constraint is applied.
*/
EDIT_CONSTRAINT( EDIT_TYPE& aConstrained ) :
m_constrained( aConstrained )
{};
virtual ~EDIT_CONSTRAINT() {};
/**
2020-12-27 00:41:04 +00:00
* Correct coordinates of the constrained edit handle.
*/
virtual void Apply( EDIT_TYPE& aHandle, const GRID_HELPER& aGrid ) = 0;
/**
2020-12-27 00:41:04 +00:00
* Correct coordinates of the constrained edit handle.
*/
void Apply( const GRID_HELPER& aGrid )
{
Apply( m_constrained, aGrid );
}
protected:
2020-12-27 00:41:04 +00:00
EDIT_TYPE& m_constrained; ///< Point that is constrained by rules implemented by Apply().
};
/**
2020-12-27 00:41:04 +00:00
* #EDIT_CONSTRAINT that imposes a constraint that two points have to have the same X coordinate.
*/
class EC_VERTICAL : public EDIT_CONSTRAINT<EDIT_POINT>
{
public:
/**
* @param aConstrained is the point that is put under constrain.
* @param aConstrainer is the point that is the source of the constrain.
*/
EC_VERTICAL( EDIT_POINT& aConstrained, const EDIT_POINT& aConstrainer ) :
EDIT_CONSTRAINT<EDIT_POINT>( aConstrained ),
m_constrainer( aConstrainer )
{}
2020-12-27 00:41:04 +00:00
///< @copydoc EDIT_CONSTRAINT::Apply()
virtual void Apply( EDIT_POINT& aHandle, const GRID_HELPER& aGrid ) override;
private:
const EDIT_POINT& m_constrainer; ///< Point that imposes the constraint.
};
/**
2020-12-27 00:41:04 +00:00
* #EDIT_CONSTRAINT that imposes a constraint that two points have to have the same Y coordinate.
*/
class EC_HORIZONTAL : public EDIT_CONSTRAINT<EDIT_POINT>
{
public:
/**
* @param aConstrained is the point that is put under constrain.
* @param aConstrainer is the point that is the source of the constrain.
*/
EC_HORIZONTAL( EDIT_POINT& aConstrained, const EDIT_POINT& aConstrainer ) :
EDIT_CONSTRAINT<EDIT_POINT>( aConstrained ),
m_constrainer( aConstrainer )
{}
2020-12-27 00:41:04 +00:00
///< @copydoc EDIT_CONSTRAINT::Apply()
virtual void Apply( EDIT_POINT& aHandle, const GRID_HELPER& aGrid ) override;
private:
const EDIT_POINT& m_constrainer; ///< Point that imposes the constraint.
};
/**
2020-12-27 00:41:04 +00:00
* #EDIT_CONSTRAINT that imposes a constraint that two points have to be located at angle of 45
* degree multiplicity.
*/
class EC_45DEGREE : public EDIT_CONSTRAINT<EDIT_POINT>
{
public:
/**
* @param aConstrained is the point that is put under constrain.
* @param aConstrainer is the point that is the source of the constrain.
*/
EC_45DEGREE( EDIT_POINT& aConstrained, const EDIT_POINT& aConstrainer ) :
EDIT_CONSTRAINT<EDIT_POINT>( aConstrained ),
m_constrainer( aConstrainer )
{}
2020-12-27 00:41:04 +00:00
///< @copydoc EDIT_CONSTRAINT::Apply()
virtual void Apply( EDIT_POINT& aHandle, const GRID_HELPER& aGrid ) override;
private:
const EDIT_POINT& m_constrainer; ///< Point that imposes the constraint.
};
/**
2020-12-27 00:41:04 +00:00
* #EDIT_CONSTRAINT that imposes a constraint that a point has to lie on a line (determined
* by 2 points).
*/
class EC_LINE : public EDIT_CONSTRAINT<EDIT_POINT>
{
public:
EC_LINE( EDIT_POINT& aConstrained, const EDIT_POINT& aConstrainer );
2020-12-27 00:41:04 +00:00
///< @copydoc EDIT_CONSTRAINT::Apply()
virtual void Apply( EDIT_POINT& aHandle, const GRID_HELPER& aGrid ) override;
private:
const EDIT_POINT& m_constrainer; ///< Point that imposes the constraint.
VECTOR2I m_line; ///< Vector representing the constraining line.
};
/**
2020-12-27 00:41:04 +00:00
* #EDIT_CONSTRAINT that imposes a constraint that a point has to lie on a circle.
*/
class EC_CIRCLE : public EDIT_CONSTRAINT<EDIT_POINT>
{
public:
/**
* @param aConstrained is the point that is put under constrain.
* @param aCenter is the point that is the center of the circle.
* @param aEnd is the point that decides on the radius of the circle.
*/
EC_CIRCLE( EDIT_POINT& aConstrained, const EDIT_POINT& aCenter, const EDIT_POINT& aEnd ) :
EDIT_CONSTRAINT<EDIT_POINT>( aConstrained ),
m_center( aCenter ),
m_end( aEnd )
{}
2020-12-27 00:41:04 +00:00
///< @copydoc EDIT_CONSTRAINT::Apply()
virtual void Apply( EDIT_POINT& aHandle, const GRID_HELPER& aGrid ) override;
private:
2020-12-27 00:41:04 +00:00
///< Point that imposes the constraint (center of the circle).
const EDIT_POINT& m_center;
2020-12-27 00:41:04 +00:00
///< Point that imposes the constraint (decides on the radius of the circle).
const EDIT_POINT& m_end;
};
/**
2020-12-27 00:41:04 +00:00
* #EDIT_CONSTRAINT for 3 segments: dragged and two adjacent ones, enforcing to keep their slopes
* and allows only to change ending points. Applied to zones.
*/
class EC_CONVERGING : public EDIT_CONSTRAINT<EDIT_LINE>
{
public:
EC_CONVERGING( EDIT_LINE& aLine, EDIT_POINTS& aPoints );
virtual ~EC_CONVERGING();
2020-12-27 00:41:04 +00:00
///< @copydoc EDIT_CONSTRAINT::Apply()
virtual void Apply( EDIT_LINE& aHandle, const GRID_HELPER& aGrid ) override;
private:
2020-12-27 00:41:04 +00:00
///< Constraint for origin side segment.
EDIT_CONSTRAINT<EDIT_POINT>* m_originSideConstraint;
2020-12-27 00:41:04 +00:00
///< Constraint for end side segment.
EDIT_CONSTRAINT<EDIT_POINT>* m_endSideConstraint;
2020-12-27 00:41:04 +00:00
///< Additional constraint, applied when at least two points are collinear. It is a pointer to
///< m_[origin/end]SideConstraint, so it should not be freed.
EDIT_CONSTRAINT<EDIT_POINT>* m_colinearConstraint;
2020-12-27 00:41:04 +00:00
///< EDIT_POINTS instance that stores currently modified lines.
EDIT_POINTS& m_editPoints;
2020-12-27 00:41:04 +00:00
///< Vector that represents the initial direction of the dragged segment.
VECTOR2I m_draggedVector;
};
/**
2020-12-27 00:41:04 +00:00
* #EDIT_CONSTRAINT for a EDIT_LINE, that constrains the line to move perpendicular
* to the line itself.
*/
class EC_PERPLINE : public EDIT_CONSTRAINT<EDIT_LINE>
{
public:
EC_PERPLINE( EDIT_LINE& aLine );
virtual ~EC_PERPLINE()
{}
2020-12-27 00:41:04 +00:00
///< @copydoc EDIT_CONSTRAINT::Apply()
virtual void Apply( EDIT_LINE& aHandle, const GRID_HELPER& aGrid ) override;
private:
VECTOR2I m_mid;
VECTOR2I m_line;
};
#endif /* EDIT_CONSTRAINTS_H_ */