KiCad PCB EDA Suite
shape.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) 2013 CERN
5  * @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #ifndef __SHAPE_H
26 #define __SHAPE_H
27 
28 #include <string>
29 #include <sstream>
30 
31 #include <math/vector2d.h>
32 #include <math/box2.h>
33 
34 #include <geometry/seg.h>
35 
42 {
43  SH_RECT = 0,
50 };
51 
57 class SHAPE
58 {
59 protected:
61 
62 public:
69  SHAPE( SHAPE_TYPE aType ) : m_type( aType )
70  {}
71 
72  // Destructor
73  virtual ~SHAPE()
74  {}
75 
82  SHAPE_TYPE Type() const
83  {
84  return m_type;
85  }
86 
93  virtual SHAPE* Clone() const
94  {
95  assert( false );
96  return NULL;
97  };
98 
106  virtual bool Collide( const VECTOR2I& aP, int aClearance = 0 ) const
107  {
108  return Collide( SEG( aP, aP ), aClearance );
109  }
110 
121  virtual bool Collide( const SHAPE* aShape, int aClearance, VECTOR2I& aMTV ) const;
122  virtual bool Collide( const SHAPE* aShape, int aClearance = 0 ) const;
123 
131  virtual bool Collide( const SEG& aSeg, int aClearance = 0 ) const = 0;
132 
142  virtual const BOX2I BBox( int aClearance = 0 ) const = 0;
143 
150  virtual VECTOR2I Centre() const
151  {
152  return BBox( 0 ).Centre(); // if nothing better is available....
153  }
154 
155  virtual void Move ( const VECTOR2I& aVector ) = 0;
156 
157  virtual bool IsSolid() const = 0;
158 
159  virtual bool Parse( std::stringstream& aStream );
160 
161  virtual const std::string Format( ) const;
162 
163 protected:
166 };
167 
168 bool CollideShapes( const SHAPE* aA, const SHAPE* aB, int aClearance,
169  bool aNeedMTV, VECTOR2I& aMTV );
170 
171 #endif // __SHAPE_H
VECTOR2_TRAITS< int >::extended_type extended_type
Definition: vector2d.h:77
any polygon (with holes, etc.)
Definition: shape.h:49
SHAPE(SHAPE_TYPE aType)
Constructor.
Definition: shape.h:69
virtual ~SHAPE()
Definition: shape.h:73
virtual const BOX2I BBox(int aClearance=0) const =0
Function BBox()
virtual SHAPE * Clone() const
Function Clone()
Definition: shape.h:93
Class SHAPE.
Definition: shape.h:57
virtual const std::string Format() const
Definition: shape.cpp:35
virtual bool Parse(std::stringstream &aStream)
Definition: shape.cpp:28
SHAPE_TYPE m_type
type of our shape
Definition: shape.h:165
Vec Centre() const
Definition: box2.h:67
line chain (polyline)
Definition: shape.h:46
virtual bool Collide(const VECTOR2I &aP, int aClearance=0) const
Function Collide()
Definition: shape.h:106
Definition: seg.h:36
convex polygon
Definition: shape.h:48
virtual bool IsSolid() const =0
SHAPE_TYPE Type() const
Function Type()
Definition: shape.h:82
VECTOR2I::extended_type ecoord
Definition: shape.h:60
bool CollideShapes(const SHAPE *aA, const SHAPE *aB, int aClearance, bool aNeedMTV, VECTOR2I &aMTV)
virtual VECTOR2I Centre() const
Function Centre()
Definition: shape.h:150
line segment
Definition: shape.h:45
Definition: shape.h:43
virtual void Move(const VECTOR2I &aVector)=0
SHAPE_TYPE
Enum SHAPE_TYPE Lists all supported shapes.
Definition: shape.h:41
circle
Definition: shape.h:47
axis-aligned rectangle
Definition: shape.h:44