KiCad PCB EDA Suite: FP_SHAPE Class Reference

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(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

STATUS_FLAGS m_flags

Definition: eda_item.h:531

References EDA_ITEM::m_flags.

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 182 of file eda_item.h.

182 { ClearFlags( SELECTED ); }

SELECTED

#define SELECTED

Definition: eda_item.h:114

EDA_ITEM::ClearFlags

void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:204

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by PCB_POINT_EDITOR::addCorner(), EDIT_TOOL::Duplicate(), ARRAY_CREATOR::Invoke(), LIB_PART::LIB_PART(), 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 216 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 148 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 136 of file fp_shape.cpp.

 {
     return new FP_SHAPE( *this );
 }

References FP_SHAPE().

◆ computeArcBBox()

void PCB_SHAPE::computeArcBBox ( EDA_RECT & aBBox ) const

protectedinherited

Definition at line 1008 of file pcb_shape.cpp.

 {
     // Do not include the center, which is not necessarily
     // inside the BB of a arc with a small angle
     aBBox.SetOrigin( m_end );
 
     wxPoint end = m_end;
     RotatePoint( &end, m_start, -m_angle );
     aBBox.Merge( end );
 
     // Determine the starting quarter
     // 0 right-bottom
     // 1 left-bottom
     // 2 left-top
     // 3 right-top
     unsigned int quarter = 0;       // assume right-bottom
 
     if( m_end.x < m_start.x )
     {
         if( m_end.y <= m_start.y )
             quarter = 2;
         else // ( m_End.y > m_Start.y )
             quarter = 1;
     }
     else if( m_end.x >= m_start.x )
     {
         if( m_end.y < m_start.y )
             quarter = 3;
         else if( m_end.x == m_start.x )
             quarter = 1;
     }
 
     int radius = GetRadius();
     int angle = (int) GetArcAngleStart() % 900 + m_angle;
     bool directionCW = ( m_angle > 0 );      // Is the direction of arc clockwise?
 
     // Make the angle positive, so we go clockwise and merge points belonging to the arc
     if( !directionCW )
     {
         angle = 900 - angle;
         quarter = ( quarter + 3 ) % 4;       // -1 modulo arithmetic
     }
 
     while( angle > 900 )
     {
         switch( quarter )
         {
         case 0: aBBox.Merge( wxPoint( m_start.x,          m_start.y + radius ) ); break;  // down
         case 1: aBBox.Merge( wxPoint( m_start.x - radius, m_start.y          ) ); break;  // left
         case 2: aBBox.Merge( wxPoint( m_start.x,          m_start.y - radius ) ); break;  // up
         case 3: aBBox.Merge( wxPoint( m_start.x + radius, m_start.y          ) ); break;  // right
         }
 
         if( directionCW )
             ++quarter;
         else
             quarter += 3;       // -1 modulo arithmetic
 
         quarter %= 4;
         angle -= 900;
     }
 
     aBBox.Inflate( m_width );   // Technically m_width / 2, but it doesn't hurt to have the
                                 // bounding box a bit large to account for drawing clearances,
                                 // etc.
 }

References PNS::angle(), PCB_SHAPE::GetArcAngleStart(), PCB_SHAPE::GetRadius(), EDA_RECT::Inflate(), PCB_SHAPE::m_angle, PCB_SHAPE::m_end, PCB_SHAPE::m_start, PCB_SHAPE::m_width, EDA_RECT::Merge(), RotatePoint(), and EDA_RECT::SetOrigin().

Referenced by PCB_SHAPE::GetBoundingBox(), and PCB_SHAPE::ViewBBox().

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )

inherited

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

Definition at line 113 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 202 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(), 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().

◆ 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 158 of file fp_shape.cpp.

 {
     wxPoint pt( 0, 0 );
 
     switch( GetShape() )
     {
     case PCB_SHAPE_TYPE::ARC:
         // Update arc angle but do not yet update m_ThirdPoint0 and m_thirdPoint,
         // arc center and start point must be updated before calculation arc end.
         SetAngle( -GetAngle(), false );
         KI_FALLTHROUGH;
 
     default:
     case PCB_SHAPE_TYPE::SEGMENT:
     case PCB_SHAPE_TYPE::CURVE:
         // 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_thirdPoint.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_ThirdPoint0.x, pt.x );
             MIRROR( m_Bezier0_C1.x, pt.x );
             MIRROR( m_Bezier0_C2.x, pt.x );
         }
         else
         {
             MIRROR( m_start.y, aCentre.y );
             MIRROR( m_end.y, aCentre.y );
             MIRROR( m_thirdPoint.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_ThirdPoint0.y, pt.y );
             MIRROR( m_Bezier0_C1.y, pt.y );
             MIRROR( m_Bezier0_C2.y, pt.y );
         }
 
         RebuildBezierToSegmentsPointsList( m_width );
         break;
 
     case PCB_SHAPE_TYPE::POLYGON:
         // polygon corners coordinates are relative to the footprint position, orientation 0
         m_poly.Mirror( aFlipLeftRight, !aFlipLeftRight );
         break;
     }
 
     SetLayer( FlipLayer( GetLayer(), GetBoard()->GetCopperLayerCount() ) );
 }

References ARC, CURVE, FlipLayer(), PCB_SHAPE::GetAngle(), BOARD_ITEM::GetBoard(), BOARD_ITEM::GetLayer(), PCB_SHAPE::GetShape(), KI_FALLTHROUGH, m_Bezier0_C1, m_Bezier0_C2, PCB_SHAPE::m_bezierC1, PCB_SHAPE::m_bezierC2, PCB_SHAPE::m_end, m_End0, PCB_SHAPE::m_poly, PCB_SHAPE::m_start, m_Start0, PCB_SHAPE::m_thirdPoint, m_ThirdPoint0, PCB_SHAPE::m_width, MIRROR(), SHAPE_POLY_SET::Mirror(), POLYGON, PCB_SHAPE::RebuildBezierToSegmentsPointsList(), SEGMENT, SetAngle(), and BOARD_ITEM::SetLayer().

◆ Flip() [2/2]

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

inlineinherited

Definition at line 315 of file board_item.h.

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

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

◆ 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;
 
         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().

◆ GetAngle()

double PCB_SHAPE::GetAngle ( ) const

inlineinherited

Definition at line 127 of file pcb_shape.h.

127 { return m_angle; }

PCB_SHAPE::m_angle

double m_angle

Definition: pcb_shape.h:53

References PCB_SHAPE::m_angle.

Referenced by BOARD_ADAPTER::addShapeWithClearance(), GRAPHICS_CLEANER::areEquivalent(), ConvertOutlineToPolygon(), KIGFX::PCB_PAINTER::draw(), PCB_POINT_EDITOR::editArcEndpointKeepCenter(), PCB_POINT_EDITOR::editArcEndpointKeepTangent(), Flip(), FootprintWriteShape(), PCB_IO::format(), PCB_SHAPE::GetLength(), CADSTAR_PCB_ARCHIVE_LOADER::getLineChainFromDrawsegments(), hash_fp_item(), PCB_SHAPE::HitTest(), idf_export_outline(), PCB_SHAPE::MakeEffectiveShapes(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromDrawsegments(), Mirror(), PCB_PARSER::parseFOOTPRINT_unchecked(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), PCB_SHAPE::SetArcGeometry(), AR_MATRIX::TraceSegmentPcb(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), and DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow().

◆ GetArcAngleEnd()

double PCB_SHAPE::GetArcAngleEnd ( ) const

inherited

function GetArcAngleEnd()

Returns: the angle of the ending point of this arc, between 0 and 3600 in 0.1 deg

Definition at line 428 of file pcb_shape.cpp.

 {
     // due to the Y axis orient atan2 needs - y value
     double angleStart = ArcTangente( GetArcEnd().y - GetCenter().y,
                                      GetArcEnd().x - GetCenter().x );
 
     // Normalize it to 0 ... 360 deg, to avoid discontinuity for angles near 180 deg
     // because 180 deg and -180 are very near angles when ampping betewwen -180 ... 180 deg.
     // and this is not easy to handle in calculations
     NORMALIZE_ANGLE_POS( angleStart );
 
     return angleStart;
 }

References ArcTangente(), PCB_SHAPE::GetArcEnd(), PCB_SHAPE::GetCenter(), and NORMALIZE_ANGLE_POS().

◆ GetArcAngleStart()

double PCB_SHAPE::GetArcAngleStart ( ) const

inherited

function GetArcAngleStart()

Returns: the angle of the starting point of this arc, between 0 and 3600 in 0.1 deg

Definition at line 414 of file pcb_shape.cpp.

 {
     // due to the Y axis orient atan2 needs - y value
     double angleStart = ArcTangente( GetArcStart().y - GetCenter().y,
                                      GetArcStart().x - GetCenter().x );
 
     // Normalize it to 0 ... 360 deg, to avoid discontinuity for angles near 180 deg
     // because 180 deg and -180 are very near angles when ampping betewwen -180 ... 180 deg.
     // and this is not easy to handle in calculations
     NORMALIZE_ANGLE_POS( angleStart );
 
     return angleStart;
 }

References ArcTangente(), PCB_SHAPE::GetArcStart(), PCB_SHAPE::GetCenter(), and NORMALIZE_ANGLE_POS().

Referenced by PCB_SHAPE::computeArcBBox(), KIGFX::PCB_PAINTER::draw(), and PCB_SHAPE::HitTest().

◆ GetArcEnd()

wxPoint PCB_SHAPE::GetArcEnd ( ) const

inherited

Definition at line 374 of file pcb_shape.cpp.

 {
     wxPoint endPoint( m_end );         // start of arc
 
     switch( m_shape )
     {
     case PCB_SHAPE_TYPE::ARC:
         endPoint = m_thirdPoint;
         break;
 
     default:
         break;
     }
 
     return endPoint;   // after rotation, the end of the arc.
 }

References ARC, PCB_SHAPE::m_end, PCB_SHAPE::m_shape, and PCB_SHAPE::m_thirdPoint.

Referenced by PCB_GRID_HELPER::computeAnchors(), ConvertOutlineToPolygon(), PCB_POINT_EDITOR::editArcEndpointKeepTangent(), PCB_SHAPE::GetArcAngleEnd(), PCB_POINT_EDITOR::makePoints(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), PCB_SHAPE::TransformShapeWithClearanceToPolygon(), and PCB_POINT_EDITOR::updatePoints().

◆ GetArcMid()

wxPoint PCB_SHAPE::GetArcMid ( ) const

inherited

Definition at line 392 of file pcb_shape.cpp.

 {
     wxPoint endPoint( m_end );
 
     switch( m_shape )
     {
     case PCB_SHAPE_TYPE::ARC:
         // rotate the starting point of the arc, given by m_End, through half
         // the angle m_Angle to get the middle of the arc.
         // m_Start is the arc centre
         endPoint  = m_end;         // m_End = start point of arc
         RotatePoint( &endPoint, m_start, -m_angle / 2.0 );
         break;
 
     default:
         break;
     }
 
     return endPoint;   // after rotation, the end of the arc.
 }

References ARC, PCB_SHAPE::m_angle, PCB_SHAPE::m_end, PCB_SHAPE::m_shape, PCB_SHAPE::m_start, and RotatePoint().

Referenced by PCB_GRID_HELPER::computeAnchors(), PCB_POINT_EDITOR::editArcMidKeepEndpoints(), PCB_POINT_EDITOR::makePoints(), PCB_SHAPE::TransformShapeWithClearanceToPolygon(), and PCB_POINT_EDITOR::updatePoints().

◆ GetArcStart()

wxPoint PCB_SHAPE::GetArcStart ( ) const

inlineinherited

◆ GetBezControl1()

const wxPoint& PCB_SHAPE::GetBezControl1 ( ) const

inlineinherited

Definition at line 133 of file pcb_shape.h.

133 { return m_bezierC1; }

PCB_SHAPE::m_bezierC1

wxPoint m_bezierC1

Definition: pcb_shape.h:54

References PCB_SHAPE::m_bezierC1.

Referenced by GRAPHICS_CLEANER::areEquivalent(), KIGFX::PCB_PAINTER::draw(), PCB_IO::format(), PCB_POINT_EDITOR::makePoints(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), and PCB_POINT_EDITOR::updatePoints().

◆ GetBezControl2()

const wxPoint& PCB_SHAPE::GetBezControl2 ( ) const

inlineinherited

Definition at line 136 of file pcb_shape.h.

136 { return m_bezierC2; }

PCB_SHAPE::m_bezierC2

wxPoint m_bezierC2

Definition: pcb_shape.h:55

References PCB_SHAPE::m_bezierC2.

Referenced by GRAPHICS_CLEANER::areEquivalent(), KIGFX::PCB_PAINTER::draw(), PCB_IO::format(), PCB_POINT_EDITOR::makePoints(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), and PCB_POINT_EDITOR::updatePoints().

◆ GetBezier0_C1()

const wxPoint& FP_SHAPE::GetBezier0_C1 ( ) const

inline

Definition at line 121 of file fp_shape.h.

121 { return m_Bezier0_C1; }

FP_SHAPE::m_Bezier0_C1

wxPoint m_Bezier0_C1

Bezier Control Point 1, relative to footprint origin, orient 0.

Definition: fp_shape.h:163

References m_Bezier0_C1.

Referenced by PCB_IO::format().

◆ GetBezier0_C2()

const wxPoint& FP_SHAPE::GetBezier0_C2 ( ) const

inline

Definition at line 124 of file fp_shape.h.

124 { return m_Bezier0_C2; }

FP_SHAPE::m_Bezier0_C2

wxPoint m_Bezier0_C2

Bezier Control Point 2, relative to footprint origin, orient 0.

Definition: fp_shape.h:164

References m_Bezier0_C2.

Referenced by PCB_IO::format().

◆ GetBezierPoints()

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

inlineinherited

Definition at line 253 of file pcb_shape.h.

253 { return m_bezierPoints; }

PCB_SHAPE::m_bezierPoints

std::vector< wxPoint > m_bezierPoints

Definition: pcb_shape.h:57

References PCB_SHAPE::m_bezierPoints.

Referenced by GRAPHICS_CLEANER::areEquivalent(), ConvertOutlineToPolygon(), and GRAPHICS_CLEANER::isNullSegment().

◆ GetBoard()

BOARD * BOARD_ITEM::GetBoard ( ) const

virtualinherited

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

Definition at line 46 of file board_item.cpp.

 {
     if( Type() == PCB_T )
         return (BOARD*) this;
 
     BOARD_ITEM* parent = GetParent();
 
     if( parent )
         return parent->GetBoard();
 
     return NULL;
 }

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

Referenced by PAD::BuildEffectivePolygon(), PAD::BuildEffectiveShapes(), ZONE::BuildSmoothedPoly(), KIGFX::PCB_PAINTER::draw(), exprFromTo(), VIA::FlashLayer(), PAD::FlashLayer(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), TRACK::Flip(), Flip(), FP_TEXT::Flip(), DIMENSION_BASE::Flip(), ARC::Flip(), PCB_SHAPE::Flip(), VIA::Flip(), ZONE::Flip(), BOARD_ITEM::GetBoard(), FOOTPRINT::GetBoundingBox(), FOOTPRINT::GetBoundingHull(), BOARD_CONNECTED_ITEM::GetEffectiveNetclass(), ZONE::GetInteractingZones(), BOARD_ITEM::GetLayerName(), VIA::GetMinAnnulus(), PCB_DRAW_PANEL_GAL::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), TRACK::GetMsgPanelInfo(), 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(), TRACK::GetWidthConstraints(), inDiffPair(), insideArea(), insideBackCourtyard(), insideCourtyard(), insideFrontCourtyard(), BOARD_ITEM::layerMaskDescribe(), 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(), TRACK::ViewBBox(), FOOTPRINT::ViewBBox(), VIA::ViewGetLOD(), and PAD::ViewGetLOD().

