KiCad PCB EDA Suite
Loading...
Searching...
No Matches
chamfer.h
Go to the documentation of this file.
1
/*
2
* This program source code file is part of KiCad, a free EDA CAD application.
3
*
4
* Copyright (C) 2023 KiCad Developers, see AUTHORS.txt for contributors.
5
*
6
* @author Tomasz Wlostowski <
[email protected]
>
7
*
8
* This program is free software; you can redistribute it and/or
9
* modify it under the terms of the GNU General Public License
10
* as published by the Free Software Foundation; either version 2
11
* of the License, or (at your option) any later version.
12
*
13
* This program is distributed in the hope that it will be useful,
14
* but WITHOUT ANY WARRANTY; without even the implied warranty of
15
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16
* GNU General Public License for more details.
17
*
18
* You should have received a copy of the GNU General Public License
19
* along with this program; if not, you may find one here:
20
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21
* or you may search the http://www.gnu.org website for the version 2 license,
22
* or you may write to the Free Software Foundation, Inc.,
23
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24
*/
25
26
#ifndef __CHAMFER_H
27
#define __CHAMFER_H
28
29
#include <optional>
30
31
#include <
geometry/seg.h
>
32
36
struct
CHAMFER_PARAMS
37
{
39
int
m_chamfer_setback_a
;
41
int
m_chamfer_setback_b
;
42
};
43
44
struct
CHAMFER_RESULT
45
{
46
// The chamfer segment
47
SEG
m_chamfer
;
48
49
// The updated original segments
50
// These can be empty if the chamfer "consumed" "he original segments
51
std::optional<SEG>
m_updated_seg_a
;
52
std::optional<SEG>
m_updated_seg_b
;
53
};
54
58
std::optional<CHAMFER_RESULT>
ComputeChamferPoints
(
const
SEG
& aSegA,
const
SEG
& aSegB,
59
const
CHAMFER_PARAMS
& aChamferParams );
60
61
62
#endif
ComputeChamferPoints
std::optional< CHAMFER_RESULT > ComputeChamferPoints(const SEG &aSegA, const SEG &aSegB, const CHAMFER_PARAMS &aChamferParams)
Compute the chamfer points for a given line pair and chamfer parameters.
Definition:
chamfer.cpp:26
SEG
Definition:
seg.h:42
seg.h
CHAMFER_PARAMS
Parameters that define a simple chamfer operation.
Definition:
chamfer.h:37
CHAMFER_PARAMS::m_chamfer_setback_b
int m_chamfer_setback_b
Chamfer set-back distance along the second line.
Definition:
chamfer.h:41
CHAMFER_PARAMS::m_chamfer_setback_a
int m_chamfer_setback_a
Chamfer set-back distance along the first line.
Definition:
chamfer.h:39
CHAMFER_RESULT
Definition:
chamfer.h:45
CHAMFER_RESULT::m_chamfer
SEG m_chamfer
Definition:
chamfer.h:47
CHAMFER_RESULT::m_updated_seg_a
std::optional< SEG > m_updated_seg_a
Definition:
chamfer.h:51
CHAMFER_RESULT::m_updated_seg_b
std::optional< SEG > m_updated_seg_b
Definition:
chamfer.h:52
src
libs
kimath
include
geometry
chamfer.h
Generated on Wed Nov 29 2023 00:04:27 for KiCad PCB EDA Suite by
1.9.5