KiCad PCB EDA Suite: PCB_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().

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References EDA_ITEM::m_flags.

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 132 of file eda_item.h.

132 { ClearFlags( SELECTED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:154

SELECTED

#define SELECTED

Definition: eda_item_flags.h:48

References EDA_ITEM::ClearFlags(), and SELECTED.

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

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 166 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 * PCB_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 EDA_ITEM.

Reimplemented in FP_SHAPE.

Definition at line 1022 of file pcb_shape.cpp.

 {
     return new PCB_SHAPE( *this );
 }

References PCB_SHAPE().

Referenced by DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run().

◆ computeArcBBox()

void PCB_SHAPE::computeArcBBox ( EDA_RECT & aBBox ) const

protected

Definition at line 1085 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(), GetArcAngleStart(), GetRadius(), EDA_RECT::Inflate(), m_angle, m_end, m_start, m_width, EDA_RECT::Merge(), RotatePoint(), and EDA_RECT::SetOrigin().

Referenced by GetBoundingBox(), and ViewBBox().

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )

inherited

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

Definition at line 140 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 200 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().

◆ DupPolyPointsList()

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

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

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

Definition at line 1277 of file pcb_shape.cpp.

 {
     if( m_poly.OutlineCount() )
     {
         int pointCount = m_poly.COutline( 0 ).PointCount();
 
         if( pointCount )
         {
             aBuffer.reserve( pointCount );
 
             for ( auto iter = m_poly.CIterate(); iter; iter++ )
                 aBuffer.emplace_back( iter->x, iter->y );
         }
     }
 }

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

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

◆ Flip() [1/2]

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

overridevirtual

Flip this object, i.e.

change the board side for this object.

Parameters

aCentre	the rotation point.
aFlipLeftRight	mirror across Y axis instead of X (the default).

Reimplemented from BOARD_ITEM.

Reimplemented in FP_SHAPE.

Definition at line 296 of file pcb_shape.cpp.

 {
     if( aFlipLeftRight )
     {
         m_start.x = aCentre.x - ( m_start.x - aCentre.x );
         m_end.x   = aCentre.x - ( m_end.x - aCentre.x );
     }
     else
     {
         m_start.y = aCentre.y - ( m_start.y - aCentre.y );
         m_end.y   = aCentre.y - ( m_end.y - aCentre.y );
     }
 
     switch ( m_shape )
     {
     case SHAPE_T::ARC:
         if( aFlipLeftRight )
             m_thirdPoint.x   = aCentre.x - ( m_thirdPoint.x - aCentre.x );
         else
             m_thirdPoint.y   = aCentre.y - ( m_thirdPoint.y - aCentre.y );
 
         m_angle = -m_angle;
         break;
 
     case SHAPE_T::POLY:
         m_poly.Mirror( aFlipLeftRight, !aFlipLeftRight, VECTOR2I( aCentre ) );
         break;
 
     case SHAPE_T::BEZIER:
         {
             if( aFlipLeftRight )
             {
                 m_bezierC1.x = aCentre.x - ( m_bezierC1.x - aCentre.x );
                 m_bezierC2.x = aCentre.x - ( m_bezierC2.x - aCentre.x );
             }
             else
             {
                 m_bezierC1.y = aCentre.y - ( m_bezierC1.y - aCentre.y );
                 m_bezierC2.y = aCentre.y - ( m_bezierC2.y - aCentre.y );
             }
 
             // Rebuild the poly points shape
             std::vector<wxPoint> ctrlPoints = { m_start, m_bezierC1, m_bezierC2, m_end };
             BEZIER_POLY converter( ctrlPoints );
             converter.GetPoly( m_bezierPoints, m_width );
         }
         break;
 
     case SHAPE_T::SEGMENT:
     case SHAPE_T::RECT:
     case SHAPE_T::CIRCLE:
         break;
 
     default:
         wxFAIL_MSG( "PCB_SHAPE::Flip not implemented for "
                     + SHAPE_T_asString( m_shape ) );
         break;
     }
 
     SetLayer( FlipLayer( GetLayer(), GetBoard()->GetCopperLayerCount() ) );
 }

References ARC, BEZIER, CIRCLE, FlipLayer(), BOARD_ITEM::GetBoard(), BOARD_ITEM::GetLayer(), BEZIER_POLY::GetPoly(), m_angle, m_bezierC1, m_bezierC2, m_bezierPoints, m_end, m_poly, m_shape, m_start, m_thirdPoint, m_width, SHAPE_POLY_SET::Mirror(), POLY, RECT, SEGMENT, BOARD_ITEM::SetLayer(), and SHAPE_T_asString().

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex().

◆ Flip() [2/2]

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

inlineinherited

Definition at line 304 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 = T();
 
         if( prop )
         {
             void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
 
             if( object )
                 ret = prop->get<T>( object );
         }
 
         return ret;
     }

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

◆ GetAngle()

double PCB_SHAPE::GetAngle ( ) const

inline

Definition at line 107 of file pcb_shape.h.

107 { return m_angle; }

PCB_SHAPE::m_angle

double m_angle

Definition: pcb_shape.h:350

References m_angle.

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

◆ GetArcAngleEnd()

double PCB_SHAPE::GetArcAngleEnd ( ) const

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

Definition at line 472 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 mapping between -180 ... 180 deg.
     // and this is not easy to handle in calculations
     NORMALIZE_ANGLE_POS( angleStart );
 
     return angleStart;
 }

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

Referenced by DSN::SPECCTRA_DB::makeIMAGE().

◆ GetArcAngleStart()

double PCB_SHAPE::GetArcAngleStart ( ) const

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

Definition at line 457 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 mapping between -180 ... 180 deg.
     // and this is not easy to handle in calculations
     NORMALIZE_ANGLE_POS( angleStart );
 
     return angleStart;
 }

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

Referenced by computeArcBBox(), KIGFX::PCB_PAINTER::draw(), HitTest(), and DSN::SPECCTRA_DB::makeIMAGE().

◆ GetArcEnd()

wxPoint PCB_SHAPE::GetArcEnd ( ) const

Definition at line 417 of file pcb_shape.cpp.

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

References ARC, m_end, m_shape, and m_thirdPoint.

