KiCad PCB EDA Suite
EDA_RECT Class Reference

EDA_RECT handles the component boundary box. More...

#include <eda_rect.h>

Public Member Functions

 EDA_RECT ()
 
 EDA_RECT (const wxPoint &aPos, const wxSize &aSize)
 
virtual ~EDA_RECT ()
 
wxPoint Centre () const
 
void Move (const wxPoint &aMoveVector)
 Function Move moves the rectangle by the aMoveVector. More...
 
void Normalize ()
 Function Normalize ensures that the height ant width are positive. More...
 
bool Contains (const wxPoint &aPoint) const
 Function Contains. More...
 
bool Contains (int x, int y) const
 Function Contains. More...
 
bool Contains (const EDA_RECT &aRect) const
 Function Contains. More...
 
const wxSize GetSize () const
 
int GetSizeMax () const
 GetSizeMax. More...
 
int GetX () const
 
int GetY () const
 
const wxPoint GetOrigin () const
 
const wxPoint GetPosition () const
 
const wxPoint GetEnd () const
 
const wxPoint GetCenter () const
 
int GetWidth () const
 
int GetHeight () const
 
int GetRight () const
 
int GetLeft () const
 
int GetTop () const
 
int GetBottom () const
 
bool IsValid () const
 
void SetOrigin (const wxPoint &pos)
 
void SetOrigin (int x, int y)
 
void SetSize (const wxSize &size)
 
void SetSize (int w, int h)
 
void Offset (int dx, int dy)
 
void Offset (const wxPoint &offset)
 
void SetX (int val)
 
void SetY (int val)
 
void SetWidth (int val)
 
void SetHeight (int val)
 
void SetEnd (int x, int y)
 
void SetEnd (const wxPoint &pos)
 
void RevertYAxis ()
 Function RevertYAxis Mirror the rectangle from the X axis (negate Y pos and size) More...
 
bool Intersects (const EDA_RECT &aRect) const
 Function Intersects tests for a common area between rectangles. More...
 
bool Intersects (const EDA_RECT &aRect, double aRot) const
 Tests for a common area between this rectangle, and a rectangle with arbitrary rotation. More...
 
bool Intersects (const wxPoint &aPoint1, const wxPoint &aPoint2) const
 Function Intersects tests for a common area between a segment and this rectangle. More...
 
const wxPoint ClosestPointTo (const wxPoint &aPoint) const
 Return the point in this rect that is closest to the provided point. More...
 
const wxPoint FarthestPointTo (const wxPoint &aPoint) const
 Return the point in this rect that is farthest from the provided point. More...
 
bool IntersectsCircle (const wxPoint &aCenter, const int aRadius) const
 Function IntersectsCircle tests for a common area between a circle and this rectangle. More...
 
bool IntersectsCircleEdge (const wxPoint &aCenter, const int aRadius, const int aWidth) const
 IntersectsCircleEdge Tests for intersection between this rect and the edge (radius) of a circle. More...
 
 operator wxRect () const
 Function operator(wxRect) overloads the cast operator to return a wxRect wxRect does not accept negative values for size, so ensure the wxRect size is always >= 0. More...
 
 operator BOX2I () const
 Function operator(BOX2I) overloads the cast operator to return a BOX2I. More...
 
EDA_RECTInflate (wxCoord dx, wxCoord dy)
 Function Inflate inflates the rectangle horizontally by dx and vertically by dy. More...
 
EDA_RECTInflate (int aDelta)
 Function Inflate inflates the rectangle horizontally and vertically by aDelta. More...
 
void Merge (const EDA_RECT &aRect)
 Function Merge modifies the position and size of the rectangle in order to contain aRect. More...
 
void Merge (const wxPoint &aPoint)
 Function Merge modifies the position and size of the rectangle in order to contain the given point. More...
 
double GetArea () const
 Function GetArea returns the area of the rectangle. More...
 
EDA_RECT Common (const EDA_RECT &aRect) const
 Function Common returns the area that is common with another rectangle. More...
 
const EDA_RECT GetBoundingBoxRotated (wxPoint aRotCenter, double aAngle)
 Function GetBoundingBoxRotated. More...
 

Private Attributes

wxPoint m_Pos
 
wxSize m_Size
 
bool m_init
 

Detailed Description

EDA_RECT handles the component boundary box.

This class is similar to wxRect, but some wxRect functions are very curious, and are working only if dimensions are >= 0 (not always the case in KiCad) and also KiCad needs some specific method. so I prefer this more suitable class

Definition at line 44 of file eda_rect.h.

Constructor & Destructor Documentation

◆ EDA_RECT() [1/2]

EDA_RECT::EDA_RECT ( )
inline

Definition at line 52 of file eda_rect.h.

52 : m_init( false ) { };
bool m_init
Definition: eda_rect.h:49

◆ EDA_RECT() [2/2]

EDA_RECT::EDA_RECT ( const wxPoint aPos,
const wxSize &  aSize 
)
inline

Definition at line 54 of file eda_rect.h.

54  :
55  m_Pos( aPos ),
56  m_Size( aSize ),
57  m_init( true )
58  { }
wxSize m_Size
Definition: eda_rect.h:48
bool m_init
Definition: eda_rect.h:49
wxPoint m_Pos
Definition: eda_rect.h:47

◆ ~EDA_RECT()

virtual EDA_RECT::~EDA_RECT ( )
inlinevirtual

Definition at line 60 of file eda_rect.h.

60 { };

Member Function Documentation

◆ Centre()

◆ ClosestPointTo()

const wxPoint EDA_RECT::ClosestPointTo ( const wxPoint aPoint) const

Return the point in this rect that is closest to the provided point.

Definition at line 491 of file base_struct.cpp.

