Class EDA_RECT handles the component boundary box. More...

#include <eda_rect.h>

Inheritance diagram for EDA_RECT:

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

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_RECT &	Inflate (wxCoord dx, wxCoord dy)
	Function Inflate inflates the rectangle horizontally by dx and vertically by dy. More...

EDA_RECT &	Inflate (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

Detailed Description

Class 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 51 of file eda_rect.h.

51 { };

◆ EDA_RECT() [2/2]

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

inline

Definition at line 53 of file eda_rect.h.

                                                          :
         m_Pos( aPos ),
         m_Size( aSize )
     { }

◆ ~EDA_RECT()

virtual EDA_RECT::~EDA_RECT ( )

inlinevirtual

Definition at line 58 of file eda_rect.h.

58 { };

Member Function Documentation

◆ Centre()

wxPoint EDA_RECT::Centre ( ) const

inline

Definition at line 60 of file eda_rect.h.

     {
         return wxPoint( m_Pos.x + ( m_Size.x >> 1 ),
                         m_Pos.y + ( m_Size.y >> 1 ) );
     }

References m_Pos, and m_Size.

Referenced by PCB_EDIT_FRAME::AppendBoardFile(), FOOTPRINT_EDIT_FRAME::BestZoom(), PCB_BASE_FRAME::BestZoom(), GERBVIEW_FRAME::BestZoom(), PCB_EDIT_FRAME::Block_Flip(), PCB_EDIT_FRAME::Block_Rotate(), KIGFX::SCH_PAINTER::draw(), SCH_FIELD::Draw(), LIB_TEXT::drawGraphic(), BOARD_NETLIST_UPDATER::estimateComponentInsertionPosition(), AUTOPLACER::field_box_placement(), AUTOPLACER::field_horiz_placement(), GENDRILL_WRITER_BASE::genDrillMapFile(), DRAWSEGMENT::GetCenter(), FOOTPRINT_EDIT_FRAME::HandleBlockEnd(), initializePlotter(), CINFO3D_VISU::InitSettings(), Intersects(), InvokeDialogImportGfxBoard(), InvokeDialogImportGfxModule(), SCH_FIELD::IsHorizJustifyFlipped(), SCH_EAGLE_PLUGIN::loadSheet(), LIB_PIN::Matches(), SCH_TEXT::Matches(), SCH_SHEET_PIN::Matches(), SCH_FIELD::Matches(), SCH_EDIT_TOOL::Mirror(), PCB_EDIT_FRAME::OnExportIDF3(), DIALOG_LIB_EDIT_PIN::OnPaintShowPanel(), LIB_TEXT::Plot(), SCH_FIELD::Plot(), LIB_FIELD::Plot(), and SCH_EDIT_TOOL::Rotate().

◆ 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 531 of file base_struct.cpp.

 {
     EDA_RECT me( *this );
 
     me.Normalize();         // ensure size is >= 0
 
     // Determine closest point to the circle centre within this rect
     int nx = std::max( me.GetLeft(), std::min( aPoint.x, me.GetRight() ) );
     int ny = std::max( me.GetTop(), std::min( aPoint.y, me.GetBottom() ) );
 
     return wxPoint( nx, ny );
 }

References GetBottom(), GetLeft(), GetRight(), GetTop(), max, min, and Normalize().

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

aRect is 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 705 of file base_struct.cpp.

 {
     EDA_RECT r;
 
     if( Intersects( aRect ) )
     {
         wxPoint originA( std::min( GetOrigin().x, GetEnd().x ),
                          std::min( GetOrigin().y, GetEnd().y ) );
         wxPoint originB( std::min( aRect.GetOrigin().x, aRect.GetEnd().x ),
                          std::min( aRect.GetOrigin().y, aRect.GetEnd().y ) );
         wxPoint endA( std::max( GetOrigin().x, GetEnd().x ),
                       std::max( GetOrigin().y, GetEnd().y ) );
         wxPoint endB( std::max( aRect.GetOrigin().x, aRect.GetEnd().x ),
                       std::max( aRect.GetOrigin().y, aRect.GetEnd().y ) );
 
         r.SetOrigin( wxPoint( std::max( originA.x, originB.x ), std::max( originA.y, originB.y ) ) );
         r.SetEnd   ( wxPoint( std::min( endA.x, endB.x ),       std::min( endA.y, endB.y ) ) );
     }
 
     return r;
 }

References GetEnd(), GetOrigin(), Intersects(), max, min, SetEnd(), and SetOrigin().

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 345 of file base_struct.cpp.

 {
     wxPoint rel_pos = aPoint - m_Pos;
     wxSize size     = m_Size;
 
     if( size.x < 0 )
     {
         size.x    = -size.x;
         rel_pos.x += size.x;
     }
 
     if( size.y < 0 )
     {
         size.y    = -size.y;
         rel_pos.y += size.y;
     }
 
     return (rel_pos.x >= 0) && (rel_pos.y >= 0) && ( rel_pos.y <= size.y) && ( rel_pos.x <= size.x);
 }

References m_Pos, and m_Size.

Referenced by AR_AUTOPLACER::AutoplaceModules(), Contains(), GRPutPixel(), LIB_CIRCLE::HitTest(), SCH_PIN::HitTest(), LIB_BEZIER::HitTest(), LIB_POLYLINE::HitTest(), LIB_ARC::HitTest(), PCB_TARGET::HitTest(), SCH_JUNCTION::HitTest(), SCH_NO_CONNECT::HitTest(), SCH_BUS_ENTRY_BASE::HitTest(), LIB_PIN::HitTest(), SCH_BITMAP::HitTest(), SCH_SHEET_PIN::HitTest(), SCH_TEXT::HitTest(), SCH_LINE::HitTest(), SCH_FIELD::HitTest(), DRAWSEGMENT::HitTest(), LIB_ITEM::HitTest(), DIMENSION::HitTest(), TRACK::HitTest(), GERBER_DRAW_ITEM::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_POLYLINE::Inside(), LIB_ARC::Inside(), LIB_PIN::Inside(), Intersects(), MarkItemsInBloc(), AR_AUTOPLACER::nearestPad(), PCB_EDIT_FRAME::SpreadFootprints(), 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 92 of file eda_rect.h.

92 { return Contains( wxPoint( x, y ) ); }

EDA_RECT::Contains

bool Contains(const wxPoint &aPoint) const

Function Contains.

Definition: base_struct.cpp:345

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 366 of file base_struct.cpp.

 {
     return Contains( aRect.GetOrigin() ) && Contains( aRect.GetEnd() );
 }

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 545 of file base_struct.cpp.

 {
     EDA_RECT me( *this );
 
     me.Normalize();         // ensure size is >= 0
 
     int fx = std::max( std::abs( aPoint.x - me.GetLeft() ), std::abs( aPoint.x - me.GetRight() ) );
     int fy = std::max( std::abs( aPoint.y - me.GetTop() ), std::abs( aPoint.y - me.GetBottom() ) );
 
     return wxPoint( fx, fy );
 }

References abs, GetBottom(), GetLeft(), GetRight(), GetTop(), max, and Normalize().

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 699 of file base_struct.cpp.

 {
     return (double) GetWidth() * (double) GetHeight();
 }

References GetHeight(), and GetWidth().

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

◆ GetBottom()

int EDA_RECT::GetBottom ( ) const

inline

Definition at line 122 of file eda_rect.h.

122 { return m_Pos.y + m_Size.y; } // Y axis from top to bottom

EDA_RECT::m_Size

wxSize m_Size

Definition: eda_rect.h:48

EDA_RECT::m_Pos

wxPoint m_Pos

Definition: eda_rect.h:47

References m_Pos, and m_Size.

Referenced by AR_AUTOPLACER::addPad(), clipCircle(), ClipLine(), clipOutCode(), ClosestPointTo(), PCB_EDIT_FRAME::DoGenFootprintsReport(), GBR_LAYOUT::Draw(), DrawMovingBlockOutlines(), BOARD_NETLIST_UPDATER::estimateComponentInsertionPosition(), FarthestPointTo(), AUTOPLACER::fit_fields_between_wires(), GENDRILL_WRITER_BASE::genDrillMapFile(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), SCH_COMPONENT::GetBodyBoundingBox(), DIMENSION::GetBoundingBox(), SCH_SHEET::GetMinHeight(), GRArc(), GRArc1(), GRFilledArc(), GRRect(), GRRectPs(), D_PAD::HitTest(), IsGRSPolyDrawable(), SCH_EAGLE_PLUGIN::loadSchematic(), and EDA_TEXT::TransformBoundingBoxWithClearanceToPolygon().

◆ 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 728 of file base_struct.cpp.

 {
     wxPoint corners[4];
 
     // Build the corners list
     corners[0]   = GetOrigin();
     corners[2]   = GetEnd();
     corners[1].x = corners[0].x;
     corners[1].y = corners[2].y;
     corners[3].x = corners[2].x;
     corners[3].y = corners[0].y;
 
     // Rotate all corners, to find the bounding box
     for( int ii = 0; ii < 4; ii ++ )
         RotatePoint( &corners[ii], aRotCenter, aAngle );
 
     // Find the corners bounding box
     wxPoint start = corners[0];
     wxPoint end = corners[0];
 
     for( int ii = 1; ii < 4; ii ++ )
     {
         start.x = std::min( start.x, corners[ii].x);
         start.y = std::min( start.y, corners[ii].y);
         end.x = std::max( end.x, corners[ii].x);
         end.y = std::max( end.y, corners[ii].y);
     }
 
     EDA_RECT bbox;
     bbox.SetOrigin( start );
     bbox.SetEnd( end );
 
     return bbox;
 }

References GetEnd(), GetOrigin(), max, min, RotatePoint(), SetEnd(), and SetOrigin().

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

◆ GetCenter()

const wxPoint EDA_RECT::GetCenter ( ) const

inline

Definition at line 115 of file eda_rect.h.

115 { return wxPoint( m_Pos.x + ( m_Size.x / 2 ), m_Pos.y + ( m_Size.y / 2 ) ); }

EDA_RECT::m_Size

wxSize m_Size

Definition: eda_rect.h:48

EDA_RECT::m_Pos

wxPoint m_Pos

Definition: eda_rect.h:47

References m_Pos, and m_Size.

Referenced by DIALOG_EXPORT_STEP::onExportButton().

◆ GetEnd()

const wxPoint EDA_RECT::GetEnd ( ) const

inline

Definition at line 114 of file eda_rect.h.

114 { return wxPoint( m_Pos.x + m_Size.x, m_Pos.y + m_Size.y ); }

EDA_RECT::m_Size

wxSize m_Size

Definition: eda_rect.h:48

EDA_RECT::m_Pos

wxPoint m_Pos

Definition: eda_rect.h:47

References m_Pos, and m_Size.

Referenced by BuildBoardPolygonOutlines(), AR_AUTOPLACER::buildFpAreas(), AR_AUTOPLACER::calculateKeepOutArea(), Common(), AR_MATRIX::ComputeMatrixSize(), Contains(), FillNegativeKnockout(), LIB_TEXT::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), LIB_FIELD::GetBoundingBox(), SCH_LABEL::GetBoundingBox(), GERBER_DRAW_ITEM::GetBoundingBox(), GetBoundingBoxRotated(), LIB_CIRCLE::GetMsgPanelInfo(), LIB_POLYLINE::GetMsgPanelInfo(), LIB_ARC::GetMsgPanelInfo(), LIB_BEZIER::GetMsgPanelInfo(), AR_AUTOPLACER::getOptimalModulePlacement(), Intersects(), Merge(), PCB_EDIT_FRAME::OnNetlistChanged(), SVG_PLOTTER::Rect(), PCB_EDIT_FRAME::SpreadFootprints(), AR_AUTOPLACER::testRectangle(), and TRANSFORM::TransformCoordinate().

