FP_SHAPE Class Reference

#include <fp_shape.h>

Inheritance diagram for FP_SHAPE:

Public Member Functions
	FP_SHAPE (FOOTPRINT *parent, SHAPE_T aShape=SHAPE_T::SEGMENT)
	~FP_SHAPE ()
bool	IsType (const KICAD_T aScanTypes[]) const override
	Check whether the item is one of the listed types. More...
void	SetArcAngleAndEnd0 (double aAngle, bool aCheckNegativeAngle=false)
	Sets the angle for arcs, and normalizes it within the range 0 - 360 degrees. More...
void	SetArcGeometry0 (const wxPoint &aStart, const wxPoint &aMid, const wxPoint &aEnd)
void	Move (const wxPoint &aMoveVector) override
	Move an edge of the footprint. More...
void	Mirror (const wxPoint &aCentre, bool aMirrorAroundXAxis)
	Mirror an edge of the footprint. More...
void	Rotate (const wxPoint &aRotCentre, double aAngle) override
	Rotate an edge of the footprint. More...
void	Flip (const wxPoint &aCentre, bool aFlipLeftRight) override
	Flip entity relative to aCentre. More...
bool	IsParentFlipped () const
void	SetStart0 (const wxPoint &aPoint)
const wxPoint &	GetStart0 () const
void	SetEnd0 (const wxPoint &aPoint)
const wxPoint &	GetEnd0 () const
void	SetBezierC1_0 (const wxPoint &aPoint)
const wxPoint &	GetBezierC1_0 () const
void	SetBezierC2_0 (const wxPoint &aPoint)
const wxPoint &	GetBezierC2_0 () const
wxPoint	GetCenter0 () const
void	SetCenter0 (const wxPoint &aPt)
wxPoint	GetArcMid0 () const
void	SetLocalCoord ()
	Set relative coordinates from draw coordinates. More...
void	SetDrawCoord ()
	Set draw coordinates (absolute values ) from relative coordinates. More...
void	GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
	Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
wxString	GetClass () const override
	Return the class name. More...
wxString	GetParentAsString () const
wxString	GetSelectMenuText (EDA_UNITS aUnits) const override
	Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
BITMAPS	GetMenuImage () const override
	Return a pointer to an image to be used in menus. More...
EDA_ITEM *	Clone () const override
	Create a duplicate of this item with linked list members set to NULL. More...
double	ViewGetLOD (int aLayer, KIGFX::VIEW *aView) const override
	Return the level of detail (LOD) of the item. More...
void	SetPosition (const wxPoint &aPos) override
wxPoint	GetPosition () const override
wxPoint	GetCenter () const override
	This defaults to the center of the bounding box if not overridden. More...
const wxPoint	GetFocusPosition () const override
	Allows items to return their visual center rather than their anchor. More...
FOOTPRINT *	GetParentFootprint () const
	Return the parent footprint or NULL if PCB_SHAPE does not belong to a footprint. More...
std::shared_ptr< SHAPE >	GetEffectiveShape (PCB_LAYER_ID aLayer=UNDEFINED_LAYER) const override
	Make a set of SHAPE objects representing the PCB_SHAPE. More...
const EDA_RECT	GetBoundingBox () const override
	Return the orthogonal bounding box of this object for display purposes. More...
bool	HitTest (const wxPoint &aPosition, int aAccuracy=0) const override
	Test if aPosition is inside or on the boundary of this item. More...
bool	HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
	Test if aRect intersects this item. More...
void	Move (const VECTOR2I &aMoveVector)
void	Rotate (const VECTOR2I &aRotCentre, double aAngle)
void	Flip (const VECTOR2I &aCentre, bool aFlipLeftRight)
void	Scale (double aScale)
void	TransformShapeWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, PCB_LAYER_ID aLayer, int aClearanceValue, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const override
	Convert the shape to a closed polygon. More...
void	TransformShapeWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, int aClearanceValue, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth) const
	Convert the shape to a closed polygon. More...
virtual const BOX2I	ViewBBox () const override
	Return the bounding box of the item covering all its layers. More...
virtual void	SwapData (BOARD_ITEM *aImage) override
	Swap data between aItem and aImage. More...
void	SetParentGroup (PCB_GROUP *aGroup)
PCB_GROUP *	GetParentGroup () const
int	GetX () const
int	GetY () const
void	SetX (int aX)
void	SetY (int aY)
virtual bool	IsConnected () const
	Returns information if the object is derived from BOARD_CONNECTED_ITEM. More...
virtual bool	IsOnCopperLayer () const
BOARD_ITEM_CONTAINER *	GetParent () const
virtual PCB_LAYER_ID	GetLayer () const
	Return the primary layer this item is on. More...
virtual LSET	GetLayerSet () const
	Return a std::bitset of all layers on which the item physically resides. More...
virtual void	SetLayerSet (LSET aLayers)
virtual void	SetLayer (PCB_LAYER_ID aLayer)
	Set the layer this item is on. More...
virtual BOARD_ITEM *	Duplicate () const
	Create a copy of this BOARD_ITEM. More...
virtual bool	IsOnLayer (PCB_LAYER_ID aLayer) const
	Test to see if this object is on the given layer. More...
bool	IsTrack () const
	Test to see if this object is a track or via (or microvia). More...
virtual bool	IsLocked () const
virtual void	SetLocked (bool aLocked)
	Modify the 'lock' status for of the item. More...
void	DeleteStructure ()
	Delete this object after removing from its parent if it has one. More...
virtual const BOARD *	GetBoard () const
	Return the BOARD in which this BOARD_ITEM resides, or NULL if none. More...
virtual BOARD *	GetBoard ()
wxString	GetLayerName () const
	Return the name of the PCB layer on which the item resides. More...
virtual void	ViewGetLayers (int aLayers[], int &aCount) const override
	Return the all the layers within the VIEW the object is painted on. More...
KICAD_T	Type () const
	Returns the type of object. More...
virtual void	SetParent (EDA_ITEM *aParent)
bool	IsModified () const
bool	IsNew () const
bool	IsMoving () const
bool	IsDragging () const
bool	IsWireImage () const
bool	IsSelected () const
bool	IsEntered () const
bool	IsResized () const
bool	IsBrightened () const
void	SetWireImage ()
void	SetSelected ()
void	SetBrightened ()
void	ClearSelected ()
void	ClearBrightened ()
void	SetModified ()
int	GetState (EDA_ITEM_FLAGS type) const
void	SetState (EDA_ITEM_FLAGS type, bool state)
EDA_ITEM_FLAGS	GetStatus () const
void	SetStatus (EDA_ITEM_FLAGS aStatus)
void	SetFlags (EDA_ITEM_FLAGS aMask)
void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
EDA_ITEM_FLAGS	GetFlags () const
bool	HasFlag (EDA_ITEM_FLAGS aFlag) const
EDA_ITEM_FLAGS	GetEditFlags () const
void	ClearTempFlags ()
void	ClearEditFlags ()
void	SetForceVisible (bool aEnable)
	Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
bool	IsForceVisible () const
virtual SEARCH_RESULT	Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	May be re-implemented for each derived class in order to handle all the types given by its member data. More...
virtual bool	Matches (const wxFindReplaceData &aSearchData, void *aAuxData) const
	Compare the item against the search criteria in aSearchData. More...
virtual bool	Replace (const wxFindReplaceData &aSearchData, void *aAuxData=nullptr)
	Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
virtual bool	IsReplaceable () const
	Override this method in any derived object that supports test find and replace. More...
bool	operator< (const EDA_ITEM &aItem) const
	Test if another item is less than this object. More...
virtual void	ViewDraw (int aLayer, VIEW *aView) const
	Draw the parts of the object belonging to layer aLayer. More...
VIEW_ITEM_DATA *	viewPrivData () const
void	ClearViewPrivData ()
bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue)
template<typename T >
bool	Set (PROPERTY_BASE *aProperty, T aValue)
template<typename T >
bool	Set (const wxString &aProperty, T aValue)
wxAny	Get (PROPERTY_BASE *aProperty)
template<typename T >
T	Get (PROPERTY_BASE *aProperty)
template<typename T >
boost::optional< T >	Get (const wxString &aProperty)
void	SwapShape (EDA_SHAPE *aImage)
wxString	ShowShape () const
wxString	SHAPE_T_asString () const
void	SetFillMode (FILL_T aFill)
FILL_T	GetFillType () const
bool	IsFilled () const
void	SetFilled (bool aFlag)
void	SetWidth (int aWidth)
int	GetWidth () const
void	SetShape (SHAPE_T aShape)
SHAPE_T	GetShape () const
const wxPoint &	GetStart () const
	Return the starting point of the graphic. More...
int	GetStartY ()
int	GetStartX ()
void	SetStart (const wxPoint &aStart)
void	SetStartY (int y)
void	SetStartX (int x)
const wxPoint &	GetEnd () const
	Return the ending point of the graphic. More...
int	GetEndY ()
int	GetEndX ()
void	SetEnd (const wxPoint &aEnd)
void	SetEndY (int y)
void	SetEndX (int x)
void	SetBezierC1 (const wxPoint &aPt)
const wxPoint &	GetBezierC1 () const
void	SetBezierC2 (const wxPoint &aPt)
const wxPoint &	GetBezierC2 () const
wxPoint	getCenter () const
void	SetCenter (const wxPoint &aCenter)
void	SetArcAngleAndEnd (double aAngle, bool aCheckNegativeAngle=false)
	Set the end point from the angle center and start. More...
double	GetArcAngle () const
bool	EndsSwapped () const
	Have the start and end points been swapped since they were set? More...
wxPoint	GetArcMid () const
std::vector< wxPoint >	GetRectCorners () const
void	CalcArcAngles (double &aStartAngle, double &aEndAngle) const
	Calc arc start and end angles such that aStartAngle < aEndAngle. More...
int	GetRadius () const
void	SetArcGeometry (const wxPoint &aStart, const wxPoint &aMid, const wxPoint &aEnd)
	Set the three controlling points for an arc. More...
const std::vector< wxPoint > &	GetBezierPoints () const
void	DupPolyPointsList (std::vector< wxPoint > &aBuffer) const
	Duplicate the list of corners in a std::vector<wxPoint> More...
int	GetPointCount () const
SHAPE_POLY_SET &	GetPolyShape ()
const SHAPE_POLY_SET &	GetPolyShape () const
bool	IsPolyShapeValid () const
void	SetPolyShape (const SHAPE_POLY_SET &aShape)
void	SetBezierPoints (const std::vector< wxPoint > &aPoints)
void	RebuildBezierToSegmentsPointsList (int aMinSegLen)
	Rebuild the m_BezierPoints vertex list that approximate the Bezier curve by a list of segments. More...
void	SetPolyPoints (const std::vector< wxPoint > &aPoints)
std::vector< SHAPE * >	MakeEffectiveShapes () const
	Make a set of SHAPE objects representing the EDA_SHAPE. More...
void	ShapeGetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList)
double	GetLength () const
	Return the length of the track using the hypotenuse calculation. More...
int	Compare (const EDA_SHAPE *aOther) const

Static Public Member Functions
static bool	ClassOf (const EDA_ITEM *aItem)
template<class T >
static SEARCH_RESULT	IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	This changes first parameter to avoid the DList and use the main queue instead. More...
template<class T >
static SEARCH_RESULT	IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	Change first parameter to avoid the DList and use std::vector instead. More...
static bool	Replace (const wxFindReplaceData &aSearchData, wxString &aText)
	Perform a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