492 {
493  EDA_RECT me( *this );
494 
495  me.Normalize(); // ensure size is >= 0
496 
497  // Determine closest point to the circle centre within this rect
498  int nx = std::max( me.GetLeft(), std::min( aPoint.x, me.GetRight() ) );
499  int ny = std::max( me.GetTop(), std::min( aPoint.y, me.GetBottom() ) );
500 
501  return wxPoint( nx, ny );
502 }
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

References GetBottom(), GetLeft(), GetRight(), GetTop(), Normalize(), wxPoint::x, and wxPoint::y.

Referenced by IntersectsCircle().

◆ Common()

EDA_RECT EDA_RECT::Common ( const EDA_RECT aRect) const

Function Common returns the area that is common with another rectangle.

Parameters
aRectis the rectangle to find the common area with.
Returns
The common area rect or 0-sized rectangle if there is no intersection.

Definition at line 689 of file base_struct.cpp.

690 {
691  EDA_RECT r;
692 
693  if( Intersects( aRect ) )
694  {
695  wxPoint originA( std::min( GetOrigin().x, GetEnd().x ),
696  std::min( GetOrigin().y, GetEnd().y ) );
697  wxPoint originB( std::min( aRect.GetOrigin().x, aRect.GetEnd().x ),
698  std::min( aRect.GetOrigin().y, aRect.GetEnd().y ) );
699  wxPoint endA( std::max( GetOrigin().x, GetEnd().x ),
700  std::max( GetOrigin().y, GetEnd().y ) );
701  wxPoint endB( std::max( aRect.GetOrigin().x, aRect.GetEnd().x ),
702  std::max( aRect.GetOrigin().y, aRect.GetEnd().y ) );
703 
704  r.SetOrigin( wxPoint( std::max( originA.x, originB.x ), std::max( originA.y, originB.y ) ) );
705  r.SetEnd ( wxPoint( std::min( endA.x, endB.x ), std::min( endA.y, endB.y ) ) );
706  }
707 
708  return r;
709 }
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:131
const wxPoint GetEnd() const
Definition: eda_rect.h:116
const wxPoint GetOrigin() const
Definition: eda_rect.h:114
void SetEnd(int x, int y)
Definition: eda_rect.h:192
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
bool Intersects(const EDA_RECT &aRect) const
Function Intersects tests for a common area between rectangles.

References GetEnd(), GetOrigin(), Intersects(), SetEnd(), SetOrigin(), wxPoint::x, and wxPoint::y.

Referenced by calcCommonArea(), LIB_ARC::HitTest(), and DRAWSEGMENT::HitTest().

◆ Contains() [1/3]

bool EDA_RECT::Contains ( const wxPoint aPoint) const

Function Contains.

Parameters
aPoint= the wxPoint to test
Returns
true if aPoint is inside the boundary box. A point on a edge is seen as inside

Definition at line 299 of file base_struct.cpp.

300 {
301  wxPoint rel_pos = aPoint - m_Pos;
302  wxSize size = m_Size;
303 
304  if( size.x < 0 )
305  {
306  size.x = -size.x;
307  rel_pos.x += size.x;
308  }
309 
310  if( size.y < 0 )
311  {
312  size.y = -size.y;
313  rel_pos.y += size.y;
314  }
315 
316  return (rel_pos.x >= 0) && (rel_pos.y >= 0) && ( rel_pos.y <= size.y) && ( rel_pos.x <= size.x);
317 }
wxSize m_Size
Definition: eda_rect.h:48
wxPoint m_Pos
Definition: eda_rect.h:47

References m_Pos, m_Size, wxPoint::x, and wxPoint::y.

Referenced by AR_AUTOPLACER::AutoplaceModules(), Contains(), GRPutPixel(), LIB_CIRCLE::HitTest(), LIB_ARC::HitTest(), LIB_BEZIER::HitTest(), LIB_POLYLINE::HitTest(), SCH_PIN::HitTest(), PCB_TARGET::HitTest(), WS_DRAW_ITEM_BASE::HitTest(), SCH_JUNCTION::HitTest(), SCH_BUS_ENTRY_BASE::HitTest(), SCH_NO_CONNECT::HitTest(), LIB_PIN::HitTest(), SCH_BITMAP::HitTest(), WS_DRAW_ITEM_POLYPOLYGONS::HitTest(), TRACK::HitTest(), SCH_FIELD::HitTest(), LIB_ITEM::HitTest(), SCH_SHEET_PIN::HitTest(), SCH_LINE::HitTest(), DRAWSEGMENT::HitTest(), DIMENSION::HitTest(), GERBER_DRAW_ITEM::HitTest(), ARC::HitTest(), SCH_TEXT::HitTest(), WS_DRAW_ITEM_BITMAP::HitTest(), ZONE_CONTAINER::HitTest(), VIA::HitTest(), MODULE::HitTest(), SCH_SHEET::HitTest(), SCH_COMPONENT::HitTest(), D_PAD::HitTest(), MARKER_BASE::HitTestMarker(), LIB_RECTANGLE::Inside(), LIB_BEZIER::Inside(), LIB_ARC::Inside(), LIB_POLYLINE::Inside(), LIB_PIN::Inside(), Intersects(), EE_SELECTION_TOOL::Main(), SELECTION_TOOL::Main(), AR_AUTOPLACER::nearestPad(), TEXTE_MODULE::TextHitTest(), and EDA_TEXT::TextHitTest().

◆ Contains() [2/3]

bool EDA_RECT::Contains ( int  x,
int  y 
) const
inline

Function Contains.

Parameters
x= the x coordinate of the point to test
y= the x coordinate of the point to test
Returns
true if point is inside the boundary box. A point on a edge is seen as inside