◆ GetHeight()

int EDA_RECT::GetHeight ( ) const

inline

Definition at line 118 of file eda_rect.h.

118 { return m_Size.y; }

EDA_RECT::m_Size

wxSize m_Size

Definition: eda_rect.h:48

References m_Size.

Referenced by GERBER_JOBFILE_WRITER::addJSONGeneralSpecs(), AllAreModulesAndReturnSmallestIfSo(), FOOTPRINT_EDIT_FRAME::BestZoom(), PCB_BASE_FRAME::BestZoom(), GERBVIEW_FRAME::BestZoom(), BuildBoardPolygonOutlines(), EAGLE_PLUGIN::centerBoard(), ClipAndDrawPoly(), AR_MATRIX::ComputeMatrixSize(), DIALOG_EXPORT_SVG::CreateSVGFile(), CreateThermalReliefPadPolygon(), DrawPageOnClipboard(), BOARD_NETLIST_UPDATER::estimateComponentInsertionPosition(), AUTOPLACER::field_box_placement(), AUTOPLACER::field_vert_placement(), fillRectList(), GENDRILL_WRITER_BASE::genDrillMapFile(), AR_AUTOPLACER::genPlacementRoutingMatrix(), AUTOPLACER::get_preferred_sides(), GetArea(), MODULE::GetArea(), PCB_BASE_FRAME::GetBoardBoundingBox(), MARKER_PCB::GetBoundingBox(), LIB_VIEW_FRAME::GetDocumentExtents(), BOARD::GetFootprint(), SCH_SHEET::GetMinHeight(), D_PAD::HitTest(), CINFO3D_VISU::InitSettings(), Intersects(), SCH_EAGLE_PLUGIN::loadSchematic(), DSN::SPECCTRA_DB::makePADSTACK(), moveFootprintsInArea(), EDA_DRAW_PANEL::OnMouseEvent(), DIALOG_LIB_EDIT_PIN::OnPaintShowPanel(), SELECTION_TOOL::pickSmallestComponent(), WORKSHEET_DATAITEM_TEXT::SetConstrainedTextSize(), PCB_EDIT_FRAME::SpreadFootprints(), DRC::testCopperTextItem(), and MARKER_PCB::ViewBBox().