◆ GetBoundingBox()

const EDA_RECT PCB_SHAPE::GetBoundingBox ( ) const

overridevirtualinherited

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 569 of file pcb_shape.cpp.

 {
     EDA_RECT bbox;
 
     bbox.SetOrigin( m_start );
 
     switch( m_shape )
     {
     case PCB_SHAPE_TYPE::RECT:
     {
         std::vector<wxPoint> pts = GetRectCorners();
 
         bbox = EDA_RECT();  // re-init for merging
 
         for( wxPoint& pt : pts )
             bbox.Merge( pt );
     }
         break;
 
     case PCB_SHAPE_TYPE::SEGMENT:
         bbox.SetEnd( m_end );
         break;
 
     case PCB_SHAPE_TYPE::CIRCLE:
         bbox.Inflate( GetRadius() );
         break;
 
     case PCB_SHAPE_TYPE::ARC:
         computeArcBBox( bbox );
         break;
 
     case PCB_SHAPE_TYPE::POLYGON:
     {
         if( m_poly.IsEmpty() )
             break;
 
         FOOTPRINT* parentFootprint = GetParentFootprint();
         bbox = EDA_RECT();  // re-init for merging
 
         for( auto iter = m_poly.CIterate(); iter; iter++ )
         {
             wxPoint pt( iter->x, iter->y );
 
             if( parentFootprint ) // Transform, if we belong to a footprint
             {
                 RotatePoint( &pt, parentFootprint->GetOrientation() );
                 pt += parentFootprint->GetPosition();
             }
 
             bbox.Merge( pt );
         }
     }
         break;
 
     case PCB_SHAPE_TYPE::CURVE:
         bbox.Merge( m_bezierC1 );
         bbox.Merge( m_bezierC2 );
         bbox.Merge( m_end );
         break;
 
     default:
         wxFAIL_MSG( "PCB_SHAPE::GetBoundingBox not implemented for "
                     + PCB_SHAPE_TYPE_T_asString( m_shape ) );
         break;
     }
 
     bbox.Inflate( m_width / 2 );
     bbox.Normalize();
 
     return bbox;
 }

References ARC, CIRCLE, SHAPE_POLY_SET::CIterate(), PCB_SHAPE::computeArcBBox(), CURVE, FOOTPRINT::GetOrientation(), PCB_SHAPE::GetParentFootprint(), FOOTPRINT::GetPosition(), PCB_SHAPE::GetRadius(), PCB_SHAPE::GetRectCorners(), EDA_RECT::Inflate(), SHAPE_POLY_SET::IsEmpty(), PCB_SHAPE::m_bezierC1, PCB_SHAPE::m_bezierC2, PCB_SHAPE::m_end, PCB_SHAPE::m_poly, PCB_SHAPE::m_shape, PCB_SHAPE::m_start, PCB_SHAPE::m_width, EDA_RECT::Merge(), EDA_RECT::Normalize(), PCB_SHAPE_TYPE_T_asString(), POLYGON, RECT, RotatePoint(), SEGMENT, EDA_RECT::SetEnd(), and EDA_RECT::SetOrigin().

Referenced by BOARD_ADAPTER::addShapeWithClearance(), PCB_SHAPE::GetCenter(), and PCB_SHAPE::HitTest().

◆ GetCenter()

wxPoint PCB_SHAPE::GetCenter ( ) const

overridevirtualinherited

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 342 of file pcb_shape.cpp.

 {
     wxPoint c;
 
     switch( m_shape )
     {
     case PCB_SHAPE_TYPE::ARC:
     case PCB_SHAPE_TYPE::CIRCLE:
         c = m_start;
         break;
 
     case PCB_SHAPE_TYPE::SEGMENT:
         // Midpoint of the line
         c = ( GetStart() + GetEnd() ) / 2;
         break;
 
     case PCB_SHAPE_TYPE::POLYGON:
     case PCB_SHAPE_TYPE::RECT:
     case PCB_SHAPE_TYPE::CURVE:
         c = GetBoundingBox().Centre();
         break;
 
     default:
         wxFAIL_MSG( "PCB_SHAPE::GetCentre not implemented for "
                     + PCB_SHAPE_TYPE_T_asString( m_shape ) );
         break;
     }
 
     return c;
 }

References ARC, EDA_RECT::Centre(), CIRCLE, CURVE, PCB_SHAPE::GetBoundingBox(), PCB_SHAPE::GetEnd(), PCB_SHAPE::GetStart(), PCB_SHAPE::m_shape, PCB_SHAPE::m_start, PCB_SHAPE_TYPE_T_asString(), POLYGON, RECT, and SEGMENT.

Referenced by BOARD_ADAPTER::addShapeWithClearance(), GRAPHICS_CLEANER::areEquivalent(), PCB_GRID_HELPER::computeAnchors(), ConvertOutlineToPolygon(), PCB_SHAPE::GetArcAngleEnd(), PCB_SHAPE::GetArcAngleStart(), PCB_SHAPE::GetFocusPosition(), PCB_SHAPE::HitTest(), idf_export_outline(), GRAPHICS_CLEANER::isNullSegment(), PCB_SHAPE::MakeEffectiveShapes(), PCB_POINT_EDITOR::makePoints(), EAGLE_PLUGIN::packageRectangle(), PCB_PARSER::parsePAD(), PCB_SHAPE::TransformShapeWithClearanceToPolygon(), PCB_POINT_EDITOR::updateItem(), and PCB_POINT_EDITOR::updatePoints().

◆ GetClass()

wxString FP_SHAPE::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Definition at line 141 of file fp_shape.h.

     {
         return wxT( "MGRAPHIC" );
     }

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 208 of file eda_item.h.

     {
         constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVED | IS_RESIZED | IS_DRAGGED |
                                IS_WIRE_IMAGE | STRUCT_DELETED );
 
         return m_flags & mask;
     }

References IS_DRAGGED, IS_MOVED, IS_NEW, IS_PASTED, IS_RESIZED, 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_COMPONENT::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_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), and DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow().

◆ GetEffectiveShape()

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

overridevirtualinherited

Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.

This routine returns a COMPOUND shape (set of simple shapes which make up the pad for use with routing, collision determination, etc).

Note: This list can contain a SHAPE_SIMPLE (a simple single-outline non-intersecting polygon), but should never contain a SHAPE_POLY_SET (a complex polygon consisting of multiple outlines and/or holes).

Parameters

aLayer in case of items spanning multiple layers, only the shapes belonging to aLayer will be returned. Pass UNDEFINED_LAYER to return shapes for all layers.

Reimplemented from BOARD_ITEM.

Definition at line 1192 of file pcb_shape.cpp.

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

References PCB_SHAPE::MakeEffectiveShapes().

◆ GetEnd()

const wxPoint& PCB_SHAPE::GetEnd ( ) const

inlineinherited

Function GetEnd returns the ending point of the graphic.

Definition at line 156 of file pcb_shape.h.

156 { return m_end; }