Definition at line 94 of file eda_rect.h.

94 { return Contains( wxPoint( x, y ) ); }
bool Contains(const wxPoint &aPoint) const
Function Contains.

References Contains().

Referenced by Contains().

◆ Contains() [3/3]

bool EDA_RECT::Contains ( const EDA_RECT aRect) const

Function Contains.

Parameters
aRect= the EDA_RECT to test
Returns
true if aRect is Contained. A common edge is seen as contained

Definition at line 320 of file base_struct.cpp.

321 {
322  return Contains( aRect.GetOrigin() ) && Contains( aRect.GetEnd() );
323 }
bool Contains(const wxPoint &aPoint) const
Function Contains.
const wxPoint GetEnd() const
Definition: eda_rect.h:116
const wxPoint GetOrigin() const
Definition: eda_rect.h:114

References Contains(), GetEnd(), and GetOrigin().

◆ FarthestPointTo()

const wxPoint EDA_RECT::FarthestPointTo ( const wxPoint aPoint) const

Return the point in this rect that is farthest from the provided point.

Definition at line 505 of file base_struct.cpp.

506 {
507  EDA_RECT me( *this );
508 
509  me.Normalize(); // ensure size is >= 0
510 
511  int fx = std::max( std::abs( aPoint.x - me.GetLeft() ), std::abs( aPoint.x - me.GetRight() ) );
512  int fy = std::max( std::abs( aPoint.y - me.GetTop() ), std::abs( aPoint.y - me.GetBottom() ) );
513 
514  return wxPoint( fx, fy );
515 }
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

References GetBottom(), GetLeft(), GetRight(), GetTop(), Normalize(), wxPoint::x, and wxPoint::y.

Referenced by IntersectsCircleEdge().

◆ GetArea()

double EDA_RECT::GetArea ( ) const

Function GetArea returns the area of the rectangle.

Returns
The area of the rectangle.

Definition at line 683 of file base_struct.cpp.

684 {
685  return (double) GetWidth() * (double) GetHeight();
686 }
int GetWidth() const
Definition: eda_rect.h:119
int GetHeight() const
Definition: eda_rect.h:120

References GetHeight(), and GetWidth().

Referenced by calcArea(), calcCommonArea(), MODULE::CoverageRatio(), and SCH_COMPONENT::operator<().

◆ GetBottom()

◆ GetBoundingBoxRotated()

const EDA_RECT EDA_RECT::GetBoundingBoxRotated ( wxPoint  aRotCenter,
double  aAngle 
)

Function GetBoundingBoxRotated.

Returns
the bounding box of this, after rotation
Parameters
aAngle= the rotation angle in 0.1 deg.
aRotCenter= the rotation point. useful to calculate bounding box of rotated items, when rotation if not k*90 degrees

Definition at line 712 of file base_struct.cpp.

713 {
714  wxPoint corners[4];
715 
716  // Build the corners list
717  corners[0] = GetOrigin();
718  corners[2] = GetEnd();
719  corners[1].x = corners[0].x;
720  corners[1].y = corners[2].y;
721  corners[3].x = corners[2].x;
722  corners[3].y = corners[0].y;
723 
724  // Rotate all corners, to find the bounding box
725  for( int ii = 0; ii < 4; ii ++ )
726  RotatePoint( &corners[ii], aRotCenter, aAngle );
727 
728  // Find the corners bounding box
729  wxPoint start = corners[0];
730  wxPoint end = corners[0];
731 
732  for( int ii = 1; ii < 4; ii ++ )
733  {
734  start.x = std::min( start.x, corners[ii].x);
735  start.y = std::min( start.y, corners[ii].y);
736  end.x = std::max( end.x, corners[ii].x);
737  end.y = std::max( end.y, corners[ii].y);
738  }
739 
740  EDA_RECT bbox;
741  bbox.SetOrigin( start );
742  bbox.SetEnd( end );
743 
744  return bbox;
745 }
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:131
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
const wxPoint GetEnd() const
Definition: eda_rect.h:116
const wxPoint GetOrigin() const
Definition: eda_rect.h:114
void SetEnd(int x, int y)
Definition: eda_rect.h:192
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

References GetEnd(), GetOrigin(), RotatePoint(), SetEnd(), SetOrigin(), wxPoint::x, and wxPoint::y.

Referenced by TEXTE_PCB::GetBoundingBox(), TEXTE_MODULE::GetBoundingBox(), D_PAD::GetBoundingBox(), WX_ANGLE_TEXT::OnPaint(), TEXTE_MODULE::ViewBBox(), and WX_ANGLE_TEXT::WX_ANGLE_TEXT().

◆ GetCenter()

const wxPoint EDA_RECT::GetCenter ( ) const
inline

◆ GetEnd()

◆ GetHeight()

◆ GetLeft()

◆ GetOrigin()

◆ GetPosition()

◆ GetRight()

◆ GetSize()

◆ GetSizeMax()

int EDA_RECT::GetSizeMax ( ) const
inline

GetSizeMax.

Returns
the max size dimension

Definition at line 109 of file eda_rect.h.

109 { return ( m_Size.x > m_Size.y )?m_Size.x:m_Size.y; }
wxSize m_Size
Definition: eda_rect.h:48

References m_Size.

Referenced by CINFO3D_VISU::AddShapeWithClearanceToContainer().

◆ GetTop()

◆ GetWidth()

◆ GetX()

◆ GetY()

◆ Inflate() [1/2]

EDA_RECT & EDA_RECT::Inflate ( wxCoord  dx,
wxCoord  dy 
)

Function Inflate inflates the rectangle horizontally by dx and vertically by dy.

If dx and/or dy is negative the rectangle is deflated.