◆ GetLeft()

int EDA_RECT::GetLeft ( ) const

inline

Definition at line 120 of file eda_rect.h.

120 { return m_Pos.x; }

EDA_RECT::m_Pos

wxPoint m_Pos

Definition: eda_rect.h:47

References m_Pos.

Referenced by AR_AUTOPLACER::addPad(), ClosestPointTo(), FarthestPointTo(), AUTOPLACER::field_horiz_placement(), D_PAD::HitTest(), and SCH_EAGLE_PLUGIN::loadSchematic().

◆ GetOrigin()

const wxPoint EDA_RECT::GetOrigin ( ) const

inline

Definition at line 112 of file eda_rect.h.

112 { return m_Pos; }

EDA_RECT::m_Pos

wxPoint m_Pos

Definition: eda_rect.h:47

References m_Pos.

Referenced by PCB_EDIT_FRAME::AppendBoardFile(), BuildBoardPolygonOutlines(), AR_AUTOPLACER::buildFpAreas(), AR_AUTOPLACER::calculateKeepOutArea(), Common(), Contains(), DIALOG_EXPORT_SVG::CreateSVGFile(), BOARD_PRINTOUT::DrawPage(), FillNegativeKnockout(), LIB_TEXT::GetBoundingBox(), MARKER_PCB::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), LIB_FIELD::GetBoundingBox(), SCH_LABEL::GetBoundingBox(), GERBER_DRAW_ITEM::GetBoundingBox(), GetBoundingBoxRotated(), AR_MATRIX::GetBrdCoordOrigin(), MATRIX_ROUTING_HEAD::GetBrdCoordOrigin(), LIB_VIEW_FRAME::GetDocumentExtents(), LIB_CIRCLE::GetMsgPanelInfo(), LIB_POLYLINE::GetMsgPanelInfo(), LIB_ARC::GetMsgPanelInfo(), LIB_BEZIER::GetMsgPanelInfo(), AR_AUTOPLACER::getOptimalModulePlacement(), idf_export_outline(), Intersects(), InvokeDialogImportGfxBoard(), InvokeDialogImportGfxModule(), moveFootprintsInArea(), PCB_EDIT_FRAME::OnNetlistChanged(), operator BOX2I(), SVG_PLOTTER::Rect(), PCB_EDIT_FRAME::SpreadFootprints(), AR_AUTOPLACER::testRectangle(), EDA_TEXT::TransformBoundingBoxWithClearanceToPolygon(), TRANSFORM::TransformCoordinate(), MARKER_PCB::ViewBBox(), DRAWSEGMENT::ViewBBox(), GERBER_DRAW_ITEM::ViewBBox(), and D_PAD::ViewBBox().

◆ GetPosition()

const wxPoint EDA_RECT::GetPosition ( ) const

inline

Definition at line 113 of file eda_rect.h.

113 { return m_Pos; }

EDA_RECT::m_Pos

wxPoint m_Pos

Definition: eda_rect.h:47

References m_Pos.

Referenced by CN_ITEM::BBox(), AUTOPLACER::fit_fields_between_wires(), MARKER_BASE::GetBoundingBoxMarker(), DIALOG_SHIM::Show(), DRC::testOutline(), TEXTE_MODULE::ViewBBox(), and SCH_BASE_FRAME::Window_Zoom().

◆ GetRight()

int EDA_RECT::GetRight ( ) const

inline

Definition at line 119 of file eda_rect.h.

119 { return m_Pos.x + m_Size.x; }

EDA_RECT::m_Size

wxSize m_Size

Definition: eda_rect.h:48

EDA_RECT::m_Pos

wxPoint m_Pos

Definition: eda_rect.h:47

References m_Pos, and m_Size.

Referenced by AR_AUTOPLACER::addPad(), clipCircle(), ClipLine(), clipOutCode(), ClosestPointTo(), PCB_EDIT_FRAME::DoGenFootprintsReport(), GBR_LAYOUT::Draw(), DrawMovingBlockOutlines(), FarthestPointTo(), AUTOPLACER::field_horiz_placement(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), SCH_COMPONENT::GetBodyBoundingBox(), DIMENSION::GetBoundingBox(), SCH_SHEET::GetMinWidth(), GRArc(), GRArc1(), GRFilledArc(), GRRect(), GRRectPs(), D_PAD::HitTest(), IsGRSPolyDrawable(), and EDA_TEXT::TransformBoundingBoxWithClearanceToPolygon().