static bool	Sort (const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
	Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...

Public Attributes
const KIID	m_Uuid

Static Public Attributes
static wxPoint	ZeroOffset
	A value of wxPoint(0,0) which can be passed to the Draw() functions. More...

Protected Member Functions
double	getParentOrientation () const override
wxPoint	getParentPosition () const override
virtual wxString	layerMaskDescribe () const
	Return a string (to be shown to the user) describing a layer mask. More...
bool	Matches (const wxString &aText, const wxFindReplaceData &aSearchData) const
	Compare aText against search criteria in aSearchData. More...
void	setPosition (const wxPoint &aPos)
wxPoint	getPosition () const
void	move (const wxPoint &aMoveVector)
void	rotate (const wxPoint &aRotCentre, double aAngle)
void	flip (const wxPoint &aCentre, bool aFlipLeftRight)
void	scale (double aScale)
const EDA_RECT	getBoundingBox () const
void	computeArcBBox (EDA_RECT &aBBox) const
bool	hitTest (const wxPoint &aPosition, int aAccuracy=0) const
bool	hitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const
const std::vector< wxPoint >	buildBezierToSegmentsPointsList (int aMinSegLen) const
void	beginEdit (const wxPoint &aStartPoint)
bool	continueEdit (const wxPoint &aPosition)
void	calcEdit (const wxPoint &aPosition)
void	endEdit (bool aClosed=true)
	Finishes editing the shape. More...
void	setEditState (int aState)

Protected Attributes
wxPoint	m_start0
	Start point or circle center, relative to footprint origin, orient 0. More...
wxPoint	m_end0
	End point or circle edge, relative to footprint origin, orient 0. More...
wxPoint	m_arcCenter0
	Center of arc, relative to footprint origin, orient 0. More...
wxPoint	m_bezierC1_0
	Bezier Control Point 1, relative to footprint origin, orient 0. More...
wxPoint	m_bezierC2_0
	Bezier Control Point 2, relative to footprint origin, orient 0. More...
PCB_LAYER_ID	m_layer
PCB_GROUP *	m_group
EDA_ITEM_FLAGS	m_status
EDA_ITEM *	m_parent
	Linked list: Link (parent struct) More...
bool	m_forceVisible
EDA_ITEM_FLAGS	m_flags
bool	m_endsSwapped
SHAPE_T	m_shape
int	m_width
FILL_T	m_fill
wxPoint	m_start
wxPoint	m_end
wxPoint	m_arcCenter
wxPoint	m_bezierC1
wxPoint	m_bezierC2
std::vector< wxPoint >	m_bezierPoints
SHAPE_POLY_SET	m_poly
int	m_editState
bool	m_eeWinding

Detailed Description

Definition at line 39 of file fp_shape.h.

Constructor & Destructor Documentation

FP_SHAPE()

FP_SHAPE::FP_SHAPE	(	FOOTPRINT *	parent,
		SHAPE_T	aShape = SHAPE_T::SEGMENT
	)

Definition at line 40 of file fp_shape.cpp.

 :
 PCB_SHAPE( parent, PCB_FP_SHAPE_T, aShape )
{
 m_layer = F_SilkS;
}

References F_SilkS, and BOARD_ITEM::m_layer.

Referenced by Clone().

~FP_SHAPE()

FP_SHAPE::~FP_SHAPE

(

)

Definition at line 47 of file fp_shape.cpp.

{
}

Member Function Documentation

beginEdit()

void EDA_SHAPE::beginEdit ( const wxPoint &  aStartPoint )

protectedinherited

Definition at line 1208 of file eda_shape.cpp.

{
 switch( GetShape() )
 {
 case SHAPE_T::SEGMENT:
 case SHAPE_T::CIRCLE:
 case SHAPE_T::RECT:
 SetStart( aPosition );
 SetEnd( aPosition );
 break;

 case SHAPE_T::ARC:
 SetArcGeometry( aPosition, aPosition, aPosition );
 m_editState = 1;
 break;

 case SHAPE_T::POLY:
 m_poly.NewOutline();
 m_poly.Outline( 0 ).SetClosed( false );

 // Start and end of the first segment (co-located for now)
 m_poly.Outline( 0 ).Append( aPosition );
 m_poly.Outline( 0 ).Append( aPosition, true );
 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 }
}

References SHAPE_LINE_CHAIN::Append(), ARC, CIRCLE, EDA_SHAPE::GetShape(), EDA_SHAPE::m_editState, EDA_SHAPE::m_poly, SHAPE_POLY_SET::NewOutline(), SHAPE_POLY_SET::Outline(), POLY, RECT, SEGMENT, EDA_SHAPE::SetArcGeometry(), SHAPE_LINE_CHAIN::SetClosed(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetStart(), EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by LIB_SHAPE::BeginEdit().

buildBezierToSegmentsPointsList()

const std::vector< wxPoint > EDA_SHAPE::buildBezierToSegmentsPointsList ( int  aMinSegLen ) const

protectedinherited

Definition at line 380 of file eda_shape.cpp.

{
 std::vector<wxPoint> bezierPoints;

 // Rebuild the m_BezierPoints vertex list that approximate the Bezier curve
 std::vector<wxPoint> ctrlPoints = { m_start, m_bezierC1, m_bezierC2, m_end };
 BEZIER_POLY converter( ctrlPoints );
 converter.GetPoly( bezierPoints, aMinSegLen );

 return bezierPoints;
}

References BEZIER_POLY::GetPoly(), EDA_SHAPE::m_bezierC1, EDA_SHAPE::m_bezierC2, EDA_SHAPE::m_end, and EDA_SHAPE::m_start.

Referenced by EDA_SHAPE::MakeEffectiveShapes(), and EDA_SHAPE::RebuildBezierToSegmentsPointsList().

CalcArcAngles()

void EDA_SHAPE::CalcArcAngles ( double &  aStartAngle, double &  aEndAngle  ) const

inherited

Calc arc start and end angles such that aStartAngle < aEndAngle.

Each may be between -360.0 and 360.0.

Definition at line 445 of file eda_shape.cpp.

{
 VECTOR2D startRadial( GetStart() - getCenter() );
 VECTOR2D endRadial( GetEnd() - getCenter() );

 aStartAngle = 180.0 / M_PI * atan2( startRadial.y, startRadial.x );
 aEndAngle = 180.0 / M_PI * atan2( endRadial.y, endRadial.x );

 if( aEndAngle == aStartAngle )
 aEndAngle = aStartAngle + 360.0; // ring, not null

 if( aStartAngle > aEndAngle )
 {
 if( aEndAngle < 0 )
 aEndAngle = NormalizeAngleDegrees( aEndAngle, 0.0, 360.0 );
 else
 aStartAngle = NormalizeAngleDegrees( aStartAngle, -360.0, 0.0 );
 }
}

References EDA_SHAPE::getCenter(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetStart(), NormalizeAngleDegrees(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by EDA_SHAPE::computeArcBBox(), KIGFX::PCB_PAINTER::draw(), EDA_SHAPE::GetArcAngle(), and EDA_SHAPE::hitTest().

calcEdit()

void EDA_SHAPE::calcEdit ( const wxPoint &  aPosition )

protectedinherited

Definition at line 1266 of file eda_shape.cpp.

{
#define sq( x ) pow( x, 2 )

 switch( GetShape() )
 {
 case SHAPE_T::SEGMENT:
 case SHAPE_T::CIRCLE:
 case SHAPE_T::RECT:
 SetEnd( aPosition );
 break;

 case SHAPE_T::ARC:
 {
 int radius = GetRadius();

 // Edit state 0: drawing: place start
 // Edit state 1: drawing: place end (center calculated for 90-degree subtended angle)
 // Edit state 2: point edit: move start (center calculated for invariant subtended angle)
 // Edit state 3: point edit: move end (center calculated for invariant subtended angle)
 // Edit state 4: point edit: move center
 // Edit state 5: point edit: move arc-mid-point

 switch( m_editState )
 {
 case 0:
 SetArcGeometry( aPosition, aPosition, aPosition );
 return;

 case 1:
 m_end = aPosition;
 radius = KiROUND( sqrt( sq( GetLineLength( m_start, m_end ) ) / 2.0 ) );
 break;

 case 2:
 case 3:
 {
 wxPoint v = m_start - m_end;
 double chordBefore = sq( v.x ) + sq( v.y );

 if( m_editState == 2 )
 m_start = aPosition;
 else
 m_end = aPosition;

 v = m_start - m_end;
 double chordAfter = sq( v.x ) + sq( v.y );
 double ratio = chordAfter / chordBefore;

 if( ratio != 0 )
 {
 radius = std::max( int( sqrt( sq( radius ) * ratio ) ) + 1,
 int( sqrt( chordAfter ) / 2 ) + 1 );
 }
 }
 break;

 case 4:
 {
 double chordA = GetLineLength( m_start, aPosition );
 double chordB = GetLineLength( m_end, aPosition );
 radius = int( ( chordA + chordB ) / 2.0 ) + 1;
 }
 break;

 case 5:
 SetArcGeometry( GetStart(), aPosition, GetEnd() );
 return;
 }

 // Calculate center based on start, end, and radius
 //
 // Let 'l' be the length of the chord and 'm' the middle point of the chord
 double l = GetLineLength( m_start, m_end );
 wxPoint m = ( m_start + m_end ) / 2;

 // Calculate 'd', the vector from the chord midpoint to the center
 wxPoint d;
 d.x = KiROUND( sqrt( sq( radius ) - sq( l/2 ) ) * ( m_start.y - m_end.y ) / l );
 d.y = KiROUND( sqrt( sq( radius ) - sq( l/2 ) ) * ( m_end.x - m_start.x ) / l );

 wxPoint c1 = m + d;
 wxPoint c2 = m - d;

 // Solution gives us 2 centers; we need to pick one:
 switch( m_editState )
 {
 case 1:
 {
 // Keep center clockwise from chord while drawing
 wxPoint chordVector = m_end - m_start;
 double chordAngle = ArcTangente( chordVector.y, chordVector.x );
 NORMALIZE_ANGLE_POS( chordAngle );

 wxPoint c1Test = c1;
 RotatePoint( &c1Test, m_start, -chordAngle );

 m_arcCenter = c1Test.x > 0 ? c2 : c1;
 }
 break;

 case 2:
 case 3:
 // Pick the one closer to the old center
 m_arcCenter = GetLineLength( c1, m_arcCenter ) < GetLineLength( c2, m_arcCenter ) ? c1 : c2;
 break;

 case 4:
 // Pick the one closer to the mouse position
 m_arcCenter = GetLineLength( c1, aPosition ) < GetLineLength( c2, aPosition ) ? c1 : c2;
 break;
 }
 }
 break;

 case SHAPE_T::POLY:
 m_poly.Outline( 0 ).SetPoint( m_poly.Outline( 0 ).GetPointCount() - 1, aPosition );
 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 }
}

References ARC, ArcTangente(), CIRCLE, EDA_SHAPE::GetEnd(), GetLineLength(), SHAPE_LINE_CHAIN::GetPointCount(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetShape(), EDA_SHAPE::GetStart(), KiROUND(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_editState, EDA_SHAPE::m_end, EDA_SHAPE::m_poly, EDA_SHAPE::m_start, NORMALIZE_ANGLE_POS(), SHAPE_POLY_SET::Outline(), POLY, RECT, RotatePoint(), SEGMENT, EDA_SHAPE::SetArcGeometry(), EDA_SHAPE::SetEnd(), SHAPE_LINE_CHAIN::SetPoint(), EDA_SHAPE::SHAPE_T_asString(), sq, and UNIMPLEMENTED_FOR.

Referenced by LIB_SHAPE::CalcEdit().

ClassOf()

static bool FP_SHAPE::ClassOf ( const EDA_ITEM *  aItem )

inlinestatic

Definition at line 49 of file fp_shape.h.

 {
 return aItem && PCB_FP_SHAPE_T == aItem->Type();
 }

References PCB_FP_SHAPE_T, and EDA_ITEM::Type().

ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 132 of file eda_item.h.

{ ClearFlags( BRIGHTENED ); }

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PCB_BASE_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), PL_SELECTION_TOOL::unhighlight(), EE_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 171 of file eda_item.h.

 {
 ClearFlags( GetEditFlags() );
 }

References EDA_ITEM::ClearFlags(), and EDA_ITEM::GetEditFlags().

Referenced by FOOTPRINT::Add(), BOARD::Add(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS  aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 153 of file eda_item.h.

{ m_flags &= ~aMask; }

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), FOOTPRINT::BuildPolyCourtyards(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_SELECTION_TOOL::ExitGroup(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), EE_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::narrowSelection(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), EE_SELECTION_TOOL::selectMultiple(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 131 of file eda_item.h.

{ ClearFlags( SELECTED ); }

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by PCB_POINT_EDITOR::addCorner(), EDIT_TOOL::Duplicate(), ARRAY_CREATOR::Invoke(), LIB_SYMBOL::LIB_SYMBOL(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), PL_SELECTION_TOOL::unhighlight(), EE_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 165 of file eda_item.h.

 {
 ClearFlags( STARTPOINT | ENDPOINT | CANDIDATE | TEMP_SELECTED | IS_LINKED | SKIP_STRUCT |
 DO_NOT_DRAW );
 }

References CANDIDATE, EDA_ITEM::ClearFlags(), DO_NOT_DRAW, ENDPOINT, IS_LINKED, SKIP_STRUCT, STARTPOINT, and TEMP_SELECTED.

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 143 of file view_item.h.

 {
 m_viewPrivData = nullptr;
 }

References KIGFX::VIEW_ITEM::m_viewPrivData.

Referenced by KIGFX::VIEW::OnDestroy().

Clone()

EDA_ITEM * FP_SHAPE::Clone ( ) const

overridevirtual

Create a duplicate of this item with linked list members set to NULL.

The default version will return NULL in release builds and likely crash the program. In debug builds, a warning message indicating the derived class has not implemented cloning. This really should be a pure virtual function. Due to the fact that there are so many objects derived from EDA_ITEM, the decision was made to return NULL until all the objects derived from EDA_ITEM implement cloning. Once that happens, this function should be made pure.

Returns

A clone of the item.

Reimplemented from PCB_SHAPE.

Definition at line 139 of file fp_shape.cpp.

{
 return new FP_SHAPE( *this );
}

References FP_SHAPE().

Compare()

int EDA_SHAPE::Compare ( const EDA_SHAPE *  aOther ) const

inherited

Definition at line 1440 of file eda_shape.cpp.

{
#define EPSILON 2 // Should be enough for rounding errors on calculated items

#define TEST( a, b ) { if( a != b ) return a - b; }
#define TEST_E( a, b ) { if( abs( a - b ) > EPSILON ) return a - b; }
#define TEST_PT( a, b ) { TEST_E( a.x, b.x ); TEST_E( a.y, b.y ); }

 TEST_PT( m_start, aOther->m_start );
 TEST_PT( m_end, aOther->m_end );

 TEST( (int) m_shape, (int) aOther->m_shape );

 if( m_shape == SHAPE_T::ARC )
 {
 TEST_PT( m_arcCenter, aOther->m_arcCenter );
 }
 else if( m_shape == SHAPE_T::BEZIER )
 {
 TEST_PT( m_bezierC1, aOther->m_bezierC1 );
 TEST_PT( m_bezierC2, aOther->m_bezierC2 );
 }
 else if( m_shape == SHAPE_T::POLY )
 {
 TEST( m_poly.TotalVertices(), aOther->m_poly.TotalVertices() );

 for( int ii = 0; ii < m_poly.TotalVertices(); ++ii )
 TEST_PT( m_poly.CVertex( ii ), aOther->m_poly.CVertex( ii ) );
 }

 TEST_E( m_width, aOther->m_width );
 TEST( (int) m_fill, (int) aOther->m_fill );

 return 0;
}

References ARC, BEZIER, SHAPE_POLY_SET::CVertex(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_bezierC1, EDA_SHAPE::m_bezierC2, EDA_SHAPE::m_end, EDA_SHAPE::m_fill, EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, EDA_SHAPE::m_width, POLY, TEST, TEST_E, TEST_PT, and SHAPE_POLY_SET::TotalVertices().

Referenced by LIB_SHAPE::compare(), and BOARD::cmp_drawings::operator()().

computeArcBBox()

void EDA_SHAPE::computeArcBBox ( EDA_RECT &  aBBox ) const

protectedinherited

Definition at line 995 of file eda_shape.cpp.

{
 wxPoint start = m_start;
 wxPoint end = m_end;
 double t1, t2;

 CalcArcAngles( t1, t2 );

 if( m_eeWinding && NormalizeAngleDegrees( t1 - t2, -180.0, 180.0 ) > 0 )
 std::swap( start, end );

 // Do not include the center, which is not necessarily inside the BB of an arc with a small
 // included angle
 aBBox.SetOrigin( start );
 aBBox.Merge( end );

 // Determine the starting quarter
 // 0 right-bottom
 // 1 left-bottom
 // 2 left-top
 // 3 right-top
 unsigned int quarter;

 if( start.x < m_arcCenter.x )
 {
 if( start.y <= m_arcCenter.y )
 quarter = 2;
 else
 quarter = 1;
 }
 else if( start.x == m_arcCenter.x )
 {
 if( start.y < m_arcCenter.y )
 quarter = 3;
 else
 quarter = 1;
 }
 else
 {
 if( start.y < m_arcCenter.y )
 quarter = 3;
 else
 quarter = 0;
 }

 int radius = GetRadius();
 VECTOR2I startRadial = start - m_arcCenter;
 VECTOR2I endRadial = end - m_arcCenter;
 double angleStart = ArcTangente( startRadial.y, startRadial.x );
 double arcAngle = RAD2DECIDEG( endRadial.Angle() - startRadial.Angle() );
 int angle = (int) NormalizeAnglePos( angleStart ) % 900 + NormalizeAnglePos( arcAngle );

 while( angle > 900 )
 {
 switch( quarter )
 {
 case 0: aBBox.Merge( wxPoint( m_arcCenter.x, m_arcCenter.y + radius ) ); break; // down
 case 1: aBBox.Merge( wxPoint( m_arcCenter.x - radius, m_arcCenter.y ) ); break; // left
 case 2: aBBox.Merge( wxPoint( m_arcCenter.x, m_arcCenter.y - radius ) ); break; // up
 case 3: aBBox.Merge( wxPoint( m_arcCenter.x + radius, m_arcCenter.y ) ); break; // right
 }

 ++quarter %= 4;
 angle -= 900;
 }
}

References PNS::angle(), VECTOR2< T >::Angle(), ArcTangente(), EDA_SHAPE::CalcArcAngles(), EDA_SHAPE::GetRadius(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_eeWinding, EDA_SHAPE::m_end, EDA_SHAPE::m_start, EDA_RECT::Merge(), NormalizeAngleDegrees(), NormalizeAnglePos(), RAD2DECIDEG(), EDA_RECT::SetOrigin(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by EDA_SHAPE::getBoundingBox().

continueEdit()

bool EDA_SHAPE::continueEdit ( const wxPoint &  aPosition )

protectedinherited

Definition at line 1239 of file eda_shape.cpp.

{
 switch( GetShape() )
 {
 case SHAPE_T::ARC:
 case SHAPE_T::SEGMENT:
 case SHAPE_T::CIRCLE:
 case SHAPE_T::RECT:
 return false;

 case SHAPE_T::POLY:
 {
 SHAPE_LINE_CHAIN& poly = m_poly.Outline( 0 );

 // do not add zero-length segments
 if( poly.CPoint( poly.GetPointCount() - 2 ) != poly.CLastPoint() )
 poly.Append( aPosition, true );
 }
 return true;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 return false;
 }
}

References SHAPE_LINE_CHAIN::Append(), ARC, CIRCLE, SHAPE_LINE_CHAIN::CLastPoint(), SHAPE_LINE_CHAIN::CPoint(), SHAPE_LINE_CHAIN::GetPointCount(), EDA_SHAPE::GetShape(), EDA_SHAPE::m_poly, SHAPE_POLY_SET::Outline(), POLY, RECT, SEGMENT, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by LIB_SHAPE::ContinueEdit().

DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )

inherited

Delete this object after removing from its parent if it has one.

Definition at line 128 of file board_item.cpp.

{
 BOARD_ITEM_CONTAINER* parent = GetParent();

 if( parent )
 parent->Remove( this );

 delete this;
}

References BOARD_ITEM::GetParent(), and BOARD_ITEM_CONTAINER::Remove().

Referenced by BOARD::PadDelete(), and DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow().

Duplicate()

virtual BOARD_ITEM* BOARD_ITEM::Duplicate ( ) const

inlinevirtualinherited

Create a copy of this BOARD_ITEM.

Reimplemented in FOOTPRINT.

Definition at line 171 of file board_item.h.

 {
 EDA_ITEM* dupe = Clone();
 const_cast<KIID&>( dupe->m_Uuid ) = KIID();

 return static_cast<BOARD_ITEM*>( dupe );
 }

References EDA_ITEM::Clone(), and EDA_ITEM::m_Uuid.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), BOOST_AUTO_TEST_CASE(), PCB_GROUP::DeepDuplicate(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawBoardCharacteristics(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawSpecificationStackup(), EDIT_TOOL::Duplicate(), and ARRAY_CREATOR::Invoke().

DupPolyPointsList()

void EDA_SHAPE::DupPolyPointsList ( std::vector< wxPoint > &  aBuffer ) const

inherited

Duplicate the list of corners in a std::vector<wxPoint>

It must be used only to convert the SHAPE_POLY_SET internal corner buffer to a list of wxPoints, and nothing else, because it duplicates the buffer, that is inefficient to know for instance the corner count

Definition at line 1168 of file eda_shape.cpp.

{
 if( m_poly.OutlineCount() )
 {
 int pointCount = m_poly.COutline( 0 ).PointCount();

 if( pointCount )
 {
 aBuffer.reserve( pointCount );

 for ( auto iter = m_poly.CIterate(); iter; iter++ )
 aBuffer.emplace_back( iter->x, iter->y );
 }
 }
}

References SHAPE_POLY_SET::CIterate(), SHAPE_POLY_SET::COutline(), EDA_SHAPE::m_poly, SHAPE_POLY_SET::OutlineCount(), and SHAPE_LINE_CHAIN::PointCount().

Referenced by PCB_GRID_HELPER::computeAnchors(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), EDA_SHAPE::TransformShapeWithClearanceToPolygon(), and PCB_POINT_EDITOR::updatePoints().

endEdit()

void EDA_SHAPE::endEdit ( bool  aClosed = true )

protectedinherited

Finishes editing the shape.

Parameters

aClosed

Should polygon shapes be closed (yes for pcbnew/fpeditor, no for libedit)

Definition at line 1391 of file eda_shape.cpp.

{
 switch( GetShape() )
 {
 case SHAPE_T::ARC:
 case SHAPE_T::SEGMENT:
 case SHAPE_T::CIRCLE:
 case SHAPE_T::RECT:
 break;

 case SHAPE_T::POLY:
 {
 SHAPE_LINE_CHAIN& poly = m_poly.Outline( 0 );

 // do not include last point twice
 if( poly.GetPointCount() > 2 )
 {
 if( poly.CPoint( poly.GetPointCount() - 2 ) == poly.CLastPoint() )
 {
 poly.SetClosed( aClosed );
 poly.Remove( poly.GetPointCount() - 1 );
 }
 }
 }
 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 }
}

References ARC, CIRCLE, SHAPE_LINE_CHAIN::CLastPoint(), SHAPE_LINE_CHAIN::CPoint(), SHAPE_LINE_CHAIN::GetPointCount(), EDA_SHAPE::GetShape(), EDA_SHAPE::m_poly, SHAPE_POLY_SET::Outline(), POLY, RECT, SHAPE_LINE_CHAIN::Remove(), SEGMENT, SHAPE_LINE_CHAIN::SetClosed(), EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by LIB_SHAPE::EndEdit().

EndsSwapped()

bool EDA_SHAPE::EndsSwapped ( ) const

inlineinherited

Have the start and end points been swapped since they were set?

Returns

true if they have

Definition at line 166 of file eda_shape.h.

{ return m_endsSwapped; }

References EDA_SHAPE::m_endsSwapped.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes().

Flip() [1/2]

void FP_SHAPE::Flip ( const wxPoint &  aCentre, bool  aFlipLeftRight  )

overridevirtual

Flip entity relative to aCentre.

The item is mirrored, and layer changed to the paired corresponding layer if it is on a paired layer. This function should be called only from FOOTPRINT::Flip because it is not usual to flip an item alone, without flipping the parent footprint (consider Mirror() instead).

Reimplemented from PCB_SHAPE.

Definition at line 206 of file fp_shape.cpp.

{
 wxPoint pt( 0, 0 );

 switch( GetShape() )
 {
 case SHAPE_T::ARC:
 case SHAPE_T::SEGMENT:
 case SHAPE_T::RECT:
 case SHAPE_T::CIRCLE:
 case SHAPE_T::BEZIER:
 // If Start0 and Start are equal (ie: Footprint Editor), then flip both sets around the
 // centre point.
 if( m_start == m_start0 )
 pt = aCentre;

 if( aFlipLeftRight )
 {
 MIRROR( m_start.x, aCentre.x );
 MIRROR( m_end.x, aCentre.x );
 MIRROR( m_arcCenter.x, aCentre.x );
 MIRROR( m_bezierC1.x, aCentre.x );
 MIRROR( m_bezierC2.x, aCentre.x );
 MIRROR( m_start0.x, pt.x );
 MIRROR( m_end0.x, pt.x );
 MIRROR( m_arcCenter0.x, pt.x );
 MIRROR( m_bezierC1_0.x, pt.x );
 MIRROR( m_bezierC2_0.x, pt.x );
 }
 else
 {
 MIRROR( m_start.y, aCentre.y );
 MIRROR( m_end.y, aCentre.y );
 MIRROR( m_arcCenter.y, aCentre.y );
 MIRROR( m_bezierC1.y, aCentre.y );
 MIRROR( m_bezierC2.y, aCentre.y );
 MIRROR( m_start0.y, pt.y );
 MIRROR( m_end0.y, pt.y );
 MIRROR( m_arcCenter0.y, pt.y );
 MIRROR( m_bezierC1_0.y, pt.y );
 MIRROR( m_bezierC2_0.y, pt.y );
 }

 if( GetShape() == SHAPE_T::BEZIER )
 RebuildBezierToSegmentsPointsList( m_width );

 if( GetShape() == SHAPE_T::ARC )
 {
 std::swap( m_start, m_end );
 std::swap( m_start0, m_end0 );
 }

 break;

 case SHAPE_T::POLY:
 // polygon corners coordinates are relative to the footprint position, orientation 0
 m_poly.Mirror( aFlipLeftRight, !aFlipLeftRight );
 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 }

 SetLayer( FlipLayer( GetLayer(), GetBoard()->GetCopperLayerCount() ) );
}

References ARC, BEZIER, CIRCLE, FlipLayer(), BOARD_ITEM::GetBoard(), BOARD_ITEM::GetLayer(), EDA_SHAPE::GetShape(), EDA_SHAPE::m_arcCenter, m_arcCenter0, EDA_SHAPE::m_bezierC1, m_bezierC1_0, EDA_SHAPE::m_bezierC2, m_bezierC2_0, EDA_SHAPE::m_end, m_end0, EDA_SHAPE::m_poly, EDA_SHAPE::m_start, m_start0, EDA_SHAPE::m_width, MIRROR(), SHAPE_POLY_SET::Mirror(), POLY, EDA_SHAPE::RebuildBezierToSegmentsPointsList(), RECT, SEGMENT, BOARD_ITEM::SetLayer(), EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Flip() [2/2]

void BOARD_ITEM::Flip ( const VECTOR2I &  aCentre, bool  aFlipLeftRight  )

inlineinherited

Definition at line 269 of file board_item.h.

 {
 Flip( wxPoint( aCentre.x, aCentre.y ), aFlipLeftRight );
 }

References BOARD_ITEM::Flip(), VECTOR2< T >::x, and VECTOR2< T >::y.

flip()

void EDA_SHAPE::flip ( const wxPoint &  aCentre, bool  aFlipLeftRight  )

protectedinherited

Definition at line 281 of file eda_shape.cpp.

{
 switch ( m_shape )
 {
 case SHAPE_T::SEGMENT:
 case SHAPE_T::RECT:
 if( aFlipLeftRight )
 {
 m_start.x = aCentre.x - ( m_start.x - aCentre.x );
 m_end.x = aCentre.x - ( m_end.x - aCentre.x );
 }
 else
 {
 m_start.y = aCentre.y - ( m_start.y - aCentre.y );
 m_end.y = aCentre.y - ( m_end.y - aCentre.y );
 }

 std::swap( m_start, m_end );
 break;

 case SHAPE_T::CIRCLE:
 if( aFlipLeftRight )
 {
 m_start.x = aCentre.x - ( m_start.x - aCentre.x );
 m_end.x = aCentre.x - ( m_end.x - aCentre.x );
 }
 else
 {
 m_start.y = aCentre.y - ( m_start.y - aCentre.y );
 m_end.y = aCentre.y - ( m_end.y - aCentre.y );
 }
 break;

 case SHAPE_T::ARC:
 if( aFlipLeftRight )
 {
 m_start.x = aCentre.x - ( m_start.x - aCentre.x );
 m_end.x = aCentre.x - ( m_end.x - aCentre.x );
 m_arcCenter.x = aCentre.x - ( m_arcCenter.x - aCentre.x );
 }
 else
 {
 m_start.y = aCentre.y - ( m_start.y - aCentre.y );
 m_end.y = aCentre.y - ( m_end.y - aCentre.y );
 m_arcCenter.y = aCentre.y - ( m_arcCenter.y - aCentre.y );
 }

 std::swap( m_start, m_end );
 break;

 case SHAPE_T::POLY:
 m_poly.Mirror( aFlipLeftRight, !aFlipLeftRight, VECTOR2I( aCentre ) );
 break;

 case SHAPE_T::BEZIER:
 if( aFlipLeftRight )
 {
 m_start.x = aCentre.x - ( m_start.x - aCentre.x );
 m_end.x = aCentre.x - ( m_end.x - aCentre.x );
 m_bezierC1.x = aCentre.x - ( m_bezierC1.x - aCentre.x );
 m_bezierC2.x = aCentre.x - ( m_bezierC2.x - aCentre.x );
 }
 else
 {
 m_start.y = aCentre.y - ( m_start.y - aCentre.y );
 m_end.y = aCentre.y - ( m_end.y - aCentre.y );
 m_bezierC1.y = aCentre.y - ( m_bezierC1.y - aCentre.y );
 m_bezierC2.y = aCentre.y - ( m_bezierC2.y - aCentre.y );
 }

 // Rebuild the poly points shape
 {
 std::vector<wxPoint> ctrlPoints = { m_start, m_bezierC1, m_bezierC2, m_end };
 BEZIER_POLY converter( ctrlPoints );
 converter.GetPoly( m_bezierPoints, m_width );
 }
 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 break;
 }
}

References ARC, BEZIER, CIRCLE, BEZIER_POLY::GetPoly(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_bezierC1, EDA_SHAPE::m_bezierC2, EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_end, EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, EDA_SHAPE::m_width, SHAPE_POLY_SET::Mirror(), POLY, RECT, SEGMENT, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by PCB_SHAPE::Flip(), LIB_SHAPE::MirrorHorizontal(), and LIB_SHAPE::MirrorVertical().

Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE *  aProperty )

inlineinherited

Definition at line 86 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
 return object ? aProperty->getter( object ) : wxAny();
 }

References PROPERTY_BASE::getter(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Referenced by BOOST_AUTO_TEST_CASE(), CLASS_D_DESC::CLASS_D_DESC(), PCB_EXPR_VAR_REF::GetValue(), and PAD_DESC::PAD_DESC().

Get() [2/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE *  aProperty )

inlineinherited

Definition at line 95 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
  TYPE_ID thisType = TYPE_HASH( *this );
 void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
 return object ? aProperty->get<T>( object ) : T();
 }

References PROPERTY_BASE::get(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Get() [3/3]

template<typename T >

boost::optional<T> INSPECTABLE::Get ( const wxString &  aProperty )

inlineinherited

Definition at line 104 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
 boost::optional<T> ret = T();

 if( prop )
 {
 void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );

 if( object )
 ret = prop->get<T>( object );
 }

 return ret;
 }

References PROPERTY_BASE::get(), PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

GetArcAngle()

double EDA_SHAPE::GetArcAngle ( ) const

inherited

Definition at line 514 of file eda_shape.cpp.

{
 double startAngle;
 double endAngle;

 CalcArcAngles( startAngle, endAngle );

 return ( endAngle - startAngle ) * 10;
}

References EDA_SHAPE::CalcArcAngles().

Referenced by BOARD_ADAPTER::addShapeWithClearance(), GRAPHICS_CLEANER::areEquivalent(), ConvertOutlineToPolygon(), FootprintWriteShape(), EDA_SHAPE::GetArcMid(), GetArcMid0(), EDA_SHAPE::GetLength(), CADSTAR_PCB_ARCHIVE_LOADER::getLineChainFromShapes(), hash_fp_item(), idf_export_outline(), EDA_SHAPE::MakeEffectiveShapes(), DSN::SPECCTRA_DB::makeIMAGE(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), EDA_SHAPE::ShapeGetMsgPanelInfo(), AR_MATRIX::TraceSegmentPcb(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), and DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow().

GetArcMid()

wxPoint EDA_SHAPE::GetArcMid ( ) const

inherited

Definition at line 437 of file eda_shape.cpp.

{
 wxPoint mid = m_start;
 RotatePoint( &mid, m_arcCenter, -GetArcAngle() / 2.0 );
 return mid;
}

References EDA_SHAPE::GetArcAngle(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_start, and RotatePoint().

Referenced by PCB_GRID_HELPER::computeAnchors(), CONVERT_TOOL::CreateLines(), PCB_POINT_EDITOR::editArcMidKeepEndpoints(), PCB_PLUGIN::format(), formatArc(), PCB_SHAPE::GetFocusPosition(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromSegs(), EDA_SHAPE::SetArcGeometry(), EDA_SHAPE::TransformShapeWithClearanceToPolygon(), and PCB_POINT_EDITOR::updatePoints().

GetArcMid0()

wxPoint FP_SHAPE::GetArcMid0

(

)

const

Definition at line 180 of file fp_shape.cpp.

{
 wxPoint mid0 = m_start0;
 RotatePoint( &mid0, m_arcCenter0, -GetArcAngle() / 2.0 );
 return mid0;
}

References EDA_SHAPE::GetArcAngle(), m_arcCenter0, m_start0, and RotatePoint().

Referenced by PCB_PLUGIN::format(), and CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes().

GetBezierC1()

const wxPoint& EDA_SHAPE::GetBezierC1 ( ) const

inlineinherited

Definition at line 145 of file eda_shape.h.

{ return m_bezierC1; }

References EDA_SHAPE::m_bezierC1.

Referenced by GRAPHICS_CLEANER::areEquivalent(), KIGFX::PCB_PAINTER::draw(), PCB_PLUGIN::format(), formatBezier(), EDA_SHAPE::getBoundingBox(), PCB_POINT_EDITOR::makePoints(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), EDA_SHAPE::TransformShapeWithClearanceToPolygon(), and PCB_POINT_EDITOR::updatePoints().

GetBezierC1_0()

const wxPoint& FP_SHAPE::GetBezierC1_0 ( ) const

inline

Definition at line 118 of file fp_shape.h.

{ return m_bezierC1_0; }

References m_bezierC1_0.

Referenced by PCB_PLUGIN::format().

GetBezierC2()

const wxPoint& EDA_SHAPE::GetBezierC2 ( ) const

inlineinherited

Definition at line 148 of file eda_shape.h.

{ return m_bezierC2; }

References EDA_SHAPE::m_bezierC2.

Referenced by GRAPHICS_CLEANER::areEquivalent(), KIGFX::PCB_PAINTER::draw(), PCB_PLUGIN::format(), formatBezier(), EDA_SHAPE::getBoundingBox(), PCB_POINT_EDITOR::makePoints(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), EDA_SHAPE::TransformShapeWithClearanceToPolygon(), and PCB_POINT_EDITOR::updatePoints().

GetBezierC2_0()

const wxPoint& FP_SHAPE::GetBezierC2_0 ( ) const

inline

Definition at line 121 of file fp_shape.h.

{ return m_bezierC2_0; }

References m_bezierC2_0.

Referenced by PCB_PLUGIN::format().

GetBezierPoints()

const std::vector<wxPoint>& EDA_SHAPE::GetBezierPoints ( ) const

inlineinherited

Definition at line 190 of file eda_shape.h.

{ return m_bezierPoints; }

References EDA_SHAPE::m_bezierPoints.

Referenced by GRAPHICS_CLEANER::areEquivalent(), ConvertOutlineToPolygon(), KIGFX::SCH_PAINTER::draw(), GRAPHICS_CLEANER::isNullShape(), and SCH_LEGACY_PLUGIN_CACHE::saveBezier().

GetBoard() [1/2]

const BOARD * BOARD_ITEM::GetBoard ( ) const

virtualinherited

Return the BOARD in which this BOARD_ITEM resides, or NULL if none.

Definition at line 36 of file board_item.cpp.

{
 if( Type() == PCB_T )
 return static_cast<const BOARD*>( this );

 BOARD_ITEM* parent = GetParent();

 if( parent )
 return parent->GetBoard();

 return nullptr;
}

References BOARD_ITEM::GetBoard(), BOARD_ITEM::GetParent(), PCB_T, and EDA_ITEM::Type().

Referenced by ZONE_FILLER::addHoleKnockout(), PAD::BuildEffectivePolygon(), PAD::BuildEffectiveShapes(), ZONE::BuildSmoothedPoly(), calcIsInsideArea(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), PCB_LAYER_VALUE::EqualTo(), existsOnLayer(), exprFromTo(), PCB_VIA::FlashLayer(), PAD::FlashLayer(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), PCB_TRACK::Flip(), Flip(), PCB_SHAPE::Flip(), FP_TEXT::Flip(), PCB_DIMENSION_BASE::Flip(), PCB_ARC::Flip(), PCB_VIA::Flip(), ZONE::Flip(), PCB_EXPR_CONTEXT::GetBoard(), BOARD_ITEM::GetBoard(), FOOTPRINT::GetBoundingBox(), FOOTPRINT::GetBoundingHull(), BOARD_CONNECTED_ITEM::GetEffectiveNetclass(), PCB_VIA::GetEffectiveShape(), ZONE::GetInteractingZones(), BOARD_ITEM::GetLayerName(), PCB_VIA::GetMinAnnulus(), PCB_DRAW_PANEL_GAL::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetClass(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), BOARD_CONNECTED_ITEM::GetOwnClearance(), ZONE::GetSelectMenuText(), DRC_ENGINE::GetShape(), FP_TEXT::GetShownText(), PAD::GetSolderMaskMargin(), PAD::GetSolderPasteMargin(), BOARD::GetTrackLength(), inDiffPair(), insideArea(), insideBackCourtyard(), insideCourtyard(), insideFrontCourtyard(), isInsideArea(), isInsideCourtyard(), BOARD_ITEM::IsLocked(), BOARD_ITEM::layerMaskDescribe(), PCB_VIA::layerMaskDescribe(), CONVERT_TOOL::makePolysFromCircles(), PAD::MergePrimitivesAsPolygon(), EAGLE_PLUGIN::packageWire(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), BOARD::ResolveDRCExclusions(), BOARD_CONNECTED_ITEM::SetNetCode(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), ZONE::TransformSmoothedOutlineToPolygon(), ZONE::TransformSolidAreasShapesToPolygon(), PCB_TRACK::ViewBBox(), FOOTPRINT::ViewBBox(), PCB_VIA::ViewGetLOD(), and PAD::ViewGetLOD().

GetBoard() [2/2]

BOARD * BOARD_ITEM::GetBoard ( )

virtualinherited

Definition at line 50 of file board_item.cpp.

{
 if( Type() == PCB_T )
 return static_cast<BOARD*>( this );

 BOARD_ITEM* parent = GetParent();

 if( parent )
 return parent->GetBoard();

 return nullptr;
}

References BOARD_ITEM::GetBoard(), BOARD_ITEM::GetParent(), PCB_T, and EDA_ITEM::Type().

GetBoundingBox()

const EDA_RECT PCB_SHAPE::GetBoundingBox ( ) const

inlineoverridevirtualinherited

Return the orthogonal bounding box of this object for display purposes.

This box should be an enclosing perimeter for visible components of this object, and the units should be in the pcb or schematic coordinate system. It is OK to overestimate the size by a few counts.

Reimplemented from EDA_ITEM.

Definition at line 101 of file pcb_shape.h.

{ return getBoundingBox(); }

References EDA_SHAPE::getBoundingBox().

Referenced by BOARD_ADAPTER::addShapeWithClearance().

getBoundingBox()

const EDA_RECT EDA_SHAPE::getBoundingBox ( ) const

protectedinherited

Definition at line 612 of file eda_shape.cpp.

{
 EDA_RECT bbox;

 switch( m_shape )
 {
 case SHAPE_T::RECT:
 for( wxPoint& pt : GetRectCorners() )
 bbox.Merge( pt );

 break;

 case SHAPE_T::SEGMENT:
 bbox.SetOrigin( GetStart() );
 bbox.SetEnd( GetEnd() );
 break;

 case SHAPE_T::CIRCLE:
 bbox.SetOrigin( GetStart() );
 bbox.Inflate( GetRadius() );
 break;

 case SHAPE_T::ARC:
 computeArcBBox( bbox );
 break;

 case SHAPE_T::POLY:
 if( m_poly.IsEmpty() )
 break;

 for( auto iter = m_poly.CIterate(); iter; iter++ )
 {
 wxPoint pt( iter->x, iter->y );

 RotatePoint( &pt, getParentOrientation() );
 pt += getParentPosition();

 bbox.Merge( pt );
 }

 break;

 case SHAPE_T::BEZIER:
 bbox.SetOrigin( GetStart() );
 bbox.Merge( GetBezierC1() );
 bbox.Merge( GetBezierC2() );
 bbox.Merge( GetEnd() );
 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 break;
 }

 bbox.Inflate( std::max( 0, m_width / 2 ) );
 bbox.Normalize();

 return bbox;
}

References ARC, BEZIER, CIRCLE, SHAPE_POLY_SET::CIterate(), EDA_SHAPE::computeArcBBox(), EDA_SHAPE::GetBezierC1(), EDA_SHAPE::GetBezierC2(), EDA_SHAPE::GetEnd(), EDA_SHAPE::getParentOrientation(), EDA_SHAPE::getParentPosition(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetRectCorners(), EDA_SHAPE::GetStart(), EDA_RECT::Inflate(), SHAPE_POLY_SET::IsEmpty(), EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, EDA_SHAPE::m_width, EDA_RECT::Merge(), EDA_RECT::Normalize(), POLY, RECT, RotatePoint(), SEGMENT, EDA_RECT::SetEnd(), EDA_RECT::SetOrigin(), EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by LIB_SHAPE::GetBoundingBox(), PCB_SHAPE::GetBoundingBox(), EDA_SHAPE::getCenter(), and EDA_SHAPE::hitTest().

GetCenter()

wxPoint PCB_SHAPE::GetCenter ( ) const

inlineoverridevirtualinherited

This defaults to the center of the bounding box if not overridden.

Returns

center point of the item

Reimplemented from BOARD_ITEM.

Definition at line 79 of file pcb_shape.h.

{ return getCenter(); }

References EDA_SHAPE::getCenter().

Referenced by BOARD_ADAPTER::addShapeWithClearance(), GRAPHICS_CLEANER::areEquivalent(), PCB_GRID_HELPER::computeAnchors(), ConvertOutlineToPolygon(), KIGFX::PCB_PAINTER::draw(), PCB_SHAPE::GetFocusPosition(), hash_fp_item(), idf_export_outline(), DSN::SPECCTRA_DB::makeIMAGE(), PCB_POINT_EDITOR::makePoints(), EAGLE_PLUGIN::packageRectangle(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), AR_MATRIX::TraceSegmentPcb(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), PCB_POINT_EDITOR::updateItem(), and PCB_POINT_EDITOR::updatePoints().

getCenter()

wxPoint EDA_SHAPE::getCenter ( ) const

inherited

Definition at line 393 of file eda_shape.cpp.

{
 switch( m_shape )
 {
 case SHAPE_T::ARC:
 return m_arcCenter;

 case SHAPE_T::CIRCLE:
 return m_start;

 case SHAPE_T::SEGMENT:
 // Midpoint of the line
 return ( m_start + m_end ) / 2;

 case SHAPE_T::POLY:
 case SHAPE_T::RECT:
 case SHAPE_T::BEZIER:
 return getBoundingBox().Centre();

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 return wxPoint();
 }
}

References ARC, BEZIER, EDA_RECT::Centre(), CIRCLE, EDA_SHAPE::getBoundingBox(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_end, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, POLY, RECT, SEGMENT, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by EDA_SHAPE::CalcArcAngles(), PCB_SHAPE::GetCenter(), LIB_SHAPE::GetCenter(), EDA_SHAPE::getPosition(), EDA_SHAPE::hitTest(), EDA_SHAPE::MakeEffectiveShapes(), LIB_SHAPE::Plot(), LIB_SHAPE::print(), and EDA_SHAPE::TransformShapeWithClearanceToPolygon().

GetCenter0()

wxPoint FP_SHAPE::GetCenter0

(

)

const

Definition at line 145 of file fp_shape.cpp.

{
 switch( m_shape )
 {
 case SHAPE_T::ARC:
 return m_arcCenter0;

 case SHAPE_T::CIRCLE:
 return m_start0;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 return wxPoint();
 }
}

References ARC, CIRCLE, m_arcCenter0, EDA_SHAPE::m_shape, m_start0, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by FootprintWriteShape(), CADSTAR_PCB_ARCHIVE_LOADER::getLineChainFromShapes(), hash_fp_item(), and DSN::SPECCTRA_DB::makeIMAGE().

GetClass()

wxString FP_SHAPE::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Definition at line 143 of file fp_shape.h.

 {
 return wxT( "MGRAPHIC" );
 }

GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 157 of file eda_item.h.

 {
 constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVING | IS_RESIZING | IS_DRAGGING
 | IS_WIRE_IMAGE | STRUCT_DELETED );

 return m_flags & mask;
 }

References IS_DRAGGING, IS_MOVING, IS_NEW, IS_PASTED, IS_RESIZING, IS_WIRE_IMAGE, EDA_ITEM::m_flags, and STRUCT_DELETED.

Referenced by EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), SCH_SYMBOL::GetMsgPanelInfo(), SELECTION_CONDITIONS::Idle(), SELECTION_CONDITIONS::IdleSelection(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PCB_POINT_EDITOR::OnSelectionChange(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), PAD_TOOL::recombinePad(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

GetEffectiveShape()

std::shared_ptr< SHAPE > PCB_SHAPE::GetEffectiveShape ( PCB_LAYER_ID  aLayer = UNDEFINED_LAYER ) const

overridevirtualinherited

Make a set of SHAPE objects representing the PCB_SHAPE.

Caller owns the objects.

Reimplemented from BOARD_ITEM.

Definition at line 192 of file pcb_shape.cpp.

{
 return std::make_shared<SHAPE_COMPOUND>( MakeEffectiveShapes() );
}

References EDA_SHAPE::MakeEffectiveShapes().

GetEnd()

const wxPoint& EDA_SHAPE::GetEnd ( ) const

inlineinherited

Return the ending point of the graphic.

Definition at line 122 of file eda_shape.h.

{ return m_end; }

References EDA_SHAPE::m_end.

Referenced by PCB_POINT_EDITOR::addCorner(), BOARD_ADAPTER::addShapeWithClearance(), GRAPHICS_CLEANER::areEquivalent(), LIB_SHAPE::CalcArcAngles(), EDA_SHAPE::CalcArcAngles(), EDA_SHAPE::calcEdit(), PCB_GRID_HELPER::computeAnchors(), ConvertOutlineToPolygon(), CreateBoardSection(), CONVERT_TOOL::CreateLines(), MICROWAVE_TOOL::createMicrowaveInductor(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), PCB_POINT_EDITOR::editArcEndpointKeepTangent(), PCB_PLUGIN::format(), formatArc(), formatBezier(), formatRect(), EDA_SHAPE::getBoundingBox(), EDA_SHAPE::GetLength(), EDA_SHAPE::GetRectCorners(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), CONVERT_TOOL::getStartEndPoints(), hash_fp_item(), EDA_SHAPE::hitTest(), idf_export_outline(), GRAPHICS_CLEANER::isNullShape(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), SCH_EAGLE_PLUGIN::loadSymbolRectangle(), EDIT_POINTS_FACTORY::Make(), EDA_SHAPE::MakeEffectiveShapes(), DSN::SPECCTRA_DB::makeIMAGE(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromRects(), CONVERT_TOOL::makePolysFromSegs(), GRAPHICS_CLEANER::mergeRects(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), EDA_SHAPE::ShapeGetMsgPanelInfo(), AR_MATRIX::TraceSegmentPcb(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), EDA_SHAPE::TransformShapeWithClearanceToPolygon(), EE_POINT_EDITOR::updatePoints(), and PCB_POINT_EDITOR::updatePoints().

GetEnd0()

const wxPoint& FP_SHAPE::GetEnd0 ( ) const

inline

Definition at line 115 of file fp_shape.h.

{ return m_end0; }

References m_end0.

Referenced by FootprintWriteShape(), PCB_PLUGIN::format(), CADSTAR_PCB_ARCHIVE_LOADER::getLineChainFromShapes(), hash_fp_item(), DSN::SPECCTRA_DB::makeIMAGE(), and CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes().

GetEndX()

int EDA_SHAPE::GetEndX ( )

inlineinherited

Definition at line 124 of file eda_shape.h.

{ return m_end.x; }

References EDA_SHAPE::m_end.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), and DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run().

GetEndY()

int EDA_SHAPE::GetEndY ( )

inlineinherited

Definition at line 123 of file eda_shape.h.

{ return m_end.y; }

References EDA_SHAPE::m_end.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), and DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run().

GetFillType()

FILL_T EDA_SHAPE::GetFillType ( ) const

inlineinherited

Definition at line 79 of file eda_shape.h.

{ return m_fill; }

References EDA_SHAPE::m_fill.

Referenced by LIB_SHAPE::GetEffectivePenWidth(), EDA_SHAPE::IsFilled(), LIB_SYMBOL::Plot(), LIB_SHAPE::print(), LIB_SYMBOL::Print(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), KIGFX::SCH_PAINTER::setDeviceColors(), and DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow().

GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 154 of file eda_item.h.

{ return m_flags; }

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), calcIsInsideArea(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), KIGFX::SCH_PAINTER::draw(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::expandConnection(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), BOARD_INSPECTION_TOOL::InspectConstraints(), LIB_SYMBOL::LIB_SYMBOL(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), FOOTPRINT::Remove(), BOARD::Remove(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

GetFocusPosition()

const wxPoint PCB_SHAPE::GetFocusPosition ( ) const

overridevirtualinherited

Allows items to return their visual center rather than their anchor.

For some shapes this is similar to GetCenter(), but for unfilled shapes a point on the outline is better.

Reimplemented from EDA_ITEM.

Definition at line 55 of file pcb_shape.cpp.

{
 // For some shapes return the visual center, but for not filled polygonal shapes,
 // the center is usually far from the shape: a point on the outline is better

 switch( m_shape )
 {
 case SHAPE_T::CIRCLE:
 if( !IsFilled() )
 return wxPoint( GetCenter().x + GetRadius(), GetCenter().y );
 else
 return GetCenter();

 case SHAPE_T::RECT:
 if( !IsFilled() )
 return GetStart();
 else
 return GetCenter();

 case SHAPE_T::POLY:
 if( !IsFilled() )
 {
 VECTOR2I pos = GetPolyShape().Outline(0).CPoint(0);
 return wxPoint( pos.x, pos.y );
 }
 else
 {
 return GetCenter();
 }

 case SHAPE_T::ARC:
 return GetArcMid();

 case SHAPE_T::BEZIER:
 return GetStart();

 default:
 return GetCenter();
 }
}

References ARC, BEZIER, CIRCLE, SHAPE_LINE_CHAIN::CPoint(), EDA_SHAPE::GetArcMid(), PCB_SHAPE::GetCenter(), EDA_SHAPE::GetPolyShape(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetStart(), EDA_SHAPE::IsFilled(), EDA_SHAPE::m_shape, SHAPE_POLY_SET::Outline(), POLY, RECT, VECTOR2< T >::x, and VECTOR2< T >::y.

GetLayer()

virtual PCB_LAYER_ID BOARD_ITEM::GetLayer ( ) const

inlinevirtualinherited

Return the primary layer this item is on.

Reimplemented in ZONE.

Definition at line 142 of file board_item.h.

{ return m_layer; }

References BOARD_ITEM::m_layer.

Referenced by CN_LIST::Add(), BOARD_ADAPTER::addFootprintShapesWithClearance(), GRAPHICS_CLEANER::areEquivalent(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), AR_AUTOPLACER::buildFpAreas(), TRACKS_CLEANER::cleanup(), CreateBoardSection(), MICROWAVE_TOOL::createMicrowaveInductor(), PCB_BASE_FRAME::CreateNewFootprint(), CreateRoutesSection(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDIT_TOOL::DragArcTrack(), KIGFX::PCB_PAINTER::draw(), PCB_EDIT_FRAME::ExchangeFootprint(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), extractDiffPairCoupledItems(), EDIT_TOOL::FilletTracks(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), PCB_TRACK::Flip(), Flip(), PCB_SHAPE::Flip(), FP_TEXT::Flip(), PCB_DIMENSION_BASE::Flip(), FOOTPRINT::Flip(), PCB_ARC::Flip(), PCB_BASE_FRAME::FocusOnItem(), FOOTPRINT_DESC::FOOTPRINT_DESC(), PCB_PLUGIN::FootprintSave(), FootprintWriteShape(), PCB_PLUGIN::format(), PCB_PLUGIN::formatLayer(), FP_TEXT::FP_TEXT(), DSN::SPECCTRA_DB::FromBOARD(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), FOOTPRINT::GetBoundingBox(), ZONE::GetLayer(), getMatchingTextItem(), PCB_TRACK::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), AR_AUTOPLACER::getOptimalFPPlacement(), BOARD::GetPad(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), idf_export_footprint(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), isEdge(), PAD::IsFlipped(), FOOTPRINT::IsFlipped(), PNS_KICAD_IFACE::IsItemVisible(), BOARD_ITEM::IsOnCopperLayer(), IsParentFlipped(), FP_TEXT::IsParentFlipped(), itemIsIncludedByFilter(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), PCB_SHAPE::cmp_drawings::operator()(), PCB_TRACK::cmp_tracks::operator()(), BOARD_ITEM::ptr_cmp::operator()(), FOOTPRINT::cmp_drawings::operator()(), BOARD::cmp_items::operator()(), BOARD::cmp_drawings::operator()(), EAGLE_PLUGIN::packagePad(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), BRDITEMS_PLOTTER::PlotPcbShape(), BRDITEMS_PLOTTER::PlotPcbTarget(), BRDITEMS_PLOTTER::PlotPcbText(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), processTextItem(), PAD_TOOL::recombinePad(), CLIPBOARD_IO::SaveSelection(), CONVERT_TOOL::SegmentToArc(), PCB_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::selectConnectedTracks(), GLOBAL_EDIT_TOOL::swapBoardItem(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncGraphicalItem(), PNS_KICAD_IFACE_BASE::syncTrack(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), AR_AUTOPLACER::testFootprintOnBoard(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), TRACK_VIA_DESC::TRACK_VIA_DESC(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), BOARD_ADAPTER::transformFPShapesToPolygon(), FOOTPRINT::TransformFPShapesWithClearanceToPolygon(), PCB_TRACK::ViewGetLayers(), FP_TEXT::ViewGetLayers(), FP_TEXT::ViewGetLOD(), FP_ZONE::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

GetLayerName()

wxString BOARD_ITEM::GetLayerName ( ) const

inherited

Return the name of the PCB layer on which the item resides.

Returns

the layer name associated with this item.

Definition at line 75 of file board_item.cpp.

{
 const BOARD* board = GetBoard();

 if( board )
 return board->GetLayerName( m_layer );

 // If no parent, return standard name
 return BOARD::GetStandardLayerName( m_layer );
}

References BOARD_ITEM::GetBoard(), BOARD::GetLayerName(), BOARD::GetStandardLayerName(), and BOARD_ITEM::m_layer.

Referenced by PCB_TARGET::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PCB_SHAPE::GetSelectMenuText(), PCB_TEXT::GetSelectMenuText(), GetSelectMenuText(), PCB_TRACK::GetSelectMenuText(), PCB_DIMENSION_BASE::GetSelectMenuText(), PCB_TEXT::GetShownText(), and FOOTPRINT::ResolveTextVar().

GetLayerSet()

virtual LSET BOARD_ITEM::GetLayerSet ( ) const

inlinevirtualinherited

Return a std::bitset of all layers on which the item physically resides.

Reimplemented in PAD, PCB_VIA, ZONE, and PCB_GROUP.

Definition at line 147 of file board_item.h.

{ return LSET( m_layer ); }

References BOARD_ITEM::m_layer.

Referenced by PCB_GRID_HELPER::BestSnapAnchor(), APPEARANCE_CONTROLS::doApplyLayerPreset(), DRAWING_TOOL::DrawVia(), DRC_ENGINE::EvalRules(), existsOnLayer(), extractDiffPairCoupledItems(), hash_board_item(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_ITEM::layerMaskDescribe(), FABMASTER::loadZone(), PCB_GRID_HELPER::nearestAnchor(), PCB_POINT_EDITOR::OnSelectionChange(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), CN_VISITOR::operator()(), EDIT_TOOL::Properties(), and PANEL_SETUP_LAYERS::TransferDataFromWindow().

GetLength()

double EDA_SHAPE::GetLength ( ) const

inherited

Return the length of the track using the hypotenuse calculation.

Returns

the length of the track

Definition at line 106 of file eda_shape.cpp.

{
 double length = 0.0;

 switch( m_shape )
 {
 case SHAPE_T::BEZIER:
 for( size_t ii = 1; ii < m_bezierPoints.size(); ++ii )
 length += GetLineLength( m_bezierPoints[ ii - 1], m_bezierPoints[ii] );

 return length;

 case SHAPE_T::SEGMENT:
 return GetLineLength( GetStart(), GetEnd() );

 case SHAPE_T::POLY:
 for( int ii = 0; ii < m_poly.COutline( 0 ).SegmentCount(); ii++ )
 length += m_poly.COutline( 0 ).CSegment( ii ).Length();

 return length;

 case SHAPE_T::ARC:
 return 2 * M_PI * GetRadius() * ( GetArcAngle() / 3600.0 );

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 return 0.0;
 }
}

References ARC, BEZIER, SHAPE_POLY_SET::COutline(), SHAPE_LINE_CHAIN::CSegment(), EDA_SHAPE::GetArcAngle(), EDA_SHAPE::GetEnd(), GetLineLength(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetStart(), SEG::Length(), EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, POLY, SEGMENT, SHAPE_LINE_CHAIN::SegmentCount(), EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by EDA_SHAPE::ShapeGetMsgPanelInfo().

GetMenuImage()

BITMAPS FP_SHAPE::GetMenuImage ( ) const

overridevirtual

Return a pointer to an image to be used in menus.

The default version returns the right arrow image. Override this function to provide object specific menu images.

Returns

The menu image associated with the item.

Reimplemented from PCB_SHAPE.

Definition at line 133 of file fp_shape.cpp.

{
 return BITMAPS::show_mod_edge;
}

References show_mod_edge.

GetMsgPanelInfo()

void FP_SHAPE::GetMsgPanelInfo ( EDA_DRAW_FRAME *  aFrame, std::vector< MSG_PANEL_ITEM > &  aList  )

overridevirtual

Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

Parameters

aList

is the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 110 of file fp_shape.cpp.

{
 if( aFrame->GetName() == PCB_EDIT_FRAME_NAME )
 {
 FOOTPRINT* fp = static_cast<FOOTPRINT*>( m_parent );

 if( fp )
 aList.emplace_back( _( "Footprint" ), fp->GetReference() );
 }

 // append the features shared with the base class
 PCB_SHAPE::GetMsgPanelInfo( aFrame, aList );
}

References _, PCB_SHAPE::GetMsgPanelInfo(), FOOTPRINT::GetReference(), EDA_ITEM::m_parent, and PCB_EDIT_FRAME_NAME.

GetParent()

BOARD_ITEM_CONTAINER* BOARD_ITEM::GetParent ( void  ) const

inlineinherited

Definition at line 135 of file board_item.h.

{ return (BOARD_ITEM_CONTAINER*) m_parent; }

References EDA_ITEM::m_parent.

Referenced by PCB_POINT_EDITOR::addCorner(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), PNS_KICAD_IFACE::Commit(), EDIT_TOOL::copyToClipboard(), FOOTPRINT::CoverageRatio(), BOARD_ITEM::DeleteStructure(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), EDIT_TOOL::DragArcTrack(), KIGFX::PCB_PAINTER::draw(), EDIT_TOOL::Duplicate(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_PLUGIN::format(), FormatProbeItem(), BOARD_ITEM::GetBoard(), PCB_MARKER::GetColorLayer(), BOARD_ITEM::GetParentFootprint(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), FP_TEXT::GetSelectMenuText(), PCB_TEXT::GetShownText(), FP_TEXT::GetShownText(), getTopLevelGroup(), GENERAL_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), isInsideArea(), DRC_ENGINE::IsNetTie(), IsParentFlipped(), FP_TEXT::IsParentFlipped(), PCB_SELECTION_TOOL::itemPassesFilter(), LEGACY_PLUGIN::loadMODULE_TEXT(), memberOf(), EDIT_TOOL::MoveExact(), ALTIUM_PCB::ParseTexts6Data(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), POSITION_RELATIVE_TOOL::PositionRelative(), BOARD_COMMIT::Push(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), CLIPBOARD_IO::SaveSelection(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::Selectable(), SwapItemData(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), PCB_MARKER::ViewGetLayers(), FP_ZONE::ViewGetLOD(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

GetParentAsString()

wxString FP_SHAPE::GetParentAsString ( ) const

inline

Definition at line 148 of file fp_shape.h.

{ return m_parent->m_Uuid.AsString(); }

References KIID::AsString(), EDA_ITEM::m_parent, and EDA_ITEM::m_Uuid.

Referenced by FP_SHAPE_DESC::FP_SHAPE_DESC().

GetParentFootprint()

FOOTPRINT * PCB_SHAPE::GetParentFootprint ( ) const

inherited

Return the parent footprint or NULL if PCB_SHAPE does not belong to a footprint.

Returns

the parent footprint or NULL.

Definition at line 123 of file pcb_shape.cpp.

{
 if( !m_parent || m_parent->Type() != PCB_FOOTPRINT_T )
 return nullptr;

 return (FOOTPRINT*) m_parent;
}

References EDA_ITEM::m_parent, PCB_FOOTPRINT_T, and EDA_ITEM::Type().

Referenced by ConvertOutlineToPolygon(), KIGFX::PCB_PAINTER::draw(), PCB_SHAPE::getParentOrientation(), PCB_SHAPE::getParentPosition(), and BRDITEMS_PLOTTER::PlotFootprintGraphicItem().

GetParentGroup()

PCB_GROUP* BOARD_ITEM::GetParentGroup ( ) const

inlineinherited

Definition at line 60 of file board_item.h.

{ return m_group; }

References BOARD_ITEM::m_group.

Referenced by PCB_GROUP::AddItem(), PCB_EDIT_FRAME::ExchangeFootprint(), getTopLevelGroup(), BOARD_ITEM::IsLocked(), memberOf(), PCB_CONTROL::placeBoardItems(), BOARD_COMMIT::Push(), EDIT_TOOL::Remove(), FOOTPRINT::Remove(), BOARD::Remove(), GROUP_TOOL::RemoveFromGroup(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

getParentOrientation()

double PCB_SHAPE::getParentOrientation ( ) const

overrideprotectedvirtualinherited

Implements EDA_SHAPE.

Definition at line 132 of file pcb_shape.cpp.

{
 if( GetParentFootprint() )
 return GetParentFootprint()->GetOrientation();
 else
 return 0.0;
}

References FOOTPRINT::GetOrientation(), and PCB_SHAPE::GetParentFootprint().

getParentPosition()

wxPoint PCB_SHAPE::getParentPosition ( ) const

overrideprotectedvirtualinherited

Implements EDA_SHAPE.

Definition at line 141 of file pcb_shape.cpp.

{
 if( GetParentFootprint() )
 return GetParentFootprint()->GetPosition();
 else
 return wxPoint( 0, 0 );
}

References PCB_SHAPE::GetParentFootprint(), and FOOTPRINT::GetPosition().

GetPointCount()

int EDA_SHAPE::GetPointCount ( ) const

inherited

Returns

the number of corners of the polygonal shape

Definition at line 1197 of file eda_shape.cpp.

{
 // return the number of corners of the polygonal shape
 // this shape is expected to be only one polygon without hole
 if( GetPolyShape().OutlineCount() )
 return GetPolyShape().VertexCount( 0 );

 return 0;
}

References EDA_SHAPE::GetPolyShape(), and SHAPE_POLY_SET::VertexCount().

Referenced by GRAPHICS_CLEANER::isNullShape(), and EE_POINT_EDITOR::updatePoints().

GetPolyShape() [1/2]

SHAPE_POLY_SET& EDA_SHAPE::GetPolyShape ( )

inlineinherited

Definition at line 207 of file eda_shape.h.

{ return m_poly; }

References EDA_SHAPE::m_poly.

Referenced by EE_POINT_EDITOR::addCorner(), PCB_POINT_EDITOR::addCorner(), ConvertOutlineToPolygon(), CONVERT_TOOL::CreateLines(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), KIGFX::SCH_PAINTER::draw(), CADSTAR_SCH_ARCHIVE_LOADER::fixUpLibraryPins(), PCB_PLUGIN::format(), formatPoly(), PCB_SHAPE::GetFocusPosition(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), EDA_SHAPE::GetPointCount(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), ALTIUM_PCB::HelperShapeSetLocalCoord(), EDA_SHAPE::IsPolyShapeValid(), EDIT_POINTS_FACTORY::Make(), EDA_SHAPE::MakeEffectiveShapes(), PCB_POINT_EDITOR::makePoints(), EAGLE_PLUGIN::packagePolygon(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotPcbShape(), EE_POINT_EDITOR::removeCorner(), PCB_POINT_EDITOR::removeCorner(), EE_POINT_EDITOR::removeCornerCondition(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), EDA_SHAPE::ShapeGetMsgPanelInfo(), PCB_POINT_EDITOR::updateItem(), EE_POINT_EDITOR::updateParentItem(), and EE_POINT_EDITOR::updatePoints().

GetPolyShape() [2/2]

const SHAPE_POLY_SET& EDA_SHAPE::GetPolyShape ( ) const

inlineinherited

Definition at line 208 of file eda_shape.h.

{ return m_poly; }

References EDA_SHAPE::m_poly.

GetPosition()

wxPoint PCB_SHAPE::GetPosition ( ) const

inlineoverridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 77 of file pcb_shape.h.

{ return getPosition(); }

References EDA_SHAPE::getPosition().

Referenced by PCB_GRID_HELPER::computeAnchors(), CONVERT_TOOL::makePolysFromCircles(), and ALTIUM_PCB::Parse().

getPosition()

wxPoint EDA_SHAPE::getPosition ( ) const

protectedinherited

Definition at line 95 of file eda_shape.cpp.

{
 if( m_shape == SHAPE_T::ARC )
 return getCenter();
 else if( m_shape == SHAPE_T::POLY )
 return (wxPoint) m_poly.CVertex( 0 );
 else
 return m_start;
}

References ARC, SHAPE_POLY_SET::CVertex(), EDA_SHAPE::getCenter(), EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, and POLY.

Referenced by PCB_SHAPE::GetPosition(), LIB_SHAPE::GetPosition(), and EDA_SHAPE::setPosition().

GetRadius()

int EDA_SHAPE::GetRadius ( ) const

inherited

Definition at line 466 of file eda_shape.cpp.

{
 double radius = 0.0;

 switch( m_shape )
 {
 case SHAPE_T::ARC:
 radius = GetLineLength( m_arcCenter, m_start );
 break;

 case SHAPE_T::CIRCLE:
 radius = GetLineLength( m_start, m_end );
 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 }

 // don't allow degenerate circles/arcs
 return std::max( 1, KiROUND( radius ) );
}

References ARC, CIRCLE, GetLineLength(), KiROUND(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_end, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by BOARD_ADAPTER::addShapeWithClearance(), EDA_SHAPE::calcEdit(), EDA_SHAPE::computeArcBBox(), ConvertOutlineToPolygon(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), formatCircle(), EDA_SHAPE::getBoundingBox(), PCB_SHAPE::GetFocusPosition(), EDA_SHAPE::GetLength(), LIB_SHAPE::GetSelectMenuText(), hash_fp_item(), EDA_SHAPE::hitTest(), idf_export_outline(), GRAPHICS_CLEANER::isNullShape(), EDA_SHAPE::MakeEffectiveShapes(), DSN::SPECCTRA_DB::makeIMAGE(), CONVERT_TOOL::makePolysFromCircles(), ALTIUM_PCB::Parse(), PCB_PARSER::parsePAD(), LIB_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotPcbShape(), LIB_SHAPE::print(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), EDA_SHAPE::scale(), EDA_SHAPE::ShapeGetMsgPanelInfo(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), and EDA_SHAPE::TransformShapeWithClearanceToPolygon().

GetRectCorners()

std::vector< wxPoint > EDA_SHAPE::GetRectCorners ( ) const

inherited

Definition at line 959 of file eda_shape.cpp.

{
 std::vector<wxPoint> pts;
 wxPoint topLeft = GetStart();
 wxPoint botRight = GetEnd();

 // Un-rotate rect topLeft and botRight
 if( KiROUND( getParentOrientation() ) % 900 != 0 )
 {
 topLeft -= getParentPosition();
 RotatePoint( &topLeft, -getParentOrientation() );

 botRight -= getParentPosition();
 RotatePoint( &botRight, -getParentOrientation() );
 }

 // Set up the un-rotated 4 corners
 pts.emplace_back( topLeft );
 pts.emplace_back( botRight.x, topLeft.y );
 pts.emplace_back( botRight );
 pts.emplace_back( topLeft.x, botRight.y );

 // Now re-rotate the 4 corners to get a diamond
 if( KiROUND( getParentOrientation() ) % 900 != 0 )
 {
 for( wxPoint& pt : pts )
 {
 RotatePoint( &pt, getParentOrientation() );
 pt += getParentPosition();
 }
 }

 return pts;
}

References EDA_SHAPE::GetEnd(), EDA_SHAPE::getParentOrientation(), EDA_SHAPE::getParentPosition(), EDA_SHAPE::GetStart(), KiROUND(), and RotatePoint().

Referenced by BOARD_ADAPTER::addShapeWithClearance(), ConvertOutlineToPolygon(), KIGFX::PCB_PAINTER::draw(), EDA_SHAPE::getBoundingBox(), EDA_SHAPE::hitTest(), EDA_SHAPE::MakeEffectiveShapes(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), and EDA_SHAPE::TransformShapeWithClearanceToPolygon().

GetSelectMenuText()

wxString FP_SHAPE::GetSelectMenuText ( EDA_UNITS  aUnits ) const

overridevirtual

Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position.

The default version of this function raises an assertion in the debug mode and returns a string to indicate that it was not overridden to provide the object specific text.

Returns

The menu text string.

Reimplemented from PCB_SHAPE.

Definition at line 125 of file fp_shape.cpp.

{
 return wxString::Format( _( "%s on %s" ),
 ShowShape(),
 GetLayerName() );
}

References _, Format(), BOARD_ITEM::GetLayerName(), and EDA_SHAPE::ShowShape().

GetShape()

SHAPE_T EDA_SHAPE::GetShape ( ) const

inlineinherited

Definition at line 92 of file eda_shape.h.

{ return m_shape; }

References EDA_SHAPE::m_shape.

Referenced by PCB_POINT_EDITOR::addCorner(), EE_POINT_EDITOR::addCornerCondition(), LIB_SHAPE::AddPoint(), BOARD_ADAPTER::addShapeWithClearance(), GRAPHICS_CLEANER::areEquivalent(), EDA_SHAPE::beginEdit(), EDA_SHAPE::calcEdit(), PCB_POINT_EDITOR::canAddCorner(), GRAPHICS_CLEANER::cleanupSegments(), PCB_GRID_HELPER::computeAnchors(), EDA_SHAPE::continueEdit(), ConvertOutlineToPolygon(), CONVERT_TOOL::CreateLines(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), EDA_SHAPE::endEdit(), PAD_TOOL::explodePad(), CADSTAR_SCH_ARCHIVE_LOADER::fixUpLibraryPins(), Flip(), FootprintWriteShape(), PCB_PLUGIN::format(), FOOTPRINT::GetCoverageArea(), LIB_SHAPE::GetMenuImage(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), LIB_SHAPE::GetSelectMenuText(), EE_SELECTION_TOOL::GuessSelectionCandidates(), hash_fp_item(), idf_export_outline(), GRAPHICS_CLEANER::isNullShape(), EE_POINT_EDITOR::Main(), EDIT_POINTS_FACTORY::Make(), DSN::SPECCTRA_DB::makeIMAGE(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromCircles(), CONVERT_TOOL::makePolysFromRects(), GRAPHICS_CLEANER::mergeRects(), Mirror(), Move(), PCB_SHAPE::cmp_drawings::operator()(), FOOTPRINT::cmp_drawings::operator()(), ALTIUM_PCB::Parse(), LIB_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), LIB_SHAPE::print(), PAD_TOOL::recombinePad(), PCB_POINT_EDITOR::removeCorner(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), PNS_KICAD_IFACE_BASE::syncGraphicalItem(), AR_MATRIX::TraceSegmentPcb(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), PCB_POINT_EDITOR::updateItem(), EE_POINT_EDITOR::updateParentItem(), EE_POINT_EDITOR::updatePoints(), PCB_POINT_EDITOR::updatePoints(), and DIALOG_GRAPHIC_ITEM_PROPERTIES::Validate().

GetStart()

const wxPoint& EDA_SHAPE::GetStart ( ) const

inlineinherited

Return the starting point of the graphic.

Definition at line 97 of file eda_shape.h.

{ return m_start; }

References EDA_SHAPE::m_start.

Referenced by PCB_POINT_EDITOR::addCorner(), BOARD_ADAPTER::addShapeWithClearance(), GRAPHICS_CLEANER::areEquivalent(), LIB_SHAPE::CalcArcAngles(), EDA_SHAPE::CalcArcAngles(), EDA_SHAPE::calcEdit(), PCB_GRID_HELPER::computeAnchors(), ConvertOutlineToPolygon(), CreateBoardSection(), CONVERT_TOOL::CreateLines(), MICROWAVE_TOOL::createMicrowaveInductor(), KIGFX::PCB_PAINTER::draw(), PCB_POINT_EDITOR::editArcEndpointKeepCenter(), PCB_POINT_EDITOR::editArcEndpointKeepTangent(), PCB_PLUGIN::format(), formatArc(), formatBezier(), formatCircle(), formatRect(), EDA_SHAPE::getBoundingBox(), PCB_SHAPE::GetFocusPosition(), EDA_SHAPE::GetLength(), EDA_SHAPE::GetRectCorners(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), CONVERT_TOOL::getStartEndPoints(), hash_fp_item(), EDA_SHAPE::hitTest(), idf_export_outline(), GRAPHICS_CLEANER::isNullShape(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), EDIT_POINTS_FACTORY::Make(), DSN::SPECCTRA_DB::makeIMAGE(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromRects(), CONVERT_TOOL::makePolysFromSegs(), GRAPHICS_CLEANER::mergeRects(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), BRDITEMS_PLOTTER::PlotPcbTarget(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), EDA_SHAPE::ShapeGetMsgPanelInfo(), AR_MATRIX::TraceSegmentPcb(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), EDA_SHAPE::TransformShapeWithClearanceToPolygon(), EE_POINT_EDITOR::updatePoints(), and PCB_POINT_EDITOR::updatePoints().

GetStart0()

const wxPoint& FP_SHAPE::GetStart0 ( ) const

inline

Definition at line 112 of file fp_shape.h.

{ return m_start0; }

References m_start0.

Referenced by FootprintWriteShape(), PCB_PLUGIN::format(), CADSTAR_PCB_ARCHIVE_LOADER::getLineChainFromShapes(), hash_fp_item(), DSN::SPECCTRA_DB::makeIMAGE(), and CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes().

GetStartX()

int EDA_SHAPE::GetStartX ( )

inlineinherited

Definition at line 99 of file eda_shape.h.

{ return m_start.x; }

References EDA_SHAPE::m_start.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC(), and DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run().

GetStartY()

int EDA_SHAPE::GetStartY ( )

inlineinherited

Definition at line 98 of file eda_shape.h.

{ return m_start.y; }

References EDA_SHAPE::m_start.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC(), and DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run().

GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS  type ) const

inlineinherited

Definition at line 136 of file eda_item.h.

 {
 return m_status & type;
 }

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 149 of file eda_item.h.

{ return m_status; }

References EDA_ITEM::m_status.

GetWidth()

int EDA_SHAPE::GetWidth ( ) const

inlineinherited

Definition at line 89 of file eda_shape.h.

{ return m_width; }

References EDA_SHAPE::m_width.

Referenced by BOARD_ADAPTER::addShapeWithClearance(), GRAPHICS_CLEANER::areEquivalent(), ConvertOutlineToPolygon(), KIGFX::PCB_PAINTER::draw(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), PCB_PLUGIN::format(), FOOTPRINT::GetCoverageArea(), LIB_SHAPE::GetPenWidth(), CONVERT_TOOL::getStartEndPoints(), hash_fp_item(), EDA_SHAPE::hitTest(), GRAPHICS_CLEANER::isNullShape(), SCH_LEGACY_PLUGIN_CACHE::loadBezier(), FABMASTER::loadPolygon(), EDA_SHAPE::MakeEffectiveShapes(), DSN::SPECCTRA_DB::makeIMAGE(), CONVERT_TOOL::makePolysFromRects(), CONVERT_TOOL::makePolysFromSegs(), PCB_PARSER::parsePAD(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), CONVERT_TOOL::SegmentToArc(), AR_MATRIX::TraceSegmentPcb(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::TransferDataToWindow(), PCB_POINT_EDITOR::updateItem(), and PCB_SHAPE::ViewBBox().

GetX()

int BOARD_ITEM::GetX ( ) const

inlineinherited

Definition at line 64 of file board_item.h.

 {
 wxPoint p = GetPosition();
 return p.x;
 }

References EDA_ITEM::GetPosition().

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), BOARD_ITEM::SetY(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

GetY()

int BOARD_ITEM::GetY ( ) const

inlineinherited

Definition at line 70 of file board_item.h.

 {
 wxPoint p = GetPosition();
 return p.y;
 }

References EDA_ITEM::GetPosition().

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), BOARD_ITEM::SetX(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS  aFlag ) const

inlineinherited

Definition at line 155 of file eda_item.h.

{ return ( m_flags & aFlag ) == aFlag; }

References EDA_ITEM::m_flags.

Referenced by TRACKS_CLEANER::cleanup(), GRAPHICS_CLEANER::cleanupSegments(), SCH_EDIT_TOOL::DoDelete(), KIGFX::SCH_PAINTER::draw(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::moveItem(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_TOOL::Rotate(), and EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList().

HitTest() [1/2]

bool PCB_SHAPE::HitTest ( const wxPoint &  aPosition, int  aAccuracy = 0  ) const

inlineoverridevirtualinherited

Test if aPosition is inside or on the boundary of this item.

Parameters

aPosition	A reference to a wxPoint object containing the coordinates to test.
aAccuracy	Increase the item bounding box by this amount.

Returns

True if aPosition is within the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 103 of file pcb_shape.h.

 {
 return hitTest( aPosition, aAccuracy );
 }

References EDA_SHAPE::hitTest().

Referenced by GENERAL_COLLECTOR::Inspect().

HitTest() [2/2]

bool PCB_SHAPE::HitTest ( const EDA_RECT &  aRect, bool  aContained, int  aAccuracy = 0  ) const

inlineoverridevirtualinherited

Test if aRect intersects this item.

Parameters

aRect	A reference to a EDA_RECT object containing the rectangle to test.
aContained	Set to true to test for containment instead of an intersection.
aAccuracy	Increase aRect by this amount.

Returns

True if aRect contains or intersects the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 108 of file pcb_shape.h.

 {
  return hitTest( aRect, aContained, aAccuracy );
 }

References EDA_SHAPE::hitTest().

hitTest() [1/2]

bool EDA_SHAPE::hitTest ( const wxPoint &  aPosition, int  aAccuracy = 0  ) const

protectedinherited

Definition at line 673 of file eda_shape.cpp.

{
 int maxdist = aAccuracy;

 if( m_width > 0 )
 maxdist += m_width / 2;

 switch( m_shape )
 {
 case SHAPE_T::CIRCLE:
 {
 int radius = GetRadius();
 int dist = KiROUND( EuclideanNorm( aPosition - getCenter() ) );

 if( IsFilled() )
 return dist <= radius + maxdist; // Filled circle hit-test
 else
 return abs( radius - dist ) <= maxdist; // Ring hit-test
 }

 case SHAPE_T::ARC:
 {
 if( EuclideanNorm( aPosition - m_start ) <= maxdist )
 return true;

 if( EuclideanNorm( aPosition - m_end ) <= maxdist )
 return true;

 wxPoint relPos = aPosition - getCenter();
 int radius = GetRadius();
 int dist = KiROUND( EuclideanNorm( relPos ) );

 if( abs( radius - dist ) <= maxdist )
 {
 double startAngle;
 double endAngle;
 CalcArcAngles( startAngle, endAngle );

 if( m_eeWinding && NormalizeAngleDegrees( startAngle - endAngle, -180.0, 180.0 ) > 0 )
 std::swap( startAngle, endAngle );

 double relPosAngle = 180.0 / M_PI * atan2( relPos.y, relPos.x );

 startAngle = NormalizeAngleDegrees( startAngle, 0.0, 360.0 );
 endAngle = NormalizeAngleDegrees( endAngle, 0.0, 360.0 );
 relPosAngle = NormalizeAngleDegrees( relPosAngle, 0.0, 360.0 );

 if( endAngle > startAngle )
 return relPosAngle >= startAngle && relPosAngle <= endAngle;
 else
 return relPosAngle >= startAngle || relPosAngle <= endAngle;
 }

 return false;
 }

 case SHAPE_T::BEZIER:
 const_cast<EDA_SHAPE*>( this )->RebuildBezierToSegmentsPointsList( m_width );

 for( unsigned int i= 1; i < m_bezierPoints.size(); i++)
 {
 if( TestSegmentHit( aPosition, m_bezierPoints[ i - 1], m_bezierPoints[i], maxdist ) )
 return true;
 }

 return false;

 case SHAPE_T::SEGMENT:
 return TestSegmentHit( aPosition, GetStart(), GetEnd(), maxdist );

 case SHAPE_T::RECT:
 if( IsFilled() ) // Filled rect hit-test
 {
 SHAPE_POLY_SET poly;
 poly.NewOutline();

 for( const wxPoint& pt : GetRectCorners() )
 poly.Append( pt );

 return poly.Collide( VECTOR2I( aPosition ), maxdist );
 }
 else // Open rect hit-test
 {
 std::vector<wxPoint> pts = GetRectCorners();

 return TestSegmentHit( aPosition, pts[0], pts[1], maxdist )
 || TestSegmentHit( aPosition, pts[1], pts[2], maxdist )
 || TestSegmentHit( aPosition, pts[2], pts[3], maxdist )
 || TestSegmentHit( aPosition, pts[3], pts[0], maxdist );
 }

 case SHAPE_T::POLY:
 if( IsFilled() )
 {
 return m_poly.Collide( VECTOR2I( aPosition ), maxdist );
 }
 else
 {
 SHAPE_POLY_SET::VERTEX_INDEX dummy;
 return m_poly.CollideEdge( VECTOR2I( aPosition ), dummy, maxdist );
 }

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 return false;
 }
}

References SHAPE_POLY_SET::Append(), ARC, BEZIER, EDA_SHAPE::CalcArcAngles(), CIRCLE, SHAPE_POLY_SET::Collide(), SHAPE_POLY_SET::CollideEdge(), dummy(), EuclideanNorm(), EDA_SHAPE::getCenter(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetRectCorners(), EDA_SHAPE::GetStart(), EDA_SHAPE::IsFilled(), KiROUND(), EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_eeWinding, EDA_SHAPE::m_end, EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, EDA_SHAPE::m_width, SHAPE_POLY_SET::NewOutline(), NormalizeAngleDegrees(), POLY, RECT, SEGMENT, EDA_SHAPE::SHAPE_T_asString(), TestSegmentHit(), and UNIMPLEMENTED_FOR.

Referenced by LIB_SHAPE::HitTest(), and PCB_SHAPE::HitTest().

hitTest() [2/2]

bool EDA_SHAPE::hitTest ( const EDA_RECT &  aRect, bool  aContained, int  aAccuracy = 0  ) const

protectedinherited

Definition at line 782 of file eda_shape.cpp.

{
 EDA_RECT arect = aRect;
 arect.Normalize();
 arect.Inflate( aAccuracy );

 EDA_RECT arcRect;
 EDA_RECT bb = getBoundingBox();

 switch( m_shape )
 {
 case SHAPE_T::CIRCLE:
 // Test if area intersects or contains the circle:
 if( aContained )
 {
 return arect.Contains( bb );
 }
 else
 {
 // If the rectangle does not intersect the bounding box, this is a much quicker test
 if( !aRect.Intersects( bb ) )
 {
 return false;
 }
 else
 {
 return arect.IntersectsCircleEdge( getCenter(), GetRadius(), GetWidth() );
 }
 }

 case SHAPE_T::ARC:
 // Test for full containment of this arc in the rect
 if( aContained )
 {
 return arect.Contains( bb );
 }
 // Test if the rect crosses the arc
 else
 {
 arcRect = bb.Common( arect );

 /* All following tests must pass:
 * 1. Rectangle must intersect arc BoundingBox
 * 2. Rectangle must cross the outside of the arc
 */
 return arcRect.Intersects( arect ) &&
 arcRect.IntersectsCircleEdge( getCenter(), GetRadius(), GetWidth() );
 }

 case SHAPE_T::RECT:
 if( aContained )
 {
 return arect.Contains( bb );
 }
 else
 {
 std::vector<wxPoint> pts = GetRectCorners();

 // Account for the width of the lines
 arect.Inflate( GetWidth() / 2 );
 return ( arect.Intersects( pts[0], pts[1] )
 || arect.Intersects( pts[1], pts[2] )
 || arect.Intersects( pts[2], pts[3] )
 || arect.Intersects( pts[3], pts[0] ) );
 }

 case SHAPE_T::SEGMENT:
 if( aContained )
 {
 return arect.Contains( GetStart() ) && aRect.Contains( GetEnd() );
 }
 else
 {
 // Account for the width of the line
 arect.Inflate( GetWidth() / 2 );
 return arect.Intersects( GetStart(), GetEnd() );
 }

 case SHAPE_T::POLY:
 if( aContained )
 {
 return arect.Contains( bb );
 }
 else
 {
 // Fast test: if aRect is outside the polygon bounding box,
 // rectangles cannot intersect
 if( !arect.Intersects( bb ) )
 return false;

 // Account for the width of the line
 arect.Inflate( GetWidth() / 2 );

 // Polygons in footprints use coordinates relative to the footprint.
 // Therefore, instead of using m_poly, we make a copy which is translated
 // to the actual location in the board.
 double orientation = 0.0;
 wxPoint offset = getParentPosition();

 if( getParentOrientation() )
 orientation = -DECIDEG2RAD( getParentOrientation() );

 SHAPE_LINE_CHAIN poly = m_poly.Outline( 0 );
 poly.Rotate( orientation );
 poly.Move( offset );

 int count = poly.GetPointCount();

 for( int ii = 0; ii < count; ii++ )
 {
 VECTOR2I vertex = poly.GetPoint( ii );

 // Test if the point is within aRect
 if( arect.Contains( ( wxPoint ) vertex ) )
 return true;

 if( ii + 1 < count )
 {
 VECTOR2I vertexNext = poly.GetPoint( ii + 1 );

 // Test if this edge intersects aRect
 if( arect.Intersects( ( wxPoint ) vertex, ( wxPoint ) vertexNext ) )
 return true;
 }
 else if( poly.IsClosed() )
 {
 VECTOR2I vertexNext = poly.GetPoint( 0 );

 // Test if this edge intersects aRect
 if( arect.Intersects( ( wxPoint ) vertex, ( wxPoint ) vertexNext ) )
 return true;
 }
 }

 return false;
 }

 case SHAPE_T::BEZIER:
 if( aContained )
 {
 return arect.Contains( bb );
 }
 else
 {
 // Fast test: if aRect is outside the polygon bounding box,
 // rectangles cannot intersect
 if( !arect.Intersects( bb ) )
 return false;

 // Account for the width of the line
 arect.Inflate( GetWidth() / 2 );
 unsigned count = m_bezierPoints.size();

 for( unsigned ii = 1; ii < count; ii++ )
 {
 wxPoint vertex = m_bezierPoints[ ii - 1];
 wxPoint vertexNext = m_bezierPoints[ii];

 // Test if the point is within aRect
 if( arect.Contains( ( wxPoint ) vertex ) )
 return true;

 // Test if this edge intersects aRect
 if( arect.Intersects( vertex, vertexNext ) )
 return true;
 }

 return false;
 }

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 return false;
 }
}

References ARC, BEZIER, CIRCLE, EDA_RECT::Common(), EDA_RECT::Contains(), DECIDEG2RAD(), EDA_SHAPE::getBoundingBox(), EDA_SHAPE::getCenter(), EDA_SHAPE::GetEnd(), EDA_SHAPE::getParentOrientation(), EDA_SHAPE::getParentPosition(), SHAPE_LINE_CHAIN::GetPoint(), SHAPE_LINE_CHAIN::GetPointCount(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetRectCorners(), EDA_SHAPE::GetStart(), EDA_SHAPE::GetWidth(), EDA_RECT::Inflate(), EDA_RECT::Intersects(), EDA_RECT::IntersectsCircleEdge(), SHAPE_LINE_CHAIN::IsClosed(), EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, SHAPE_LINE_CHAIN::Move(), EDA_RECT::Normalize(), SHAPE_POLY_SET::Outline(), POLY, RECT, SHAPE_LINE_CHAIN::Rotate(), SEGMENT, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 125 of file eda_item.h.

{ return m_flags & BRIGHTENED; }

References BRIGHTENED, and EDA_ITEM::m_flags.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_EDITOR_CONTROL::UpdateFind(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

IsConnected()

virtual bool BOARD_ITEM::IsConnected ( ) const

inlinevirtualinherited

Returns information if the object is derived from BOARD_CONNECTED_ITEM.

Returns

True if the object is of BOARD_CONNECTED_ITEM type, false otherwise.

Reimplemented in ZONE, and BOARD_CONNECTED_ITEM.

Definition at line 103 of file board_item.h.

 {
 return false;
 }

Referenced by PNS_PCBNEW_RULE_RESOLVER::DpNetPair(), DRC_ENGINE::EvalRules(), PNS::NODE::FindItemByParent(), BOARD_INSPECTION_TOOL::getItemDescription(), PCB_EXPR_NETCLASS_REF::GetValue(), PCB_EXPR_NETNAME_REF::GetValue(), inDiffPair(), BOARD_INSPECTION_TOOL::InspectClearance(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones().

IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 120 of file eda_item.h.

{ return m_flags & IS_DRAGGING; }

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 123 of file eda_item.h.

{ return m_flags & ENTERED; }

References ENTERED, and EDA_ITEM::m_flags.

Referenced by KIGFX::PCB_PAINTER::draw().

IsFilled()

bool EDA_SHAPE::IsFilled ( ) const

inlineinherited

Definition at line 81 of file eda_shape.h.

{ return GetFillType() != FILL_T::NO_FILL; }

References EDA_SHAPE::GetFillType(), and NO_FILL.

Referenced by BOARD_ADAPTER::addShapeWithClearance(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), PCB_PLUGIN::format(), FOOTPRINT::GetCoverageArea(), PCB_SHAPE::GetFocusPosition(), hash_fp_item(), EDA_SHAPE::hitTest(), EDA_SHAPE::MakeEffectiveShapes(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), LIB_SHAPE::print(), KIGFX::SCH_PAINTER::setDeviceColors(), PNS_KICAD_IFACE_BASE::syncGraphicalItem(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::TransferDataToWindow(), and EDA_SHAPE::TransformShapeWithClearanceToPolygon().

IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 205 of file eda_item.h.

{ return m_forceVisible; }

References EDA_ITEM::m_forceVisible.

Referenced by KIGFX::SCH_PAINTER::draw(), and SCH_FIELD::Print().

IsLocked()

bool BOARD_ITEM::IsLocked ( ) const

virtualinherited

Returns

true if the object is locked, else false.

Reimplemented in FOOTPRINT, and PAD.

Definition at line 64 of file board_item.cpp.

{
 if( GetParentGroup() )
 return GetParentGroup()->IsLocked();

 const BOARD* board = GetBoard();

 return board && board->GetBoardUse() != BOARD_USE::FPHOLDER && GetState( LOCKED );
}

References FPHOLDER, BOARD_ITEM::GetBoard(), BOARD::GetBoardUse(), BOARD_ITEM::GetParentGroup(), EDA_ITEM::GetState(), BOARD_ITEM::IsLocked(), and LOCKED.

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), PCB_CONTROL::DeleteItemCursor(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDIT_TOOL::DragArcTrack(), EDIT_TOOL::FilletTracks(), PCB_PLUGIN::format(), PCB_TEXT::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), PCB_GROUP::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), GROUP_TOOL::Group(), ROUTER_TOOL::InlineDrag(), GENERAL_COLLECTOR::Inspect(), PAD::IsLocked(), BOARD_ITEM::IsLocked(), PCB_SELECTION_TOOL::itemPassesFilter(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), TRACKS_CLEANER::mergeCollinearSegments(), BOARD_EDITOR_CONTROL::modifyLockSelected(), PCB_POINT_EDITOR::OnSelectionChange(), ZONE_SETTINGS::operator<<(), POSITION_RELATIVE_TOOL::PositionRelative(), processTextItem(), PCB_SELECTION_TOOL::RequestSelection(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::syncVia(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), and DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow().

IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 117 of file eda_item.h.

{ return m_flags & IS_CHANGED; }

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 119 of file eda_item.h.

{ return m_flags & IS_MOVING; }

References IS_MOVING, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), LIB_SHAPE::CalcArcAngles(), LIB_PIN::CalcEdit(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), and SCH_EDIT_TOOL::Rotate().

IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 118 of file eda_item.h.

{ return m_flags & IS_NEW; }

References IS_NEW, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), SCH_EDIT_TOOL::ConvertDeMorgan(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), EDIT_TOOL::DragArcTrack(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EDIT_TOOL::MoveExact(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), and DIALOG_SHEET_PROPERTIES::TransferDataFromWindow().

IsOnCopperLayer()

virtual bool BOARD_ITEM::IsOnCopperLayer ( ) const

inlinevirtualinherited

Returns

true if the object is on any copper layer, false otherwise.

Reimplemented in PAD, PCB_TRACK, and ZONE.

Definition at line 111 of file board_item.h.

 {
 return IsCopperLayer( GetLayer() );
 }

References BOARD_ITEM::GetLayer(), and IsCopperLayer().

Referenced by CN_CONNECTIVITY_ALGO::Add(), DRC_ENGINE::EvalRules(), and BOARD_CONNECTED_ITEM::SetNetCode().

IsOnLayer()

virtual bool BOARD_ITEM::IsOnLayer ( PCB_LAYER_ID  aLayer ) const

inlinevirtualinherited

Test to see if this object is on the given layer.

Virtual so objects like PAD, which reside on multiple layers can do their own form of testing.

Parameters

aLayer

The layer to test for.

Returns

true if on given layer, else false.

Reimplemented in PAD, PCB_VIA, FOOTPRINT, ZONE, and PCB_GROUP.

Definition at line 200 of file board_item.h.

 {
 return m_layer == aLayer;
 }

References BOARD_ITEM::m_layer.

Referenced by BOARD_ADAPTER::createLayers(), existsOnLayer(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), and PNS_KICAD_IFACE::IsItemVisible().

IsParentFlipped()

bool FP_SHAPE::IsParentFlipped

(

)

const

Definition at line 272 of file fp_shape.cpp.

{
 if( GetParent() && GetParent()->GetLayer() == B_Cu )
 return true;
 return false;
}

References B_Cu, BOARD_ITEM::GetLayer(), and BOARD_ITEM::GetParent().

Referenced by ViewGetLOD().

IsPolyShapeValid()

bool EDA_SHAPE::IsPolyShapeValid ( ) const

inherited

Returns

true if the polygonal shape is valid (has more than 2 points)

Definition at line 1185 of file eda_shape.cpp.

{
 // return true if the polygonal shape is valid (has more than 2 points)
 if( GetPolyShape().OutlineCount() == 0 )
 return false;

 const SHAPE_LINE_CHAIN& outline = ( (SHAPE_POLY_SET&)GetPolyShape() ).Outline( 0 );

 return outline.PointCount() > 2;
}

References EDA_SHAPE::GetPolyShape(), and SHAPE_LINE_CHAIN::PointCount().

Referenced by PCB_PLUGIN::format(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), and EDA_SHAPE::TransformShapeWithClearanceToPolygon().

IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

Override this method in any derived object that supports test find and replace.

Returns

True if the item has replaceable text that can be modified using the find and replace dialog.

Reimplemented in SCH_SYMBOL, SCH_SHEET, SCH_LABEL, SCH_TEXT, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 402 of file eda_item.h.

{ return false; }

Referenced by EDA_ITEM::Matches().

IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 124 of file eda_item.h.

{ return m_flags & IS_RESIZING; }

References IS_RESIZING, and EDA_ITEM::m_flags.

IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 122 of file eda_item.h.

{ return m_flags & SELECTED; }

References EDA_ITEM::m_flags, and SELECTED.

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), DS_PROXY_UNDO_ITEM::DS_PROXY_UNDO_ITEM(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::getRenderColor(), KIGFX::SCH_PAINTER::getTextThickness(), DIALOG_EXCHANGE_FOOTPRINTS::isMatch(), DIALOG_CHANGE_SYMBOLS::isMatch(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), EE_SELECTION_TOOL::RebuildSelection(), RENDER_3D_OPENGL::renderFootprint(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::selectionContains(), PCB_SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), KIGFX::SCH_PAINTER::setDeviceColors(), GERBVIEW_SELECTION_TOOL::unselect(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

IsTrack()

bool BOARD_ITEM::IsTrack ( ) const

inlineinherited

Test to see if this object is a track or via (or microvia).

Returns

true if a track or via, else false.

Definition at line 210 of file board_item.h.

 {
 return ( Type() == PCB_TRACE_T ) || ( Type() == PCB_VIA_T );
 }

References PCB_TRACE_T, PCB_VIA_T, and EDA_ITEM::Type().

IsType()

bool FP_SHAPE::IsType ( const KICAD_T  aScanTypes[] ) const

inlineoverridevirtual

Check whether the item is one of the listed types.

Parameters

aScanTypes

List of item types

Returns

true if the item type is contained in the list aScanTypes

Reimplemented from EDA_ITEM.

Definition at line 54 of file fp_shape.h.

 {
 if( BOARD_ITEM::IsType( aScanTypes ) )
 return true;

 for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
 {
 if( *p == PCB_LOCATE_GRAPHIC_T )
 return true;
 else if( *p == PCB_LOCATE_BOARD_EDGE_T )
 return m_layer == Edge_Cuts;
 }

 return false;
 }

References Edge_Cuts, EOT, EDA_ITEM::IsType(), BOARD_ITEM::m_layer, PCB_LOCATE_BOARD_EDGE_T, and PCB_LOCATE_GRAPHIC_T.

IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 121 of file eda_item.h.

{ return m_flags & IS_WIRE_IMAGE; }

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

IterateForward() [1/2]

template<class T >

static SEARCH_RESULT EDA_ITEM::IterateForward ( std::deque< T > &  aList, INSPECTOR  inspector, void *  testData, const KICAD_T  scanTypes[]  )

inlinestaticinherited

This changes first parameter to avoid the DList and use the main queue instead.

Definition at line 294 of file eda_item.h.

 {
 for( auto it : aList )
 {
 if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
 == SEARCH_RESULT::QUIT )
 return SEARCH_RESULT::QUIT;
 }

 return SEARCH_RESULT::CONTINUE;
 }

References CONTINUE, QUIT, and EDA_ITEM::Visit().

Referenced by GERBER_FILE_IMAGE::Visit().

IterateForward() [2/2]

template<class T >

static SEARCH_RESULT EDA_ITEM::IterateForward ( std::vector< T > &  aList, INSPECTOR  inspector, void *  testData, const KICAD_T  scanTypes[]  )

inlinestaticinherited

Change first parameter to avoid the DList and use std::vector instead.

Definition at line 313 of file eda_item.h.

 {
 for( auto it : aList )
 {
 if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
 == SEARCH_RESULT::QUIT )
 return SEARCH_RESULT::QUIT;
 }

 return SEARCH_RESULT::CONTINUE;
 }

References CONTINUE, QUIT, and EDA_ITEM::Visit().

layerMaskDescribe()

wxString BOARD_ITEM::layerMaskDescribe ( ) const

protectedvirtualinherited

Return a string (to be shown to the user) describing a layer mask.

The BOARD is needed because layer names are customizable.

Reimplemented in PCB_VIA.

Definition at line 87 of file board_item.cpp.

{
 const BOARD* board = GetBoard();
 LSET layers = GetLayerSet();

 // Try to be smart and useful. Check all copper first.
 if( layers[F_Cu] && layers[B_Cu] )
 return _( "all copper layers" );

 LSET copperLayers = layers & board->GetEnabledLayers().AllCuMask();
 LSET techLayers = layers & board->GetEnabledLayers().AllTechMask();

 for( LSET testLayers : { copperLayers, techLayers, layers } )
 {
 for( int bit = PCBNEW_LAYER_ID_START; bit < PCB_LAYER_ID_COUNT; ++bit )
 {
 if( testLayers[ bit ] )
 {
 wxString layerInfo = board->GetLayerName( static_cast<PCB_LAYER_ID>( bit ) );

 if( testLayers.count() > 1 )
 layerInfo << wxS( " " ) + _( "and others" );

 return layerInfo;
 }
 }
 }

 // No copper, no technicals: no layer
 return _( "no layers" );
}

References _, LSET::AllCuMask(), LSET::AllTechMask(), B_Cu, F_Cu, BOARD_ITEM::GetBoard(), BOARD::GetEnabledLayers(), BOARD::GetLayerName(), BOARD_ITEM::GetLayerSet(), PCB_LAYER_ID_COUNT, and PCBNEW_LAYER_ID_START.

Referenced by PCB_TRACK::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), and PAD::GetSelectMenuText().

MakeEffectiveShapes()

std::vector< SHAPE * > EDA_SHAPE::MakeEffectiveShapes ( ) const

inherited

Make a set of SHAPE objects representing the EDA_SHAPE.

Caller owns the objects.

Definition at line 1073 of file eda_shape.cpp.

{
 std::vector<SHAPE*> effectiveShapes;

 switch( m_shape )
 {
 case SHAPE_T::ARC:
 effectiveShapes.emplace_back( new SHAPE_ARC( m_arcCenter, m_start, GetArcAngle() / 10.0,
 m_width ) );
 break;

 case SHAPE_T::SEGMENT:
 effectiveShapes.emplace_back( new SHAPE_SEGMENT( m_start, m_end, m_width ) );
 break;

 case SHAPE_T::RECT:
 {
 std::vector<wxPoint> pts = GetRectCorners();

 if( IsFilled() )
 effectiveShapes.emplace_back( new SHAPE_SIMPLE( pts ) );

 if( m_width > 0 || !IsFilled() )
 {
 effectiveShapes.emplace_back( new SHAPE_SEGMENT( pts[0], pts[1], m_width ) );
 effectiveShapes.emplace_back( new SHAPE_SEGMENT( pts[1], pts[2], m_width ) );
 effectiveShapes.emplace_back( new SHAPE_SEGMENT( pts[2], pts[3], m_width ) );
 effectiveShapes.emplace_back( new SHAPE_SEGMENT( pts[3], pts[0], m_width ) );
 }
 }
 break;

 case SHAPE_T::CIRCLE:
 {
 if( IsFilled() )
 effectiveShapes.emplace_back( new SHAPE_CIRCLE( getCenter(), GetRadius() ) );

 if( m_width > 0 || !IsFilled() )
 {
 // SHAPE_CIRCLE has no ConvertToPolyline() method, so use a 360.0 SHAPE_ARC
 SHAPE_ARC circle( getCenter(), GetEnd(), 360.0 );
 SHAPE_LINE_CHAIN l = circle.ConvertToPolyline();

 for( int i = 0; i < l.SegmentCount(); i++ )
 {
 effectiveShapes.emplace_back( new SHAPE_SEGMENT( l.Segment( i ).A, l.Segment( i ).B,
 m_width ) );
 }
 }

 break;
 }

 case SHAPE_T::BEZIER:
 {
 auto bezierPoints = buildBezierToSegmentsPointsList( GetWidth() );
 wxPoint start_pt = bezierPoints[0];

 for( unsigned int jj = 1; jj < bezierPoints.size(); jj++ )
 {
 wxPoint end_pt = bezierPoints[jj];
 effectiveShapes.emplace_back( new SHAPE_SEGMENT( start_pt, end_pt, m_width ) );
 start_pt = end_pt;
 }

 break;
 }

 case SHAPE_T::POLY:
 {
 SHAPE_LINE_CHAIN l = GetPolyShape().COutline( 0 );

 l.Rotate( -DECIDEG2RAD( getParentOrientation() ) );
 l.Move( getParentPosition() );

 if( IsFilled() )
 effectiveShapes.emplace_back( new SHAPE_SIMPLE( l ) );

 if( m_width > 0 || !IsFilled() )
 {
 for( int i = 0; i < l.SegmentCount(); i++ )
 effectiveShapes.emplace_back( new SHAPE_SEGMENT( l.Segment( i ), m_width ) );
 }
 }
 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 break;
 }

 return effectiveShapes;
}

References SEG::A, ARC, SEG::B, BEZIER, EDA_SHAPE::buildBezierToSegmentsPointsList(), CIRCLE, SHAPE_ARC::ConvertToPolyline(), SHAPE_POLY_SET::COutline(), DECIDEG2RAD(), EDA_SHAPE::GetArcAngle(), EDA_SHAPE::getCenter(), EDA_SHAPE::GetEnd(), EDA_SHAPE::getParentOrientation(), EDA_SHAPE::getParentPosition(), EDA_SHAPE::GetPolyShape(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetRectCorners(), EDA_SHAPE::GetWidth(), EDA_SHAPE::IsFilled(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_end, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, EDA_SHAPE::m_width, SHAPE_LINE_CHAIN::Move(), POLY, RECT, SHAPE_LINE_CHAIN::Rotate(), SEGMENT, SHAPE_LINE_CHAIN::Segment(), SHAPE_LINE_CHAIN::SegmentCount(), EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by PCB_SHAPE::GetEffectiveShape(), and PNS_KICAD_IFACE_BASE::syncGraphicalItem().

Matches() [1/2]

virtual bool EDA_ITEM::Matches ( const wxFindReplaceData &  aSearchData, void *  aAuxData  ) const

inlinevirtualinherited

Compare the item against the search criteria in aSearchData.

The base class returns false since many of the objects derived from EDA_ITEM do not have any text to search.

Parameters

aSearchData	A reference to a wxFindReplaceData object containing the search criteria.
aAuxData	A pointer to optional data required for the search or NULL if not used.

Returns

True if the item's text matches the search criteria in aSearchData.

Reimplemented in SCH_SYMBOL, SCH_SHEET, SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, ZONE, SCH_PIN, PCB_MARKER, SCH_MARKER, FP_TEXT, and PCB_TEXT.

Definition at line 364 of file eda_item.h.

 {
 return false;
 }

Referenced by SCH_EDITOR_CONTROL::HasMatch(), inDiffPair(), PCB_TEXT::Matches(), FP_TEXT::Matches(), SCH_MARKER::Matches(), PCB_MARKER::Matches(), SCH_PIN::Matches(), ZONE::Matches(), SCH_SHEET_PIN::Matches(), SCH_FIELD::Matches(), SCH_TEXT::Matches(), SCH_EDITOR_CONTROL::ReplaceAndFindNext(), and SCH_EDITOR_CONTROL::UpdateFind().

Matches() [2/2]

bool EDA_ITEM::Matches ( const wxString &  aText, const wxFindReplaceData &  aSearchData  ) const

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

aText	A reference to a wxString object containing the string to test.
aSearchData	The criteria to search against.

Returns

True if aText matches the search criteria in aSearchData.

Definition at line 118 of file eda_item.cpp.

{
 wxString text = aText;
 int flags = aSearchData.GetFlags();
 wxString searchText = aSearchData.GetFindString();

 // Don't match if searching for replaceable item and the item doesn't support text replace.
 if( ( flags & FR_SEARCH_REPLACE ) && !IsReplaceable() )
 return false;

 if( !( flags & wxFR_MATCHCASE ) )
 {
 text.MakeUpper();
 searchText.MakeUpper();
 }

 if( flags & wxFR_WHOLEWORD )
 {
 int ii = 0;

 while( ii < (int) text.length() )
 {
 int next = text.find( searchText, ii );

 if( next == wxNOT_FOUND )
 return false;

 ii = next;
 next += searchText.length();

 bool startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
 bool endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );

 if( startOK && endOK )
 return true;
 else
 ii++;
 }

 return false;
 }
 else if( flags & FR_MATCH_WILDCARD )
 {
 return text.Matches( searchText );
 }
 else
 {
 return text.Find( searchText ) != wxNOT_FOUND;
 }
}

References FR_MATCH_WILDCARD, FR_SEARCH_REPLACE, EDA_ITEM::IsReplaceable(), next(), and text.

Mirror()

void FP_SHAPE::Mirror	(	const wxPoint &	aCentre,
		bool	aMirrorAroundXAxis
	)

Mirror an edge of the footprint.

Do not change the layer This is a footprint shape modification. (should be only called by a footprint editing function)

Definition at line 279 of file fp_shape.cpp.

{
 // Mirror an edge of the footprint. the layer is not modified
 // This is a footprint shape modification.

 switch( GetShape() )
 {
 case SHAPE_T::ARC:
 case SHAPE_T::SEGMENT:
 case SHAPE_T::RECT:
 case SHAPE_T::CIRCLE:
 case SHAPE_T::BEZIER:
 if( aMirrorAroundXAxis )
 {
 MIRROR( m_start0.y, aCentre.y );
 MIRROR( m_end0.y, aCentre.y );
 MIRROR( m_arcCenter0.y, aCentre.y );
 MIRROR( m_bezierC1_0.y, aCentre.y );
 MIRROR( m_bezierC2_0.y, aCentre.y );
 }
 else
 {
 MIRROR( m_start0.x, aCentre.x );
 MIRROR( m_end0.x, aCentre.x );
 MIRROR( m_arcCenter0.x, aCentre.x );
 MIRROR( m_bezierC1_0.x, aCentre.x );
 MIRROR( m_bezierC2_0.x, aCentre.x );
 }

 if( GetShape() == SHAPE_T::ARC )
 {
 std::swap( m_start, m_end );
 std::swap( m_start0, m_end0 );
 }

 if( GetShape() == SHAPE_T::BEZIER )
 RebuildBezierToSegmentsPointsList( m_width );

 break;

 case SHAPE_T::POLY:
 // polygon corners coordinates are always relative to the
 // footprint position, orientation 0
 m_poly.Mirror( !aMirrorAroundXAxis, aMirrorAroundXAxis );
 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 }

 SetDrawCoord();
}

References ARC, BEZIER, CIRCLE, EDA_SHAPE::GetShape(), m_arcCenter0, m_bezierC1_0, m_bezierC2_0, EDA_SHAPE::m_end, m_end0, EDA_SHAPE::m_poly, EDA_SHAPE::m_start, m_start0, EDA_SHAPE::m_width, MIRROR(), SHAPE_POLY_SET::Mirror(), POLY, EDA_SHAPE::RebuildBezierToSegmentsPointsList(), RECT, SEGMENT, SetDrawCoord(), EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by EDIT_TOOL::Mirror().

Move() [1/2]

void FP_SHAPE::Move ( const wxPoint &  aMoveVector )

overridevirtual

Move an edge of the footprint.

This is a footprint shape modification. (should be only called by a footprint editing function)

Reimplemented from PCB_SHAPE.

Definition at line 344 of file fp_shape.cpp.

{
 // Move an edge of the footprint.
 // This is a footprint shape modification.

 switch( GetShape() )
 {
 case SHAPE_T::ARC:
 case SHAPE_T::SEGMENT:
 case SHAPE_T::RECT:
 case SHAPE_T::CIRCLE:
 case SHAPE_T::BEZIER:
 m_start0 += aMoveVector;
 m_end0 += aMoveVector;
 m_arcCenter0 += aMoveVector;
 m_bezierC1_0 += aMoveVector;
 m_bezierC2_0 += aMoveVector;
 break;

 case SHAPE_T::POLY:
 // polygon corners coordinates are always relative to the
 // footprint position, orientation 0
 m_poly.Move( VECTOR2I( aMoveVector ) );

 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 }

 SetDrawCoord();
}

References ARC, BEZIER, CIRCLE, EDA_SHAPE::GetShape(), m_arcCenter0, m_bezierC1_0, m_bezierC2_0, m_end0, EDA_SHAPE::m_poly, m_start0, SHAPE_POLY_SET::Move(), POLY, RECT, SEGMENT, SetDrawCoord(), EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by PAD_TOOL::explodePad(), and FOOTPRINT::MoveAnchorPosition().

Move() [2/2]

void BOARD_ITEM::Move ( const VECTOR2I &  aMoveVector )

inlineinherited

Definition at line 243 of file board_item.h.

 {
 Move( wxPoint( aMoveVector.x, aMoveVector.y ) );
 }

References BOARD_ITEM::Move(), VECTOR2< T >::x, and VECTOR2< T >::y.

move()

void EDA_SHAPE::move ( const wxPoint &  aMoveVector )

protectedinherited

Definition at line 137 of file eda_shape.cpp.

{
 switch ( m_shape )
 {
 case SHAPE_T::ARC:
 case SHAPE_T::SEGMENT:
 case SHAPE_T::RECT:
 case SHAPE_T::CIRCLE:
 m_start += aMoveVector;
 m_end += aMoveVector;
 m_arcCenter += aMoveVector;
 break;

 case SHAPE_T::POLY:
 m_poly.Move( VECTOR2I( aMoveVector ) );
 break;

 case SHAPE_T::BEZIER:
 m_start += aMoveVector;
 m_end += aMoveVector;
 m_bezierC1 += aMoveVector;
 m_bezierC2 += aMoveVector;

 for( wxPoint& pt : m_bezierPoints)
 pt += aMoveVector;

 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 break;
 }
}

References ARC, BEZIER, CIRCLE, EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_bezierC1, EDA_SHAPE::m_bezierC2, EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_end, EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, SHAPE_POLY_SET::Move(), POLY, RECT, SEGMENT, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by PCB_SHAPE::Move(), LIB_SHAPE::Offset(), and EDA_SHAPE::setPosition().

operator<()

bool EDA_ITEM::operator< ( const EDA_ITEM &  aItem ) const

inherited

Test if another item is less than this object.

Parameters

aItem

- Item to compare against.

Returns

- True if aItem is less than the item.

Definition at line 234 of file eda_item.cpp.

{
 wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
 GetClass() ) );

 return false;
}

References Format(), and EDA_ITEM::GetClass().

RebuildBezierToSegmentsPointsList()

void EDA_SHAPE::RebuildBezierToSegmentsPointsList ( int  aMinSegLen )

inherited

Rebuild the m_BezierPoints vertex list that approximate the Bezier curve by a list of segments.

Has meaning only for BEZIER shape.

Parameters

aMinSegLen

is the min length of segments approximating the bezier. The shape's last segment can be shorter. This parameter avoids having too many very short segment in list. Good values are between m_width/2 and m_width.

Definition at line 366 of file eda_shape.cpp.

{
 // Has meaning only for S_CURVE DRAW_SEGMENT shape
 if( m_shape != SHAPE_T::BEZIER )
 {
 m_bezierPoints.clear();
 return;
 }

 // Rebuild the m_BezierPoints vertex list that approximate the Bezier curve
 m_bezierPoints = buildBezierToSegmentsPointsList( aMinSegLen );
}

References BEZIER, EDA_SHAPE::buildBezierToSegmentsPointsList(), EDA_SHAPE::m_bezierPoints, and EDA_SHAPE::m_shape.

Referenced by ConvertOutlineToPolygon(), Flip(), GRAPHICS_CLEANER::isNullShape(), SCH_LEGACY_PLUGIN_CACHE::loadBezier(), Mirror(), SetDrawCoord(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), and PCB_POINT_EDITOR::updateItem().

Replace() [1/2]

bool EDA_ITEM::Replace ( const wxFindReplaceData &  aSearchData, wxString &  aText  )

staticinherited

Perform a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace.

Parameters

aSearchData	A reference to a wxFindReplaceData object containing the search and replace criteria.
aText	A reference to a wxString object containing the text to be replaced.

Returns

True if aText was modified, otherwise false.

Definition at line 170 of file eda_item.cpp.

{
 wxString text = aText;
 int flags = aSearchData.GetFlags();
 wxString searchText = aSearchData.GetFindString();
 wxString result;
 bool replaced = false;

 if( flags & wxFR_MATCHCASE )
 {
 text = text.Upper();
 searchText = searchText.Upper();
 }

 int ii = 0;

 while( ii < (int) text.length() )
 {
 int next = text.find( searchText, ii );

 if( next == wxNOT_FOUND )
 {
 result += aText.Mid( ii, wxString::npos );
 break;
 }

 if( next > ii )
 result += aText.Mid( ii, next - ii );

 ii = next;
 next += searchText.length();

 bool startOK;
 bool endOK;

 if( flags & wxFR_WHOLEWORD )
 {
 startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
 endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
 }
 else
 {
 startOK = true;
 endOK = true;
 }

 if( startOK && endOK )
 {
 result += aSearchData.GetReplaceString();
 replaced = true;
 ii = next;
 }
 else
 {
 result += aText.GetChar( ii );
 ii++;
 }
 }

 aText = result;
 return replaced;
}

References next(), and text.

Referenced by SCH_FIELD::Replace(), EDA_TEXT::Replace(), SCH_EDITOR_CONTROL::ReplaceAll(), and SCH_EDITOR_CONTROL::ReplaceAndFindNext().

Replace() [2/2]

virtual bool EDA_ITEM::Replace ( const wxFindReplaceData &  aSearchData, void *  aAuxData = nullptr  )

inlinevirtualinherited

Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace.

This function must be overridden for items that support text replace.

Parameters

aSearchData	A reference to a wxFindReplaceData object containing the search and replace criteria.
aAuxData	A pointer to optional data required for the search or NULL if not used.

Returns

True if the item text was modified, otherwise false.

Reimplemented in SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, and SCH_PIN.

Definition at line 391 of file eda_item.h.

 {
 return false;
 }

Rotate() [1/2]

void FP_SHAPE::Rotate ( const wxPoint &  aRotCentre, double  aAngle  )

overridevirtual

Rotate an edge of the footprint.

This is a footprint shape modification. (should be only called by a footprint editing function )

Reimplemented from PCB_SHAPE.

Definition at line 332 of file fp_shape.cpp.

{
 // We should rotate the relative coordinates, but to avoid duplicate code do the base class
 // rotation of draw coordinates, which is acceptable because in the footprint editor
 // m_Pos0 = m_Pos
 PCB_SHAPE::Rotate( aRotCentre, aAngle );

 // and now update the relative coordinates, which are the reference in most transforms.
 SetLocalCoord();
}

References PCB_SHAPE::Rotate(), and SetLocalCoord().

Referenced by PAD_TOOL::explodePad(), and EAGLE_PLUGIN::packageRectangle().

Rotate() [2/2]

void BOARD_ITEM::Rotate ( const VECTOR2I &  aRotCentre, double  aAngle  )

inlineinherited

Definition at line 256 of file board_item.h.

 {
 Rotate( wxPoint( aRotCentre.x, aRotCentre.y ), aAngle );
 }

References BOARD_ITEM::Rotate(), VECTOR2< T >::x, and VECTOR2< T >::y.

rotate()

void EDA_SHAPE::rotate ( const wxPoint &  aRotCentre, double  aAngle  )

protectedinherited

Definition at line 224 of file eda_shape.cpp.

{
 switch( m_shape )
 {
 case SHAPE_T::SEGMENT:
 case SHAPE_T::CIRCLE:
 RotatePoint( &m_start, aRotCentre, aAngle );
 RotatePoint( &m_end, aRotCentre, aAngle );
 break;

 case SHAPE_T::ARC:
 RotatePoint( &m_start, aRotCentre, aAngle );
 RotatePoint( &m_end, aRotCentre, aAngle );
 RotatePoint( &m_arcCenter, aRotCentre, aAngle );
 break;

 case SHAPE_T::RECT:
 if( KiROUND( aAngle ) % 900 == 0 )
 {
 RotatePoint( &m_start, aRotCentre, aAngle );
 RotatePoint( &m_end, aRotCentre, aAngle );
 break;
 }

 // Convert non-cartesian-rotated rect to a diamond
 m_shape = SHAPE_T::POLY;
 m_poly.RemoveAllContours();
 m_poly.NewOutline();
 m_poly.Append( m_start );
 m_poly.Append( m_end.x, m_start.y );
 m_poly.Append( m_end );
 m_poly.Append( m_start.x, m_end.y );

 KI_FALLTHROUGH;

 case SHAPE_T::POLY:
 m_poly.Rotate( -DECIDEG2RAD( aAngle ), VECTOR2I( aRotCentre ) );
 break;

 case SHAPE_T::BEZIER:
 RotatePoint( &m_start, aRotCentre, aAngle);
 RotatePoint( &m_end, aRotCentre, aAngle);
 RotatePoint( &m_bezierC1, aRotCentre, aAngle);
 RotatePoint( &m_bezierC2, aRotCentre, aAngle);

 for( wxPoint& pt : m_bezierPoints )
 RotatePoint( &pt, aRotCentre, aAngle);

 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 break;
 }
}

References SHAPE_POLY_SET::Append(), ARC, BEZIER, CIRCLE, DECIDEG2RAD(), KI_FALLTHROUGH, KiROUND(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_bezierC1, EDA_SHAPE::m_bezierC2, EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_end, EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, SHAPE_POLY_SET::NewOutline(), POLY, RECT, SHAPE_POLY_SET::RemoveAllContours(), SHAPE_POLY_SET::Rotate(), RotatePoint(), SEGMENT, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by LIB_SHAPE::Rotate(), and PCB_SHAPE::Rotate().

Scale()

void PCB_SHAPE::Scale ( double  aScale )

inherited

Definition at line 103 of file pcb_shape.cpp.

{
 scale( aScale );
}

References EDA_SHAPE::scale().

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex().

scale()

void EDA_SHAPE::scale ( double  aScale )

protectedinherited

Definition at line 172 of file eda_shape.cpp.

{
 auto scalePt = [&]( wxPoint& pt )
 {
 pt.x = KiROUND( pt.x * aScale );
 pt.y = KiROUND( pt.y * aScale );
 };

 switch( m_shape )
 {
 case SHAPE_T::ARC:
 case SHAPE_T::SEGMENT:
 case SHAPE_T::RECT:
 scalePt( m_start );
 scalePt( m_end );
 scalePt( m_arcCenter );
 break;

 case SHAPE_T::CIRCLE: // ring or circle
 scalePt( m_start );
 m_end.x = m_start.x + KiROUND( GetRadius() * aScale );
 m_end.y = m_start.y;
 break;

 case SHAPE_T::POLY: // polygon
 {
 std::vector<wxPoint> pts;

 for( const VECTOR2I& pt : m_poly.Outline( 0 ).CPoints() )
 {
 pts.emplace_back( pt );
 scalePt( pts.back() );
 }

 SetPolyPoints( pts );
 }
 break;

 case SHAPE_T::BEZIER:
 scalePt( m_start );
 scalePt( m_end );
 scalePt( m_bezierC1 );
 scalePt( m_bezierC2 );
 break;

 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 break;
 }
}

References ARC, BEZIER, CIRCLE, SHAPE_LINE_CHAIN::CPoints(), EDA_SHAPE::GetRadius(), KiROUND(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_bezierC1, EDA_SHAPE::m_bezierC2, EDA_SHAPE::m_end, EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, SHAPE_POLY_SET::Outline(), POLY, RECT, SEGMENT, EDA_SHAPE::SetPolyPoints(), EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by PCB_SHAPE::Scale().

Set() [1/3]

bool INSPECTABLE::Set ( PROPERTY_BASE *  aProperty, wxAny &  aValue  )

inlineinherited

Definition at line 42 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );

 if( object )
 aProperty->setter( object, aValue );

 return object != nullptr;
 }

References PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::setter(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Set() [2/3]

template<typename T >

bool INSPECTABLE::Set ( PROPERTY_BASE *  aProperty, T  aValue  )

inlineinherited

Definition at line 55 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );

 if( object )
 aProperty->set<T>( object, aValue );

 return object != nullptr;
 }

References PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::set(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Set() [3/3]

template<typename T >

bool INSPECTABLE::Set ( const wxString &  aProperty, T  aValue  )

inlineinherited

Definition at line 68 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
 void* object = nullptr;

 if( prop )
 {
 object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );

 if( object )
 prop->set<T>( object, aValue );
 }

 return object != nullptr;
 }

References PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::set(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

SetArcAngleAndEnd()

void EDA_SHAPE::SetArcAngleAndEnd ( double  aAngle, bool  aCheckNegativeAngle = false  )

inherited

Set the end point from the angle center and start.

Parameters

aAngle

is tenths of degrees.

Definition at line 525 of file eda_shape.cpp.

{
 m_end = m_start;
 RotatePoint( &m_end, m_arcCenter, -NormalizeAngle360Max( aAngle ) );

 if( aCheckNegativeAngle && aAngle < 0 )
 {
 std::swap( m_start, m_end );
 m_endsSwapped = true;
 }
}

References EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_end, EDA_SHAPE::m_endsSwapped, EDA_SHAPE::m_start, NormalizeAngle360Max(), and RotatePoint().

Referenced by PAD::AddPrimitiveArc(), PCAD2KICAD::PCB_ARC::AddToBoard(), DRAWING_TOOL::drawArc(), CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex(), EAGLE_PLUGIN::loadPlain(), ALTIUM_PCB::ParseArcs6Data(), and DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow().

SetArcAngleAndEnd0()

void FP_SHAPE::SetArcAngleAndEnd0	(	double	aAngle,
		bool	aCheckNegativeAngle = false
	)

Sets the angle for arcs, and normalizes it within the range 0 - 360 degrees.

Parameters

aAngle

is tenths of degrees, but will soon be degrees.

Definition at line 188 of file fp_shape.cpp.

{
 m_end0 = m_start0;
 RotatePoint( &m_end0, m_arcCenter0, -NormalizeAngle360Max( aAngle ) );

 if( aCheckNegativeAngle && aAngle < 0 )
 std::swap( m_start0, m_end0 );
}

References m_arcCenter0, m_end0, m_start0, NormalizeAngle360Max(), and RotatePoint().

Referenced by PCAD2KICAD::PCB_ARC::AddToFootprint(), EAGLE_PLUGIN::packageWire(), and GPCB_FPL_CACHE::parseFOOTPRINT().

SetArcGeometry()

void EDA_SHAPE::SetArcGeometry ( const wxPoint &  aStart, const wxPoint &  aMid, const wxPoint &  aEnd  )

inherited

Set the three controlling points for an arc.

NB: these are NOT what's currently stored, so we have to do some calculations behind the scenes. However, they are what SHOULD be stored.

If the input winding doesn't match our internal winding, the calculated midpoint will end up on the other side of the arc. In this case, we need to flip the start/end points and flag this change for the system

Definition at line 489 of file eda_shape.cpp.

{
 m_start = aStart;
 m_end = aEnd;
 m_arcCenter = CalcArcCenter( aStart, aMid, aEnd );
 m_endsSwapped = false;

 wxPoint new_mid = GetArcMid();
 VECTOR2D dist( new_mid - aMid );
 VECTOR2D dist2( new_mid - m_arcCenter );

 if( dist.SquaredEuclideanNorm() > dist2.SquaredEuclideanNorm() )
 {
 std::swap( m_start, m_end );
 m_endsSwapped = true;
 }

}