kicad/libs/kimath/include/geometry/chamfer.h

62 lines
2.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.
*
* @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
*
* 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 __CHAMFER_H
#define __CHAMFER_H
#include <optional>
#include <geometry/seg.h>
/**
* Parameters that define a simple chamfer operation.
*/
struct CHAMFER_PARAMS
{
/// Chamfer set-back distance along the first line
int m_chamfer_setback_a_IU;
/// Chamfer set-back distance along the second line
int m_chamfer_setback_b_IU;
};
struct CHAMFER_RESULT
{
// The chamfer segment
SEG m_chamfer;
// The updated original segments
// These can be empty if the chamfer "consumed" "he original segments
std::optional<SEG> m_updated_seg_a;
std::optional<SEG> m_updated_seg_b;
};
/**
* Compute the chamfer points for a given line pair and chamfer parameters.
*/
std::optional<CHAMFER_RESULT> ComputeChamferPoints( const SEG aSegA, const SEG& aSegB,
const CHAMFER_PARAMS& aChamferParams );
#endif