Definition at line 566 of file base_struct.cpp.

567 {
568  if( m_Size.x >= 0 )
569  {
570  if( m_Size.x < -2 * dx )
571  {
572  // Don't allow deflate to eat more width than we have,
573  m_Pos.x += m_Size.x / 2;
574  m_Size.x = 0;
575  }
576  else
577  {
578  // The inflate is valid.
579  m_Pos.x -= dx;
580  m_Size.x += 2 * dx;
581  }
582  }
583  else // size.x < 0:
584  {
585  if( m_Size.x > -2 * dx )
586  {
587  // Don't allow deflate to eat more width than we have,
588  m_Pos.x -= m_Size.x / 2;
589  m_Size.x = 0;
590  }
591  else
592  {
593  // The inflate is valid.
594  m_Pos.x += dx;
595  m_Size.x -= 2 * dx; // m_Size.x <0: inflate when dx > 0
596  }
597  }
598 
599  if( m_Size.y >= 0 )
600  {
601  if( m_Size.y < -2 * dy )
602  {
603  // Don't allow deflate to eat more height than we have,
604  m_Pos.y += m_Size.y / 2;
605  m_Size.y = 0;
606  }
607  else
608  {
609  // The inflate is valid.
610  m_Pos.y -= dy;
611  m_Size.y += 2 * dy;
612  }
613  }
614  else // size.y < 0:
615  {
616  if( m_Size.y > 2 * dy )
617  {
618  // Don't allow deflate to eat more height than we have,
619  m_Pos.y -= m_Size.y / 2;
620  m_Size.y = 0;
621  }
622  else
623  {
624  // The inflate is valid.
625  m_Pos.y += dy;
626  m_Size.y -= 2 * dy; // m_Size.y <0: inflate when dy > 0
627  }
628  }
629 
630  return *this;
631 }
wxSize m_Size
Definition: eda_rect.h:48
wxPoint m_Pos
Definition: eda_rect.h:47

References m_Pos, m_Size, wxPoint::x, and wxPoint::y.

Referenced by AR_AUTOPLACER::addPad(), BuildBoardPolygonOutlines(), ZONE_FILLER::buildCopperItemClearances(), AR_AUTOPLACER::buildFpAreas(), FillNegativeKnockout(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), APERTURE_MACRO::GetApertureMacroShape(), SCH_SHEET::GetBodyBoundingBox(), LIB_CIRCLE::GetBoundingBox(), LIB_RECTANGLE::GetBoundingBox(), SCH_JUNCTION::GetBoundingBox(), LIB_ARC::GetBoundingBox(), LIB_BEZIER::GetBoundingBox(), SCH_NO_CONNECT::GetBoundingBox(), LIB_POLYLINE::GetBoundingBox(), SCH_BUS_ENTRY_BASE::GetBoundingBox(), LIB_PIN::GetBoundingBox(), BITMAP_BASE::GetBoundingBox(), DRAWSEGMENT::GetBoundingBox(), GERBER_DRAW_ITEM::GetBoundingBox(), D_PAD::GetBoundingBox(), MODULE::GetFootprintRect(), SCH_SCREEN::GetItem(), GRCSegm(), GRLineArray(), GRSFilledRect(), hasThermalConnection(), LIB_CIRCLE::HitTest(), LIB_ARC::HitTest(), LIB_BEZIER::HitTest(), LIB_POLYLINE::HitTest(), SCH_PIN::HitTest(), PCB_TARGET::HitTest(), WS_DRAW_ITEM_BASE::HitTest(), SCH_JUNCTION::HitTest(), SCH_BUS_ENTRY_BASE::HitTest(), SCH_NO_CONNECT::HitTest(), LIB_PIN::HitTest(), SCH_BITMAP::HitTest(), WS_DRAW_ITEM_POLYPOLYGONS::HitTest(), TRACK::HitTest(), SCH_FIELD::HitTest(), LIB_ITEM::HitTest(), SCH_SHEET_PIN::HitTest(), SCH_LINE::HitTest(), DRAWSEGMENT::HitTest(), DIMENSION::HitTest(), ARC::HitTest(), SCH_TEXT::HitTest(), WS_DRAW_ITEM_BITMAP::HitTest(), ZONE_CONTAINER::HitTest(), VIA::HitTest(), MODULE::HitTest(), SCH_SHEET::HitTest(), SCH_COMPONENT::HitTest(), D_PAD::HitTest(), MARKER_BASE::HitTestMarker(), Inflate(), CINFO3D_VISU::InitSettings(), Intersects(), EE_RTREE::Overlapping(), SpreadFootprints(), AR_AUTOPLACER::testModuleOnBoard(), AR_AUTOPLACER::testRectangle(), TEXTE_MODULE::TextHitTest(), EDA_TEXT::TextHitTest(), EDA_TEXT::TransformBoundingBoxWithClearanceToPolygon(), MODULE::ViewBBox(), and WinClipAndDrawLine().

◆ Inflate() [2/2]

EDA_RECT & EDA_RECT::Inflate ( int  aDelta)

Function Inflate inflates the rectangle horizontally and vertically by aDelta.

If aDelta is negative the rectangle is deflated.

Definition at line 559 of file base_struct.cpp.

560 {
561  Inflate( aDelta, aDelta );
562  return *this;
563 }
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.

References Inflate().

◆ Intersects() [1/3]

bool EDA_RECT::Intersects ( const EDA_RECT aRect) const

Function Intersects tests for a common area between rectangles.

Parameters
aRectA rectangle to test intersection with.
Returns
bool - true if the argument rectangle intersects this rectangle. (i.e. if the 2 rectangles have at least a common point)

Definition at line 352 of file base_struct.cpp.