◆ GetSize()

const wxSize EDA_RECT::GetSize ( ) const

inline

Definition at line 101 of file eda_rect.h.

101 { return m_Size; }

EDA_RECT::m_Size

wxSize m_Size

Definition: eda_rect.h:48

References m_Size.

Referenced by PCB_EDIT_FRAME::AppendBoardFile(), CN_ITEM::BBox(), BOARD_PRINTOUT::DrawPage(), MARKER_BASE::GetBoundingBoxMarker(), idf_export_outline(), initializePlotter(), CINFO3D_VISU::InitSettings(), InvokeDialogImportGfxBoard(), InvokeDialogImportGfxModule(), SCH_EAGLE_PLUGIN::loadSheet(), LIB_EDIT_FRAME::OnPlotCurrentComponent(), operator BOX2I(), DIALOG_SHIM::Show(), TEXTE_MODULE::ViewBBox(), DRAWSEGMENT::ViewBBox(), GERBER_DRAW_ITEM::ViewBBox(), D_PAD::ViewBBox(), and SCH_BASE_FRAME::Window_Zoom().

◆ GetSizeMax()

int EDA_RECT::GetSizeMax ( ) const

inline

GetSizeMax.

Returns: the max size dimension

Definition at line 107 of file eda_rect.h.

107 { return ( m_Size.x > m_Size.y )?m_Size.x:m_Size.y; }

EDA_RECT::m_Size

wxSize m_Size

Definition: eda_rect.h:48

References m_Size.

Referenced by CINFO3D_VISU::AddShapeWithClearanceToContainer(), and CINFO3D_VISU::transformGraphicModuleEdgeToPolygonSet().

◆ GetTop()

int EDA_RECT::GetTop ( ) const

inline

Definition at line 121 of file eda_rect.h.

121 { return m_Pos.y; }

EDA_RECT::m_Pos

wxPoint m_Pos

Definition: eda_rect.h:47

References m_Pos.

Referenced by AR_AUTOPLACER::addPad(), ClosestPointTo(), AUTOPLACER::DoAutoplace(), FarthestPointTo(), AUTOPLACER::fit_fields_between_wires(), and D_PAD::HitTest().

◆ GetWidth()

int EDA_RECT::GetWidth ( ) const

inline

Definition at line 117 of file eda_rect.h.

117 { return m_Size.x; }

EDA_RECT::m_Size

wxSize m_Size

Definition: eda_rect.h:48

References m_Size.

Referenced by GERBER_JOBFILE_WRITER::addJSONGeneralSpecs(), AllAreModulesAndReturnSmallestIfSo(), FOOTPRINT_EDIT_FRAME::BestZoom(), PCB_BASE_FRAME::BestZoom(), GERBVIEW_FRAME::BestZoom(), PCB_EDIT_FRAME::Block_SelectItems(), BuildBoardPolygonOutlines(), EAGLE_PLUGIN::centerBoard(), ClipAndDrawPoly(), AR_MATRIX::ComputeMatrixSize(), DIALOG_EXPORT_SVG::CreateSVGFile(), CreateThermalReliefPadPolygon(), DrawPageOnClipboard(), BOARD_NETLIST_UPDATER::estimateComponentInsertionPosition(), AUTOPLACER::field_box_placement(), fillRectList(), GENDRILL_WRITER_BASE::genDrillMapFile(), AR_AUTOPLACER::genPlacementRoutingMatrix(), AUTOPLACER::get_preferred_sides(), GetArea(), MODULE::GetArea(), PCB_BASE_FRAME::GetBoardBoundingBox(), MARKER_PCB::GetBoundingBox(), LIB_VIEW_FRAME::GetDocumentExtents(), BOARD::GetFootprint(), SCH_SHEET::GetMinWidth(), EDA_TEXT::GetTextBox(), D_PAD::HitTest(), CINFO3D_VISU::InitSettings(), Intersects(), SCH_EAGLE_PLUGIN::loadSchematic(), DSN::SPECCTRA_DB::makePADSTACK(), moveFootprintsInArea(), EDA_DRAW_PANEL::OnMouseEvent(), DIALOG_LIB_EDIT_PIN::OnPaintShowPanel(), SELECTION_TOOL::pickSmallestComponent(), WORKSHEET_DATAITEM_TEXT::SetConstrainedTextSize(), PCB_EDIT_FRAME::SpreadFootprints(), DRC::testCopperTextItem(), MARKER_PCB::ViewBBox(), and GERBER_DRAW_ITEM::ViewGetLOD().

◆ GetX()

int EDA_RECT::GetX ( ) const

inline

Definition at line 109 of file eda_rect.h.

109 { return m_Pos.x; }

EDA_RECT::m_Pos

wxPoint m_Pos

Definition: eda_rect.h:47

References m_Pos.

Referenced by Autoroute_One_Track(), EAGLE_PLUGIN::centerBoard(), ClipAndDrawPoly(), clipCircle(), ClipLine(), AR_MATRIX::ComputeMatrixSize(), AR_MATRIX::CreateKeepOutRectangle(), PCB_EDIT_FRAME::DoGenFootprintsReport(), GBR_LAYOUT::Draw(), DrawPageOnClipboard(), GENDRILL_WRITER_BASE::genDrillMapFile(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), SCH_COMPONENT::GetBodyBoundingBox(), DRAWSEGMENT::GetBoundingBox(), DIMENSION::GetBoundingBox(), BOARD::GetFootprint(), EDA_TEXT::GetTextBox(), GRArc(), GRArc1(), GRFilledArc(), GRRect(), GRRectPs(), IsGRSPolyDrawable(), OrCell_Trace(), and DRC::testCopperTextItem().

◆ GetY()

int EDA_RECT::GetY ( ) const

inline

Definition at line 110 of file eda_rect.h.

110 { return m_Pos.y; }

EDA_RECT::m_Pos

wxPoint m_Pos

Definition: eda_rect.h:47

References m_Pos.

