mirror of
https://gitlab.com/kicad/code/kicad.git
synced 2024-11-28 00:31:20 +00:00
1d2fb3ec82
Makes it easier to reason about oval shapes in geometric terms. For now, this isn't a SHAPE, but it could be (and it's a fairly common primitive, so it could be useful, though the obvious use (clearance) is equivalent to a SEG with a clearance, which is already a function that exists.
140 lines
4.0 KiB
C++
140 lines
4.0 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2023 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 <vector>
|
|
|
|
#include <math/box2.h>
|
|
#include <math/vector2d.h>
|
|
#include <geometry/approximation.h>
|
|
#include <geometry/eda_angle.h>
|
|
#include <geometry/point_types.h>
|
|
#include <geometry/seg.h>
|
|
|
|
|
|
class SHAPE_LINE_CHAIN;
|
|
|
|
/**
|
|
* Class that represents an oval shape (rectangle with semicircular end caps)
|
|
*
|
|
* This is not a full-blown SHAPE (yet), but can be used for some simple
|
|
* purposes, as well as for type-based logic.
|
|
*/
|
|
class OVAL
|
|
{
|
|
public:
|
|
/**
|
|
* Create an oval from the segment joining the centers of the semicircles
|
|
* and the diameter of the semicircles.
|
|
*/
|
|
OVAL( const SEG& aSeg, int aWidth );
|
|
|
|
/**
|
|
* Create an oval from the overall size, the center of the oval, and the rotation.
|
|
*
|
|
* The shorter dimension is the width of the semicircles.
|
|
*/
|
|
OVAL( const VECTOR2I& aOverallSize, const VECTOR2I& aCenter, const EDA_ANGLE& aRotation );
|
|
|
|
/**
|
|
* Get the bounding box of the oval
|
|
*/
|
|
BOX2I BBox( int aClearance ) const;
|
|
|
|
/**
|
|
* Get the width of the oval (diameter of the semicircles)
|
|
*/
|
|
int GetWidth() const { return m_width; }
|
|
|
|
/**
|
|
* Get the overall length of the oval from endcap tip to endcap tip
|
|
*/
|
|
int GetLength() const { return m_seg.Length() + m_width; }
|
|
|
|
/**
|
|
* Get the side length of the oval (=length between the centers of the semicircles)
|
|
*/
|
|
int GetSideLength() const { return m_seg.Length(); }
|
|
|
|
/**
|
|
* Get the center point of the oval.
|
|
*/
|
|
VECTOR2I GetCenter() const { return m_seg.Center(); }
|
|
|
|
/**
|
|
* Get the central segment of the oval
|
|
*
|
|
* (Endpoint are the centers of the semicircles)
|
|
*/
|
|
const SEG& GetSegment() const { return m_seg; }
|
|
|
|
/**
|
|
* Get the angle of the oval's central segment.
|
|
*
|
|
* The direction is aligned with the segment start/end
|
|
*/
|
|
EDA_ANGLE GetAngle() const { return EDA_ANGLE( m_seg.B - m_seg.A ); }
|
|
|
|
private:
|
|
SEG m_seg;
|
|
int m_width;
|
|
};
|
|
|
|
namespace KIGEOM
|
|
{
|
|
|
|
SHAPE_LINE_CHAIN ConvertToChain( const OVAL& aOval );
|
|
|
|
|
|
enum OVAL_KEY_POINTS
|
|
{
|
|
OVAL_CENTER = 1 << 0,
|
|
OVAL_CAP_TIPS = 1 << 1,
|
|
OVAL_CAP_CENTERS = 1 << 2,
|
|
OVAL_SIDE_MIDPOINTS = 1 << 3,
|
|
OVAL_SIDE_ENDS = 1 << 4,
|
|
OVAL_CARDINAL_EXTREMES = 1 << 5,
|
|
OVAL_ALL_KEY_POINTS = 0xFF
|
|
};
|
|
|
|
using OVAL_KEY_POINT_FLAGS = unsigned int;
|
|
|
|
/**
|
|
* @brief Get a list of interesting points on an oval (rectangle
|
|
* with semicircular end caps)
|
|
*
|
|
* This may includes:
|
|
* - The middles of the sides
|
|
* - The tips of the end caps
|
|
* - The extreme cardinal points of the whole oval (if rotated non-cardinally)
|
|
*
|
|
* @param aOvalSize - The size of the oval (overall length and width)
|
|
* @param aRotation - The rotation of the oval
|
|
* @param aFlags - The flags indicating which points to return
|
|
*
|
|
* @return std::vector<TYPED_POINT2I> - The list of points and their geomtrical types
|
|
*/
|
|
std::vector<TYPED_POINT2I> GetOvalKeyPoints( const OVAL& aOval, OVAL_KEY_POINT_FLAGS aFlags );
|
|
|
|
} // namespace KIGEOM
|