Referenced by PCB_GRID_HELPER::computeAnchors(), ConvertOutlineToPolygon(), PCB_POINT_EDITOR::editArcEndpointKeepTangent(), GetArcAngleEnd(), CONVERT_TOOL::getStartEndPoints(), DSN::SPECCTRA_DB::makeIMAGE(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromSegs(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), TransformShapeWithClearanceToPolygon(), and PCB_POINT_EDITOR::updatePoints().

◆ GetArcMid()

wxPoint PCB_SHAPE::GetArcMid ( ) const

Definition at line 435 of file pcb_shape.cpp.

 {
     wxPoint endPoint( m_end );
 
     switch( m_shape )
     {
     case SHAPE_T::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 center
         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, m_angle, m_end, m_shape, m_start, and RotatePoint().

Referenced by PCB_GRID_HELPER::computeAnchors(), PCB_POINT_EDITOR::editArcMidKeepEndpoints(), GetFocusPosition(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromSegs(), TransformShapeWithClearanceToPolygon(), and PCB_POINT_EDITOR::updatePoints().

◆ GetArcStart()

wxPoint PCB_SHAPE::GetArcStart ( ) const

inline

Definition at line 156 of file pcb_shape.h.

156 { return m_end; }

Referenced by BOARD_ADAPTER::addShapeWithClearance(), GRAPHICS_CLEANER::areEquivalent(), PCB_GRID_HELPER::computeAnchors(), ConvertOutlineToPolygon(), PCB_POINT_EDITOR::editArcEndpointKeepCenter(), PCB_POINT_EDITOR::editArcEndpointKeepTangent(), GetArcAngleStart(), CONVERT_TOOL::getStartEndPoints(), idf_export_outline(), GRAPHICS_CLEANER::isNullShape(), MakeEffectiveShapes(), DSN::SPECCTRA_DB::makeIMAGE(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromSegs(), PCB_PARSER::parsePAD(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), TransformShapeWithClearanceToPolygon(), and PCB_POINT_EDITOR::updatePoints().

wxPoint m_end

Definition: pcb_shape.h:346

References m_end.

◆ GetBezierC1()

const wxPoint& PCB_SHAPE::GetBezierC1 ( ) const

inline

Definition at line 113 of file pcb_shape.h.

113 { return m_bezierC1; }

PCB_SHAPE::m_bezierC1

wxPoint m_bezierC1

Definition: pcb_shape.h:351

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

◆ GetBezierC2()

const wxPoint& PCB_SHAPE::GetBezierC2 ( ) const

inline

Definition at line 116 of file pcb_shape.h.

116 { return m_bezierC2; }

PCB_SHAPE::m_bezierC2

wxPoint m_bezierC2

Definition: pcb_shape.h:352

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

◆ GetBezierPoints()

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

inline

Definition at line 223 of file pcb_shape.h.

223 { return m_bezierPoints; }

PCB_SHAPE::m_bezierPoints

std::vector< wxPoint > m_bezierPoints

Definition: pcb_shape.h:354

References m_bezierPoints.

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

◆ GetBoard() [1/2]

const BOARD * BOARD_ITEM::GetBoard ( ) const

virtualinherited

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

Definition at line 50 of file board_item.cpp.

 {
     if( Type() == PCB_T )
         return static_cast<const BOARD*>( this );
 
     BOARD_ITEM* parent = GetParent();
 
     if( parent )
         return parent->GetBoard();
 
     return nullptr;
 }

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

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

◆ GetBoard() [2/2]

BOARD * BOARD_ITEM::GetBoard ( )

virtualinherited

Definition at line 64 of file board_item.cpp.

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

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

◆ GetBoundingBox()

const EDA_RECT PCB_SHAPE::GetBoundingBox ( ) const

overridevirtual

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

 {
     EDA_RECT bbox;
 
     bbox.SetOrigin( m_start );
 
     switch( m_shape )
     {
     case SHAPE_T::RECT:
     {
         std::vector<wxPoint> pts = GetRectCorners();
 
         bbox = EDA_RECT();  // re-init for merging
 
         for( wxPoint& pt : pts )
             bbox.Merge( pt );
 
         break;
     }
 
     case SHAPE_T::SEGMENT:
         bbox.SetEnd( m_end );
         break;
 
     case SHAPE_T::CIRCLE:
         bbox.Inflate( GetRadius() );
         break;
 
     case SHAPE_T::ARC:
         computeArcBBox( bbox );
         break;
 
     case SHAPE_T::POLY:
     {
         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 SHAPE_T::BEZIER:
         bbox.Merge( m_bezierC1 );
         bbox.Merge( m_bezierC2 );
         bbox.Merge( m_end );
         break;
 
     default:
         wxFAIL_MSG( "PCB_SHAPE::GetBoundingBox not implemented for "
                     + SHAPE_T_asString( m_shape ) );
         break;
     }
 
     bbox.Inflate( m_width / 2 );
     bbox.Normalize();
 
     return bbox;
 }

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

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

◆ GetCenter()

wxPoint PCB_SHAPE::GetCenter ( ) const

overridevirtual

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

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

References ARC, BEZIER, EDA_RECT::Centre(), CIRCLE, GetBoundingBox(), GetEnd(), GetStart(), m_shape, m_start, POLY, RECT, SEGMENT, and SHAPE_T_asString().

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

◆ GetClass()

wxString PCB_SHAPE::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Definition at line 282 of file pcb_shape.h.

     {
         return wxT( "PCB_SHAPE" );
     }

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 158 of file eda_item.h.

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

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

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

◆ GetEffectiveShape()

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

overridevirtual

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

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

References MakeEffectiveShapes().

◆ GetEnd()

const wxPoint& PCB_SHAPE::GetEnd ( ) const

inline

Return the ending point of the graphic.

Definition at line 134 of file pcb_shape.h.

134 { return m_end; }

Referenced by PCB_POINT_EDITOR::addCorner(), BOARD_ADAPTER::addShapeWithClearance(), GRAPHICS_CLEANER::areEquivalent(), PCB_GRID_HELPER::computeAnchors(), ConvertOutlineToPolygon(), CreateBoardSection(), CONVERT_TOOL::CreateLines(), MICROWAVE_TOOL::createMicrowaveInductor(), KIGFX::PCB_PAINTER::draw(), PCB_IO::format(), GetCenter(), GetLength(), GetRectCorners(), CONVERT_TOOL::getStartEndPoints(), hash_fp_item(), HitTest(), idf_export_outline(), GRAPHICS_CLEANER::isNullShape(), MakeEffectiveShapes(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromRects(), GRAPHICS_CLEANER::mergeRects(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), 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:346

References m_end.

◆ GetEndX()

int PCB_SHAPE::GetEndX ( )

inline

Definition at line 136 of file pcb_shape.h.

136 { return m_end.x; }

wxPoint m_end

Definition: pcb_shape.h:346

References m_end.

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

◆ GetEndY()

int PCB_SHAPE::GetEndY ( )

inline

Definition at line 135 of file pcb_shape.h.

135 { return m_end.y; }

wxPoint m_end

Definition: pcb_shape.h:346

References m_end.

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

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 155 of file eda_item.h.

155 { return m_flags; }

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

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References EDA_ITEM::m_flags.

◆ GetFocusPosition()

const wxPoint PCB_SHAPE::GetFocusPosition ( ) const

overridevirtual

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

For some shapes this is similar to GetPosition, but for polygonal shapes, the anchor is not suitable (shows nothing): a point on the outline is better

Reimplemented from EDA_ITEM.

Definition at line 79 of file pcb_shape.cpp.

 {
     // For some shapes return the visual center, but for not filled polygonal shapes,
     // the center is usually far from the shape: a point on the outline is better
 
     switch( m_shape )
     {
     case SHAPE_T::CIRCLE:
         if( !IsFilled() )
             return wxPoint( GetCenter().x + GetRadius(), GetCenter().y );
         break;
 
     case SHAPE_T::RECT:
         if( !IsFilled() )
             return GetStart();
         break;
 
     case SHAPE_T::POLY:
         if( !IsFilled() )
         {
             VECTOR2I pos = GetPolyShape().Outline(0).CPoint(0);
             return wxPoint( pos.x, pos.y );
         }
         break;
 
     case SHAPE_T::ARC:
         return GetArcMid();
         break;
 
     case SHAPE_T::BEZIER:
         return GetStart();
         break;
 
     default:
         break;
     }
 
     return GetCenter();
 }

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

◆ GetLayer()

virtual PCB_LAYER_ID BOARD_ITEM::GetLayer ( ) const

inlinevirtualinherited

Return the primary layer this item is on.

Reimplemented in ZONE.

Definition at line 171 of file board_item.h.

171 { return m_layer; }

BOARD_ITEM::m_layer

PCB_LAYER_ID m_layer

Definition: board_item.h:353

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

 {
     const BOARD* board = GetBoard();
 
     if( board )
         return board->GetLayerName( m_layer );
 
     // If no parent, return standard name
     return BOARD::GetStandardLayerName( m_layer );
 }

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

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

◆ GetLayerSet()

virtual LSET BOARD_ITEM::GetLayerSet ( ) const

inlinevirtualinherited

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

Reimplemented in PAD, PCB_VIA, ZONE, and PCB_GROUP.

Definition at line 176 of file board_item.h.

176 { return LSET( m_layer ); }

LSET

LSET is a set of PCB_LAYER_IDs.

Definition: layer_ids.h:502

BOARD_ITEM::m_layer

PCB_LAYER_ID m_layer

Definition: board_item.h:353

References BOARD_ITEM::m_layer.

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

◆ GetLength()

double PCB_SHAPE::GetLength ( ) const

Return the length of the track using the hypotenuse calculation.

Returns: the length of the track

Definition at line 120 of file pcb_shape.cpp.

 {
     double length = 0.0;
 
     switch( m_shape )
     {
     case SHAPE_T::BEZIER:
         for( size_t ii = 1; ii < m_bezierPoints.size(); ++ii )
             length += GetLineLength( m_bezierPoints[ ii - 1], m_bezierPoints[ii] );
 
         break;
 
     case SHAPE_T::SEGMENT:
         length = GetLineLength( GetStart(), GetEnd() );
         break;
 
     case SHAPE_T::POLY:
         for( int ii = 0; ii < m_poly.COutline( 0 ).SegmentCount(); ii++ )
             length += m_poly.COutline( 0 ).CSegment( ii ).Length();
 
         break;
 
     case SHAPE_T::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, BEZIER, SHAPE_POLY_SET::COutline(), SHAPE_LINE_CHAIN::CSegment(), GetAngle(), GetEnd(), GetLineLength(), GetRadius(), GetShape(), GetStart(), SEG::Length(), m_bezierPoints, m_poly, m_shape, POLY, SEGMENT, SHAPE_LINE_CHAIN::SegmentCount(), and BOARD_ITEM::ShowShape().

Referenced by GetMsgPanelInfo().

◆ GetMenuImage()

BITMAPS PCB_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 EDA_ITEM.

Reimplemented in FP_SHAPE.

Definition at line 1016 of file pcb_shape.cpp.

 {
     return BITMAPS::add_dashed_line;
 }

References add_dashed_line.

◆ GetMsgPanelInfo()

void PCB_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 541 of file pcb_shape.cpp.

 {
     EDA_UNITS         units = aFrame->GetUserUnits();
     ORIGIN_TRANSFORMS originTransforms = aFrame->GetOriginTransforms();
     wxString          msg;
 
     aList.emplace_back( _( "Type" ), _( "Drawing" ) );
 
     if( IsLocked() )
         aList.emplace_back( _( "Status" ), _( "Locked" ) );
 
     wxString shape = _( "Shape" );
 
     switch( m_shape )
     {
     case SHAPE_T::CIRCLE:
         aList.emplace_back( shape, _( "Circle" ) );
 
         msg = MessageTextFromValue( units, GetLineLength( m_start, m_end ) );
         aList.emplace_back( _( "Radius" ), msg );
         break;
 
     case SHAPE_T::ARC:
         aList.emplace_back( shape, _( "Arc" ) );
 
         msg.Printf( wxT( "%.1f" ), m_angle / 10.0 );
         aList.emplace_back( _( "Angle" ), msg );
 
         msg = MessageTextFromValue( units, GetLineLength( m_start, m_end ) );
         aList.emplace_back( _( "Radius" ), msg );
         break;
 
     case SHAPE_T::BEZIER:
         aList.emplace_back( shape, _( "Curve" ) );
 
         msg = MessageTextFromValue( units, GetLength() );
         aList.emplace_back( _( "Length" ), msg );
         break;
 
     case SHAPE_T::POLY:
         aList.emplace_back( shape, _( "Polygon" ) );
 
         msg.Printf( "%d", GetPolyShape().Outline(0).PointCount() );
         aList.emplace_back( _( "Points" ), msg );
         break;
 
     case SHAPE_T::RECT:
         aList.emplace_back( shape, _( "Rectangle" ) );
 
         msg = MessageTextFromValue( units, std::abs( m_end.x - m_start.x ) );
         aList.emplace_back( _( "Width" ), msg );
 
         msg = MessageTextFromValue( units, std::abs( m_end.y - m_start.y ) );
         aList.emplace_back( _( "Height" ), msg );
         break;
 
     case SHAPE_T::SEGMENT:
     {
         aList.emplace_back( shape, _( "Segment" ) );
 
         msg = MessageTextFromValue( units, GetLineLength( m_start, m_end ) );
         aList.emplace_back( _( "Length" ), msg );
 
         // angle counter-clockwise from 3'o-clock
         const double deg = RAD2DEG( atan2( (double)( m_start.y - m_end.y ),
                                            (double)( m_end.x - m_start.x ) ) );
         aList.emplace_back( _( "Angle" ), wxString::Format( "%.1f", deg ) );
     }
         break;
 
     default:
         aList.emplace_back( shape, _( "Unrecognized" ) );
         break;
     }
 
     aList.emplace_back( _( "Layer" ), GetLayerName() );
 
     aList.emplace_back( _( "Line width" ), MessageTextFromValue( units, m_width ) );
 }

References _, ARC, BEZIER, CIRCLE, Format(), BOARD_ITEM::GetLayerName(), GetLength(), GetLineLength(), EDA_DRAW_FRAME::GetOriginTransforms(), GetPolyShape(), EDA_BASE_FRAME::GetUserUnits(), BOARD_ITEM::IsLocked(), m_angle, m_end, m_shape, m_start, m_width, MessageTextFromValue(), POLY, RAD2DEG(), RECT, and SEGMENT.

Referenced by FP_SHAPE::GetMsgPanelInfo().

◆ GetParent()

BOARD_ITEM_CONTAINER* BOARD_ITEM::GetParent ( void ) const

inlineinherited

Definition at line 166 of file board_item.h.

166 { return (BOARD_ITEM_CONTAINER*) m_parent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:479

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.

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

◆ GetParentFootprint()

FOOTPRINT * PCB_SHAPE::GetParentFootprint ( ) const

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

Returns: the parent footprint or NULL.

Definition at line 532 of file pcb_shape.cpp.

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

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

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

◆ GetParentGroup()

PCB_GROUP* BOARD_ITEM::GetParentGroup ( ) const

inlineinherited

Definition at line 91 of file board_item.h.

91 { return m_group; }

BOARD_ITEM::m_group

PCB_GROUP * m_group

Definition: board_item.h:354

References BOARD_ITEM::m_group.

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

◆ GetPointCount()

int PCB_SHAPE::GetPointCount ( ) const

Returns: the number of corners of the polygonal shape

Definition at line 1306 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 GetPolyShape(), and SHAPE_POLY_SET::VertexCount().

Referenced by GRAPHICS_CLEANER::isNullShape().

◆ GetPolyShape() [1/2]

SHAPE_POLY_SET& PCB_SHAPE::GetPolyShape ( )

inline

Definition at line 240 of file pcb_shape.h.

240 { return m_poly; }

PCB_SHAPE::m_poly

SHAPE_POLY_SET m_poly

Definition: pcb_shape.h:355

References m_poly.

Referenced by PCB_POINT_EDITOR::addCorner(), ConvertOutlineToPolygon(), CONVERT_TOOL::CreateLines(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), PCB_IO::format(), GetFocusPosition(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), GetMsgPanelInfo(), GetPointCount(), ALTIUM_PCB::HelperDrawsegmentSetLocalCoord(), IsPolyShapeValid(), MakeEffectiveShapes(), PCB_POINT_EDITOR::makePoints(), EAGLE_PLUGIN::packagePolygon(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotPcbShape(), PCB_POINT_EDITOR::removeCorner(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), and PCB_POINT_EDITOR::updateItem().

◆ GetPolyShape() [2/2]

const SHAPE_POLY_SET& PCB_SHAPE::GetPolyShape ( ) const

inline

Definition at line 241 of file pcb_shape.h.

241 { return m_poly; }

PCB_SHAPE::m_poly

SHAPE_POLY_SET m_poly

Definition: pcb_shape.h:355

References m_poly.

◆ GetPosition()

wxPoint PCB_SHAPE::GetPosition ( ) const

overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 70 of file pcb_shape.cpp.

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

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

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

◆ GetRadius()

int PCB_SHAPE::GetRadius ( ) const

Return the radius of this item.

Has meaning only for arcs and circles.

Definition at line 487 of file pcb_shape.cpp.

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

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

Referenced by BOARD_ADAPTER::addShapeWithClearance(), computeArcBBox(), ConvertOutlineToPolygon(), KIGFX::PCB_PAINTER::draw(), GetBoundingBox(), GetFocusPosition(), GetLength(), hash_fp_item(), HitTest(), idf_export_outline(), GRAPHICS_CLEANER::isNullShape(), MakeEffectiveShapes(), DSN::SPECCTRA_DB::makeIMAGE(), CONVERT_TOOL::makePolysFromCircles(), ALTIUM_PCB::Parse(), PCB_PARSER::parsePAD(), Scale(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), and TransformShapeWithClearanceToPolygon().

◆ GetRectCorners()

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

Definition at line 1048 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 GetEnd(), FOOTPRINT::GetOrientation(), GetParentFootprint(), FOOTPRINT::GetPosition(), GetStart(), KiROUND(), and RotatePoint().

Referenced by BOARD_ADAPTER::addShapeWithClearance(), ConvertOutlineToPolygon(), KIGFX::PCB_PAINTER::draw(), GetBoundingBox(), HitTest(), MakeEffectiveShapes(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), and TransformShapeWithClearanceToPolygon().

◆ GetSelectMenuText()

wxString PCB_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 EDA_ITEM.

Reimplemented in FP_SHAPE.

Definition at line 1010 of file pcb_shape.cpp.

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

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

◆ GetShape()

SHAPE_T PCB_SHAPE::GetShape ( ) const

inline

Definition at line 110 of file pcb_shape.h.

110 { return m_shape; }

PCB_SHAPE::m_shape

SHAPE_T m_shape

Definition: pcb_shape.h:349

References 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(), CONVERT_TOOL::CreateLines(), KIGFX::PCB_PAINTER::draw(), FP_SHAPE::Flip(), FootprintWriteShape(), PCB_IO::format(), FOOTPRINT::GetCoverageArea(), GetLength(), CONVERT_TOOL::getStartEndPoints(), hash_fp_item(), idf_export_outline(), GRAPHICS_CLEANER::isNullShape(), DSN::SPECCTRA_DB::makeIMAGE(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromCircles(), CONVERT_TOOL::makePolysFromRects(), GRAPHICS_CLEANER::mergeRects(), FP_SHAPE::Mirror(), FP_SHAPE::Move(), PCB_SHAPE::cmp_drawings::operator()(), FOOTPRINT::cmp_drawings::operator()(), ALTIUM_PCB::Parse(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), 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

inline

Return the starting point of the graphic.

Definition at line 124 of file pcb_shape.h.

124 { return m_start; }

Referenced by PCB_POINT_EDITOR::addCorner(), BOARD_ADAPTER::addShapeWithClearance(), GRAPHICS_CLEANER::areEquivalent(), PCB_GRID_HELPER::computeAnchors(), ConvertOutlineToPolygon(), CreateBoardSection(), CONVERT_TOOL::CreateLines(), MICROWAVE_TOOL::createMicrowaveInductor(), KIGFX::PCB_PAINTER::draw(), PCB_IO::format(), GetCenter(), GetFocusPosition(), GetLength(), GetRectCorners(), CONVERT_TOOL::getStartEndPoints(), hash_fp_item(), HitTest(), idf_export_outline(), GRAPHICS_CLEANER::isNullShape(), MakeEffectiveShapes(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromRects(), GRAPHICS_CLEANER::mergeRects(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), BRDITEMS_PLOTTER::PlotPcbTarget(), 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:345

References m_start.

◆ GetStartX()

int PCB_SHAPE::GetStartX ( )

inline

Definition at line 126 of file pcb_shape.h.

126 { return m_start.x; }

wxPoint m_start

Definition: pcb_shape.h:345

References m_start.

Referenced by DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run().

◆ GetStartY()

int PCB_SHAPE::GetStartY ( )

inline

Definition at line 125 of file pcb_shape.h.

125 { return m_start.y; }

wxPoint m_start

Definition: pcb_shape.h:345

References m_start.

Referenced by DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run().

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS type ) const

inlineinherited

Definition at line 137 of file eda_item.h.

     {
         return m_status & type;
     }

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 150 of file eda_item.h.

150 { return m_status; }

EDA_ITEM::m_status

EDA_ITEM_FLAGS m_status

Definition: eda_item.h:478

References EDA_ITEM::m_status.

◆ GetThirdPoint()

const wxPoint& PCB_SHAPE::GetThirdPoint ( ) const

inline

Return the third point of the graphic.

Definition at line 144 of file pcb_shape.h.

144 { return m_thirdPoint; }

wxPoint m_thirdPoint

Definition: pcb_shape.h:347

References m_thirdPoint.

◆ GetThirdPointX()

int PCB_SHAPE::GetThirdPointX ( )

inline

Definition at line 146 of file pcb_shape.h.

146 { return m_thirdPoint.x; }

wxPoint m_thirdPoint

Definition: pcb_shape.h:347

References m_thirdPoint.

◆ GetThirdPointY()

int PCB_SHAPE::GetThirdPointY ( )

inline

Definition at line 145 of file pcb_shape.h.

145 { 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(), HitTest(), GRAPHICS_CLEANER::isNullShape(), FABMASTER::loadPolygon(), MakeEffectiveShapes(), DSN::SPECCTRA_DB::makeIMAGE(), CONVERT_TOOL::makePolysFromRects(), CONVERT_TOOL::makePolysFromSegs(), 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:347

References m_thirdPoint.

◆ GetWidth()

int PCB_SHAPE::GetWidth ( ) const

inline

Definition at line 97 of file pcb_shape.h.

97 { return m_width; }

PCB_SHAPE::m_width

int m_width

Definition: pcb_shape.h:343

References m_width.

◆ GetX()

int BOARD_ITEM::GetX ( ) const

inlineinherited

Definition at line 95 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 101 of file board_item.h.

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

References EDA_ITEM::GetPosition().

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

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 156 of file eda_item.h.

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

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

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

overridevirtual

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

 {
     int maxdist = aAccuracy + ( m_width / 2 );
 
     switch( m_shape )
     {
     case SHAPE_T::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 SHAPE_T::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 test 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;
 
             // Normalize 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 SHAPE_T::BEZIER:
         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 SHAPE_T::SEGMENT:
         if( TestSegmentHit( aPosition, m_start, m_end, maxdist ) )
             return true;
 
         break;
 
     case SHAPE_T::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 SHAPE_T::POLY:
         if( IsFilled() )
         {
             return m_poly.Collide( VECTOR2I( aPosition ), maxdist );
         }
         else
         {
             SHAPE_POLY_SET::VERTEX_INDEX dummy;
             return m_poly.CollideEdge( VECTOR2I( aPosition ), dummy, maxdist );
         }
 
         break;
 
     default:
         wxFAIL_MSG( "PCB_SHAPE::HitTest (point) not implemented for "
                     + SHAPE_T_asString( m_shape ) );
         break;
     }
 
     return false;
 }

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

Referenced by GENERAL_COLLECTOR::Inspect().

◆ HitTest() [2/2]

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

overridevirtual

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 832 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 SHAPE_T::CIRCLE:
         // Test if area intersects or contains the circle:
         if( aContained )
         {
             return arect.Contains( bb );
         }
         else
         {
             // If the rectangle does not intersect the bounding box, this is a much quicker test
             if( !aRect.Intersects( bb ) )
             {
                 return false;
             }
             else
             {
                 return arect.IntersectsCircleEdge( GetCenter(), GetRadius(), GetWidth() );
             }
         }
 
         break;
 
     case SHAPE_T::ARC:
         // Test for full containment of this arc in the rect
         if( aContained )
         {
             return arect.Contains( bb );
         }
         else
         {
             // Test if the rect crosses the arc
             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 SHAPE_T::RECT:
         if( aContained )
         {
             return arect.Contains( bb );
         }
         else
         {
             std::vector<wxPoint> pts = GetRectCorners();
 
             // Account for the width of the lines
             arect.Inflate( GetWidth() / 2 );
             return ( arect.Intersects( pts[0], pts[1] )
                   || arect.Intersects( pts[1], pts[2] )
                   || arect.Intersects( pts[2], pts[3] )
                   || arect.Intersects( pts[3], pts[0] ) );
         }
 
         break;
 
     case SHAPE_T::SEGMENT:
         if( aContained )
         {
             return arect.Contains( GetStart() ) && aRect.Contains( GetEnd() );
         }
         else
         {
             // Account for the width of the line
             arect.Inflate( GetWidth() / 2 );
             return arect.Intersects( GetStart(), GetEnd() );
         }
 
         break;
 
     case SHAPE_T::POLY:
         if( aContained )
         {
             return arect.Contains( bb );
         }
         else
         {
             // Fast test: if aRect is outside the polygon bounding box,
             // rectangles cannot intersect
             if( !arect.Intersects( bb ) )
                 return false;
 
             // Account for the width of the line
             arect.Inflate( GetWidth() / 2 );
 
             // Polygons in footprints use coordinates relative to the footprint.
             // Therefore, instead of using m_poly, we make a copy which is translated
             // to the actual location in the board.
 
             FOOTPRINT* fp{ GetParentFootprint() };
             double     orientation{ fp ? -DECIDEG2RAD( fp->GetOrientation() ) : 0.0 };
             wxPoint    offset;
 
             if( fp )
                 offset = fp->GetPosition();
 
             SHAPE_POLY_SET poly{ m_poly };
             poly.Rotate( orientation );
             poly.Move( offset );
 
             int count = poly.TotalVertices();
 
             for( int ii = 0; ii < count; ii++ )
             {
                 auto vertex = poly.CVertex( ii );
                 auto vertexNext = 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 SHAPE_T::BEZIER:
         if( aContained )
         {
             return arect.Contains( bb );
         }
         else
         {
             // Fast test: if aRect is outside the polygon bounding box,
             // rectangles cannot intersect
             if( !arect.Intersects( bb ) )
                 return false;
 
             // Account for the width of the line
             arect.Inflate( GetWidth() / 2 );
             unsigned count = m_bezierPoints.size();
 
             for( unsigned ii = 1; ii < count; ii++ )
             {
                 wxPoint vertex = m_bezierPoints[ ii - 1];
                 wxPoint vertexNext = m_bezierPoints[ii];
 
                 // Test if the point is within aRect
                 if( arect.Contains( ( wxPoint ) vertex ) )
                     return true;
 
                 // Test if this edge intersects aRect
                 if( arect.Intersects( vertex, vertexNext ) )
                     return true;
             }
         }
 
         break;
 
     default:
         wxFAIL_MSG( "PCB_SHAPE::HitTest (rect) not implemented for "
                     + SHAPE_T_asString( m_shape ) );
         break;
     }
 
     return false;
 }

References ARC, BEZIER, CIRCLE, EDA_RECT::Common(), EDA_RECT::Contains(), DECIDEG2RAD(), GetBoundingBox(), GetCenter(), GetEnd(), GetParentFootprint(), GetRadius(), GetRectCorners(), GetStart(), GetWidth(), EDA_RECT::Inflate(), EDA_RECT::Intersects(), EDA_RECT::IntersectsCircleEdge(), m_bezierPoints, m_poly, m_shape, EDA_RECT::Normalize(), POLY, RECT, SHAPE_POLY_SET::Rotate(), SEGMENT, and SHAPE_T_asString().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 126 of file eda_item.h.

126 { return m_flags & BRIGHTENED; }

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

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

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

     {
         return false;
     }

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 121 of file eda_item.h.

121 { return m_flags & IS_DRAGGING; }

IS_DRAGGING

#define IS_DRAGGING

Item being dragged.

Definition: eda_item_flags.h:43

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 124 of file eda_item.h.

124 { return m_flags & ENTERED; }

Referenced by BOARD_ADAPTER::addShapeWithClearance(), KIGFX::PCB_PAINTER::draw(), PCB_IO::format(), FOOTPRINT::GetCoverageArea(), GetFocusPosition(), hash_fp_item(), HitTest(), 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 TransformShapeWithClearanceToPolygon().

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

ENTERED

#define ENTERED

indicates a group has been entered

Definition: eda_item_flags.h:72

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsFilled()

bool PCB_SHAPE::IsFilled ( ) const

inline

Definition at line 75 of file pcb_shape.h.

     {
         switch( m_shape )
         {
         case SHAPE_T::RECT:
         case SHAPE_T::CIRCLE:
         case SHAPE_T::POLY:
             return m_filled;
 
         case SHAPE_T::SEGMENT:
         case SHAPE_T::ARC:
         case SHAPE_T::BEZIER:
             return false;
 
         case SHAPE_T::LAST: // Make CLang compiler happy
             return false;
         }
 
         return false;       // Make GCC compiler happy
     }

References ARC, BEZIER, CIRCLE, LAST, m_filled, m_shape, POLY, RECT, and SEGMENT.

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 206 of file eda_item.h.

206 { return m_forceVisible; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:480

References EDA_ITEM::m_forceVisible.

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

◆ IsLocked()

bool BOARD_ITEM::IsLocked ( ) const

virtualinherited

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

Reimplemented in FOOTPRINT, and PAD.

Definition at line 78 of file board_item.cpp.

 {
     if( GetParentGroup() )
         return GetParentGroup()->IsLocked();
 
     return GetState( LOCKED );
 }

References BOARD_ITEM::GetParentGroup(), EDA_ITEM::GetState(), BOARD_ITEM::IsLocked(), and LOCKED.

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

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 118 of file eda_item.h.

118 { return m_flags & IS_CHANGED; }

IS_CHANGED

#define IS_CHANGED

Item was edited, and modified.

Definition: eda_item_flags.h:37

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 120 of file eda_item.h.

120 { return m_flags & IS_MOVING; }

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

IS_MOVING

#define IS_MOVING

Item being moved.

Definition: eda_item_flags.h:40

References IS_MOVING, 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 119 of file eda_item.h.

119 { return m_flags & IS_NEW; }

IS_NEW

#define IS_NEW

New item, just created.

Definition: eda_item_flags.h:41

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

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

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 PAD, PCB_TRACK, and ZONE.

Definition at line 142 of file board_item.h.

     {
         return IsCopperLayer( GetLayer() );
     }

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

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

◆ IsOnLayer()

virtual bool BOARD_ITEM::IsOnLayer ( PCB_LAYER_ID aLayer ) const

inlinevirtualinherited

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

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

Parameters

aLayer The layer to test for.

Returns: true if on given layer, else false.

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

Definition at line 229 of file board_item.h.

     {
         return m_layer == aLayer;
     }

References BOARD_ITEM::m_layer.

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

◆ IsPolyShapeValid()

bool PCB_SHAPE::IsPolyShapeValid ( ) const

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

Definition at line 1294 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 GetPolyShape(), and SHAPE_LINE_CHAIN::PointCount().

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

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

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

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

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

Definition at line 403 of file eda_item.h.

403 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 125 of file eda_item.h.

125 { return m_flags & IS_RESIZING; }

IS_RESIZING

#define IS_RESIZING

Item being resized.

Definition: eda_item_flags.h:42

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References IS_RESIZING, and EDA_ITEM::m_flags.

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 123 of file eda_item.h.

123 { return m_flags & SELECTED; }

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

SELECTED

#define SELECTED

Definition: eda_item_flags.h:48

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 239 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 PCB_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 57 of file pcb_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 122 of file eda_item.h.

122 { return m_flags & IS_WIRE_IMAGE; }

Referenced by PAD::AddPrimitiveArc(), PCAD2KICAD::PCB_ARC::AddToBoard(), DRAWING_TOOL::drawArc(), PCB_POINT_EDITOR::editArcEndpointKeepCenter(), PCB_POINT_EDITOR::editArcEndpointKeepTangent(), CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex(), ALTIUM_PCB::HelperCreateBoardOutline(), EAGLE_PLUGIN::loadPlain(), ALTIUM_PCB::ParseArcs6Data(), PAD_TOOL::recombinePad(), CONVERT_TOOL::SegmentToArc(), FP_SHAPE::SetAngle(), SetArcGeometry(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow(), and updateArcFromConstructionMgr().

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

IS_WIRE_IMAGE

#define IS_WIRE_IMAGE

Item to be drawn as wireframe while editing.

Definition: eda_item_flags.h:45

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 295 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 314 of file eda_item.h.

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

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

◆ layerMaskDescribe()

wxString BOARD_ITEM::layerMaskDescribe ( ) const

protectedvirtualinherited

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

The BOARD is needed because layer names are customizable.

Reimplemented in PCB_VIA.

Definition at line 99 of file board_item.cpp.

 {
     const BOARD* board = GetBoard();
     LSET         layers = GetLayerSet();
 
     // Try to be smart and useful.  Check all copper first.
     if( layers[F_Cu] && layers[B_Cu] )
         return _( "all copper layers" );
 
     LSET copperLayers = layers & board->GetEnabledLayers().AllCuMask();
     LSET techLayers = layers & board->GetEnabledLayers().AllTechMask();
 
     for( LSET testLayers : { copperLayers, techLayers, layers } )
     {
         for( int bit = PCBNEW_LAYER_ID_START; bit < PCB_LAYER_ID_COUNT; ++bit )
         {
             if( testLayers[ bit ] )
             {
                 wxString layerInfo = board->GetLayerName( static_cast<PCB_LAYER_ID>( bit ) );
 
                 if( testLayers.count() > 1 )
                     layerInfo << wxS( " " ) + _( "and others" );
 
                 return layerInfo;
             }
         }
     }
 
     // No copper, no technicals: no layer
     return _( "no layers" );
 }

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

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

◆ MakeEffectiveShapes()

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

Make a set of SHAPE objects representing the PCB_SHAPE.

Caller owns the objects.

Definition at line 1163 of file pcb_shape.cpp.

 {
     std::vector<SHAPE*> effectiveShapes;
 
     switch( m_shape )
     {
     case SHAPE_T::ARC:
         effectiveShapes.emplace_back( new SHAPE_ARC( GetCenter(), GetArcStart(),
                                                      GetAngle() / 10.0, m_width ) );
         break;
 
     case SHAPE_T::SEGMENT:
         effectiveShapes.emplace_back( new SHAPE_SEGMENT( GetStart(), GetEnd(), m_width ) );
         break;
 
     case SHAPE_T::RECT:
     {
         std::vector<wxPoint> pts = GetRectCorners();
 
         if( IsFilled() )
         {
             effectiveShapes.emplace_back( new SHAPE_SIMPLE( pts ) );
         }
 
         if( m_width > 0 || !IsFilled() )
         {
             effectiveShapes.emplace_back( new SHAPE_SEGMENT( pts[0], pts[1], m_width ) );
             effectiveShapes.emplace_back( new SHAPE_SEGMENT( pts[1], pts[2], m_width ) );
             effectiveShapes.emplace_back( new SHAPE_SEGMENT( pts[2], pts[3], m_width ) );
             effectiveShapes.emplace_back( new SHAPE_SEGMENT( pts[3], pts[0], m_width ) );
         }
 
         break;
     }
 
     case SHAPE_T::CIRCLE:
     {
         if( IsFilled() )
         {
             effectiveShapes.emplace_back( new SHAPE_CIRCLE( GetCenter(), GetRadius() ) );
         }
 
         if( m_width > 0 || !IsFilled() )
         {
             // SHAPE_CIRCLE has no ConvertToPolyline() method, so use a 360.0 SHAPE_ARC
             SHAPE_ARC        circle( GetCenter(), GetEnd(), 360.0 );
             SHAPE_LINE_CHAIN l = circle.ConvertToPolyline();
 
             for( int i = 0; i < l.SegmentCount(); i++ )
             {
                 effectiveShapes.emplace_back( new SHAPE_SEGMENT( l.Segment( i ).A,
                                                                  l.Segment( i ).B, m_width ) );
             }
         }
 
         break;
     }
 
     case SHAPE_T::BEZIER:
     {
         auto bezierPoints = buildBezierToSegmentsPointsList( GetWidth() );
         wxPoint start_pt = bezierPoints[0];
 
         for( unsigned int jj = 1; jj < bezierPoints.size(); jj++ )
         {
             wxPoint end_pt = bezierPoints[jj];
             effectiveShapes.emplace_back( new SHAPE_SEGMENT( start_pt, end_pt, m_width ) );
             start_pt = end_pt;
         }
 
         break;
     }
 
     case SHAPE_T::POLY:
     {
         SHAPE_LINE_CHAIN l = GetPolyShape().COutline( 0 );
         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: "
                     + SHAPE_T_asString( m_shape ) );
         break;
     }
 
     return effectiveShapes;
 }

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

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

◆ Matches() [1/2]

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

inlinevirtualinherited

Compare the item against the search criteria in aSearchData.

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

Parameters

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

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

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

Definition at line 365 of file eda_item.h.

     {
         return false;
     }

Referenced by SCH_EDITOR_CONTROL::HasMatch(), inDiffPair(), 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 118 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.

◆ Move() [1/2]

void BOARD_ITEM::Move ( const VECTOR2I & aMoveVector )

inlineinherited

Definition at line 278 of file board_item.h.

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

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

◆ Move() [2/2]

void PCB_SHAPE::Move ( const wxPoint & aMoveVector )

overridevirtual

Move this object.

Parameters

aMoveVector the move vector for this object.

Reimplemented from BOARD_ITEM.

Reimplemented in FP_SHAPE.

Definition at line 156 of file pcb_shape.cpp.

 {
     // Move vector should not affect start/end for polygon since it will
     // be applied directly to polygon outline.
     if( m_shape != SHAPE_T::POLY )
     {
         m_start += aMoveVector;
         m_end += aMoveVector;
     }
 
     switch ( m_shape )
     {
     case SHAPE_T::POLY:
         m_poly.Move( VECTOR2I( aMoveVector ) );
         break;
 
     case SHAPE_T::ARC:
         m_thirdPoint += aMoveVector;
         break;
 
     case SHAPE_T::BEZIER:
         m_bezierC1 += aMoveVector;
         m_bezierC2 += aMoveVector;
 
         for( wxPoint& pt : m_bezierPoints)
             pt += aMoveVector;
 
         break;
 
     default:
         break;
     }
 }

References ARC, BEZIER, m_bezierC1, m_bezierC2, m_bezierPoints, m_end, m_poly, m_shape, m_start, m_thirdPoint, SHAPE_POLY_SET::Move(), and POLY.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex(), PAD_TOOL::recombinePad(), DIALOG_PAD_PROPERTIES::redraw(), and PCB_POINT_EDITOR::updateItem().

◆ 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 171 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 )

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 he. shape last segment can be shorter. This parameter avoids having too many very short segment in list. A good value is m_Width/2 to m_Width.

Definition at line 359 of file pcb_shape.cpp.

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

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

Referenced by ConvertOutlineToPolygon(), FP_SHAPE::Flip(), GRAPHICS_CLEANER::isNullShape(), FP_SHAPE::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 145 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 392 of file eda_item.h.

     {
         return false;
     }

◆ Rotate() [1/2]

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

inlineinherited

Definition at line 291 of file board_item.h.

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

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

◆ Rotate() [2/2]

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

overridevirtual

Rotate this object.

Parameters

aRotCentre	the rotation point.
aAngle	the rotation angle in 0.1 degree.

Reimplemented from BOARD_ITEM.

Reimplemented in FP_SHAPE.

Definition at line 241 of file pcb_shape.cpp.

 {
     switch( m_shape )
     {
     case SHAPE_T::ARC:
     case SHAPE_T::SEGMENT:
     case SHAPE_T::CIRCLE:
         // these can all be done by just rotating the constituent points
         RotatePoint( &m_start, aRotCentre, aAngle );
         RotatePoint( &m_end, aRotCentre, aAngle );
         RotatePoint( &m_thirdPoint, aRotCentre, aAngle );
         break;
 
     case SHAPE_T::RECT:
         if( KiROUND( aAngle ) % 900 == 0 )
         {
             RotatePoint( &m_start, aRotCentre, aAngle );
             RotatePoint( &m_end, aRotCentre, aAngle );
             break;
         }
 
         // Convert non-cartesian-rotated rect to a diamond
         m_shape = SHAPE_T::POLY;
         m_poly.RemoveAllContours();
         m_poly.NewOutline();
         m_poly.Append( m_start );
         m_poly.Append( m_end.x, m_start.y );
         m_poly.Append( m_end );
         m_poly.Append( m_start.x, m_end.y );
 
         KI_FALLTHROUGH;
 
     case SHAPE_T::POLY:
         m_poly.Rotate( -DECIDEG2RAD( aAngle ), VECTOR2I( aRotCentre ) );
         break;
 
     case SHAPE_T::BEZIER:
         RotatePoint( &m_start, aRotCentre, aAngle);
         RotatePoint( &m_end, aRotCentre, aAngle);
         RotatePoint( &m_bezierC1, aRotCentre, aAngle);
         RotatePoint( &m_bezierC2, aRotCentre, aAngle);
 
         for( wxPoint& pt : m_bezierPoints )
             RotatePoint( &pt, aRotCentre, aAngle);
 
         break;
 
     default:
         wxFAIL_MSG( "PCB_SHAPE::Rotate not implemented for "
                     + SHAPE_T_asString( m_shape ) );
         break;
     }
 }

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

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex(), ALTIUM_PCB::HelperParsePad6NonCopper(), ALTIUM_PCB::ParseFills6Data(), PAD_TOOL::recombinePad(), DIALOG_PAD_PROPERTIES::redraw(), and FP_SHAPE::Rotate().

◆ Scale()

void PCB_SHAPE::Scale ( double aScale )

Definition at line 191 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 SHAPE_T::BEZIER:
         scalePt( m_bezierC1 );
         scalePt( m_bezierC2 );
         break;
 
     case SHAPE_T::ARC:
         scalePt( m_thirdPoint );
         break;
 
     case SHAPE_T::CIRCLE: //  ring or circle
         m_end.x = m_start.x + KiROUND( radius * aScale );
         m_end.y = m_start.y;
         break;
 
     case SHAPE_T::POLY: // polygon
     {
         std::vector<wxPoint> pts;
 
         for( const VECTOR2I& pt : m_poly.Outline( 0 ).CPoints() )
         {
             pts.emplace_back( pt );
             scalePt( pts.back() );
         }
 
         SetPolyPoints( pts );
         break;
     }
 
     default:
         break;
     }
 }

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

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex().

◆ Set() [1/3]

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

inlineinherited

Definition at line 42 of file inspectable.h.

     {
         PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
         TYPE_ID thisType = TYPE_HASH( *this );
         void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
 
         if( object )
             aProperty->setter( object, aValue );
 
         return object != nullptr;
     }

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

◆ Set() [2/3]

template<typename T >

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

inlineinherited

Definition at line 55 of file inspectable.h.

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

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

◆ Set() [3/3]

template<typename T >

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

inlineinherited

Definition at line 68 of file inspectable.h.

     {
         PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
         TYPE_ID thisType = TYPE_HASH( *this );
         PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
         void* object = nullptr;
 
         if( prop )
         {
             object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
 
             if( object )
                 prop->set<T>( object, aValue );
         }
 
         return object != nullptr;
     }

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

◆ SetAngle()

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

virtual

Set 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	set to true to update also arc end coordinates m_thirdPoint, so must be called after setting m_Start and m_End.

Reimplemented in FP_SHAPE.

Definition at line 519 of file pcb_shape.cpp.

 {
     // m_Angle must be >= -360 and <= +360 degrees
     m_angle = NormalizeAngle360Max( aAngle );
 
     if( aUpdateEnd )
     {
         m_thirdPoint = m_end;
         RotatePoint( &m_thirdPoint, m_start, -m_angle );
     }
 }

References m_angle, m_end, m_start, m_thirdPoint, NormalizeAngle360Max(), and RotatePoint().

◆ SetArcEnd()

void PCB_SHAPE::SetArcEnd ( const wxPoint & aArcEndPoint )

inline

Initialize the end arc point.

Can be used for circles to initialize one point of the cicumference.

Definition at line 193 of file pcb_shape.h.

     {
         m_thirdPoint = aArcEndPoint;
     }

References m_thirdPoint.

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

◆ SetArcGeometry()

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

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 496 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(), GetAngle(), GetArcCenter(), RAD2DECIDEG(), SetAngle(), SetArcEnd(), SetArcStart(), and SetCenter().

Referenced by PCB_POINT_EDITOR::editArcMidKeepEndpoints().

◆ SetArcStart()

void PCB_SHAPE::SetArcStart ( const wxPoint & aArcStartPoint )

inline

Initialize the start arc point.

Can be used for circles to initialize one point of the cicumference.

Definition at line 183 of file pcb_shape.h.

     {
         m_end = aArcStartPoint;
     }

References m_end.

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

◆ SetBezierC1()

void PCB_SHAPE::SetBezierC1 ( const wxPoint & aPoint )

inline

Definition at line 112 of file pcb_shape.h.

112 { m_bezierC1 = aPoint; }

PCB_SHAPE::m_bezierC1

wxPoint m_bezierC1

Definition: pcb_shape.h:351

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

◆ SetBezierC2()

void PCB_SHAPE::SetBezierC2 ( const wxPoint & aPoint )

inline

Definition at line 115 of file pcb_shape.h.

115 { m_bezierC2 = aPoint; }

PCB_SHAPE::m_bezierC2

wxPoint m_bezierC2

Definition: pcb_shape.h:352

References m_bezierC2.

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

◆ SetBezierPoints()

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

inline

Definition at line 250 of file pcb_shape.h.

     {
         m_bezierPoints = aPoints;
     }

References m_bezierPoints.

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 130 of file eda_item.h.

130 { SetFlags( BRIGHTENED ); }

EDA_ITEM::SetFlags

void SetFlags(EDA_ITEM_FLAGS aMask)

Definition: eda_item.h:153

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

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 )

inline

Definition at line 198 of file pcb_shape.h.

198 { m_start = aCenterPoint; }

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

wxPoint m_start

Definition: pcb_shape.h:345

References m_start.

◆ SetEnd()

void PCB_SHAPE::SetEnd ( const wxPoint & aEnd )

inline

Definition at line 137 of file pcb_shape.h.

137 { 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(), CONVERT_TOOL::CreateLines(), MICROWAVE_TOOL::createMicrowaveInductor(), PAD_TOOL::explodePad(), CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex(), ALTIUM_PCB::HelperCreateBoardOutline(), ALTIUM_PCB::HelperParseDimensions6Leader(), ALTIUM_PCB::HelperParsePad6NonCopper(), EAGLE_PLUGIN::loadPlain(), GRAPHICS_CLEANER::mergeRects(), ALTIUM_PCB::ParseTracks6Data(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotPcbTarget(), 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:346

References m_end.

◆ SetEndX()

void PCB_SHAPE::SetEndX ( int x )

inline

Definition at line 139 of file pcb_shape.h.

139 { m_end.x = x; }

wxPoint m_end

Definition: pcb_shape.h:346

References 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 )

inline

Definition at line 138 of file pcb_shape.h.

138 { 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(), CONVERT_TOOL::CreatePolys(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarShape(), PAD_TOOL::explodePad(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), ALTIUM_PCB::HelperParsePad6NonCopper(), 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:346

References 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 )

inline

Definition at line 73 of file pcb_shape.h.

73 { m_filled = aFlag; }

PCB_SHAPE::m_filled

bool m_filled

Definition: pcb_shape.h:344

References m_filled.

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 153 of file eda_item.h.

153 { 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(), CONVERT_TOOL::CreateLines(), MICROWAVE_TOOL::createMicrowaveInductor(), PCB_BASE_FRAME::CreateNewFootprint(), MICROWAVE_TOOL::createPolygonShape(), CONVERT_TOOL::CreatePolys(), 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(), PCB_TRACK::Flip(), FP_SHAPE::Flip(), FP_TEXT::Flip(), FOOTPRINT::Flip(), PCB_ARC::Flip(), Flip(), FOOTPRINT_DESC::FOOTPRINT_DESC(), FP_TEXT::FP_TEXT(), ALTIUM_PCB::HelperCreateBoardOutline(), ALTIUM_PCB::HelperParseDimensions6Datum(), ALTIUM_PCB::HelperParseDimensions6Leader(), ALTIUM_PCB::HelperParsePad6NonCopper(), initTextTable(), 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::makeTracksFromShapes(), 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(), 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(), PCB_DIMENSION_BASE::SetLayer(), GLOBAL_EDIT_TOOL::swapBoardItem(), TRACK_VIA_DESC::TRACK_VIA_DESC(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow().

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

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 204 of file eda_item.h.

204 { m_forceVisible = aEnable; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:480

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 PCB_DIMENSION_BASE, ZONE, and PCB_GROUP.

Definition at line 192 of file board_item.h.

     {
         m_layer = aLayer;
     }

References BOARD_ITEM::m_layer.

◆ SetLayerSet()

virtual void BOARD_ITEM::SetLayerSet ( LSET aLayers )

inlinevirtualinherited

Reimplemented in PAD, PCB_VIA, and ZONE.

Definition at line 177 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().

◆ SetLocked()

virtual void BOARD_ITEM::SetLocked ( bool aLocked )

inlinevirtualinherited

Modify the 'lock' status for of the item.

Reimplemented in FOOTPRINT.

Definition at line 252 of file board_item.h.

     {
         SetState( LOCKED, aLocked );
     }

References LOCKED, and EDA_ITEM::SetState().

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), EDIT_TOOL::DragArcTrack(), ZONE_SETTINGS::ExportSetting(), EDIT_TOOL::FilletTracks(), ROUTER_TOOL::InlineDrag(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), CADSTAR_PCB_ARCHIVE_LOADER::loadGroups(), CADSTAR_PCB_ARCHIVE_LOADER::loadNetTracks(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), BOARD_EDITOR_CONTROL::modifyLockSelected(), PCB_PARSER::Parse(), ALTIUM_PCB::ParsePolygons6Data(), processTextItem(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 65 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_SYMBOL::Move(), SCH_LINE::MoveEnd(), SCH_LINE::MoveStart(), LIB_PIN::MoveTo(), PCB_EDIT_FRAME::OpenProjectFiles(), ALTIUM_PCB::Parse(), SCH_ALTIUM_PLUGIN::ParseFileHeader(), LIB_SYMBOL::RemoveDrawItem(), SCH_SYMBOL::SetConvert(), SCH_SYMBOL::SetLibId(), EDA_ITEM::SetModified(), LIB_FIELD::SetName(), SCH_SYMBOL::SetTransform(), and SCH_SYMBOL::SetUnit().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlinevirtualinherited

Reimplemented in PCB_DIMENSION_BASE.

Definition at line 116 of file eda_item.h.

116 { m_parent = aParent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:479

References EDA_ITEM::m_parent.

Referenced by FOOTPRINT::Add(), BOARD::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), 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::CreateNewSymbol(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_SYMBOL::Flatten(), FOOTPRINT::FOOTPRINT(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), LIB_SYMBOL::LIB_SYMBOL(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), FOOTPRINT::operator=(), LIB_SYMBOL::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_SYMBOL::SetFields(), PCB_DIMENSION_BASE::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_SHEET::SwapData(), SCH_GLOBALLABEL::SwapData(), SCH_SYMBOL::SwapData(), and SwapItemData().

◆ SetParentGroup()

void BOARD_ITEM::SetParentGroup ( PCB_GROUP * aGroup )

inlineinherited

Definition at line 90 of file board_item.h.

90 { m_group = aGroup; }

BOARD_ITEM::m_group

PCB_GROUP * m_group

Definition: board_item.h:354

References BOARD_ITEM::m_group.

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

◆ SetPolyPoints()

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

Definition at line 1153 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(), 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(), Scale(), and DIALOG_PAD_PRIMITIVE_POLY_PROPS::TransferDataFromWindow().

◆ SetPolyShape()

void PCB_SHAPE::SetPolyShape ( const SHAPE_POLY_SET & aShape )

inline

Definition at line 248 of file pcb_shape.h.

248 { m_poly = aShape; }

PCB_SHAPE::m_poly

SHAPE_POLY_SET m_poly

Definition: pcb_shape.h:355

References m_poly.

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

◆ SetPosition()

void PCB_SHAPE::SetPosition ( const wxPoint & aPos )

overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 64 of file pcb_shape.cpp.

 {
     m_start = aPos;
 }

References m_start.

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 129 of file eda_item.h.

129 { SetFlags( SELECTED ); }

EDA_ITEM::SetFlags

void SetFlags(EDA_ITEM_FLAGS aMask)

Definition: eda_item.h:153

SELECTED

#define SELECTED

Definition: eda_item_flags.h:48

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 ( SHAPE_T aShape )

inline

Definition at line 109 of file pcb_shape.h.

109 { m_shape = aShape; }

PCB_SHAPE::m_shape

SHAPE_T m_shape

Definition: pcb_shape.h:349

References m_shape.

Referenced by PAD::AddPrimitiveArc(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitivePoly(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), PCAD2KICAD::PCB_ARC::AddToBoard(), ZONE_CREATE_HELPER::commitZone(), CONVERT_TOOL::CreateLines(), MICROWAVE_TOOL::createMicrowaveInductor(), MICROWAVE_TOOL::createPolygonShape(), CONVERT_TOOL::CreatePolys(), 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::getKiCadPad(), CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex(), ALTIUM_PCB::HelperCreateBoardOutline(), ALTIUM_PCB::HelperParseDimensions6Datum(), ALTIUM_PCB::HelperParseDimensions6Leader(), ALTIUM_PCB::HelperParsePad6NonCopper(), 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(), PAD_TOOL::recombinePad(), and CONVERT_TOOL::SegmentToArc().

◆ SetStart()

void PCB_SHAPE::SetStart ( const wxPoint & aStart )

inline

Definition at line 127 of file pcb_shape.h.

127 { 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(), CONVERT_TOOL::CreateLines(), MICROWAVE_TOOL::createMicrowaveInductor(), PAD_TOOL::explodePad(), CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex(), 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(), PAD_TOOL::recombinePad(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow(), PCB_POINT_EDITOR::updateItem(), and updateSegmentFromGeometryMgr().

wxPoint m_start

Definition: pcb_shape.h:345

References m_start.

◆ SetStartX()

void PCB_SHAPE::SetStartX ( int x )

inline

Definition at line 129 of file pcb_shape.h.

129 { m_start.x = x; }

wxPoint m_start

Definition: pcb_shape.h:345

References 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 )

inline

Definition at line 128 of file pcb_shape.h.

128 { m_start.y = y; }

wxPoint m_start

Definition: pcb_shape.h:345

References 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	(	EDA_ITEM_FLAGS	type,
		bool	state
	)

inlineinherited

Definition at line 142 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 ( EDA_ITEM_FLAGS aStatus )

inlineinherited

Definition at line 151 of file eda_item.h.

151 { m_status = aStatus; }

EDA_ITEM::m_status

EDA_ITEM_FLAGS m_status

Definition: eda_item.h:478

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetThirdPoint()

void PCB_SHAPE::SetThirdPoint ( const wxPoint & aPoint )

inline

Definition at line 147 of file pcb_shape.h.

147 { m_thirdPoint = aPoint; }

wxPoint m_thirdPoint

Definition: pcb_shape.h:347

References m_thirdPoint.

◆ SetThirdPointX()

void PCB_SHAPE::SetThirdPointX ( int x )

inline

Definition at line 149 of file pcb_shape.h.

149 { m_thirdPoint.x = x; }

wxPoint m_thirdPoint

Definition: pcb_shape.h:347

References m_thirdPoint.

◆ SetThirdPointY()

void PCB_SHAPE::SetThirdPointY ( int y )

inline

Definition at line 148 of file pcb_shape.h.

148 { m_thirdPoint.y = y; }