Referenced by Autoroute_One_Track(), EAGLE_PLUGIN::centerBoard(), ClipAndDrawPoly(), clipCircle(), ClipLine(), AR_MATRIX::ComputeMatrixSize(), AR_MATRIX::CreateKeepOutRectangle(), PCB_EDIT_FRAME::DoGenFootprintsReport(), GBR_LAYOUT::Draw(), DrawPageOnClipboard(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), SCH_COMPONENT::GetBodyBoundingBox(), DRAWSEGMENT::GetBoundingBox(), DIMENSION::GetBoundingBox(), SCH_SHEET::GetBoundingBox(), BOARD::GetFootprint(), EDA_TEXT::GetTextBox(), GRArc(), GRArc1(), GRFilledArc(), GRRect(), GRRectPs(), IsGRSPolyDrawable(), SCH_EAGLE_PLUGIN::loadSchematic(), OrCell_Trace(), and DRC::testCopperTextItem().

◆ 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 600 of file base_struct.cpp.

 {
     if( m_Size.x >= 0 )
     {
         if( m_Size.x < -2 * dx )
         {
             // Don't allow deflate to eat more width than we have,
             m_Pos.x += m_Size.x / 2;
             m_Size.x = 0;
         }
         else
         {
             // The inflate is valid.
             m_Pos.x  -= dx;
             m_Size.x += 2 * dx;
         }
     }
     else    // size.x < 0:
     {
         if( m_Size.x > -2 * dx )
         {
             // Don't allow deflate to eat more width than we have,
             m_Pos.x -= m_Size.x / 2;
             m_Size.x = 0;
         }
         else
         {
             // The inflate is valid.
             m_Pos.x  += dx;
             m_Size.x -= 2 * dx; // m_Size.x <0: inflate when dx > 0
         }
     }
 
     if( m_Size.y >= 0 )
     {
         if( m_Size.y < -2 * dy )
         {
             // Don't allow deflate to eat more height than we have,
             m_Pos.y += m_Size.y / 2;
             m_Size.y = 0;
         }
         else
         {
             // The inflate is valid.
             m_Pos.y  -= dy;
             m_Size.y += 2 * dy;
         }
     }
     else    // size.y < 0:
     {
         if( m_Size.y > 2 * dy )
         {
             // Don't allow deflate to eat more height than we have,
             m_Pos.y -= m_Size.y / 2;
             m_Size.y = 0;
         }
         else
         {
             // The inflate is valid.
             m_Pos.y  += dy;
             m_Size.y -= 2 * dy; // m_Size.y <0: inflate when dy > 0
         }
     }
 
     return *this;
 }

References m_Pos, and m_Size.

Referenced by AR_AUTOPLACER::addPad(), BuildBoardPolygonOutlines(), AR_AUTOPLACER::buildFpAreas(), ZONE_FILLER::buildZoneFeatureHoleList(), FillNegativeKnockout(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), APERTURE_MACRO::GetApertureMacroShape(), SCH_JUNCTION::GetBoundingBox(), LIB_CIRCLE::GetBoundingBox(), SCH_NO_CONNECT::GetBoundingBox(), LIB_RECTANGLE::GetBoundingBox(), LIB_BEZIER::GetBoundingBox(), LIB_POLYLINE::GetBoundingBox(), LIB_ARC::GetBoundingBox(), SCH_BUS_ENTRY_BASE::GetBoundingBox(), LIB_PIN::GetBoundingBox(), BITMAP_BASE::GetBoundingBox(), DRAWSEGMENT::GetBoundingBox(), GERBER_DRAW_ITEM::GetBoundingBox(), SCH_SHEET::GetBoundingBox(), D_PAD::GetBoundingBox(), MODULE::GetFootprintRect(), GRCSegm(), GRLineArray(), GRSFilledRect(), LIB_CIRCLE::HitTest(), SCH_PIN::HitTest(), LIB_BEZIER::HitTest(), LIB_POLYLINE::HitTest(), LIB_ARC::HitTest(), PCB_TARGET::HitTest(), SCH_JUNCTION::HitTest(), SCH_NO_CONNECT::HitTest(), SCH_BUS_ENTRY_BASE::HitTest(), LIB_PIN::HitTest(), SCH_BITMAP::HitTest(), SCH_SHEET_PIN::HitTest(), SCH_TEXT::HitTest(), SCH_LINE::HitTest(), SCH_FIELD::HitTest(), DRAWSEGMENT::HitTest(), LIB_ITEM::HitTest(), DIMENSION::HitTest(), TRACK::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(), PCB_EDIT_FRAME::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 593 of file base_struct.cpp.

 {
     Inflate( aDelta, aDelta );
     return *this;
 }

References Inflate().

◆ Intersects() [1/3]

bool EDA_RECT::Intersects ( const EDA_RECT & aRect ) const

Function Intersects tests for a common area between rectangles.

Parameters

aRect A 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 398 of file base_struct.cpp.

 {
     // this logic taken from wxWidgets' geometry.cpp file:
     bool rc;
     EDA_RECT me(*this);
     EDA_RECT rect(aRect);
     me.Normalize();         // ensure size is >= 0
     rect.Normalize();       // ensure size is >= 0
 
     // calculate the left common area coordinate:
     int  left   = std::max( me.m_Pos.x, rect.m_Pos.x );
     // calculate the right common area coordinate:
     int  right  = std::min( me.m_Pos.x + me.m_Size.x, rect.m_Pos.x + rect.m_Size.x );
     // calculate the upper common area coordinate:
     int  top    = std::max( me.m_Pos.y, aRect.m_Pos.y );
     // calculate the lower common area coordinate:
     int  bottom = std::min( me.m_Pos.y + me.m_Size.y, rect.m_Pos.y + rect.m_Size.y );
 
     // if a common area exists, it must have a positive (null accepted) size
     if( left <= right && top <= bottom )
         rc = true;
     else
         rc = false;
 
     return rc;
 }

References m_Pos, m_Size, max, min, and Normalize().

