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 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, 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
 */

 
#pragma once
 
#include <algorithm>
#include <math.h>           // for copysign
#include <stdlib.h>         // for abs
#include <math/box2.h>
#include <geometry/eda_angle.h>
#include <geometry/shape_line_chain.h>
#include <geometry/shape_rect.h>
#include <geometry/shape_simple.h>
#include <geometry/shape_compound.h>

enum class LEADER_MODE
{
    DIRECT, 
    DEG45,  
    DEG90   
};

int GetArcToSegmentCount( int aRadius, int aErrorMax, const EDA_ANGLE& aArcAngle );

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 )
{
    using ext_type = typename VECTOR2<T>::extended_type;
 
    auto             newVec = aVec;
    const VECTOR2<T> absVec{ std::abs( aVec.x ), std::abs( aVec.y ) };
 
    if( !only45 && absVec.x > ext_type( absVec.y ) * 2 )
    {
        // snap along x-axis
        newVec.y = 0;
    }
    else if( !only45 && absVec.y > ext_type( 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 T>
VECTOR2<T> GetVectorSnapped90( const VECTOR2<T>& aVec )
{
    auto             newVec = aVec;
    const VECTOR2<T> absVec{ std::abs( aVec.x ), std::abs( aVec.y ) };
 
    if( absVec.x >= absVec.y )
        newVec.y = 0;
    else
        newVec.x = 0;
 
    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 = 1u )
{
    typedef std::numeric_limits<int32_t> coord_limits;
 
    in_type x = aCoords.x;
    in_type y = aCoords.y;
 
    if constexpr( !std::is_floating_point_v<in_type> )
    {
        int64_t max = static_cast<int64_t>( coord_limits::max() ) - aPadding;
        int64_t min = -max;
        x = std::clamp<int64_t>( static_cast<int64_t>( x ), min, max );
        y = std::clamp<int64_t>( static_cast<int64_t>( y ), min, max );
    }
    else
    {
        double max = static_cast<double>( coord_limits::max() ) - aPadding;
        double min = -max;
        x = std::clamp<double>( static_cast<double>( x ), min, max );
        y = std::clamp<double>( static_cast<double>( y ), min, max );
    }
 
    if constexpr( !std::is_integral_v<in_type> && std::is_integral_v<ret_type> )
    {
        return VECTOR2<ret_type>( KiROUND<in_type, ret_type>( x, true ),
                                  KiROUND<in_type, ret_type>( y, true ) );
    }
    else
    {
        return VECTOR2<ret_type>( x, y );
    }
}
 

template <typename T>
inline bool IsVec2SafeXY( const VECTOR2<T>& aVec )
{
    constexpr T min = std::numeric_limits<int>::min();
    constexpr T max = std::numeric_limits<int>::max();
 
    return aVec.x > min && aVec.x < max && aVec.y > min && aVec.y < max;
}
 

bool ClipLine( const BOX2I *aClipBox, int &x1, int &y1, int &x2, int &y2 );
 
 
namespace KIGEOM
{
bool BoxHitTest( const VECTOR2I& aHitPoint, const BOX2I& aHittee, int aAccuracy );

bool BoxHitTest( const BOX2I& aHitter, const BOX2I& aHittee, bool aHitteeContained, int aAccuracy );

bool BoxHitTest( const SHAPE_LINE_CHAIN& aHitter, const BOX2I& aHittee, bool aHitteeContained );

bool BoxHitTest( const SHAPE_LINE_CHAIN& aHitter, const BOX2I& aHittee, const EDA_ANGLE& aHitteeRotation,
                 const VECTOR2I& aHitteeRotationCenter, bool aHitteeContained );

bool ShapeHitTest( const SHAPE_LINE_CHAIN& aHitter, const SHAPE& aHittee, bool aHitteeContained );
}; // namespace KIGEOM