shape_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) 2024 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 <array>
#include <optional>
 
#include <math/vector2d.h>
#include <math/box2.h>
 
#include <geometry/direction45.h>
 
class CIRCLE;
class HALF_LINE;
class LINE;
class SEG;
class SHAPE_RECT;
class SHAPE_POLY_SET;
struct TYPED_POINT2I;
 
namespace KIGEOM
{
 
SEG NormalisedSeg( const SEG& aSeg );
 
const VECTOR2I& GetOtherEnd( const SEG& aSeg, const VECTOR2I& aPoint );
 
OPT_VECTOR2I GetSharedEndpoint( const SEG& aSegA, const SEG& aSegB );
 
std::array<SEG, 4> BoxToSegs( const BOX2I& aBox );
 
void CollectBoxCorners( const BOX2I& aBox, std::vector<VECTOR2I>& aCorners );
 
std::vector<SEG> GetSegsInDirection( const BOX2I& aBox, DIRECTION_45::Directions aDir );
 
std::optional<SEG> ClipHalfLineToBox( const HALF_LINE& aRay, const BOX2I& aBox );
 
std::optional<SEG> ClipLineToBox( const LINE& aLine, const BOX2I& aBox );
 
 
SHAPE_ARC MakeArcCw90( const VECTOR2I& aCenter, int aRadius, DIRECTION_45::Directions aDir );
 
SHAPE_ARC MakeArcCw180( const VECTOR2I& aCenter, int aRadius, DIRECTION_45::Directions aDir );
 
VECTOR2I GetPoint( const SHAPE_RECT& aRect, DIRECTION_45::Directions aDir, int aOutset = 0 );
 
 
std::vector<TYPED_POINT2I> GetCircleKeyPoints( const CIRCLE& aCircle, bool aIncludeCenter );
 
 
/*
 * Take a polygon and 'rectify' it, so that all sides are H/V.
 *
 * The entire original polygon is contained within the new one.
 * The new polygon will pass though each original corner,
 * but it can have additional corners, or corners can be simplified away.
 *
 * E.g.:
 *     ____           _______
 *    /    \___    -> |     |___
 *    |________\      |_________|
 */
SHAPE_LINE_CHAIN RectifyPolygon( const SHAPE_LINE_CHAIN& aPoly );
 
 
bool AddHoleIfValid( SHAPE_POLY_SET& aOutline, SHAPE_LINE_CHAIN&& aHole );
 
 
std::vector<VECTOR2I> MakeRegularPolygonPoints( const VECTOR2I& aCenter, size_t aN,
                                                const VECTOR2I& aPt0 );
 
std::vector<VECTOR2I> MakeRegularPolygonPoints( const VECTOR2I& aCenter, size_t aN, int aRadius,
                                                bool aAcrossCorners, EDA_ANGLE aAngle );
 
std::vector<SEG> MakeCrossSegments( const VECTOR2I& aCenter, const VECTOR2I& aSize,
                                    EDA_ANGLE aAngle );
 
} // namespace KIGEOM