Referenced by ZONE_FILLER::buildZoneFeatureHoleList(), Common(), AUTOPLACER::filtered_colliders(), LIB_CIRCLE::HitTest(), LIB_POLYLINE::HitTest(), LIB_BEZIER::HitTest(), LIB_ARC::HitTest(), PCB_TARGET::HitTest(), SCH_JUNCTION::HitTest(), SCH_NO_CONNECT::HitTest(), SCH_BUS_ENTRY_BASE::HitTest(), SCH_BITMAP::HitTest(), WS_DRAW_ITEM_LINE::HitTest(), SCH_TEXT::HitTest(), SCH_LINE::HitTest(), SCH_FIELD::HitTest(), DRAWSEGMENT::HitTest(), LIB_ITEM::HitTest(), DIMENSION::HitTest(), WS_DRAW_ITEM_POLYGON::HitTest(), TRACK::HitTest(), WS_DRAW_ITEM_RECT::HitTest(), WS_DRAW_ITEM_BITMAP::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

aRect	a rectangle to test intersection with
aRot	rectangle rotation (in 1/10 degrees)

Definition at line 426 of file base_struct.cpp.

 {
     /* Most rectangles will be axis aligned.
      * It is quicker to check for this case and pass the rect
      * to the simpler intersection test
      */
 
     // Prevent floating point comparison errors
     static const double ROT_EPS = 0.000000001;
 
     static const double ROT_PARALLEL[] = { -3600, -1800, 0, 1800, 3600 };
     static const double ROT_PERPENDICULAR[] = { -2700, -900, 0, 900, 2700 };
 
     NORMALIZE_ANGLE_POS<double>( aRot );
 
     // Test for non-rotated rectangle
     for( int ii = 0; ii < 5; ii++ )
     {
         if( std::fabs( aRot - ROT_PARALLEL[ii] ) < ROT_EPS )
         {
             return Intersects( aRect );
         }
     }
 
     // Test for rectangle rotated by multiple of 90 degrees
     for( int jj = 0; jj < 4; jj++ )
     {
         if( std::fabs( aRot - ROT_PERPENDICULAR[jj] ) < ROT_EPS )
         {
             EDA_RECT rotRect;
 
             // Rotate the supplied rect by 90 degrees
             rotRect.SetOrigin( aRect.Centre() );
             rotRect.Inflate( aRect.GetHeight(), aRect.GetWidth() );
             return Intersects( rotRect );
         }
     }
 
     /* There is some non-orthogonal rotation.
      * There are three cases to test:
      * A) One point of this rect is inside the rotated rect
      * B) One point of the rotated rect is inside this rect
      * C) One of the sides of the rotated rect intersect this
      */
 
     wxPoint corners[4];
 
     /* Test A : Any corners exist in rotated rect? */
 
     corners[0] = m_Pos;
     corners[1] = m_Pos + wxPoint( m_Size.x, 0 );
     corners[2] = m_Pos + wxPoint( m_Size.x, m_Size.y );
     corners[3] = m_Pos + wxPoint( 0, m_Size.y );
 
     wxPoint rCentre = aRect.Centre();
 
     for( int i = 0; i < 4; i++ )
     {
         wxPoint delta = corners[i] - rCentre;
         RotatePoint( &delta, -aRot );
         delta += rCentre;
 
         if( aRect.Contains( delta ) )
         {
             return true;
         }
     }
 
     /* Test B : Any corners of rotated rect exist in this one? */
     int w = aRect.GetWidth() / 2;
     int h = aRect.GetHeight() / 2;
 
     // Construct corners around center of shape
     corners[0] = wxPoint( -w, -h );
     corners[1] = wxPoint(  w, -h );
     corners[2] = wxPoint(  w,  h );
     corners[3] = wxPoint( -w,  h );
 
     // Rotate and test each corner
     for( int j=0; j<4; j++ )
     {
         RotatePoint( &corners[j], aRot );
         corners[j] += rCentre;
 
         if( Contains( corners[j] ) )
         {
             return true;
         }
     }
 
     /* Test C : Any sides of rotated rect intersect this */
 
     if( Intersects( corners[0], corners[1] ) ||
         Intersects( corners[1], corners[2] ) ||
         Intersects( corners[2], corners[3] ) ||
         Intersects( corners[3], corners[0] ) )
     {
         return true;
     }
 
 
     return false;
 }

References Centre(), Contains(), delta, GetHeight(), GetWidth(), i, Inflate(), Intersects(), 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

aPoint1	First point of the segment to test intersection with.
aPoint2	Second 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 372 of file base_struct.cpp.

 {
     wxPoint point2, point4;
 
     if( Contains( aPoint1 ) || Contains( aPoint2 ) )
         return true;
 
     point2.x = GetEnd().x;
     point2.y = GetOrigin().y;
     point4.x = GetOrigin().x;
     point4.y = GetEnd().y;
 
     //Only need to test 3 sides since a straight line cant enter and exit on same side
     if( SegmentIntersectsSegment( aPoint1, aPoint2, GetOrigin() , point2 ) )
         return true;
 
     if( SegmentIntersectsSegment( aPoint1, aPoint2, point2      , GetEnd() ) )
         return true;
 
     if( SegmentIntersectsSegment( aPoint1, aPoint2, GetEnd()    , point4 ) )
         return true;
 
     return false;
 }

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

◆ 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

aCenter	center of the circle
aRadius	radius of the circle

Definition at line 558 of file base_struct.cpp.

 {
     wxPoint closest = ClosestPointTo( aCenter );
 
     double dx = aCenter.x - closest.x;
     double dy = aCenter.y - closest.y;
 
     double r = (double) aRadius;
 
     return ( dx * dx + dy * dy ) <= ( r * r );
 }

References ClosestPointTo().

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

aCenter	center of the circle
aRadius	radius of the circle
aWidth	width of the circle edge

Definition at line 571 of file base_struct.cpp.

 {
     EDA_RECT me( *this );
     me.Normalize();         // ensure size is >= 0
 
     // Test if the circle intersects at all
     if( !IntersectsCircle( aCenter, aRadius + aWidth / 2 ) )
     {
         return false;
     }
 
     wxPoint farpt = FarthestPointTo( aCenter );
     // Farthest point must be further than the inside of the line
     double fx = (double) farpt.x;
     double fy = (double) farpt.y;
 
     double r = (double) aRadius - (double) aWidth / 2;
 
     return ( fx * fx + fy * fy ) > ( r * r );
 }

References FarthestPointTo(), IntersectsCircle(), and Normalize().

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

◆ 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

aRect The rectangle to merge with this rectangle.