Referenced by PCB_POINT_EDITOR::addCorner(), BOARD_ADAPTER::addShapeWithClearance(), GRAPHICS_CLEANER::areEquivalent(), PCB_GRID_HELPER::computeAnchors(), ConvertOutlineToPolygon(), CreateBoardSection(), MICROWAVE_TOOL::createMicrowaveInductor(), KIGFX::PCB_PAINTER::draw(), PCB_IO::format(), PCB_SHAPE::GetCenter(), PCB_SHAPE::GetLength(), PCB_SHAPE::GetRectCorners(), CONVERT_TOOL::getStartEndPoints(), hash_fp_item(), PCB_SHAPE::HitTest(), idf_export_outline(), GRAPHICS_CLEANER::isNullSegment(), PCB_SHAPE::MakeEffectiveShapes(), DSN::SPECCTRA_DB::makeIMAGE(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromRects(), GRAPHICS_CLEANER::mergeRects(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), CONVERT_TOOL::PolyToLines(), AR_MATRIX::TraceSegmentPcb(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), and PCB_POINT_EDITOR::updatePoints().

wxPoint m_end

Definition: pcb_shape.h:49

References PCB_SHAPE::m_end.

◆ GetEnd0()

const wxPoint& FP_SHAPE::GetEnd0 ( ) const

inline

Definition at line 115 of file fp_shape.h.

115 { return m_End0; }

FP_SHAPE::m_End0

wxPoint m_End0

End point, relative to footprint origin, orient 0.

Definition: fp_shape.h:161

References m_End0.

Referenced by FootprintWriteShape(), PCB_IO::format(), CADSTAR_PCB_ARCHIVE_LOADER::getLineChainFromDrawsegments(), hash_fp_item(), DSN::SPECCTRA_DB::makeIMAGE(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromDrawsegments(), and GPCB_FPL_CACHE::parseFOOTPRINT().

◆ GetEndX()

int PCB_SHAPE::GetEndX ( )

inlineinherited

Definition at line 158 of file pcb_shape.h.

158 { return m_end.x; }

wxPoint m_end

Definition: pcb_shape.h:49

References PCB_SHAPE::m_end.

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

◆ GetEndY()

int PCB_SHAPE::GetEndY ( )

inlineinherited

Definition at line 157 of file pcb_shape.h.

157 { return m_end.y; }

wxPoint m_end

Definition: pcb_shape.h:49

References PCB_SHAPE::m_end.

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

◆ GetFlags()

STATUS_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 205 of file eda_item.h.

205 { return m_flags; }

Referenced by BACK_ANNOTATE::applyChangelist(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), KIGFX::SCH_PAINTER::draw(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::expandConnection(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), insideArea(), BOARD_INSPECTION_TOOL::InspectConstraints(), LIB_PART::LIB_PART(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), LIB_PART::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(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

STATUS_FLAGS m_flags

Definition: eda_item.h:531

References EDA_ITEM::m_flags.

◆ GetFocusPosition()

const wxPoint PCB_SHAPE::GetFocusPosition ( ) const

inlineoverridevirtualinherited

Similar to GetPosition, but allows items to return their visual center rather than their anchor.

Reimplemented from EDA_ITEM.

Definition at line 239 of file pcb_shape.h.

     {
         return GetCenter();
     }

References PCB_SHAPE::GetCenter().

◆ GetLayer()

virtual PCB_LAYER_ID BOARD_ITEM::GetLayer ( ) const

inlinevirtualinherited

Return the primary layer this item is on.

Reimplemented in ZONE.

Definition at line 173 of file board_item.h.

173 { return m_layer; }

BOARD_ITEM::m_layer

PCB_LAYER_ID m_layer

Definition: board_item.h:363

References BOARD_ITEM::m_layer.

◆ 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 60 of file board_item.cpp.

 {
     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_TEXT::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), DIMENSION_BASE::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), LEADER::GetMsgPanelInfo(), PCB_TEXT::GetSelectMenuText(), GetSelectMenuText(), TRACK::GetSelectMenuText(), DIMENSION_BASE::GetSelectMenuText(), PCB_SHAPE::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 VIA, PAD, ZONE, and PCB_GROUP.

Definition at line 178 of file board_item.h.

178 { return LSET( m_layer ); }

LSET

LSET is a set of PCB_LAYER_IDs.

Definition: layers_id_colors_and_visibility.h:506

BOARD_ITEM::m_layer

PCB_LAYER_ID m_layer

Definition: board_item.h:363

References BOARD_ITEM::m_layer.

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

◆ GetLength()

double PCB_SHAPE::GetLength ( ) const

inherited

Function GetLength returns the length of the track using the hypotenuse calculation.

Returns: double - the length of the track

Definition at line 77 of file pcb_shape.cpp.

 {
     double length = 0.0;
 
     switch( m_shape )
     {
     case PCB_SHAPE_TYPE::CURVE:
         for( size_t ii = 1; ii < m_bezierPoints.size(); ++ii )
             length += GetLineLength( m_bezierPoints[ ii - 1], m_bezierPoints[ii] );
 
         break;
 
     case PCB_SHAPE_TYPE::SEGMENT:
         length = GetLineLength( GetStart(), GetEnd() );
         break;
 
     case PCB_SHAPE_TYPE::POLYGON:
         for( int ii = 0; ii < m_poly.COutline( 0 ).SegmentCount(); ii++ )
             length += m_poly.COutline( 0 ).CSegment( ii ).Length();
 
         break;
 
     case PCB_SHAPE_TYPE::ARC:
         length = 2 * M_PI * GetRadius() * ( GetAngle() / 3600.0 );
         break;
 
     default:
         wxASSERT_MSG( false, "PCB_SHAPE::GetLength not implemented for shape"
                 + ShowShape( GetShape() ) );
         break;
     }
 
     return length;
 }

References ARC, SHAPE_POLY_SET::COutline(), SHAPE_LINE_CHAIN::CSegment(), CURVE, PCB_SHAPE::GetAngle(), PCB_SHAPE::GetEnd(), GetLineLength(), PCB_SHAPE::GetRadius(), PCB_SHAPE::GetShape(), PCB_SHAPE::GetStart(), SEG::Length(), PCB_SHAPE::m_bezierPoints, PCB_SHAPE::m_poly, PCB_SHAPE::m_shape, POLYGON, SEGMENT, SHAPE_LINE_CHAIN::SegmentCount(), and BOARD_ITEM::ShowShape().

Referenced by PCB_SHAPE::GetMsgPanelInfo().

◆ 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 130 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 111 of file fp_shape.cpp.

 {
     FOOTPRINT* fp = static_cast<FOOTPRINT*>( m_parent );
 
     aList.emplace_back( _( "Footprint" ), fp ? fp->GetReference() : _( "<invalid>" ) );
 
     // append the features shared with the base class
     PCB_SHAPE::GetMsgPanelInfo( aFrame, aList );
 }

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

◆ GetParent()

BOARD_ITEM_CONTAINER* BOARD_ITEM::GetParent ( void ) const

inlineinherited

Definition at line 168 of file board_item.h.

168 { return (BOARD_ITEM_CONTAINER*) m_parent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:529

BOARD_ITEM_CONTAINER

Abstract interface for BOARD_ITEMs capable of storing other items inside.

Definition: board_item_container.h:52

References EDA_ITEM::m_parent.

◆ GetParentAsString()

wxString FP_SHAPE::GetParentAsString ( ) const

inline

Definition at line 146 of file fp_shape.h.

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

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:529

KIID::AsString

wxString AsString() const

Definition: kiid.cpp:218

EDA_ITEM::m_Uuid

const KIID m_Uuid

Definition: eda_item.h:525

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

Function GetParentFootprint returns a pointer to the parent footprint, or NULL if PCB_SHAPE does not belong to a footprint.

Returns: FOOTPRINT* - pointer to the parent footprint or NULL.

Definition at line 479 of file pcb_shape.cpp.

 {
     if( !m_parent || m_parent->Type() != PCB_FOOTPRINT_T )
         return NULL;
 
     return (FOOTPRINT*) m_parent;
 }

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

Referenced by ConvertOutlineToPolygon(), KIGFX::PCB_PAINTER::draw(), PCB_SHAPE::GetBoundingBox(), PCB_SHAPE::GetRectCorners(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), and PCB_SHAPE::TransformShapeWithClearanceToPolygon().

◆ GetParentGroup()

PCB_GROUP* BOARD_ITEM::GetParentGroup ( ) const

inlineinherited

Definition at line 93 of file board_item.h.

93 { return m_group; }

BOARD_ITEM::m_group

PCB_GROUP * m_group

Definition: board_item.h:364

References BOARD_ITEM::m_group.

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

◆ GetPointCount()

int PCB_SHAPE::GetPointCount ( ) const

inherited

Returns: the number of corners of the polygonal shape

Definition at line 1227 of file pcb_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 PCB_SHAPE::GetPolyShape(), and SHAPE_POLY_SET::VertexCount().

Referenced by GRAPHICS_CLEANER::isNullSegment().

◆ GetPolyShape() [1/2]

SHAPE_POLY_SET& PCB_SHAPE::GetPolyShape ( )

inlineinherited

◆ GetPolyShape() [2/2]

const SHAPE_POLY_SET& PCB_SHAPE::GetPolyShape ( ) const

inlineinherited

Definition at line 269 of file pcb_shape.h.

269 { return m_poly; }

PCB_SHAPE::m_poly

SHAPE_POLY_SET m_poly

Definition: pcb_shape.h:58

References PCB_SHAPE::m_poly.

◆ GetPosition()

wxPoint PCB_SHAPE::GetPosition ( ) const

overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 68 of file pcb_shape.cpp.

 {
     if( m_shape == PCB_SHAPE_TYPE::POLYGON )
         return (wxPoint) m_poly.CVertex( 0 );
     else
         return m_start;
 }

References SHAPE_POLY_SET::CVertex(), PCB_SHAPE::m_poly, PCB_SHAPE::m_shape, PCB_SHAPE::m_start, and POLYGON.

Referenced by CONVERT_TOOL::makePolysFromCircles().

◆ GetRadius()

int PCB_SHAPE::GetRadius ( ) const

inlineinherited

Function GetRadius returns the radius of this item Has meaning only for arc and circle.

Definition at line 201 of file pcb_shape.h.

     {
         double radius = GetLineLength( m_start, m_end );
 
         // don't allow degenerate arcs
         return std::max( 1, KiROUND( radius ) );
     }

References GetLineLength(), KiROUND(), PCB_SHAPE::m_end, and PCB_SHAPE::m_start.

Referenced by BOARD_ADAPTER::addShapeWithClearance(), PCB_SHAPE::computeArcBBox(), ConvertOutlineToPolygon(), KIGFX::PCB_PAINTER::draw(), PCB_SHAPE::GetBoundingBox(), PCB_SHAPE::GetLength(), hash_fp_item(), PCB_SHAPE::HitTest(), idf_export_outline(), GRAPHICS_CLEANER::isNullSegment(), PCB_SHAPE::MakeEffectiveShapes(), CONVERT_TOOL::makePolysFromCircles(), PCB_PARSER::parsePAD(), PCB_SHAPE::Scale(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), and PCB_SHAPE::TransformShapeWithClearanceToPolygon().

◆ GetRectCorners()

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

inherited

Definition at line 971 of file pcb_shape.cpp.

 {
     std::vector<wxPoint> pts;
     FOOTPRINT* parentFootprint = GetParentFootprint();
     wxPoint    topLeft = GetStart();
     wxPoint    botRight = GetEnd();
 
     // Un-rotate rect topLeft and botRight
     if( parentFootprint && KiROUND( parentFootprint->GetOrientation() ) % 900 != 0 )
     {
         topLeft -= parentFootprint->GetPosition();
         RotatePoint( &topLeft, -parentFootprint->GetOrientation() );
 
         botRight -= parentFootprint->GetPosition();
         RotatePoint( &botRight, -parentFootprint->GetOrientation() );
     }
 
     // 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( parentFootprint && KiROUND( parentFootprint->GetOrientation() ) % 900 != 0 )
     {
         for( wxPoint& pt : pts )
         {
             RotatePoint( &pt, parentFootprint->GetOrientation() );
             pt += parentFootprint->GetPosition();
         }
     }
 
     return pts;
 }

References PCB_SHAPE::GetEnd(), FOOTPRINT::GetOrientation(), PCB_SHAPE::GetParentFootprint(), FOOTPRINT::GetPosition(), PCB_SHAPE::GetStart(), KiROUND(), and RotatePoint().

Referenced by BOARD_ADAPTER::addShapeWithClearance(), ConvertOutlineToPolygon(), KIGFX::PCB_PAINTER::draw(), PCB_SHAPE::GetBoundingBox(), PCB_SHAPE::HitTest(), PCB_SHAPE::MakeEffectiveShapes(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), and PCB_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 122 of file fp_shape.cpp.

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

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

◆ GetShape()

PCB_SHAPE_TYPE PCB_SHAPE::GetShape ( ) const

inlineinherited

Definition at line 130 of file pcb_shape.h.

130 { return m_shape; }

PCB_SHAPE::m_shape

PCB_SHAPE_TYPE m_shape

Definition: pcb_shape.h:52

References PCB_SHAPE::m_shape.

Referenced by PCB_POINT_EDITOR::addCorner(), BOARD_ADAPTER::addShapeWithClearance(), GRAPHICS_CLEANER::areEquivalent(), PCB_POINT_EDITOR::canAddCorner(), GRAPHICS_CLEANER::cleanupSegments(), PCB_GRID_HELPER::computeAnchors(), ConvertOutlineToPolygon(), KIGFX::PCB_PAINTER::draw(), Flip(), FootprintWriteShape(), PCB_IO::format(), FOOTPRINT::GetCoverageArea(), PCB_SHAPE::GetLength(), hash_fp_item(), idf_export_outline(), GRAPHICS_CLEANER::isNullSegment(), 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()(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), CONVERT_TOOL::PolyToLines(), PCB_POINT_EDITOR::removeCorner(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), 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(), PCB_POINT_EDITOR::updatePoints(), and DIALOG_GRAPHIC_ITEM_PROPERTIES::Validate().

◆ GetStart()

const wxPoint& PCB_SHAPE::GetStart ( ) const

inlineinherited

Function GetStart returns the starting point of the graphic.

Definition at line 145 of file pcb_shape.h.

145 { return m_start; }

Referenced by PCB_POINT_EDITOR::addCorner(), BOARD_ADAPTER::addShapeWithClearance(), GRAPHICS_CLEANER::areEquivalent(), PCB_GRID_HELPER::computeAnchors(), ConvertOutlineToPolygon(), CreateBoardSection(), MICROWAVE_TOOL::createMicrowaveInductor(), KIGFX::PCB_PAINTER::draw(), PCB_IO::format(), PCB_SHAPE::GetCenter(), PCB_SHAPE::GetLength(), PCB_SHAPE::GetRectCorners(), CONVERT_TOOL::getStartEndPoints(), hash_fp_item(), PCB_SHAPE::HitTest(), idf_export_outline(), GRAPHICS_CLEANER::isNullSegment(), PCB_SHAPE::MakeEffectiveShapes(), DSN::SPECCTRA_DB::makeIMAGE(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromRects(), GRAPHICS_CLEANER::mergeRects(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), BRDITEMS_PLOTTER::PlotPcbTarget(), CONVERT_TOOL::PolyToLines(), AR_MATRIX::TraceSegmentPcb(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), and PCB_POINT_EDITOR::updatePoints().

wxPoint m_start

Definition: pcb_shape.h:48

References PCB_SHAPE::m_start.

◆ GetStart0()

const wxPoint& FP_SHAPE::GetStart0 ( ) const

inline

Definition at line 112 of file fp_shape.h.

112 { return m_Start0; }

FP_SHAPE::m_Start0

wxPoint m_Start0

Start point or center, relative to footprint origin, orient 0.

Definition: fp_shape.h:160

References m_Start0.

Referenced by FootprintWriteShape(), PCB_IO::format(), CADSTAR_PCB_ARCHIVE_LOADER::getLineChainFromDrawsegments(), hash_fp_item(), DSN::SPECCTRA_DB::makeIMAGE(), and CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromDrawsegments().

◆ GetStartX()

int PCB_SHAPE::GetStartX ( )

inlineinherited

Definition at line 147 of file pcb_shape.h.

147 { return m_start.x; }

wxPoint m_start

Definition: pcb_shape.h:48

References PCB_SHAPE::m_start.

Referenced by DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run().

◆ GetStartY()

int PCB_SHAPE::GetStartY ( )

inlineinherited

Definition at line 146 of file pcb_shape.h.

146 { return m_start.y; }

wxPoint m_start

Definition: pcb_shape.h:48

References PCB_SHAPE::m_start.

Referenced by DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run().

◆ GetState()

int EDA_ITEM::GetState ( int type ) const

inlineinherited

Definition at line 187 of file eda_item.h.

     {
         return m_status & type;
     }

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 200 of file eda_item.h.

200 { return m_status; }

EDA_ITEM::m_status

STATUS_FLAGS m_status

Definition: eda_item.h:528

References EDA_ITEM::m_status.

◆ GetThirdPoint()

const wxPoint& PCB_SHAPE::GetThirdPoint ( ) const

inlineinherited

Function GetThirdPoint returns the third point point of the graphic.

Definition at line 167 of file pcb_shape.h.

167 { return m_thirdPoint; }

wxPoint m_thirdPoint

Definition: pcb_shape.h:50

References PCB_SHAPE::m_thirdPoint.

◆ GetThirdPoint0()

const wxPoint& FP_SHAPE::GetThirdPoint0 ( ) const

inline

Definition at line 118 of file fp_shape.h.

118 { return m_ThirdPoint0; }

FP_SHAPE::m_ThirdPoint0

wxPoint m_ThirdPoint0

End point for an arc.

Definition: fp_shape.h:162

References m_ThirdPoint0.

◆ GetThirdPointX()

int PCB_SHAPE::GetThirdPointX ( )

inlineinherited

Definition at line 169 of file pcb_shape.h.

169 { return m_thirdPoint.x; }

wxPoint m_thirdPoint

Definition: pcb_shape.h:50

References PCB_SHAPE::m_thirdPoint.

◆ GetThirdPointY()

int PCB_SHAPE::GetThirdPointY ( )

inlineinherited

Definition at line 168 of file pcb_shape.h.

168 { return m_thirdPoint.y; }

Referenced by BOARD_ADAPTER::addShapeWithClearance(), GRAPHICS_CLEANER::areEquivalent(), ConvertOutlineToPolygon(), KIGFX::PCB_PAINTER::draw(), DRAWSEGMENT_DESC::DRAWSEGMENT_DESC(), PCB_IO::format(), FOOTPRINT::GetCoverageArea(), CONVERT_TOOL::getStartEndPoints(), hash_fp_item(), PCB_SHAPE::HitTest(), GRAPHICS_CLEANER::isNullSegment(), FABMASTER::loadPolygon(), PCB_SHAPE::MakeEffectiveShapes(), DSN::SPECCTRA_DB::makeIMAGE(), CONVERT_TOOL::makePolysFromRects(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), CONVERT_TOOL::SegmentToArc(), AR_MATRIX::TraceSegmentPcb(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::TransferDataToWindow(), and PCB_POINT_EDITOR::updateItem().

wxPoint m_thirdPoint

Definition: pcb_shape.h:50

References PCB_SHAPE::m_thirdPoint.

◆ GetWidth()

int PCB_SHAPE::GetWidth ( ) const

inlineinherited

Definition at line 118 of file pcb_shape.h.

118 { return m_width; }

PCB_SHAPE::m_width

int m_width

Definition: pcb_shape.h:46

References PCB_SHAPE::m_width.

◆ GetX()

int BOARD_ITEM::GetX ( ) const

inlineinherited

Definition at line 97 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 103 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 ( STATUS_FLAGS aFlag ) const

inlineinherited

Definition at line 206 of file eda_item.h.

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

STATUS_FLAGS m_flags

Definition: eda_item.h:531

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

overridevirtualinherited

Test if aPosition is contained within or on the bounding box of an 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 642 of file pcb_shape.cpp.

 {
     int maxdist = aAccuracy + ( m_width / 2 );
 
     switch( m_shape )
     {
     case PCB_SHAPE_TYPE::CIRCLE:
     {
         int radius = GetRadius();
         int dist   = KiROUND( EuclideanNorm( aPosition - GetCenter() ) );
 
         if( IsFilled() )        // Filled circle hit-test
         {
             if( dist <= radius + maxdist )
                 return true;
         }
         else                    // Ring hit-test
         {
             if( abs( radius - dist ) <= maxdist )
                 return true;
         }
     }
         break;
 
     case PCB_SHAPE_TYPE::ARC:
     {
         wxPoint relPos = aPosition - GetCenter();
         int radius = GetRadius();
         int dist   = KiROUND( EuclideanNorm( relPos ) );
 
         if( abs( radius - dist ) <= maxdist )
         {
             // For arcs, the test point angle must be >= arc angle start
             // and <= arc angle end
             // However angle values > 360 deg are not easy to handle
             // so we calculate the relative angle between arc start point and teast point
             // this relative arc should be < arc angle if arc angle > 0 (CW arc)
             // and > arc angle if arc angle < 0 (CCW arc)
             double arc_angle_start = GetArcAngleStart();    // Always 0.0 ... 360 deg, in 0.1 deg
 
             double arc_hittest = ArcTangente( relPos.y, relPos.x );
 
             // Calculate relative angle between the starting point of the arc, and the test point
             arc_hittest -= arc_angle_start;
 
             // Normalise arc_hittest between 0 ... 360 deg
             NORMALIZE_ANGLE_POS( arc_hittest );
 
             // Check angle: inside the arc angle when it is > 0
             // and outside the not drawn arc when it is < 0
             if( GetAngle() >= 0.0 )
             {
                 if( arc_hittest <= GetAngle() )
                     return true;
             }
             else
             {
                 if( arc_hittest >= ( 3600.0 + GetAngle() ) )
                     return true;
             }
         }
     }
         break;
 
     case PCB_SHAPE_TYPE::CURVE:
         const_cast<PCB_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;
         }
 
         break;
 
     case PCB_SHAPE_TYPE::SEGMENT:
         if( TestSegmentHit( aPosition, m_start, m_end, maxdist ) )
             return true;
 
         break;
 
     case PCB_SHAPE_TYPE::RECT:
     {
         std::vector<wxPoint> pts = GetRectCorners();
 
         if( IsFilled() )            // Filled rect hit-test
         {
             SHAPE_POLY_SET poly;
             poly.NewOutline();
 
             for( const wxPoint& pt : pts )
                 poly.Append( pt );
 
             if( poly.Collide( VECTOR2I( aPosition ), maxdist ) )
                 return true;
         }
         else                        // Open rect hit-test
         {
             if( 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 ) )
             {
                 return true;
             }
         }
     }
         break;
 
     case PCB_SHAPE_TYPE::POLYGON:
         if( IsFilled() )
         {
             return m_poly.Collide( VECTOR2I( aPosition ), maxdist );
         }
         else
         {
             SHAPE_POLY_SET::VERTEX_INDEX dummy;
             return m_poly.CollideEdge( VECTOR2I( aPosition ), dummy, maxdist );
         }
 
         break;
 
     default:
         wxFAIL_MSG( "PCB_SHAPE::HitTest (point) not implemented for "
                     + PCB_SHAPE_TYPE_T_asString( m_shape ) );
         break;
     }
 
     return false;
 }

References SHAPE_POLY_SET::Append(), ARC, ArcTangente(), CIRCLE, SHAPE_POLY_SET::Collide(), SHAPE_POLY_SET::CollideEdge(), CURVE, dummy(), EuclideanNorm(), PCB_SHAPE::GetAngle(), PCB_SHAPE::GetArcAngleStart(), PCB_SHAPE::GetCenter(), PCB_SHAPE::GetRadius(), PCB_SHAPE::GetRectCorners(), PCB_SHAPE::IsFilled(), KiROUND(), PCB_SHAPE::m_bezierPoints, PCB_SHAPE::m_end, PCB_SHAPE::m_poly, PCB_SHAPE::m_shape, PCB_SHAPE::m_start, PCB_SHAPE::m_width, SHAPE_POLY_SET::NewOutline(), NORMALIZE_ANGLE_POS(), PCB_SHAPE_TYPE_T_asString(), POLYGON, RECT, SEGMENT, and TestSegmentHit().

Referenced by GENERAL_COLLECTOR::Inspect().

◆ HitTest() [2/2]

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

overridevirtualinherited

Test if aRect intersects or is contained within the bounding box of an 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 774 of file pcb_shape.cpp.

 {
     EDA_RECT arect = aRect;
     arect.Normalize();
     arect.Inflate( aAccuracy );
 
     EDA_RECT arcRect;
     EDA_RECT bb = GetBoundingBox();
 
     switch( m_shape )
     {
     case PCB_SHAPE_TYPE::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() );
             }
         }
         break;
 
     case PCB_SHAPE_TYPE::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() );
         }
         break;
 
     case PCB_SHAPE_TYPE::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] ) );
         }
 
         break;
 
     case PCB_SHAPE_TYPE::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() );
         }
 
         break;
 
     case PCB_SHAPE_TYPE::POLYGON:
         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 );
             int count = m_poly.TotalVertices();
 
             for( int ii = 0; ii < count; ii++ )
             {
                 auto vertex = m_poly.CVertex( ii );
                 auto vertexNext = m_poly.CVertex(( ii + 1 ) % count );
 
                 // Test if the point is within aRect
                 if( arect.Contains( ( wxPoint ) vertex ) )
                     return true;
 
                 // Test if this edge intersects aRect
                 if( arect.Intersects( ( wxPoint ) vertex, ( wxPoint ) vertexNext ) )
                     return true;
             }
         }
         break;
 
     case PCB_SHAPE_TYPE::CURVE:
         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;
             }
         }
         break;
 
 
     default:
         wxFAIL_MSG( "PCB_SHAPE::HitTest (rect) not implemented for "
                     + PCB_SHAPE_TYPE_T_asString( m_shape ) );
         break;
     }
 
     return false;
 }

