KiCad PCB EDA Suite
ar_matrix.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) 2012 Jean-Pierre Charras, jean-pierre.charras@ujf-grenoble.fr
5  * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
6  * Copyright (C) 2011 Wayne Stambaugh <stambaughw@verizon.net>
7  *
8  * Copyright (C) 1992-2015 KiCad Developers, see change_log.txt for contributors.
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, you may find one here:
22  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
23  * or you may search the http://www.gnu.org website for the version 2 license,
24  * or you may write to the Free Software Foundation, Inc.,
25  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
26  */
27 
28 
29 #ifndef __AR_MATRIX_H
30 #define __AR_MATRIX_H
31 
32 #include <eda_rect.h>
34 
35 class DRAWSEGMENT;
36 class TRACK;
37 class D_PAD;
38 class MODULE;
39 
40 #define AR_MAX_ROUTING_LAYERS_COUNT 2
41 
42 #define AR_SIDE_TOP 0
43 #define AR_SIDE_BOTTOM 1
44 
49 class AR_MATRIX
50 {
51 public:
52  typedef unsigned char MATRIX_CELL;
53  typedef int DIST_CELL;
54 
55  MATRIX_CELL* m_BoardSide[AR_MAX_ROUTING_LAYERS_COUNT]; // the image map of 2 board sides
56  DIST_CELL* m_DistSide[AR_MAX_ROUTING_LAYERS_COUNT]; // the image map of 2 board sides:
57  // distance to cells
58  int m_RoutingLayersCount; // Number of layers for autorouting (0 or 1)
59  int m_GridRouting; // Size of grid for autoplace/autoroute
60  EDA_RECT m_BrdBox; // Actual board bounding box
61  int m_Nrows, m_Ncols; // Matrix size
62  int m_MemSize; // Memory requirement, just for statistics
63  int m_RouteCount; // Number of routes
64 
67 
68 private:
69  // a pointer to the current selected cell operation
70  void ( AR_MATRIX::*m_opWriteCell )( int aRow, int aCol, int aSide, MATRIX_CELL aCell );
71 
72 public:
73  enum CELL_OP
74  {
80  };
81 
82  AR_MATRIX();
83  ~AR_MATRIX();
84 
85  void WriteCell( int aRow, int aCol, int aSide, MATRIX_CELL aCell )
86  {
87  ( *this.*m_opWriteCell )( aRow, aCol, aSide, aCell );
88  }
89 
96  {
97  return m_BrdBox.GetOrigin();
98  }
99 
108  bool ComputeMatrixSize( const EDA_RECT& aBoundingBox );
109 
116  int InitRoutingMatrix();
117 
118  void UnInitRoutingMatrix();
119 
120  // Initialize WriteCell to make the aLogicOp
121  void SetCellOperation( CELL_OP aLogicOp );
122 
123  // functions to read/write one cell ( point on grid routing matrix:
124  MATRIX_CELL GetCell( int aRow, int aCol, int aSide );
125  void SetCell( int aRow, int aCol, int aSide, MATRIX_CELL aCell );
126  void OrCell( int aRow, int aCol, int aSide, MATRIX_CELL aCell );
127  void XorCell( int aRow, int aCol, int aSide, MATRIX_CELL aCell );
128  void AndCell( int aRow, int aCol, int aSide, MATRIX_CELL aCell );
129  void AddCell( int aRow, int aCol, int aSide, MATRIX_CELL aCell );
130  DIST_CELL GetDist( int aRow, int aCol, int aSide );
131  void SetDist( int aRow, int aCol, int aSide, DIST_CELL );
132 
133  void TraceSegmentPcb( DRAWSEGMENT* pt_segm, int color, int marge, AR_MATRIX::CELL_OP op_logic );
135  int ux0, int uy0, int ux1, int uy1, int marge, int aKeepOut, LSET aLayerMask );
136  void PlacePad( D_PAD* aPad, int color, int marge, AR_MATRIX::CELL_OP op_logic );
137  void TraceFilledRectangle( int ux0, int uy0, int ux1, int uy1, double angle, LSET aLayerMask,
138  int color, AR_MATRIX::CELL_OP op_logic );
139  void TraceFilledRectangle( int ux0, int uy0, int ux1, int uy1, LSET aLayerMask, int color,
140  AR_MATRIX::CELL_OP op_logic );
141 
142 private:
143  void drawSegmentQcq( int ux0, int uy0, int ux1, int uy1, int lg, LAYER_NUM layer, int color,
144  CELL_OP op_logic );
145 
146  void traceCircle( int ux0, int uy0, int ux1, int uy1, int lg, LAYER_NUM layer, int color,
147  AR_MATRIX::CELL_OP op_logic );
148  void traceFilledCircle(
149  int cx, int cy, int radius, LSET aLayerMask, int color, AR_MATRIX::CELL_OP op_logic );
150  void traceArc( int ux0, int uy0, int ux1, int uy1, double ArcAngle, int lg, LAYER_NUM layer,
151  int color, AR_MATRIX::CELL_OP op_logic );
152 };
153 
154 #endif
void traceArc(int ux0, int uy0, int ux1, int uy1, double ArcAngle, int lg, LAYER_NUM layer, int color, AR_MATRIX::CELL_OP op_logic)
Definition: ar_matrix.cpp:571
AR_MATRIX handle the matrix routing that describes the actual board.
Definition: ar_matrix.h:49
int InitRoutingMatrix()
Function InitBoard initializes the data structures.
Definition: ar_matrix.cpp:91
DIST_CELL * m_DistSide[AR_MAX_ROUTING_LAYERS_COUNT]
Definition: ar_matrix.h:56
int m_MemSize
Definition: ar_matrix.h:62
int m_Ncols
Definition: ar_matrix.h:61
int m_GridRouting
Definition: ar_matrix.h:59
int color
Definition: DXF_plotter.cpp:61
void TraceFilledRectangle(int ux0, int uy0, int ux1, int uy1, double angle, LSET aLayerMask, int color, AR_MATRIX::CELL_OP op_logic)
Definition: ar_matrix.cpp:615
EDA_RECT m_BrdBox
Definition: ar_matrix.h:60
void CreateKeepOutRectangle(int ux0, int uy0, int ux1, int uy1, int marge, int aKeepOut, LSET aLayerMask)
Function CreateKeepOutRectangle builds the cost map: Cells ( in Dist map ) inside the rect x0,...
Definition: ar_matrix.cpp:808
void PlacePad(D_PAD *aPad, int color, int marge, AR_MATRIX::CELL_OP op_logic)
Definition: ar_matrix.cpp:913
void TraceSegmentPcb(DRAWSEGMENT *pt_segm, int color, int marge, AR_MATRIX::CELL_OP op_logic)
Definition: ar_matrix.cpp:765
int DIST_CELL
Definition: ar_matrix.h:53
void XorCell(int aRow, int aCol, int aSide, MATRIX_CELL aCell)
Definition: ar_matrix.cpp:202
PCB_LAYER_ID m_routeLayerTop
Definition: ar_matrix.h:65
PCB_LAYER_ID
A quick note on layer IDs:
LSET is a set of PCB_LAYER_IDs.
void WriteCell(int aRow, int aCol, int aSide, MATRIX_CELL aCell)
Definition: ar_matrix.h:85
const wxPoint GetOrigin() const
Definition: eda_rect.h:114
void OrCell(int aRow, int aCol, int aSide, MATRIX_CELL aCell)
Definition: ar_matrix.cpp:191
MATRIX_CELL GetCell(int aRow, int aCol, int aSide)
Definition: ar_matrix.cpp:169
void(AR_MATRIX::* m_opWriteCell)(int aRow, int aCol, int aSide, MATRIX_CELL aCell)
Definition: ar_matrix.h:70
int m_Nrows
Definition: ar_matrix.h:61
void SetCellOperation(CELL_OP aLogicOp)
Definition: ar_matrix.cpp:153
MATRIX_CELL * m_BoardSide[AR_MAX_ROUTING_LAYERS_COUNT]
Definition: ar_matrix.h:55
void SetCell(int aRow, int aCol, int aSide, MATRIX_CELL aCell)
Definition: ar_matrix.cpp:180
void drawSegmentQcq(int ux0, int uy0, int ux1, int uy1, int lg, LAYER_NUM layer, int color, CELL_OP op_logic)
Definition: ar_matrix.cpp:285
void AndCell(int aRow, int aCol, int aSide, MATRIX_CELL aCell)
Definition: ar_matrix.cpp:213
void traceCircle(int ux0, int uy0, int ux1, int uy1, int lg, LAYER_NUM layer, int color, AR_MATRIX::CELL_OP op_logic)
Definition: ar_matrix.cpp:411
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
void UnInitRoutingMatrix()
Definition: ar_matrix.cpp:128
Board layer functions and definitions.
int m_RoutingLayersCount
Definition: ar_matrix.h:58
static DIRECTION_45::AngleType angle(const VECTOR2I &a, const VECTOR2I &b)
wxPoint GetBrdCoordOrigin()
function GetBrdCoordOrigin
Definition: ar_matrix.h:95
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
void AddCell(int aRow, int aCol, int aSide, MATRIX_CELL aCell)
Definition: ar_matrix.cpp:224
void traceFilledCircle(int cx, int cy, int radius, LSET aLayerMask, int color, AR_MATRIX::CELL_OP op_logic)
Definition: ar_matrix.cpp:450
unsigned char MATRIX_CELL
Definition: ar_matrix.h:52
void SetDist(int aRow, int aCol, int aSide, DIST_CELL)
Definition: ar_matrix.cpp:244
bool ComputeMatrixSize(const EDA_RECT &aBoundingBox)
Function ComputeMatrixSize calculates the number of rows and columns of dimensions of aPcb for routin...
Definition: ar_matrix.cpp:61
#define AR_MAX_ROUTING_LAYERS_COUNT
Definition: ar_matrix.h:40
int m_RouteCount
Definition: ar_matrix.h:63
DIST_CELL GetDist(int aRow, int aCol, int aSide)
Definition: ar_matrix.cpp:234
PCB_LAYER_ID m_routeLayerBottom
Definition: ar_matrix.h:66