353 {
354  if( !m_init )
355  return false;
356 
357  // this logic taken from wxWidgets' geometry.cpp file:
358  bool rc;
359  EDA_RECT me(*this);
360  EDA_RECT rect(aRect);
361  me.Normalize(); // ensure size is >= 0
362  rect.Normalize(); // ensure size is >= 0
363 
364  // calculate the left common area coordinate:
365  int left = std::max( me.m_Pos.x, rect.m_Pos.x );
366  // calculate the right common area coordinate:
367  int right = std::min( me.m_Pos.x + me.m_Size.x, rect.m_Pos.x + rect.m_Size.x );
368  // calculate the upper common area coordinate:
369  int top = std::max( me.m_Pos.y, aRect.m_Pos.y );
370  // calculate the lower common area coordinate:
371  int bottom = std::min( me.m_Pos.y + me.m_Size.y, rect.m_Pos.y + rect.m_Size.y );
372 
373  // if a common area exists, it must have a positive (null accepted) size
374  if( left <= right && top <= bottom )
375  rc = true;
376  else
377  rc = false;
378 
379  return rc;
380 }
bool m_init
Definition: eda_rect.h:49
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
wxPoint m_Pos
Definition: eda_rect.h:47

References m_init, m_Pos, m_Size, Normalize(), wxPoint::x, and wxPoint::y.

Referenced by BOOST_AUTO_TEST_CASE(), ZONE_FILLER::buildCopperItemClearances(), Common(), AUTOPLACER::filtered_colliders(), hasThermalConnection(), LIB_CIRCLE::HitTest(), LIB_ARC::HitTest(), LIB_BEZIER::HitTest(), LIB_POLYLINE::HitTest(), PCB_TARGET::HitTest(), WS_DRAW_ITEM_BASE::HitTest(), SCH_JUNCTION::HitTest(), SCH_BUS_ENTRY_BASE::HitTest(), SCH_NO_CONNECT::HitTest(), SCH_BITMAP::HitTest(), WS_DRAW_ITEM_POLYPOLYGONS::HitTest(), TRACK::HitTest(), SCH_FIELD::HitTest(), LIB_ITEM::HitTest(), SCH_LINE::HitTest(), DRAWSEGMENT::HitTest(), DIMENSION::HitTest(), ARC::HitTest(), SCH_TEXT::HitTest(), ZONE_CONTAINER::HitTest(), MODULE::HitTest(), SCH_SHEET::HitTest(), SCH_COMPONENT::HitTest(), D_PAD::HitTest(), LIB_TEXT::Inside(), LIB_FIELD::Inside(), Intersects(), TEXTE_MODULE::TextHitTest(), and EDA_TEXT::TextHitTest().

◆ Intersects() [2/3]

bool EDA_RECT::Intersects ( const EDA_RECT aRect,
double  aRot 
) const

Tests for a common area between this rectangle, and a rectangle with arbitrary rotation.

Parameters
aRecta rectangle to test intersection with
aRotrectangle rotation (in 1/10 degrees)

Definition at line 383 of file base_struct.cpp.

384 {
385  if( !m_init )
386  return false;
387 
388  /* Most rectangles will be axis aligned.
389  * It is quicker to check for this case and pass the rect
390  * to the simpler intersection test
391  */
392 
393  // Prevent floating point comparison errors
394  static const double ROT_EPS = 0.000000001;
395 
396  static const double ROT_PARALLEL[] = { -3600, -1800, 0, 1800, 3600 };
397  static const double ROT_PERPENDICULAR[] = { -2700, -900, 0, 900, 2700 };
398 
399  NORMALIZE_ANGLE_POS<double>( aRot );
400 
401  // Test for non-rotated rectangle
402  for( int ii = 0; ii < 5; ii++ )
403  {
404  if( std::fabs( aRot - ROT_PARALLEL[ii] ) < ROT_EPS )
405  {
406  return Intersects( aRect );
407  }
408  }
409 
410  // Test for rectangle rotated by multiple of 90 degrees
411  for( int jj = 0; jj < 4; jj++ )
412  {
413  if( std::fabs( aRot - ROT_PERPENDICULAR[jj] ) < ROT_EPS )
414  {
415  EDA_RECT rotRect;
416 
417  // Rotate the supplied rect by 90 degrees
418  rotRect.SetOrigin( aRect.Centre() );
419  rotRect.Inflate( aRect.GetHeight(), aRect.GetWidth() );
420  return Intersects( rotRect );
421  }
422  }
423 
424  /* There is some non-orthogonal rotation.
425  * There are three cases to test:
426  * A) One point of this rect is inside the rotated rect
427  * B) One point of the rotated rect is inside this rect
428  * C) One of the sides of the rotated rect intersect this
429  */
430 
431  wxPoint corners[4];
432 
433  /* Test A : Any corners exist in rotated rect? */
434 
435  corners[0] = m_Pos;
436  corners[1] = m_Pos + wxPoint( m_Size.x, 0 );
437  corners[2] = m_Pos + wxPoint( m_Size.x, m_Size.y );
438  corners[3] = m_Pos + wxPoint( 0, m_Size.y );
439 
440  wxPoint rCentre = aRect.Centre();
441 
442  for( int i = 0; i < 4; i++ )
443  {
444  wxPoint delta = corners[i] - rCentre;
445  RotatePoint( &delta, -aRot );
446  delta += rCentre;
447 
448  if( aRect.Contains( delta ) )
449  {
450  return true;
451  }
452  }
453 
454  /* Test B : Any corners of rotated rect exist in this one? */
455  int w = aRect.GetWidth() / 2;
456  int h = aRect.GetHeight() / 2;
457 
458  // Construct corners around center of shape
459  corners[0] = wxPoint( -w, -h );
460  corners[1] = wxPoint( w, -h );
461  corners[2] = wxPoint( w, h );
462  corners[3] = wxPoint( -w, h );
463 
464  // Rotate and test each corner
465  for( int j=0; j<4; j++ )
466  {
467  RotatePoint( &corners[j], aRot );
468  corners[j] += rCentre;
469 
470  if( Contains( corners[j] ) )
471  {
472  return true;
473  }
474  }
475 
476  /* Test C : Any sides of rotated rect intersect this */
477 
478  if( Intersects( corners[0], corners[1] ) ||
479  Intersects( corners[1], corners[2] ) ||
480  Intersects( corners[2], corners[3] ) ||
481  Intersects( corners[3], corners[0] ) )
482  {
483  return true;
484  }
485 
486 
487  return false;
488 }
int GetWidth() const
Definition: eda_rect.h:119
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:131
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
bool Contains(const wxPoint &aPoint) const
Function Contains.
wxSize m_Size
Definition: eda_rect.h:48
int GetHeight() const
Definition: eda_rect.h:120
bool m_init
Definition: eda_rect.h:49
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
wxPoint m_Pos
Definition: eda_rect.h:47
wxPoint Centre() const
Definition: eda_rect.h:62
bool Intersects(const EDA_RECT &aRect) const
Function Intersects tests for a common area between rectangles.
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.