Definition at line 668 of file base_struct.cpp.

 {
     Normalize();        // ensure width and height >= 0
     EDA_RECT rect = aRect;
     rect.Normalize();   // ensure width and height >= 0
     wxPoint  end = GetEnd();
     wxPoint  rect_end = rect.GetEnd();
 
     // Change origin and size in order to contain the given rect
     m_Pos.x = std::min( m_Pos.x, rect.m_Pos.x );
     m_Pos.y = std::min( m_Pos.y, rect.m_Pos.y );
     end.x   = std::max( end.x, rect_end.x );
     end.y   = std::max( end.y, rect_end.y );
     SetEnd( end );
 }

References GetEnd(), m_Pos, max, min, Normalize(), and SetEnd().

Referenced by PCB_EDIT_FRAME::AppendBoardFile(), DRAWSEGMENT::computeArcBBox(), GBR_LAYOUT::ComputeBoundingBox(), BOARD::ComputeBoundingBox(), LIB_PART::GetBodyBoundingBox(), SELECTION::GetBoundingBox(), MODULE::GetBoundingBox(), DRAWSEGMENT::GetBoundingBox(), SCH_COMPONENT::GetBoundingBox(), D_PAD::GetBoundingBox(), MODULE::GetFootprintRect(), getSheetBbox(), LIB_PART::GetUnitBoundingBox(), InvokeDialogImportGfxBoard(), InvokeDialogImportGfxModule(), 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

aPoint The point to merge with the rectangle.

Definition at line 685 of file base_struct.cpp.

 {
     Normalize();        // ensure width and height >= 0
 
     wxPoint  end = GetEnd();
     // Change origin and size in order to contain the given rect
     m_Pos.x = std::min( m_Pos.x, aPoint.x );
     m_Pos.y = std::min( m_Pos.y, aPoint.y );
     end.x   = std::max( end.x, aPoint.x );
     end.y   = std::max( end.y, aPoint.y );
     SetEnd( end );
 }

References GetEnd(), m_Pos, max, min, Normalize(), and SetEnd().

◆ Move()

void EDA_RECT::Move ( const wxPoint & aMoveVector )

Function Move moves the rectangle by the aMoveVector.

Parameters

aMoveVector A wxPoint that is the value to move this rectangle

Definition at line 339 of file base_struct.cpp.

 {
     m_Pos += aMoveVector;
 }

References m_Pos.

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

◆ Normalize()

void EDA_RECT::Normalize ( )

Function Normalize ensures that the height ant width are positive.

Definition at line 323 of file base_struct.cpp.

 {
     if( m_Size.y < 0 )
     {
         m_Size.y = -m_Size.y;
         m_Pos.y -= m_Size.y;
     }
 
     if( m_Size.x < 0 )
     {
         m_Size.x = -m_Size.x;
         m_Pos.x -= m_Size.x;
     }
 }

References m_Pos, and m_Size.

Referenced by PL_EDITOR_FRAME::Block_Move(), GERBVIEW_FRAME::Block_Move(), PCB_EDIT_FRAME::Block_SelectItems(), ClosestPointTo(), GBR_LAYOUT::ComputeBoundingBox(), KIGFX::SCH_PAINTER::draw(), FarthestPointTo(), SCH_BUS_ENTRY_BASE::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), LIB_PIN::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), DRAWSEGMENT::GetBoundingBox(), SCH_LABEL::GetBoundingBox(), GERBER_DRAW_ITEM::GetBoundingBox(), DIMENSION::GetBoundingBox(), SCH_GLOBALLABEL::GetBoundingBox(), SCH_HIERLABEL::GetBoundingBox(), EDA_TEXT::GetTextBox(), DRAWSEGMENT::HitTest(), ZONE_CONTAINER::HitTest(), D_PAD::HitTest(), Intersects(), IntersectsCircleEdge(), Merge(), operator BOX2I(), operator wxRect(), SVG_PLOTTER::Rect(), RevertYAxis(), GERBVIEW_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::selectMultiple(), and SELECTION_TOOL::selectMultiple().

◆ Offset() [1/2]

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

inline

Definition at line 128 of file eda_rect.h.

128 { m_Pos.x += dx; m_Pos.y += dy; }

EDA_RECT::m_Pos

wxPoint m_Pos

Definition: eda_rect.h:47

References m_Pos.

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

◆ Offset() [2/2]

void EDA_RECT::Offset ( const wxPoint & offset )

inline

Definition at line 129 of file eda_rect.h.

129 { m_Pos += offset; }

EDA_RECT::m_Pos

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 228 of file eda_rect.h.

     {
         EDA_RECT rect( m_Pos, m_Size );
         rect.Normalize();
         return BOX2I( rect.GetOrigin(), rect.GetSize() );
     }

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 216 of file eda_rect.h.

     {
         EDA_RECT rect( m_Pos, m_Size );
         rect.Normalize();
         return wxRect( rect.m_Pos, rect.m_Size );
     }

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 144 of file eda_rect.h.

     {
         m_Pos.y  = -m_Pos.y;
         m_Size.y = -m_Size.y;
         Normalize();
     }

References m_Pos, m_Size, and Normalize().

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

◆ SetEnd() [1/2]

void EDA_RECT::SetEnd	(	int	x,
		int	y
	)

inline

Definition at line 134 of file eda_rect.h.

134 { SetEnd( wxPoint( x, y ) ); }

EDA_RECT::SetEnd

void SetEnd(int x, int y)

Definition: eda_rect.h:134

References SetEnd().

◆ SetEnd() [2/2]

void EDA_RECT::SetEnd ( const wxPoint & pos )

inline

Definition at line 135 of file eda_rect.h.

     {
         m_Size.x = pos.x - m_Pos.x; m_Size.y = pos.y - m_Pos.y;
     }

References m_Pos, and m_Size.

◆ SetHeight()

void EDA_RECT::SetHeight ( int val )

inline

Definition at line 133 of file eda_rect.h.

133 { m_Size.y = val; }

EDA_RECT::m_Size

wxSize m_Size

Definition: eda_rect.h:48

References m_Size.