References ARC, CIRCLE, EDA_RECT::Common(), EDA_RECT::Contains(), CURVE, SHAPE_POLY_SET::CVertex(), PCB_SHAPE::GetBoundingBox(), PCB_SHAPE::GetCenter(), PCB_SHAPE::GetEnd(), PCB_SHAPE::GetRadius(), PCB_SHAPE::GetRectCorners(), PCB_SHAPE::GetStart(), PCB_SHAPE::GetWidth(), EDA_RECT::Inflate(), EDA_RECT::Intersects(), EDA_RECT::IntersectsCircleEdge(), PCB_SHAPE::m_bezierPoints, PCB_SHAPE::m_poly, PCB_SHAPE::m_shape, EDA_RECT::Normalize(), PCB_SHAPE_TYPE_T_asString(), POLYGON, RECT, SEGMENT, and SHAPE_POLY_SET::TotalVertices().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 176 of file eda_item.h.

176 { return m_flags & BRIGHTENED; }

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item.h:131

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().

STATUS_FLAGS m_flags

Definition: eda_item.h:531

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 136 of file board_item.h.

     {
         return false;
     }

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 171 of file eda_item.h.

171 { return m_flags & IS_DRAGGED; }

IS_DRAGGED

#define IS_DRAGGED

Item being dragged.

Definition: eda_item.h:109

STATUS_FLAGS m_flags

Definition: eda_item.h:531

