geometry_utils.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 1992-2021 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 GEOMETRY_UTILS_H
#define GEOMETRY_UTILS_H

#include <math.h> // for copysign
#include <stdlib.h> // for abs

#include <math/vector2d.h>

class EDA_RECT;

enum ERROR_LOC { ERROR_OUTSIDE, ERROR_INSIDE };

int GetArcToSegmentCount( int aRadius, int aErrorMax, double aArcAngleDegree );

int CircleToEndSegmentDeltaRadius( int aInnerCircleRadius, int aSegCount );

class DISABLE_ARC_RADIUS_CORRECTION
{
public:
 DISABLE_ARC_RADIUS_CORRECTION();
 ~DISABLE_ARC_RADIUS_CORRECTION();
};

int GetCircleToPolyCorrection( int aMaxError );

template<typename T>
VECTOR2<T> GetVectorSnapped45( const VECTOR2<T>& aVec, bool only45 = false )
{
 auto newVec = aVec;
 const VECTOR2<T> absVec { std::abs( aVec.x ), std::abs( aVec.y ) };

 if ( !only45 && absVec.x > absVec.y * 2 )
 {
 // snap along x-axis
 newVec.y = 0;
 }
 else if ( !only45 && absVec.y > absVec.x * 2 )
 {
 // snap onto y-axis
 newVec.x = 0;
 }
 else if ( absVec.x > absVec.y )
 {
 // snap away from x-axis towards 45
 newVec.y = std::copysign( aVec.x, aVec.y );
 } else
 {
 // snap away from y-axis towards 45
 newVec.x = std::copysign( aVec.y, aVec.x );
 }

 return newVec;
}


template <typename in_type, typename ret_type = in_type, typename pad_type = unsigned int,
 typename = typename std::enable_if<std::is_unsigned<pad_type>::value>::type>
VECTOR2<ret_type> GetClampedCoords( const VECTOR2<in_type>& aCoords, pad_type aPadding = 0u )
{
 typedef std::numeric_limits<int> coord_limits;

 long max = coord_limits::max() - aPadding;
 long min = -max;

 in_type x = aCoords.x;
 in_type y = aCoords.y;

 if( x < min )
 x = min;
 else if( x > max )
 x = max;

 if( y < min )
 y = min;
 else if( y > max )
 y = max;

 if( !std::is_integral<in_type>() && std::is_integral<ret_type>() )
 return VECTOR2<ret_type>( KiROUND( x ), KiROUND( y ) );

 return VECTOR2<ret_type>( x, y );
}


bool ClipLine( const EDA_RECT *aClipBox, int &x1, int &y1, int &x2, int &y2 );


constexpr double dot_mark_len( double aLineWidth )
{
 return std::max( 1.0, aLineWidth );
}

constexpr double dash_gap_len( double aLineWidth )
{
 return 3.0 * dot_mark_len( aLineWidth ) + ( 2.0 * aLineWidth );
}

constexpr double dash_mark_len( double aLineWidth )
{
 return std::max( dash_gap_len( aLineWidth ), 5.0 * dot_mark_len( aLineWidth ) );
}

#endif // #ifndef GEOMETRY_UTILS_H