References Centre(), Contains(), GetHeight(), GetWidth(), Inflate(), Intersects(), m_init, m_Pos, m_Size, RotatePoint(), and SetOrigin().

◆ Intersects() [3/3]

bool EDA_RECT::Intersects ( const wxPoint aPoint1,
const wxPoint aPoint2 
) const

Function Intersects tests for a common area between a segment and this rectangle.

Parameters
aPoint1First point of the segment to test intersection with.
aPoint2Second point of the segment to test intersection with.
Returns
bool - true if the argument segment intersects this rectangle. (i.e. if the segment and rectangle have at least a common point)

Definition at line 326 of file base_struct.cpp.

327 {
328  wxPoint point2, point4;
329 
330  if( Contains( aPoint1 ) || Contains( aPoint2 ) )
331  return true;
332 
333  point2.x = GetEnd().x;
334  point2.y = GetOrigin().y;
335  point4.x = GetOrigin().x;
336  point4.y = GetEnd().y;
337 
338  //Only need to test 3 sides since a straight line cant enter and exit on same side
339  if( SegmentIntersectsSegment( aPoint1, aPoint2, GetOrigin() , point2 ) )
340  return true;
341 
342  if( SegmentIntersectsSegment( aPoint1, aPoint2, point2 , GetEnd() ) )
343  return true;
344 
345  if( SegmentIntersectsSegment( aPoint1, aPoint2, GetEnd() , point4 ) )
346  return true;
347 
348  return false;
349 }
bool Contains(const wxPoint &aPoint) const
Function Contains.
bool SegmentIntersectsSegment(const wxPoint &a_p1_l1, const wxPoint &a_p2_l1, const wxPoint &a_p1_l2, const wxPoint &a_p2_l2, wxPoint *aIntersectionPoint=nullptr)
Test if two lines intersect.
Definition: trigo.cpp:61
const wxPoint GetEnd() const
Definition: eda_rect.h:116
const wxPoint GetOrigin() const
Definition: eda_rect.h:114

References Contains(), GetEnd(), GetOrigin(), SegmentIntersectsSegment(), wxPoint::x, and wxPoint::y.

◆ IntersectsCircle()

bool EDA_RECT::IntersectsCircle ( const wxPoint aCenter,
const int  aRadius 
) const

Function IntersectsCircle tests for a common area between a circle and this rectangle.

Parameters
aCentercenter of the circle
aRadiusradius of the circle

Definition at line 518 of file base_struct.cpp.

519 {
520  if( !m_init )
521  return false;
522 
523  wxPoint closest = ClosestPointTo( aCenter );
524 
525  double dx = aCenter.x - closest.x;
526  double dy = aCenter.y - closest.y;
527 
528  double r = (double) aRadius;
529 
530  return ( dx * dx + dy * dy ) <= ( r * r );
531 }
bool m_init
Definition: eda_rect.h:49
const wxPoint ClosestPointTo(const wxPoint &aPoint) const
Return the point in this rect that is closest to the provided point.

References ClosestPointTo(), m_init, wxPoint::x, and wxPoint::y.

Referenced by VIA::HitTest(), D_PAD::HitTest(), LIB_CIRCLE::Inside(), and IntersectsCircleEdge().

◆ IntersectsCircleEdge()

bool EDA_RECT::IntersectsCircleEdge ( const wxPoint aCenter,
const int  aRadius,
const int  aWidth 
) const

IntersectsCircleEdge Tests for intersection between this rect and the edge (radius) of a circle.

Parameters
aCentercenter of the circle
aRadiusradius of the circle
aWidthwidth of the circle edge

Definition at line 534 of file base_struct.cpp.

535 {
536  if( !m_init )
537  return false;
538 
539  EDA_RECT me( *this );
540  me.Normalize(); // ensure size is >= 0
541 
542  // Test if the circle intersects at all
543  if( !IntersectsCircle( aCenter, aRadius + aWidth / 2 ) )
544  {
545  return false;
546  }
547 
548  wxPoint farpt = FarthestPointTo( aCenter );
549  // Farthest point must be further than the inside of the line
550  double fx = (double) farpt.x;
551  double fy = (double) farpt.y;
552 
553  double r = (double) aRadius - (double) aWidth / 2;
554 
555  return ( fx * fx + fy * fy ) > ( r * r );
556 }
bool IntersectsCircle(const wxPoint &aCenter, const int aRadius) const
Function IntersectsCircle tests for a common area between a circle and this rectangle.
const wxPoint FarthestPointTo(const wxPoint &aPoint) const
Return the point in this rect that is farthest from the provided point.
bool m_init
Definition: eda_rect.h:49
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