Referenced by SCH_COMPONENT::GetBodyBoundingBox(), PCB_TARGET::GetBoundingBox(), DIMENSION::GetBoundingBox(), and PCB_EDIT_FRAME::SpreadFootprints().

◆ SetOrigin() [1/2]

void EDA_RECT::SetOrigin ( const wxPoint & pos )

inline

Definition at line 124 of file eda_rect.h.

124 { m_Pos = pos; }

EDA_RECT::m_Pos

wxPoint m_Pos

Definition: eda_rect.h:47

References m_Pos.

◆ SetOrigin() [2/2]

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

inline

Definition at line 125 of file eda_rect.h.

125 { m_Pos.x = x; m_Pos.y = y; }

EDA_RECT::m_Pos

wxPoint m_Pos

Definition: eda_rect.h:47

References m_Pos.

◆ SetSize() [1/2]

void EDA_RECT::SetSize ( const wxSize & size )

inline

Definition at line 126 of file eda_rect.h.

126 { m_Size = size; }

EDA_RECT::m_Size

wxSize m_Size

Definition: eda_rect.h:48

References m_Size.

Referenced by PCB_EDIT_FRAME::AppendBoardFile(), GERBVIEW_FRAME::BestZoom(), EDA_DRAW_PANEL::EDA_DRAW_PANEL(), D_PAD::GetBoundingBox(), EDA_TEXT::GetTextBox(), D_PAD::HitTest(), InvokeDialogImportGfxBoard(), and InvokeDialogImportGfxModule().

◆ SetSize() [2/2]

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

inline

Definition at line 127 of file eda_rect.h.

127 { m_Size.x = w; m_Size.y = h; }

EDA_RECT::m_Size

wxSize m_Size

Definition: eda_rect.h:48

References m_Size.

◆ SetWidth()

void EDA_RECT::SetWidth ( int val )

inline

Definition at line 132 of file eda_rect.h.

132 { m_Size.x = val; }

EDA_RECT::m_Size

wxSize m_Size

Definition: eda_rect.h:48

References m_Size.

Referenced by SCH_COMPONENT::GetBodyBoundingBox(), PCB_TARGET::GetBoundingBox(), DIMENSION::GetBoundingBox(), and PCB_EDIT_FRAME::SpreadFootprints().

◆ SetX()

void EDA_RECT::SetX ( int val )

inline

Definition at line 130 of file eda_rect.h.

130 { m_Pos.x = val; }

EDA_RECT::m_Pos

wxPoint m_Pos

Definition: eda_rect.h:47

References m_Pos.

Referenced by AR_MATRIX::ComputeMatrixSize(), EDA_DRAW_PANEL::EDA_DRAW_PANEL(), SCH_COMPONENT::GetBodyBoundingBox(), PCB_TARGET::GetBoundingBox(), DRAWSEGMENT::GetBoundingBox(), DIMENSION::GetBoundingBox(), and EDA_TEXT::GetTextBox().

◆ SetY()

void EDA_RECT::SetY ( int val )

inline

Definition at line 131 of file eda_rect.h.

131 { m_Pos.y = val; }

EDA_RECT::m_Pos

wxPoint m_Pos

Definition: eda_rect.h:47

References m_Pos.

Referenced by AR_MATRIX::ComputeMatrixSize(), EDA_DRAW_PANEL::EDA_DRAW_PANEL(), SCH_COMPONENT::GetBodyBoundingBox(), PCB_TARGET::GetBoundingBox(), DRAWSEGMENT::GetBoundingBox(), DIMENSION::GetBoundingBox(), SCH_SHEET::GetBoundingBox(), and EDA_TEXT::GetTextBox().

Member Data Documentation

◆ m_Pos

wxPoint EDA_RECT::m_Pos

private

Definition at line 47 of file eda_rect.h.

Referenced by Centre(), Contains(), GetBottom(), GetCenter(), GetEnd(), GetLeft(), GetOrigin(), GetPosition(), GetRight(), GetTop(), GetX(), GetY(), Inflate(), Intersects(), Merge(), Move(), Normalize(), Offset(), operator BOX2I(), operator wxRect(), RevertYAxis(), SetEnd(), SetOrigin(), SetX(), and SetY().

◆ m_Size

wxSize EDA_RECT::m_Size

private

Definition at line 48 of file eda_rect.h.

Referenced by Centre(), Contains(), GetBottom(), GetCenter(), GetEnd(), GetHeight(), GetRight(), GetSize(), GetSizeMax(), GetWidth(), Inflate(), Intersects(), Normalize(), operator BOX2I(), operator wxRect(), RevertYAxis(), SetEnd(), SetHeight(), SetSize(), and SetWidth().

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EDA_RECT() [1/2]

◆ EDA_RECT() [2/2]

◆ ~EDA_RECT()

Member Function Documentation

◆ Centre()

◆ ClosestPointTo()

◆ Common()

◆ Contains() [1/3]

◆ Contains() [2/3]

◆ Contains() [3/3]

◆ FarthestPointTo()

◆ GetArea()

◆ GetBottom()

◆ GetBoundingBoxRotated()

◆ GetCenter()

◆ GetEnd()

◆ GetHeight()

◆ GetLeft()

◆ GetOrigin()

◆ GetPosition()

◆ GetRight()

◆ GetSize()

◆ GetSizeMax()

◆ GetTop()

◆ GetWidth()

◆ GetX()

◆ GetY()

◆ Inflate() [1/2]

◆ Inflate() [2/2]

◆ Intersects() [1/3]

◆ Intersects() [2/3]

◆ Intersects() [3/3]

◆ IntersectsCircle()

◆ IntersectsCircleEdge()

◆ Merge() [1/2]

◆ Merge() [2/2]

◆ Move()

◆ Normalize()

◆ Offset() [1/2]

◆ Offset() [2/2]

◆ operator BOX2I()

◆ operator wxRect()

◆ RevertYAxis()

◆ SetEnd() [1/2]

◆ SetEnd() [2/2]

◆ SetHeight()

◆ SetOrigin() [1/2]

◆ SetOrigin() [2/2]

◆ SetSize() [1/2]

◆ SetSize() [2/2]

◆ SetWidth()

◆ SetX()

◆ SetY()

Member Data Documentation

◆ m_Pos

◆ m_Size