trigo.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * 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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef TRIGO_H
#define TRIGO_H
 
#include <cmath>
#include <math/vector2d.h>
#include <geometry/eda_angle.h>

bool IsPointOnSegment( const VECTOR2I& aSegStart, const VECTOR2I& aSegEnd,
                       const VECTOR2I& aTestPoint );

bool SegmentIntersectsSegment( const VECTOR2I& a_p1_l1, const VECTOR2I& a_p2_l1,
                               const VECTOR2I& a_p1_l2, const VECTOR2I& a_p2_l2,
                               VECTOR2I* aIntersectionPoint = nullptr );

void RotatePoint( int *pX, int *pY, const EDA_ANGLE& aAngle );

inline void RotatePoint( VECTOR2I& point, const EDA_ANGLE& aAngle )
{
    RotatePoint( &point.x, &point.y, aAngle );
}

inline VECTOR2I GetRotated( const VECTOR2I& aVector, const EDA_ANGLE& aAngle )
{
    VECTOR2I result = aVector;
    RotatePoint( &result.x, &result.y, aAngle );
    return result;
}

void RotatePoint( int *pX, int *pY, int cx, int cy, const EDA_ANGLE& aAngle );

inline void RotatePoint( VECTOR2I& aPoint, const VECTOR2I& aCentre, const EDA_ANGLE& aAngle )
{
    RotatePoint( &aPoint.x, &aPoint.y, aCentre.x, aCentre.y, aAngle );
}

inline VECTOR2I GetRotated( const VECTOR2I& aVector, const VECTOR2I& aCentre,
                            const EDA_ANGLE& aAngle )
{
    VECTOR2I result = aVector;
    RotatePoint( &result.x, &result.y, aCentre.x, aCentre.y, aAngle );
    return result;
}
 

void RotatePoint( double* pX, double* pY, const EDA_ANGLE& aAngle );
 
inline void RotatePoint( VECTOR2D& point, const EDA_ANGLE& aAngle )
{
    RotatePoint( &point.x, &point.y, aAngle );
}
 
void RotatePoint( double* pX, double* pY, double cx, double cy, const EDA_ANGLE& aAngle );
 
inline void RotatePoint( VECTOR2D& point, const VECTOR2D& aCenter, const EDA_ANGLE& aAngle )
{
    RotatePoint( &point.x, &point.y, aCenter.x, aCenter.y, aAngle );
}

const VECTOR2I CalcArcCenter( const VECTOR2I& aStart, const VECTOR2I& aMid, const VECTOR2I& aEnd );
const VECTOR2D CalcArcCenter( const VECTOR2D& aStart, const VECTOR2D& aMid, const VECTOR2D& aEnd );
const VECTOR2D CalcArcCenter( const VECTOR2D& aStart, const VECTOR2D& aEnd,
                              const EDA_ANGLE& aAngle );

const VECTOR2I CalcArcMid( const VECTOR2I& aStart, const VECTOR2I& aEnd, const VECTOR2I& aCenter,
                           bool aMinArcAngle = true );

bool TestSegmentHit( const VECTOR2I& aRefPoint, const VECTOR2I& aStart, const VECTOR2I& aEnd,
                     int aDist );
 
// These are the usual degrees <-> radians conversion routines
inline double DEG2RAD( double deg ) { return deg * M_PI / 180.0; }
inline double RAD2DEG( double rad ) { return rad * 180.0 / M_PI; }
 
// These are the same *but* work with the internal 'decidegrees' unit
inline double RAD2DECIDEG( double rad ) { return rad * 1800.0 / M_PI; }
 
/* These are templated over T (and not simply double) because Eeschema
   is still using int for angles in some place */

template <class T> inline T NormalizeAnglePos( T Angle )
{
    while( Angle < 0 )
        Angle += 3600;
    while( Angle >= 3600 )
        Angle -= 3600;
    return Angle;
}
 
template <class T> inline void NORMALIZE_ANGLE_POS( T& Angle )
{
    Angle = NormalizeAnglePos( Angle );
}
 

template <class T> inline T NormalizeAngle180( T Angle )
{
    while( Angle <= -1800 )
        Angle += 3600;
 
    while( Angle > 1800 )
        Angle -= 3600;
 
    return Angle;
}

inline bool InterceptsPositiveX( double aStartAngle, double aEndAngle )
{
    double end = aEndAngle;
 
    if( aStartAngle > aEndAngle )
        end += 360.0;
 
    return aStartAngle < 360.0 && end > 360.0;
}

inline bool InterceptsNegativeX( double aStartAngle, double aEndAngle )
{
    double end = aEndAngle;
 
    if( aStartAngle > aEndAngle )
        end += 360.0;
 
    return aStartAngle < 180.0 && end > 180.0;
}
 
#endif