References FarthestPointTo(), IntersectsCircle(), m_init, Normalize(), wxPoint::x, and wxPoint::y.

Referenced by LIB_CIRCLE::HitTest(), LIB_ARC::HitTest(), and DRAWSEGMENT::HitTest().

◆ IsValid()

bool EDA_RECT::IsValid ( ) const
inline

Definition at line 126 of file eda_rect.h.

127  {
128  return m_init;
129  }
bool m_init
Definition: eda_rect.h:49

References m_init.

Referenced by Merge().

◆ Merge() [1/2]

void EDA_RECT::Merge ( const EDA_RECT aRect)

Function Merge modifies the position and size of the rectangle in order to contain aRect.

It is mainly used to calculate bounding boxes.

Parameters
aRectThe rectangle to merge with this rectangle.

Definition at line 634 of file base_struct.cpp.

635 {
636  if( !m_init )
637  {
638  if( aRect.IsValid() )
639  {
640  m_Pos = aRect.GetPosition();
641  m_Size = aRect.GetSize();
642  m_init = true;
643  }
644  return;
645  }
646 
647  Normalize(); // ensure width and height >= 0
648  EDA_RECT rect = aRect;
649  rect.Normalize(); // ensure width and height >= 0
650  wxPoint end = GetEnd();
651  wxPoint rect_end = rect.GetEnd();
652 
653  // Change origin and size in order to contain the given rect
654  m_Pos.x = std::min( m_Pos.x, rect.m_Pos.x );
655  m_Pos.y = std::min( m_Pos.y, rect.m_Pos.y );
656  end.x = std::max( end.x, rect_end.x );
657  end.y = std::max( end.y, rect_end.y );
658  SetEnd( end );
659 }
const wxPoint GetEnd() const
Definition: eda_rect.h:116
wxSize m_Size
Definition: eda_rect.h:48
void SetEnd(int x, int y)
Definition: eda_rect.h:192
const wxPoint GetPosition() const
Definition: eda_rect.h:115
void Normalize()
Function Normalize ensures that the height ant width are positive.
bool m_init
Definition: eda_rect.h:49
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
wxPoint m_Pos
Definition: eda_rect.h:47
bool IsValid() const
Definition: eda_rect.h:126
const wxSize GetSize() const
Definition: eda_rect.h:103

References GetEnd(), GetPosition(), GetSize(), IsValid(), m_init, m_Pos, m_Size, Normalize(), SetEnd(), wxPoint::x, and wxPoint::y.

Referenced by DRAWSEGMENT::computeArcBBox(), GBR_LAYOUT::ComputeBoundingBox(), BOARD::ComputeBoundingBox(), LIB_PART::GetBodyBoundingBox(), SELECTION::GetBoundingBox(), MODULE::GetBoundingBox(), DRAWSEGMENT::GetBoundingBox(), SCH_COMPONENT::GetBoundingBox(), SCH_SHEET::GetBoundingBox(), D_PAD::GetBoundingBox(), GERBVIEW_SELECTION::GetCenter(), MODULE::GetFootprintRect(), MODULE::GetFpPadsLocalBbox(), getSheetBbox(), LIB_PART::GetUnitBoundingBox(), ARC::HitTest(), GERBVIEW_SELECTION::ViewBBox(), and MODULE::ViewBBox().

◆ Merge() [2/2]

void EDA_RECT::Merge ( const wxPoint aPoint)

Function Merge modifies the position and size of the rectangle in order to contain the given point.

Parameters
aPointThe point to merge with the rectangle.

Definition at line 662 of file base_struct.cpp.

663 {
664  if( !m_init )
665  {
666  m_Pos = aPoint;
667  m_Size = wxSize( 0, 0 );
668  return;
669  }
670 
671  Normalize(); // ensure width and height >= 0
672 
673  wxPoint end = GetEnd();
674  // Change origin and size in order to contain the given rect
675  m_Pos.x = std::min( m_Pos.x, aPoint.x );
676  m_Pos.y = std::min( m_Pos.y, aPoint.y );
677  end.x = std::max( end.x, aPoint.x );
678  end.y = std::max( end.y, aPoint.y );
679  SetEnd( end );
680 }
const wxPoint GetEnd() const
Definition: eda_rect.h:116
wxSize m_Size
Definition: eda_rect.h:48
void SetEnd(int x, int y)
Definition: eda_rect.h:192
void Normalize()
Function Normalize ensures that the height ant width are positive.
bool m_init
Definition: eda_rect.h:49
wxPoint m_Pos
Definition: eda_rect.h:47

References GetEnd(), m_init, m_Pos, m_Size, Normalize(), SetEnd(), wxPoint::x, and wxPoint::y.

◆ Move()

void EDA_RECT::Move ( const wxPoint aMoveVector)

Function Move moves the rectangle by the aMoveVector.

Parameters
aMoveVectorA wxPoint that is the value to move this rectangle

Definition at line 293 of file base_struct.cpp.

294 {
295  m_Pos += aMoveVector;
296 }
wxPoint m_Pos
Definition: eda_rect.h:47

References m_Pos.

Referenced by APERTURE_MACRO::GetApertureMacroShape(), SCH_BITMAP::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), AR_AUTOPLACER::getOptimalModulePlacement(), EDA_TEXT::GetTextBox(), and AR_AUTOPLACER::testModuleOnBoard().

◆ Normalize()

◆ Offset() [1/2]