References IS_DRAGGED, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 174 of file eda_item.h.

174 { return m_flags & ENTERED; }

ENTERED

#define ENTERED

indicates a group has been entered

Definition: eda_item.h:138

Referenced by BOARD_ADAPTER::addShapeWithClearance(), KIGFX::PCB_PAINTER::draw(), PCB_IO::format(), FOOTPRINT::GetCoverageArea(), hash_fp_item(), PCB_SHAPE::HitTest(), PCB_SHAPE::MakeEffectiveShapes(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), PNS_KICAD_IFACE_BASE::syncGraphicalItem(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::TransferDataToWindow(), and PCB_SHAPE::TransformShapeWithClearanceToPolygon().

STATUS_FLAGS m_flags

Definition: eda_item.h:531

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsFilled()

bool PCB_SHAPE::IsFilled ( ) const

inlineinherited

Definition at line 96 of file pcb_shape.h.

     {
         switch( m_shape )
         {
         case PCB_SHAPE_TYPE::RECT:
         case PCB_SHAPE_TYPE::CIRCLE:
         case PCB_SHAPE_TYPE::POLYGON:
             return m_filled;
 
         case PCB_SHAPE_TYPE::SEGMENT:
         case PCB_SHAPE_TYPE::ARC:
         case PCB_SHAPE_TYPE::CURVE:
             return false;
 
         case PCB_SHAPE_TYPE::LAST: // Make CLang compiler happy
             return false;
         }
 
         return false;       // Make GCC compiler happy
     }

References ARC, CIRCLE, CURVE, LAST, PCB_SHAPE::m_filled, PCB_SHAPE::m_shape, POLYGON, RECT, and SEGMENT.

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 256 of file eda_item.h.

256 { return m_forceVisible; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:530

References EDA_ITEM::m_forceVisible.

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

◆ IsLocked()

virtual bool BOARD_ITEM::IsLocked ( ) const

inlinevirtualinherited

Returns: true if the object is locked, else false.

Reimplemented in FOOTPRINT, and PAD.

Definition at line 249 of file board_item.h.

     {
         return GetState( LOCKED );
     }

References EDA_ITEM::GetState(), and LOCKED.

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), PCB_CONTROL::DeleteItemCursor(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::FilletTracks(), PCB_IO::format(), PCB_TEXT::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), DIMENSION_BASE::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), TRACK::GetMsgPanelInfoBase_Common(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), GENERAL_COLLECTOR::Inspect(), PAD::IsLocked(), PCB_SELECTION_TOOL::itemPassesFilter(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromDrawsegments(), TRACKS_CLEANER::mergeCollinearSegments(), BOARD_EDITOR_CONTROL::modifyLockSelected(), 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::TransferDataToWindow(), and DIALOG_TEXT_PROPERTIES::TransferDataToWindow().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 168 of file eda_item.h.

168 { return m_flags & IS_CHANGED; }

IS_CHANGED

#define IS_CHANGED

Item was edited, and modified.

Definition: eda_item.h:103

STATUS_FLAGS m_flags

Definition: eda_item.h:531

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 170 of file eda_item.h.

170 { return m_flags & IS_MOVED; }

IS_MOVED

#define IS_MOVED

Item being moved.

Definition: eda_item.h:106

STATUS_FLAGS m_flags

Definition: eda_item.h:531

References IS_MOVED, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), LIB_PIN::CalcEdit(), LIB_ARC::CalcRadiusAngles(), 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 169 of file eda_item.h.

169 { return m_flags & IS_NEW; }

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), SCH_EDIT_TOOL::ConvertDeMorgan(), EDIT_TOOL::DragArcTrack(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), EE_POINT_EDITOR::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PL_POINT_EDITOR::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_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), and DIALOG_SHEET_PROPERTIES::TransferDataToWindow().

STATUS_FLAGS m_flags

Definition: eda_item.h:531

IS_NEW

#define IS_NEW

New item, just created.

Definition: eda_item.h:107

References IS_NEW, and EDA_ITEM::m_flags.

◆ IsOnCopperLayer()

virtual bool BOARD_ITEM::IsOnCopperLayer ( ) const

inlinevirtualinherited

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

Reimplemented in TRACK, PAD, and ZONE.

Definition at line 144 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, VIA, FOOTPRINT, ZONE, and PCB_GROUP.

Definition at line 231 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(), and PNS_KICAD_IFACE::IsItemVisible().

◆ IsParentFlipped()

bool FP_SHAPE::IsParentFlipped ( ) const

Definition at line 217 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 PCB_SHAPE::IsPolyShapeValid ( ) const

inherited

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

Definition at line 1215 of file pcb_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 PCB_SHAPE::GetPolyShape(), and SHAPE_LINE_CHAIN::PointCount().

Referenced by PCB_IO::format(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), and PCB_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_COMPONENT, SCH_LABEL, SCH_SHEET, SCH_TEXT, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 453 of file eda_item.h.

453 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 175 of file eda_item.h.

175 { return m_flags & IS_RESIZED; }

IS_RESIZED

#define IS_RESIZED

Item being resized.

Definition: eda_item.h:108

STATUS_FLAGS m_flags

Definition: eda_item.h:531

References IS_RESIZED, and EDA_ITEM::m_flags.

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 173 of file eda_item.h.

173 { return m_flags & SELECTED; }

SELECTED

#define SELECTED

Definition: eda_item.h:114

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(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), EE_SELECTION_TOOL::RebuildSelection(), RENDER_3D_LEGACY::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(), EE_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), KIGFX::SCH_PAINTER::setDeviceColors(), and GERBVIEW_SELECTION_TOOL::unselect().

STATUS_FLAGS m_flags

Definition: eda_item.h:531

References EDA_ITEM::m_flags, and SELECTED.

◆ 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 241 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 172 of file eda_item.h.

172 { return m_flags & IS_WIRE_IMAGE; }

IS_WIRE_IMAGE

#define IS_WIRE_IMAGE

Item to be drawn as wireframe while editing.

Definition: eda_item.h:111

Referenced by PAD::AddPrimitiveArc(), PCB_POINT_EDITOR::editArcEndpointKeepCenter(), PCB_POINT_EDITOR::editArcEndpointKeepTangent(), PCB_POINT_EDITOR::editArcMidKeepCenter(), CADSTAR_PCB_ARCHIVE_LOADER::getDrawSegmentFromVertex(), ALTIUM_PCB::HelperCreateBoardOutline(), ALTIUM_PCB::HelperParsePad6NonCopper(), ALTIUM_PCB::ParseArcs6Data(), CONVERT_TOOL::SegmentToArc(), PCB_SHAPE::SetArcGeometry(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), and updateArcFromConstructionMgr().

STATUS_FLAGS m_flags

Definition: eda_item.h:531

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 345 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 364 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 VIA.

Definition at line 72 of file board_item.cpp.

 {
     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 TRACK::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), and PAD::GetSelectMenuText().

◆ MakeEffectiveShapes()

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

inherited

Makes a set of SHAPE objects representing the PCB_SHAPE.

Caller owns the objects.

Definition at line 1086 of file pcb_shape.cpp.

 {
     std::vector<SHAPE*> effectiveShapes;
 
     switch( m_shape )
     {
     case PCB_SHAPE_TYPE::ARC:
         effectiveShapes.emplace_back( new SHAPE_ARC( GetCenter(), GetArcStart(),
                                                      GetAngle() / 10.0, m_width ) );
         break;
 
     case PCB_SHAPE_TYPE::SEGMENT:
         effectiveShapes.emplace_back( new SHAPE_SEGMENT( GetStart(), GetEnd(), m_width ) );
         break;
 
     case PCB_SHAPE_TYPE::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 PCB_SHAPE_TYPE::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 PCB_SHAPE_TYPE::CURVE:
     {
         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 PCB_SHAPE_TYPE::POLYGON:
     {
         SHAPE_LINE_CHAIN l = GetPolyShape().COutline( 0 );
         FOOTPRINT*       parentFootprint = dynamic_cast<FOOTPRINT*>( m_parent );
 
         if( parentFootprint )
         {
             l.Rotate( -parentFootprint->GetOrientationRadians() );
             l.Move( parentFootprint->GetPosition() );
         }
 
         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:
         wxFAIL_MSG( "PCB_SHAPE::MakeEffectiveShapes unsupported PCB_SHAPE shape: "
                     + PCB_SHAPE_TYPE_T_asString( m_shape ) );
         break;
     }
 
     return effectiveShapes;
 }

References SEG::A, ARC, SEG::B, PCB_SHAPE::buildBezierToSegmentsPointsList(), CIRCLE, SHAPE_ARC::ConvertToPolyline(), SHAPE_POLY_SET::COutline(), CURVE, PCB_SHAPE::GetAngle(), PCB_SHAPE::GetArcStart(), PCB_SHAPE::GetCenter(), PCB_SHAPE::GetEnd(), FOOTPRINT::GetOrientationRadians(), PCB_SHAPE::GetPolyShape(), FOOTPRINT::GetPosition(), PCB_SHAPE::GetRadius(), PCB_SHAPE::GetRectCorners(), PCB_SHAPE::GetStart(), PCB_SHAPE::GetWidth(), PCB_SHAPE::IsFilled(), EDA_ITEM::m_parent, PCB_SHAPE::m_shape, PCB_SHAPE::m_width, SHAPE_LINE_CHAIN::Move(), PCB_SHAPE_TYPE_T_asString(), POLYGON, RECT, SHAPE_LINE_CHAIN::Rotate(), SEGMENT, SHAPE_LINE_CHAIN::Segment(), and SHAPE_LINE_CHAIN::SegmentCount().

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_COMPONENT, SCH_SHEET, SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, ZONE, SCH_PIN, SCH_MARKER, PCB_MARKER, FP_TEXT, and PCB_TEXT.

Definition at line 415 of file eda_item.h.

     {
         return false;
     }

Referenced by SCH_EDITOR_CONTROL::HasMatch(), PCB_TEXT::Matches(), FP_TEXT::Matches(), PCB_MARKER::Matches(), SCH_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 116 of file eda_item.cpp.

 {
     wxString text = aText;
     wxString searchText = aSearchData.GetFindString();
 
     // Don't match if searching for replaceable item and the item doesn't support text replace.
     if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
         return false;
 
     if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
         return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
 
     if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
     {
         if( aSearchData.GetFlags() & wxFR_MATCHCASE )
             return text.Matches( searchText );
 
         return text.MakeUpper().Matches( searchText.MakeUpper() );
     }
 
     if( aSearchData.GetFlags() & wxFR_MATCHCASE )
         return aText.Find( searchText ) != wxNOT_FOUND;
 
     return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
 }

References FR_MATCH_WILDCARD, FR_SEARCH_REPLACE, EDA_ITEM::IsReplaceable(), 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 224 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 PCB_SHAPE_TYPE::ARC:
         // Update arc angle but do not yet update m_ThirdPoint0 and m_thirdPoint,
         // arc center and start point must be updated before calculation arc end.
         SetAngle( -GetAngle(), false );
         KI_FALLTHROUGH;
 
     default:
     case PCB_SHAPE_TYPE::CURVE:
     case PCB_SHAPE_TYPE::SEGMENT:
         if( aMirrorAroundXAxis )
         {
             MIRROR( m_Start0.y, aCentre.y );
             MIRROR( m_End0.y, aCentre.y );
             MIRROR( m_ThirdPoint0.y, aCentre.y );
             MIRROR( m_Bezier0_C1.y, aCentre.y );
             MIRROR( m_Bezier0_C2.y, aCentre.y );
         }
         else
         {
             MIRROR( m_Start0.x, aCentre.x );
             MIRROR( m_End0.x, aCentre.x );
             MIRROR( m_ThirdPoint0.x, aCentre.x );
             MIRROR( m_Bezier0_C1.x, aCentre.x );
             MIRROR( m_Bezier0_C2.x, aCentre.x );
         }
 
         for( unsigned ii = 0; ii < m_bezierPoints.size(); ii++ )
         {
             if( aMirrorAroundXAxis )
                 MIRROR( m_bezierPoints[ii].y, aCentre.y );
             else
                 MIRROR( m_bezierPoints[ii].x, aCentre.x );
         }
 
         break;
 
     case PCB_SHAPE_TYPE::POLYGON:
         // polygon corners coordinates are always relative to the
         // footprint position, orientation 0
         m_poly.Mirror( !aMirrorAroundXAxis, aMirrorAroundXAxis );
         break;
     }
 
     SetDrawCoord();
 }

References ARC, CURVE, PCB_SHAPE::GetAngle(), PCB_SHAPE::GetShape(), KI_FALLTHROUGH, m_Bezier0_C1, m_Bezier0_C2, PCB_SHAPE::m_bezierPoints, m_End0, PCB_SHAPE::m_poly, m_Start0, m_ThirdPoint0, MIRROR(), SHAPE_POLY_SET::Mirror(), POLYGON, SEGMENT, SetAngle(), and SetDrawCoord().

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 289 of file fp_shape.cpp.

 {
     // Move an edge of the footprint.
     // This is a footprint shape modification.
     m_Start0      += aMoveVector;
     m_End0        += aMoveVector;
     m_ThirdPoint0 += aMoveVector;
     m_Bezier0_C1  += aMoveVector;
     m_Bezier0_C2  += aMoveVector;
 
     switch( GetShape() )
     {
     default:
         break;
 
     case PCB_SHAPE_TYPE::POLYGON:
         // polygon corners coordinates are always relative to the
         // footprint position, orientation 0
         m_poly.Move( VECTOR2I( aMoveVector ) );
 
         break;
     }
 
     SetDrawCoord();
 }

References PCB_SHAPE::GetShape(), m_Bezier0_C1, m_Bezier0_C2, m_End0, PCB_SHAPE::m_poly, m_Start0, m_ThirdPoint0, SHAPE_POLY_SET::Move(), POLYGON, and SetDrawCoord().

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

◆ Move() [2/2]

void BOARD_ITEM::Move ( const VECTOR2I & aMoveVector )

inlineinherited

Definition at line 283 of file board_item.h.

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

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

◆ 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 169 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 PCB_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 S_CURVE DRAW_SEGMENT shape.

Parameters

aMinSegLen is the min length of segments approximating the shape. the last segment can be shorter This param avoid having too many very short segment in list. a good value is m_Width/2 to m_Width

Definition at line 316 of file pcb_shape.cpp.

 {
     // Has meaning only for S_CURVE DRAW_SEGMENT shape
     if( m_shape != PCB_SHAPE_TYPE::CURVE )
     {
         m_bezierPoints.clear();
         return;
     }
     // Rebuild the m_BezierPoints vertex list that approximate the Bezier curve
     m_bezierPoints = buildBezierToSegmentsPointsList( aMinSegLen );
 }

References PCB_SHAPE::buildBezierToSegmentsPointsList(), CURVE, PCB_SHAPE::m_bezierPoints, and PCB_SHAPE::m_shape.

Referenced by ConvertOutlineToPolygon(), Flip(), GRAPHICS_CLEANER::isNullSegment(), 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 143 of file eda_item.cpp.

 {
     wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
 
     int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
                                     aSearchData.GetFindString() :
                                     aSearchData.GetFindString().Upper() );
 
     if( result == wxNOT_FOUND )
         return false;
 
     wxString prefix = aText.Left( result );
     wxString suffix;
 
     if( aSearchData.GetFindString().length() + result < aText.length() )
         suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
 
     wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
                 aText, prefix, aSearchData.GetReplaceString(), suffix );
 
     aText = prefix + aSearchData.GetReplaceString() + suffix;
 
     return true;
 }

References traceFindReplace.

Referenced by SCH_FIELD::Replace(), EDA_TEXT::Replace(), 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 442 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 277 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 299 of file board_item.h.

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

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

◆ Scale()

void PCB_SHAPE::Scale ( double aScale )

inherited

Definition at line 148 of file pcb_shape.cpp.

 {
     auto scalePt = [&]( wxPoint& pt )
                    {
                        pt.x = KiROUND( pt.x * aScale );
                        pt.y = KiROUND( pt.y * aScale );
                    };
 
     int radius = GetRadius();
 
     scalePt( m_start );
     scalePt( m_end );
 
     // specific parameters:
     switch( m_shape )
     {
     case PCB_SHAPE_TYPE::CURVE:
         scalePt( m_bezierC1 );
         scalePt( m_bezierC2 );
         break;
 
     case PCB_SHAPE_TYPE::ARC:
         scalePt( m_thirdPoint );
         break;
 
     case PCB_SHAPE_TYPE::CIRCLE: //  ring or circle
         m_end.x = m_start.x + KiROUND( radius * aScale );
         m_end.y = m_start.y;
         break;
 
     case PCB_SHAPE_TYPE::POLYGON: // polygon
     {
         std::vector<wxPoint> pts;
 
         for( const VECTOR2I& pt : m_poly.Outline( 0 ).CPoints() )
         {
             pts.emplace_back( pt );
             scalePt( pts.back() );
         }
 
         SetPolyPoints( pts );
     }
         break;
 
     default:
         break;
     }
 }

References ARC, CIRCLE, SHAPE_LINE_CHAIN::CPoints(), CURVE, PCB_SHAPE::GetRadius(), KiROUND(), PCB_SHAPE::m_bezierC1, PCB_SHAPE::m_bezierC2, PCB_SHAPE::m_end, PCB_SHAPE::m_poly, PCB_SHAPE::m_shape, PCB_SHAPE::m_start, PCB_SHAPE::m_thirdPoint, SHAPE_POLY_SET::Outline(), POLYGON, and PCB_SHAPE::SetPolyPoints().

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::getDrawSegmentFromVertex().

◆ 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().

Referenced by isCoupledDiffPair().

◆ 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().

◆ SetAngle()

void FP_SHAPE::SetAngle	(	double	aAngle,
		bool	aUpdateEnd = `true`
	)

overridevirtual

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.
aUpdateEnd	= true to update also arc end coordinates m_thirdPoint and m_ThirdPoint0, so must be called after setting m_Start, m_Start0, m_End and m_End0

Reimplemented from PCB_SHAPE.

Definition at line 142 of file fp_shape.cpp.

 {
     // Mark as depreciated.
     // m_Angle does not define the arc anymore
     // Update the parent class (updates the global m_ThirdPoint)
     PCB_SHAPE::SetAngle( aAngle, aUpdateEnd );
 
     // Also update the local m_ThirdPoint0 if requested
     if( aUpdateEnd )
     {
         m_ThirdPoint0 = m_End0;
         RotatePoint( &m_ThirdPoint0, m_Start0, -m_angle );
     }
 }

References PCB_SHAPE::m_angle, m_End0, m_Start0, m_ThirdPoint0, RotatePoint(), and PCB_SHAPE::SetAngle().

Referenced by PCAD2KICAD::PCB_ARC::AddToFootprint(), PAD_TOOL::explodePad(), Flip(), Mirror(), EAGLE_PLUGIN::packageWire(), and GPCB_FPL_CACHE::parseFOOTPRINT().

◆ SetArcEnd()

void PCB_SHAPE::SetArcEnd ( const wxPoint & aArcEndPoint )

inlineinherited

Initialize the end arc point.

can be used for circles to initialize one point of the cicumference

Definition at line 222 of file pcb_shape.h.

     {
         m_thirdPoint = aArcEndPoint;
     }

References PCB_SHAPE::m_thirdPoint.

Referenced by PCB_POINT_EDITOR::editArcEndpointKeepCenter(), PCB_POINT_EDITOR::editArcEndpointKeepTangent(), PCB_POINT_EDITOR::editArcMidKeepCenter(), CONVERT_TOOL::SegmentToArc(), PCB_SHAPE::SetArcGeometry(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), and updateArcFromConstructionMgr().

◆ SetArcGeometry()

void PCB_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.

Definition at line 443 of file pcb_shape.cpp.

 {
     SetArcStart( aStart );
     SetArcEnd( aEnd );
 
     // Sadly we currently store center and angle rather than mid.  So we have to calculate
     // those.
     wxPoint  center = GetArcCenter( aStart, aMid, aEnd );
     VECTOR2D startLine = aStart - center;
     VECTOR2D endLine   = aEnd - center;
     bool     clockwise = GetAngle() > 0;
     double   angle  = RAD2DECIDEG( endLine.Angle() - startLine.Angle() );
 
     if( clockwise && angle < 0.0 )
         angle += 3600.0;
     else if( !clockwise && angle > 0.0 )
         angle -= 3600.0;
 
     SetAngle( angle, false );
     SetCenter( center );
 }

References PNS::angle(), VECTOR2< T >::Angle(), PCB_SHAPE::GetAngle(), GetArcCenter(), RAD2DECIDEG(), PCB_SHAPE::SetAngle(), PCB_SHAPE::SetArcEnd(), PCB_SHAPE::SetArcStart(), and PCB_SHAPE::SetCenter().

Referenced by PCB_POINT_EDITOR::editArcMidKeepEndpoints().

◆ SetArcStart()

void PCB_SHAPE::SetArcStart ( const wxPoint & aArcStartPoint )

inlineinherited

Initialize the start arc point.

can be used for circles to initialize one point of the cicumference

Definition at line 213 of file pcb_shape.h.

     {
         m_end = aArcStartPoint;
     }

References PCB_SHAPE::m_end.

◆ SetBezControl1()

void PCB_SHAPE::SetBezControl1 ( const wxPoint & aPoint )

inlineinherited

Definition at line 132 of file pcb_shape.h.

132 { m_bezierC1 = aPoint; }

PCB_SHAPE::m_bezierC1

wxPoint m_bezierC1

Definition: pcb_shape.h:54

References PCB_SHAPE::m_bezierC1.

Referenced by PAD::AddPrimitiveCurve(), PAD_TOOL::explodePad(), PAD_TOOL::recombinePad(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow(), and PCB_POINT_EDITOR::updateItem().

◆ SetBezControl2()

void PCB_SHAPE::SetBezControl2 ( const wxPoint & aPoint )

inlineinherited

Definition at line 135 of file pcb_shape.h.

135 { m_bezierC2 = aPoint; }

PCB_SHAPE::m_bezierC2

wxPoint m_bezierC2

Definition: pcb_shape.h:55

References PCB_SHAPE::m_bezierC2.

Referenced by PAD::AddPrimitiveCurve(), PAD_TOOL::explodePad(), PAD_TOOL::recombinePad(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), and PCB_POINT_EDITOR::updateItem().

◆ SetBezier0_C1()

void FP_SHAPE::SetBezier0_C1 ( const wxPoint & aPoint )

inline

Definition at line 120 of file fp_shape.h.

120 { m_Bezier0_C1 = aPoint; }

FP_SHAPE::m_Bezier0_C1

wxPoint m_Bezier0_C1

Bezier Control Point 1, relative to footprint origin, orient 0.

Definition: fp_shape.h:163

References m_Bezier0_C1.

Referenced by DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow().

◆ SetBezier0_C2()

void FP_SHAPE::SetBezier0_C2 ( const wxPoint & aPoint )

inline

Definition at line 123 of file fp_shape.h.

123 { m_Bezier0_C2 = aPoint; }

FP_SHAPE::m_Bezier0_C2

wxPoint m_Bezier0_C2

Bezier Control Point 2, relative to footprint origin, orient 0.

Definition: fp_shape.h:164

References m_Bezier0_C2.

Referenced by DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow().

◆ SetBezierPoints()

void PCB_SHAPE::SetBezierPoints ( const std::vector< wxPoint > & aPoints )

inlineinherited

Definition at line 278 of file pcb_shape.h.

     {
         m_bezierPoints = aPoints;
     }

References PCB_SHAPE::m_bezierPoints.

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 180 of file eda_item.h.

180 { SetFlags( BRIGHTENED ); }

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item.h:131

EDA_ITEM::SetFlags

void SetFlags(STATUS_FLAGS aMask)

Definition: eda_item.h:203

References BRIGHTENED, and EDA_ITEM::SetFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), KIGFX::SCH_PAINTER::draw(), PCB_BASE_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), PL_SELECTION_TOOL::highlight(), EE_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ SetCenter()

void PCB_SHAPE::SetCenter ( const wxPoint & aCenterPoint )

inlineinherited

For arcs and circles:

Definition at line 229 of file pcb_shape.h.

229 { m_start = aCenterPoint; }

Referenced by PAD::AddPrimitiveArc(), PCB_POINT_EDITOR::editArcEndpointKeepCenter(), PCB_POINT_EDITOR::editArcEndpointKeepTangent(), CADSTAR_PCB_ARCHIVE_LOADER::getDrawSegmentFromVertex(), ALTIUM_PCB::HelperCreateBoardOutline(), ALTIUM_PCB::HelperParsePad6NonCopper(), ALTIUM_PCB::ParseArcs6Data(), CONVERT_TOOL::SegmentToArc(), PCB_SHAPE::SetArcGeometry(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), and updateArcFromConstructionMgr().

wxPoint m_start

Definition: pcb_shape.h:48

References PCB_SHAPE::m_start.

◆ SetDrawCoord()

void FP_SHAPE::SetDrawCoord ( )

Set draw coordinates (absolute values ) from relative coordinates.

Must be called when a relative coordinate has changed in order to see the changes on screen

Definition at line 82 of file fp_shape.cpp.

 {
     FOOTPRINT* fp = static_cast<FOOTPRINT*>( m_parent );
 
     m_start      = m_Start0;
     m_end        = m_End0;
     m_thirdPoint = m_ThirdPoint0;
     m_bezierC1   = m_Bezier0_C1;
     m_bezierC2   = m_Bezier0_C2;
 
     if( fp )
     {
         RotatePoint( &m_start.x, &m_start.y, fp->GetOrientation() );
         RotatePoint( &m_end.x, &m_end.y, fp->GetOrientation() );
         RotatePoint( &m_thirdPoint.x, &m_thirdPoint.y, fp->GetOrientation() );
         RotatePoint( &m_bezierC1.x, &m_bezierC1.y, fp->GetOrientation() );
         RotatePoint( &m_bezierC2.x, &m_bezierC2.y, fp->GetOrientation() );
 
         m_start      += fp->GetPosition();
         m_end        += fp->GetPosition();
         m_thirdPoint += fp->GetPosition();
         m_bezierC1   += fp->GetPosition();
         m_bezierC2   += fp->GetPosition();
     }
 
     RebuildBezierToSegmentsPointsList( m_width );
 }

References FOOTPRINT::GetOrientation(), FOOTPRINT::GetPosition(), m_Bezier0_C1, m_Bezier0_C2, PCB_SHAPE::m_bezierC1, PCB_SHAPE::m_bezierC2, PCB_SHAPE::m_end, m_End0, EDA_ITEM::m_parent, PCB_SHAPE::m_start, m_Start0, PCB_SHAPE::m_thirdPoint, m_ThirdPoint0, PCB_SHAPE::m_width, PCB_SHAPE::RebuildBezierToSegmentsPointsList(), and RotatePoint().

Referenced by PCAD2KICAD::PCB_ARC::AddToFootprint(), PCAD2KICAD::PCB_LINE::AddToFootprint(), PCAD2KICAD::PCB_POLYGON::AddToFootprint(), LEGACY_PLUGIN::loadFP_SHAPE(), Mirror(), Move(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageWire(), GPCB_FPL_CACHE::parseFOOTPRINT(), PCB_PARSER::parseFOOTPRINT_unchecked(), and FOOTPRINT::SetPosition().

◆ SetEnd()

void PCB_SHAPE::SetEnd ( const wxPoint & aEnd )

inlineinherited

Definition at line 159 of file pcb_shape.h.

159 { m_end = aEnd; }

Referenced by PCB_POINT_EDITOR::addCorner(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToBoard(), MICROWAVE_TOOL::createMicrowaveInductor(), PAD_TOOL::explodePad(), CADSTAR_PCB_ARCHIVE_LOADER::getDrawSegmentFromVertex(), ALTIUM_PCB::HelperCreateBoardOutline(), ALTIUM_PCB::HelperParseDimensions6Leader(), ALTIUM_PCB::HelperParsePad6NonCopper(), EAGLE_PLUGIN::loadPlain(), GRAPHICS_CLEANER::mergeRects(), ALTIUM_PCB::ParseTracks6Data(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotPcbTarget(), CONVERT_TOOL::PolyToLines(), PAD_TOOL::recombinePad(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow(), PCB_POINT_EDITOR::updateItem(), and updateSegmentFromGeometryMgr().

wxPoint m_end

Definition: pcb_shape.h:49

References PCB_SHAPE::m_end.

◆ SetEnd0()

void FP_SHAPE::SetEnd0 ( const wxPoint & aPoint )

inline

Definition at line 114 of file fp_shape.h.

114 { m_End0 = aPoint; }

FP_SHAPE::m_End0

wxPoint m_End0

End point, relative to footprint origin, orient 0.

Definition: fp_shape.h:161

References m_End0.

Referenced by PCAD2KICAD::PCB_POLYGON::AddToFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), EAGLE_PLUGIN::packageWire(), GPCB_FPL_CACHE::parseFOOTPRINT(), CONVERT_TOOL::PolyToLines(), and DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow().

◆ SetEndX()

void PCB_SHAPE::SetEndX ( int x )

inlineinherited

Definition at line 161 of file pcb_shape.h.

161 { m_end.x = x; }

wxPoint m_end

Definition: pcb_shape.h:49

References PCB_SHAPE::m_end.

Referenced by DRAWSEGMENT_DESC::DRAWSEGMENT_DESC(), initTextTable(), DRAWING_TOOL::PlaceCharacteristics(), DRAWING_TOOL::PlaceStackup(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), and PCB_POINT_EDITOR::updateItem().

◆ SetEndY()

void PCB_SHAPE::SetEndY ( int y )

inlineinherited

Definition at line 160 of file pcb_shape.h.

160 { m_end.y = y; }

Referenced by PAD::AddPrimitiveArc(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitivePoly(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), PCAD2KICAD::PCB_ARC::AddToBoard(), ZONE_CREATE_HELPER::commitZone(), MICROWAVE_TOOL::createPolygonShape(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarShape(), PAD_TOOL::explodePad(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), ALTIUM_PCB::HelperParsePad6NonCopper(), CONVERT_TOOL::LinesToPoly(), FABMASTER::loadGraphics(), EAGLE_PLUGIN::loadPlain(), FABMASTER::loadPolygon(), GRAPHICS_CLEANER::mergeRects(), DIALOG_PAD_PROPERTIES::onAddPrimitive(), ALTIUM_PCB::ParseFills6Data(), ALTIUM_PCB::ParseShapeBasedRegions6Data(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotPcbTarget(), PAD_TOOL::recombinePad(), CONVERT_TOOL::SegmentToArc(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow(), and DIALOG_PAD_PRIMITIVE_POLY_PROPS::TransferDataFromWindow().

wxPoint m_end

Definition: pcb_shape.h:49

References PCB_SHAPE::m_end.

Referenced by DRAWSEGMENT_DESC::DRAWSEGMENT_DESC(), initTextTable(), DRAWING_TOOL::PlaceCharacteristics(), DRAWING_TOOL::PlaceStackup(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), and PCB_POINT_EDITOR::updateItem().

◆ SetFilled()

void PCB_SHAPE::SetFilled ( bool aFlag )

inlineinherited

Definition at line 94 of file pcb_shape.h.

94 { m_filled = aFlag; }

PCB_SHAPE::m_filled

bool m_filled

Definition: pcb_shape.h:47

References PCB_SHAPE::m_filled.

◆ SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS aMask )

inlineinherited

Definition at line 203 of file eda_item.h.

203 { m_flags |= aMask; }

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PNS_KICAD_IFACE::AddItem(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCB_ARC::AddToFootprint(), PCAD2KICAD::PCB_LINE::AddToFootprint(), PCAD2KICAD::PCB_POLYGON::AddToFootprint(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), BOOST_AUTO_TEST_CASE(), ZONE_CREATE_HELPER::commitZone(), MICROWAVE_TOOL::createMicrowaveInductor(), PCB_BASE_FRAME::CreateNewFootprint(), MICROWAVE_TOOL::createPolygonShape(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawBoardCharacteristics(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarShape(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawSpecificationStackup(), PAD_TOOL::explodePad(), EDIT_TOOL::FilletTracks(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), TRACK::Flip(), Flip(), FP_TEXT::Flip(), FOOTPRINT::Flip(), ARC::Flip(), PCB_SHAPE::Flip(), FOOTPRINT_DESC::FOOTPRINT_DESC(), FP_TEXT::FP_TEXT(), ALTIUM_PCB::HelperCreateBoardOutline(), ALTIUM_PCB::HelperParseDimensions6Datum(), ALTIUM_PCB::HelperParseDimensions6Leader(), ALTIUM_PCB::HelperParsePad6NonCopper(), initTextTable(), CONVERT_TOOL::LinesToPoly(), LEGACY_PLUGIN::loadFOOTPRINT(), FABMASTER::loadFootprints(), FABMASTER::loadGraphics(), LEGACY_PLUGIN::loadMODULE_TEXT(), CADSTAR_PCB_ARCHIVE_LOADER::loadNetTracks(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), FABMASTER::loadPolygon(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), main(), DSN::SPECCTRA_DB::makeTRACK(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromDrawsegments(), GRAPHICS_CLEANER::mergeRects(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), EAGLE_PLUGIN::packageText(), EAGLE_PLUGIN::packageWire(), ALTIUM_PCB::ParseArcs6Data(), ALTIUM_PCB::ParseComponents6Data(), ALTIUM_PCB::ParseFills6Data(), GPCB_FPL_CACHE::parseFOOTPRINT(), ALTIUM_PCB::ParseShapeBasedRegions6Data(), ALTIUM_PCB::ParseTexts6Data(), ALTIUM_PCB::ParseTracks6Data(), DRAWING_TOOL::PlaceCharacteristics(), DRAWING_TOOL::PlaceStackup(), BOARD_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotPcbTarget(), CONVERT_TOOL::PolyToLines(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), processTextItem(), PNS_PCBNEW_RULE_RESOLVER::QueryConstraint(), DIALOG_PAD_PROPERTIES::redraw(), CLIPBOARD_IO::SaveSelection(), CONVERT_TOOL::SegmentToArc(), DIMENSION_BASE::SetLayer(), GLOBAL_EDIT_TOOL::swapBoardItem(), TRACK_VIA_DESC::TRACK_VIA_DESC(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

STATUS_FLAGS m_flags

Definition: eda_item.h:531

References EDA_ITEM::m_flags.

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool aEnable )

inlineinherited

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.

Parameters

aEnable True forces the item to be drawn. False uses the item's visibility setting to determine if the item is to be drawn.

Definition at line 254 of file eda_item.h.

254 { m_forceVisible = aEnable; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:530

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetLayer()

virtual void BOARD_ITEM::SetLayer ( PCB_LAYER_ID aLayer )

inlinevirtualinherited

Set the layer this item is on.

This method is virtual because some items (in fact: class DIMENSION) have a slightly different initialization.

Parameters

aLayer The layer number.

Reimplemented in DIMENSION_BASE, ZONE, and PCB_GROUP.

Definition at line 194 of file board_item.h.

     {
         m_layer = aLayer;
     }

References BOARD_ITEM::m_layer.

◆ SetLayerSet()

virtual void BOARD_ITEM::SetLayerSet ( LSET aLayers )

inlinevirtualinherited

Reimplemented in VIA, PAD, and ZONE.

Definition at line 179 of file board_item.h.

     {
         wxFAIL_MSG( "Attempted to SetLayerSet() on a single-layer object." );
 
         // Derived classes which support multiple layers must implement this
     }

Referenced by PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ SetLocalCoord()

void FP_SHAPE::SetLocalCoord ( )

Set relative coordinates from draw coordinates.

Call in only when the geometry or the footprint is modified and therefore the relative coordinates have to be updated from the draw coordinates.

Definition at line 54 of file fp_shape.cpp.

 {
     FOOTPRINT* fp = static_cast<FOOTPRINT*>( m_parent );
 
     if( fp == NULL )
     {
         m_Start0 = m_start;
         m_End0 = m_end;
         m_ThirdPoint0 = m_thirdPoint;
         m_Bezier0_C1 = m_bezierC1;
         m_Bezier0_C2 = m_bezierC2;
         return;
     }
 
     m_Start0 = m_start - fp->GetPosition();
     m_End0 = m_end - fp->GetPosition();
     m_ThirdPoint0 = m_thirdPoint - fp->GetPosition();
     m_Bezier0_C1 = m_bezierC1 - fp->GetPosition();
     m_Bezier0_C2 = m_bezierC2 - fp->GetPosition();
     double angle = fp->GetOrientation();
     RotatePoint( &m_Start0.x, &m_Start0.y, -angle );
     RotatePoint( &m_End0.x, &m_End0.y, -angle );
     RotatePoint( &m_ThirdPoint0.x, &m_ThirdPoint0.y, -angle );
     RotatePoint( &m_Bezier0_C1.x, &m_Bezier0_C1.y, -angle );
     RotatePoint( &m_Bezier0_C2.x, &m_Bezier0_C2.y, -angle );
 }

References PNS::angle(), FOOTPRINT::GetOrientation(), FOOTPRINT::GetPosition(), m_Bezier0_C1, m_Bezier0_C2, PCB_SHAPE::m_bezierC1, PCB_SHAPE::m_bezierC2, PCB_SHAPE::m_end, m_End0, EDA_ITEM::m_parent, PCB_SHAPE::m_start, m_Start0, PCB_SHAPE::m_thirdPoint, m_ThirdPoint0, NULL, and RotatePoint().

Referenced by PAD_TOOL::explodePad(), ALTIUM_PCB::HelperDrawsegmentSetLocalCoord(), PCB_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), and Rotate().

◆ SetLocked()

virtual void BOARD_ITEM::SetLocked ( bool aLocked )

inlinevirtualinherited

Modify the 'lock' status for of the item.

Reimplemented in FOOTPRINT.

Definition at line 257 of file board_item.h.

     {
         SetState( LOCKED, aLocked );
     }

References LOCKED, and EDA_ITEM::SetState().

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), ZONE_SETTINGS::ExportSetting(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), CADSTAR_PCB_ARCHIVE_LOADER::loadGroups(), CADSTAR_PCB_ARCHIVE_LOADER::loadNetTracks(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromDrawsegments(), BOARD_EDITOR_CONTROL::modifyLockSelected(), ALTIUM_PCB::ParsePolygons6Data(), processTextItem(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 63 of file eda_item.cpp.

 {
     SetFlags( IS_CHANGED );
 
     // If this a child object, then the parent modification state also needs to be set.
     if( m_parent )
         m_parent->SetModified();
 }

References IS_CHANGED, EDA_ITEM::m_parent, EDA_ITEM::SetFlags(), and EDA_ITEM::SetModified().

Referenced by SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), LEGACY_PLUGIN::loadZONE_CONTAINER(), SCH_LINE::Move(), SCH_COMPONENT::Move(), SCH_LINE::MoveEnd(), SCH_LINE::MoveStart(), LIB_PIN::MoveTo(), PCB_EDIT_FRAME::OpenProjectFiles(), ALTIUM_PCB::Parse(), SCH_ALTIUM_PLUGIN::ParseFileHeader(), LIB_PART::RemoveDrawItem(), SCH_COMPONENT::SetConvert(), SCH_COMPONENT::SetLibId(), EDA_ITEM::SetModified(), LIB_FIELD::SetName(), SCH_COMPONENT::SetTransform(), and SCH_COMPONENT::SetUnit().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlinevirtualinherited

Reimplemented in DIMENSION_BASE.

Definition at line 166 of file eda_item.h.

166 { m_parent = aParent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:529

References EDA_ITEM::m_parent.

Referenced by FOOTPRINT::Add(), BOARD::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewComponent(), SCH_SHEET::AddPin(), PAD::AddPrimitive(), PAD::AddPrimitiveArc(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitivePoly(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), LIB_FIELD::Copy(), SYMBOL_EDIT_FRAME::CreateNewPart(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SCH_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_PART::Flatten(), FOOTPRINT::FOOTPRINT(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), LIB_PART::LIB_PART(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), FOOTPRINT::operator=(), LIB_PART::operator=(), PCB_PARSER::parseFOOTPRINT_unchecked(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BACK_ANNOTATE::processNetNameChange(), BOARD_COMMIT::Push(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SaveCopyOfZones(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_PART::SetFields(), DIMENSION_BASE::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_SHEET::SwapData(), SCH_GLOBALLABEL::SwapData(), SCH_COMPONENT::SwapData(), and SwapItemData().

◆ SetParentGroup()

void BOARD_ITEM::SetParentGroup ( PCB_GROUP * aGroup )

inlineinherited

Definition at line 92 of file board_item.h.

92 { m_group = aGroup; }

BOARD_ITEM::m_group

PCB_GROUP * m_group

Definition: board_item.h:364

References BOARD_ITEM::m_group.

Referenced by PCB_GROUP::AddItem(), and PCB_GROUP::RemoveItem().

◆ SetPolyPoints()

void PCB_SHAPE::SetPolyPoints ( const std::vector< wxPoint > & aPoints )

inherited

Definition at line 1076 of file pcb_shape.cpp.

 {
     m_poly.RemoveAllContours();
     m_poly.NewOutline();
 
     for ( const wxPoint& p : aPoints )
         m_poly.Append( p.x, p.y );
 }

References SHAPE_POLY_SET::Append(), PCB_SHAPE::m_poly, SHAPE_POLY_SET::NewOutline(), and SHAPE_POLY_SET::RemoveAllContours().

Referenced by PAD::AddPrimitivePoly(), PCAD2KICAD::PCB_POLYGON::AddToFootprint(), MICROWAVE_TOOL::createPolygonShape(), ALTIUM_PCB::HelperParsePad6NonCopper(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), ALTIUM_PCB::ParseFills6Data(), PCB_SHAPE::Scale(), and DIALOG_PAD_PRIMITIVE_POLY_PROPS::TransferDataFromWindow().

◆ SetPolyShape()

void PCB_SHAPE::SetPolyShape ( const SHAPE_POLY_SET & aShape )

inlineinherited

Definition at line 276 of file pcb_shape.h.

276 { m_poly = aShape; }

PCB_SHAPE::m_poly

SHAPE_POLY_SET m_poly

Definition: pcb_shape.h:58

References PCB_SHAPE::m_poly.

Referenced by ZONE_CREATE_HELPER::commitZone(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarShape(), PAD_TOOL::explodePad(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), CONVERT_TOOL::LinesToPoly(), FABMASTER::loadGraphics(), FABMASTER::loadPolygon(), ALTIUM_PCB::ParseShapeBasedRegions6Data(), and PAD_TOOL::recombinePad().

◆ SetPosition()

void PCB_SHAPE::SetPosition ( const wxPoint & aPos )

overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 62 of file pcb_shape.cpp.

 {
     m_start = aPos;
 }

References PCB_SHAPE::m_start.

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 179 of file eda_item.h.

179 { SetFlags( SELECTED ); }

EDA_ITEM::SetFlags

void SetFlags(STATUS_FLAGS aMask)

Definition: eda_item.h:203

SELECTED

#define SELECTED

Definition: eda_item.h:114

References SELECTED, and EDA_ITEM::SetFlags().

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), KIGFX::SCH_PAINTER::draw(), PL_SELECTION_TOOL::highlight(), EE_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), DS_PROXY_UNDO_ITEM::Restore(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), and GERBVIEW_SELECTION_TOOL::selectVisually().

◆ SetShape()

void PCB_SHAPE::SetShape ( PCB_SHAPE_TYPE aShape )

inlineinherited

Definition at line 129 of file pcb_shape.h.

129 { m_shape = aShape; }

PCB_SHAPE::m_shape

PCB_SHAPE_TYPE m_shape

Definition: pcb_shape.h:52

References PCB_SHAPE::m_shape.

Referenced by PAD::AddPrimitiveArc(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitivePoly(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), PCAD2KICAD::PCB_ARC::AddToBoard(), ZONE_CREATE_HELPER::commitZone(), MICROWAVE_TOOL::createMicrowaveInductor(), MICROWAVE_TOOL::createPolygonShape(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::drawArc(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarShape(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), PAD_TOOL::explodePad(), CADSTAR_PCB_ARCHIVE_LOADER::getDrawSegmentFromVertex(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), ALTIUM_PCB::HelperCreateBoardOutline(), ALTIUM_PCB::HelperParseDimensions6Datum(), ALTIUM_PCB::HelperParseDimensions6Leader(), ALTIUM_PCB::HelperParsePad6NonCopper(), CONVERT_TOOL::LinesToPoly(), FABMASTER::loadGraphics(), EAGLE_PLUGIN::loadPlain(), FABMASTER::loadPolygon(), GRAPHICS_CLEANER::mergeRects(), DIALOG_PAD_PROPERTIES::onAddPrimitive(), ALTIUM_PCB::ParseArcs6Data(), ALTIUM_PCB::ParseFills6Data(), GPCB_FPL_CACHE::parseFOOTPRINT(), ALTIUM_PCB::ParseShapeBasedRegions6Data(), ALTIUM_PCB::ParseTracks6Data(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotPcbTarget(), CONVERT_TOOL::PolyToLines(), PAD_TOOL::recombinePad(), and CONVERT_TOOL::SegmentToArc().

◆ SetStart()

void PCB_SHAPE::SetStart ( const wxPoint & aStart )

inlineinherited

Definition at line 148 of file pcb_shape.h.

148 { m_start = aStart; }

Referenced by PCB_POINT_EDITOR::addCorner(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToBoard(), MICROWAVE_TOOL::createMicrowaveInductor(), PAD_TOOL::explodePad(), CADSTAR_PCB_ARCHIVE_LOADER::getDrawSegmentFromVertex(), ALTIUM_PCB::HelperCreateBoardOutline(), ALTIUM_PCB::HelperParseDimensions6Datum(), ALTIUM_PCB::HelperParseDimensions6Leader(), ALTIUM_PCB::HelperParsePad6NonCopper(), EAGLE_PLUGIN::loadPlain(), GRAPHICS_CLEANER::mergeRects(), ALTIUM_PCB::ParseTracks6Data(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotPcbTarget(), CONVERT_TOOL::PolyToLines(), PAD_TOOL::recombinePad(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow(), PCB_POINT_EDITOR::updateItem(), and updateSegmentFromGeometryMgr().

wxPoint m_start

Definition: pcb_shape.h:48

References PCB_SHAPE::m_start.

◆ SetStart0()

void FP_SHAPE::SetStart0 ( const wxPoint & aPoint )

inline

Definition at line 111 of file fp_shape.h.

111 { m_Start0 = aPoint; }

FP_SHAPE::m_Start0

wxPoint m_Start0

Start point or center, relative to footprint origin, orient 0.

Definition: fp_shape.h:160

References m_Start0.

Referenced by PCAD2KICAD::PCB_POLYGON::AddToFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), EAGLE_PLUGIN::packageWire(), GPCB_FPL_CACHE::parseFOOTPRINT(), CONVERT_TOOL::PolyToLines(), and DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow().

◆ SetStartX()

void PCB_SHAPE::SetStartX ( int x )

inlineinherited

Definition at line 150 of file pcb_shape.h.

150 { m_start.x = x; }

wxPoint m_start

Definition: pcb_shape.h:48

References PCB_SHAPE::m_start.

Referenced by initTextTable(), DRAWING_TOOL::PlaceCharacteristics(), DRAWING_TOOL::PlaceStackup(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), and PCB_POINT_EDITOR::updateItem().

◆ SetStartY()

void PCB_SHAPE::SetStartY ( int y )

inlineinherited

Definition at line 149 of file pcb_shape.h.

149 { m_start.y = y; }

wxPoint m_start

Definition: pcb_shape.h:48

References PCB_SHAPE::m_start.

Referenced by initTextTable(), DRAWING_TOOL::PlaceCharacteristics(), DRAWING_TOOL::PlaceStackup(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), and PCB_POINT_EDITOR::updateItem().

◆ SetState()

void EDA_ITEM::SetState	(	int	type,
		bool	state
	)

inlineinherited

Definition at line 192 of file eda_item.h.

     {
         if( state )
             m_status |= type; // state = ON or OFF
         else
             m_status &= ~type;
     }

References EDA_ITEM::m_status.

Referenced by LEGACY_PLUGIN::loadTrackList(), TRACKS_CLEANER::mergeCollinearSegments(), and BOARD_ITEM::SetLocked().

◆ SetStatus()

void EDA_ITEM::SetStatus ( STATUS_FLAGS aStatus )

inlineinherited

Definition at line 201 of file eda_item.h.

201 { m_status = aStatus; }

EDA_ITEM::m_status

STATUS_FLAGS m_status

Definition: eda_item.h:528

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetThirdPoint()

void PCB_SHAPE::SetThirdPoint ( const wxPoint & aPoint )

inlineinherited

Definition at line 170 of file pcb_shape.h.

170 { m_thirdPoint = aPoint; }

wxPoint m_thirdPoint

Definition: pcb_shape.h:50

References PCB_SHAPE::m_thirdPoint.

◆ SetThirdPoint0()

void FP_SHAPE::SetThirdPoint0 ( const wxPoint & aPoint )

inline

Definition at line 117 of file fp_shape.h.

117 { m_ThirdPoint0 = aPoint; }

FP_SHAPE::m_ThirdPoint0

wxPoint m_ThirdPoint0

End point for an arc.

Definition: fp_shape.h:162

References m_ThirdPoint0.

◆ SetThirdPointX()

void PCB_SHAPE::SetThirdPointX ( int x )

inlineinherited

Definition at line 172 of file pcb_shape.h.

172 { m_thirdPoint.x = x; }

wxPoint m_thirdPoint

Definition: pcb_shape.h:50

References PCB_SHAPE::m_thirdPoint.

◆ SetThirdPointY()

void PCB_SHAPE::SetThirdPointY ( int y )

inlineinherited

Definition at line 171 of file pcb_shape.h.

171 { m_thirdPoint.y = y; }