void EDA_RECT::Offset ( int  dx,
int  dy 
)
inline

Definition at line 157 of file eda_rect.h.

158  {
159  m_Pos.x += dx;
160  m_Pos.y += dy;
161  }
wxPoint m_Pos
Definition: eda_rect.h:47

References m_Pos, wxPoint::x, and wxPoint::y.

Referenced by SCH_COMPONENT::GetBodyBoundingBox(), and SCH_PIN::GetBoundingBox().

◆ Offset() [2/2]

void EDA_RECT::Offset ( const wxPoint offset)
inline

Definition at line 163 of file eda_rect.h.

164  {
165  m_Pos += offset;
166  }
wxPoint m_Pos
Definition: eda_rect.h:47

References m_Pos.

◆ operator BOX2I()

EDA_RECT::operator BOX2I ( ) const
inline

Function operator(BOX2I) overloads the cast operator to return a BOX2I.

Returns
BOX2I - this box shaped as a BOX2I object.

Definition at line 293 of file eda_rect.h.

294  {
295  EDA_RECT rect( m_Pos, m_Size );
296  rect.Normalize();
297  return BOX2I( rect.GetOrigin(), rect.GetSize() );
298  }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:521
wxSize m_Size
Definition: eda_rect.h:48
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
wxPoint m_Pos
Definition: eda_rect.h:47

References GetOrigin(), GetSize(), m_Pos, m_Size, and Normalize().

◆ operator wxRect()

EDA_RECT::operator wxRect ( ) const
inline

Function operator(wxRect) overloads the cast operator to return a wxRect wxRect does not accept negative values for size, so ensure the wxRect size is always >= 0.

Definition at line 281 of file eda_rect.h.

282  {
283  EDA_RECT rect( m_Pos, m_Size );
284  rect.Normalize();
285  return wxRect( rect.m_Pos, rect.m_Size );
286  }
wxSize m_Size
Definition: eda_rect.h:48
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
wxPoint m_Pos
Definition: eda_rect.h:47

References m_Pos, m_Size, and Normalize().

◆ RevertYAxis()

void EDA_RECT::RevertYAxis ( )
inline

Function RevertYAxis Mirror the rectangle from the X axis (negate Y pos and size)

Definition at line 209 of file eda_rect.h.

210  {
211  m_Pos.y = -m_Pos.y;
212  m_Size.y = -m_Size.y;
213  Normalize();
214  }
wxSize m_Size
Definition: eda_rect.h:48
void Normalize()
Function Normalize ensures that the height ant width are positive.
wxPoint m_Pos
Definition: eda_rect.h:47

References m_Pos, m_Size, Normalize(), and wxPoint::y.

Referenced by KIGFX::SCH_PAINTER::draw(), LIB_CIRCLE::GetBoundingBox(), LIB_RECTANGLE::GetBoundingBox(), LIB_TEXT::GetBoundingBox(), LIB_BEZIER::GetBoundingBox(), LIB_POLYLINE::GetBoundingBox(), SCH_PIN::GetBoundingBox(), LIB_PIN::GetBoundingBox(), LIB_FIELD::GetBoundingBox(), LIB_TEXT::Plot(), LIB_FIELD::Plot(), and LIB_TEXT::print().

◆ SetEnd() [1/2]

◆ SetEnd() [2/2]

void EDA_RECT::SetEnd ( const wxPoint pos)
inline

Definition at line 198 of file eda_rect.h.

199  {
200  m_Size.x = pos.x - m_Pos.x;
201  m_Size.y = pos.y - m_Pos.y;
202  m_init = true;
203  }
wxSize m_Size
Definition: eda_rect.h:48
bool m_init
Definition: eda_rect.h:49
wxPoint m_Pos
Definition: eda_rect.h:47

References m_init, m_Pos, m_Size, wxPoint::x, and wxPoint::y.

◆ SetHeight()

void EDA_RECT::SetHeight ( int  val)
inline

◆ SetOrigin() [1/2]

◆ SetOrigin() [2/2]

void EDA_RECT::SetOrigin ( int  x,
int  y 
)
inline

Definition at line 137 of file eda_rect.h.

138  {
139  m_Pos.x = x;
140  m_Pos.y = y;
141  m_init = true;
142  }
bool m_init
Definition: eda_rect.h:49
wxPoint m_Pos
Definition: eda_rect.h:47

References m_init, m_Pos, wxPoint::x, and wxPoint::y.

◆ SetSize() [1/2]

void EDA_RECT::SetSize ( const wxSize &  size)
inline

Definition at line 144 of file eda_rect.h.

145  {
146  m_Size = size;
147  m_init = true;
148  }
wxSize m_Size
Definition: eda_rect.h:48
bool m_init
Definition: eda_rect.h:49

References m_init, and m_Size.

Referenced by WS_DRAW_ITEM_BITMAP::GetBoundingBox(), D_PAD::GetBoundingBox(), EDA_TEXT::GetTextBox(), D_PAD::HitTest(), and DIALOG_SHIM::ResetSize().

◆ SetSize() [2/2]

void EDA_RECT::SetSize ( int  w,
int  h 
)
inline

Definition at line 150 of file eda_rect.h.

151  {
152  m_Size.x = w;
153  m_Size.y = h;
154  m_init = true;
155  }
wxSize m_Size
Definition: eda_rect.h:48
bool m_init
Definition: eda_rect.h:49

References m_init, and m_Size.

◆ SetWidth()

void EDA_RECT::SetWidth ( int  val)
inline

◆ SetX()

◆ SetY()

Member Data Documentation

◆ m_init

bool EDA_RECT::m_init
private

◆ m_Pos

◆ m_Size


The documentation for this class was generated from the following files: