KiCad PCB EDA Suite
LIB_SHAPE Class Reference

#include <lib_shape.h>

Inheritance diagram for LIB_SHAPE:
LIB_ITEM EDA_SHAPE EDA_ITEM KIGFX::VIEW_ITEM INSPECTABLE LIB_TEXTBOX

Public Types

enum  LIB_CONVERT : int { BASE = 1 , DEMORGAN = 2 }
 
enum  COMPARE_FLAGS : int { UNIT = 0x01 , EQUALITY = 0x02 , ERC = 0x04 }
 The list of flags used by the compare function. More...
 

Public Member Functions

 LIB_SHAPE (LIB_SYMBOL *aParent, SHAPE_T aShape, int aLineWidth=0, FILL_T aFillType=FILL_T::NO_FILL, KICAD_T aType=LIB_SHAPE_T)
 
 ~LIB_SHAPE ()
 
wxString GetClass () const override
 Return the class name. More...
 
wxString GetTypeName () const override
 Provide a user-consumable name of the object type. More...
 
STROKE_PARAMS GetStroke () const
 
void SetStroke (const STROKE_PARAMS &aStroke)
 
bool HitTest (const VECTOR2I &aPosition, int aAccuracy=0) const override
 Test if aPosition is inside or on the boundary of this item. More...
 
bool HitTest (const BOX2I &aRect, bool aContained, int aAccuracy=0) const override
 Test if aRect intersects this item. More...
 
int GetPenWidth () const override
 
PLOT_DASH_TYPE GetEffectiveLineStyle () const
 
const BOX2I GetBoundingBox () const override
 
void GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
 Display basic info (type, part and convert) about the current item in message panel. More...
 
void BeginEdit (const VECTOR2I &aStartPoint) override
 Begin drawing a symbol library draw item at aPosition. More...
 
bool ContinueEdit (const VECTOR2I &aPosition) override
 Continue an edit in progress at aPosition. More...
 
void CalcEdit (const VECTOR2I &aPosition) override
 Calculate the attributes of an item at aPosition when it is being edited. More...
 
void EndEdit () override
 End an object editing action. More...
 
void SetEditState (int aState)
 
void AddPoint (const VECTOR2I &aPosition)
 
void Offset (const VECTOR2I &aOffset) override
 Set the drawing object by aOffset from the current position. More...
 
void MoveTo (const VECTOR2I &aPosition) override
 Move a draw object to aPosition. More...
 
VECTOR2I GetPosition () const override
 
void SetPosition (const VECTOR2I &aPosition) override
 
VECTOR2I GetCenter () const
 
virtual std::vector< SHAPE * > MakeEffectiveShapes (bool aEdgeOnly=false) const override
 Make a set of SHAPE objects representing the LIB_SHAPE. More...
 
void Normalize ()
 
void MirrorHorizontal (const VECTOR2I &aCenter) override
 Mirror the draw object along the horizontal (X) axis about aCenter point. More...
 
void MirrorVertical (const VECTOR2I &aCenter) override
 Mirror the draw object along the MirrorVertical (Y) axis about aCenter point. More...
 
void Rotate (const VECTOR2I &aCenter, bool aRotateCCW=true) override
 Rotate the object about aCenter point. More...
 
void Plot (PLOTTER *aPlotter, bool aBackground, const VECTOR2I &aOffset, const TRANSFORM &aTransform, bool aDimmed) const override
 Plot the draw item using the plot object. More...
 
wxString GetSelectMenuText (UNITS_PROVIDER *aUnitsProvider) const override
 Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
 
BITMAPS GetMenuImage () const override
 Return a pointer to an image to be used in menus. More...
 
EDA_ITEMClone () const override
 Create a duplicate of this item with linked list members set to NULL. More...
 
void ViewGetLayers (int aLayers[], int &aCount) const override
 Return the all the layers within the VIEW the object is painted on. More...
 
virtual void Print (const RENDER_SETTINGS *aSettings, const VECTOR2I &aOffset, void *aData, const TRANSFORM &aTransform, bool aDimmed)
 Draw an item. More...
 
const wxString & GetDefaultFont () const
 
virtual int GetEffectivePenWidth (const RENDER_SETTINGS *aSettings) const
 
LIB_SYMBOLGetParent () const
 
bool operator== (const LIB_ITEM &aOther) const
 Test LIB_ITEM objects for equivalence. More...
 
bool operator== (const LIB_ITEM *aOther) const
 
bool operator< (const LIB_ITEM &aOther) const
 Test if another draw item is less than this draw object. More...
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
void SetUnit (int aUnit)
 
int GetUnit () const
 
void SetConvert (int aConvert)
 
int GetConvert () const
 
void SetPrivate (bool aPrivate)
 
bool IsPrivate () const
 
KICAD_T Type () const
 Returns the type of object. More...
 
virtual void SetParent (EDA_ITEM *aParent)
 
bool IsModified () const
 
bool IsNew () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsEntered () const
 
bool IsResized () const
 
bool IsBrightened () const
 
bool IsRollover () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (EDA_ITEM_FLAGS type) const
 
void SetState (EDA_ITEM_FLAGS type, bool state)
 
EDA_ITEM_FLAGS GetStatus () const
 
void SetStatus (EDA_ITEM_FLAGS aStatus)
 
void SetFlags (EDA_ITEM_FLAGS aMask)
 
void ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
EDA_ITEM_FLAGS GetFlags () const
 
bool HasFlag (EDA_ITEM_FLAGS aFlag) const
 
EDA_ITEM_FLAGS GetEditFlags () const
 
void ClearTempFlags ()
 
void ClearEditFlags ()
 
virtual bool RenderAsBitmap (double aWorldScale) const
 
void SetIsShownAsBitmap (bool aBitmap)
 
bool IsShownAsBitmap () const
 
virtual bool IsType (const std::vector< KICAD_T > &aScanTypes) const
 Check whether the item is one of the listed types. More...
 
void SetForceVisible (bool aEnable)
 Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
 
bool IsForceVisible () const
 
virtual const VECTOR2I GetFocusPosition () const
 Similar to GetPosition, but allows items to return their visual center rather than their anchor. More...
 
virtual VECTOR2I GetSortPosition () const
 Return the coordinates that should be used for sorting this element visually compared to other elements. More...
 
virtual INSPECT_RESULT Visit (INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &aScanTypes)
 May be re-implemented for each derived class in order to handle all the types given by its member data. More...
 
wxString GetTypeDesc ()
 Return a translated description of the type for this EDA_ITEM for display in user facing messages. More...
 
virtual bool Matches (const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const
 Compare the item against the search criteria in aSearchData. More...
 
virtual bool Replace (const EDA_SEARCH_DATA &aSearchData, void *aAuxData=nullptr)
 Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool IsReplaceable () const
 Override this method in any derived object that supports test find and replace. More...
 
virtual const BOX2I ViewBBox () const override
 Return the bounding box of the item covering all its layers. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Draw the parts of the object belonging to layer aLayer. More...
 
virtual double ViewGetLOD (int aLayer, VIEW *aView) const
 Return the level of detail (LOD) of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 
void ClearViewPrivData ()
 
bool Set (PROPERTY_BASE *aProperty, wxAny &aValue)
 
template<typename T >
bool Set (PROPERTY_BASE *aProperty, T aValue)
 
template<typename T >
bool Set (const wxString &aProperty, T aValue)
 
wxAny Get (PROPERTY_BASE *aProperty) const
 
template<typename T >
Get (PROPERTY_BASE *aProperty) const
 
template<typename T >
std::optional< T > Get (const wxString &aProperty) const
 
void SwapShape (EDA_SHAPE *aImage)
 
wxString ShowShape () const
 
wxString SHAPE_T_asString () const
 
bool IsAnnotationProxy () const
 
void SetIsAnnotationProxy (bool aIsProxy=true)
 
bool IsFilled () const
 
void SetFilled (bool aFlag)
 
void SetFillMode (FILL_T aFill)
 
FILL_T GetFillMode () const
 
COLOR4D GetFillColor () const
 
void SetFillColor (const COLOR4D &aColor)
 
void SetWidth (int aWidth)
 
int GetWidth () const
 
virtual int GetEffectiveWidth () const
 
void SetShape (SHAPE_T aShape)
 
SHAPE_T GetShape () const
 
const VECTOR2IGetStart () const
 Return the starting point of the graphic. More...
 
int GetStartY () const
 
int GetStartX () const
 
void SetStart (const VECTOR2I &aStart)
 
void SetStartY (int y)
 
void SetStartX (int x)
 
const VECTOR2IGetEnd () const
 Return the ending point of the graphic. More...
 
int GetEndY () const
 
int GetEndX () const
 
void SetEnd (const VECTOR2I &aEnd)
 
void SetEndY (int y)
 
void SetEndX (int x)
 
virtual VECTOR2I GetTopLeft () const
 
virtual VECTOR2I GetBotRight () const
 
virtual void SetTop (int val)
 
virtual void SetLeft (int val)
 
virtual void SetRight (int val)
 
virtual void SetBottom (int val)
 
void SetBezierC1 (const VECTOR2I &aPt)
 
const VECTOR2IGetBezierC1 () const
 
void SetBezierC2 (const VECTOR2I &aPt)
 
const VECTOR2IGetBezierC2 () const
 
VECTOR2I getCenter () const
 
void SetCenter (const VECTOR2I &aCenter)
 
void SetArcAngleAndEnd (const EDA_ANGLE &aAngle, bool aCheckNegativeAngle=false)
 Set the end point from the angle center and start. More...
 
EDA_ANGLE GetArcAngle () const
 
bool EndsSwapped () const
 Have the start and end points been swapped since they were set? More...
 
VECTOR2I GetArcMid () const
 
std::vector< VECTOR2IGetRectCorners () const
 
void CalcArcAngles (EDA_ANGLE &aStartAngle, EDA_ANGLE &aEndAngle) const
 Calc arc start and end angles such that aStartAngle < aEndAngle. More...
 
int GetRadius () const
 
void SetArcGeometry (const VECTOR2I &aStart, const VECTOR2I &aMid, const VECTOR2I &aEnd)
 Set the three controlling points for an arc. More...
 
void SetCachedArcData (const VECTOR2I &aStart, const VECTOR2I &aMid, const VECTOR2I &aEnd, const VECTOR2I &aCenter)
 Set the data used for mid point caching. More...
 
const std::vector< VECTOR2I > & GetBezierPoints () const
 
void DupPolyPointsList (std::vector< VECTOR2I > &aBuffer) const
 Duplicate the list of corners in a std::vector<VECTOR2I> More...
 
int GetPointCount () const
 
SHAPE_POLY_SETGetPolyShape ()
 
const SHAPE_POLY_SETGetPolyShape () const
 
bool IsPolyShapeValid () const
 
void SetPolyShape (const SHAPE_POLY_SET &aShape)
 
void SetPolyPoints (const std::vector< VECTOR2I > &aPoints)
 
void RebuildBezierToSegmentsPointsList (int aMinSegLen)
 Rebuild the m_bezierPoints vertex list that approximate the Bezier curve by a list of segments. More...
 
void ShapeGetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList)
 
double GetLength () const
 Return the length of the track using the hypotenuse calculation. More...
 
void TransformShapeWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, int aClearanceValue, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth) const
 Convert the shape to a closed polygon. More...
 
int Compare (const EDA_SHAPE *aOther) const
 

Static Public Member Functions

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

Public Attributes

const KIID m_Uuid
 

Protected Member Functions

bool Matches (const wxString &aText, const EDA_SEARCH_DATA &aSearchData) const
 Compare aText against search criteria in aSearchData. More...
 
void setPosition (const VECTOR2I &aPos)
 
VECTOR2I getPosition () const
 
void move (const VECTOR2I &aMoveVector)
 
void rotate (const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle)
 
void flip (const VECTOR2I &aCentre, bool aFlipLeftRight)
 
void scale (double aScale)
 
const BOX2I getBoundingBox () const
 
void computeArcBBox (BOX2I &aBBox) const
 
bool hitTest (const VECTOR2I &aPosition, int aAccuracy=0) const
 
bool hitTest (const BOX2I &aRect, bool aContained, int aAccuracy=0) const
 
const std::vector< VECTOR2IbuildBezierToSegmentsPointsList (int aMinSegLen) const
 
void beginEdit (const VECTOR2I &aStartPoint)
 
bool continueEdit (const VECTOR2I &aPosition)
 
void calcEdit (const VECTOR2I &aPosition)
 
void endEdit (bool aClosed=true)
 Finishes editing the shape. More...
 
void setEditState (int aState)
 
std::vector< SHAPE * > makeEffectiveShapes (bool aEdgeOnly, bool aLineChainOnly=false) const
 Make a set of SHAPE objects representing the EDA_SHAPE. More...
 

Protected Attributes

int m_unit
 Unit identification for multiple parts per package. More...
 
int m_convert
 Shape identification for alternate body styles. More...
 
bool m_private
 Private items are shown only in the Symbol Editor. More...
 
EDA_ITEM_FLAGS m_status
 
EDA_ITEMm_parent
 Linked list: Link (parent struct) More...
 
bool m_forceVisible
 
EDA_ITEM_FLAGS m_flags
 
bool m_endsSwapped
 
SHAPE_T m_shape
 
STROKE_PARAMS m_stroke
 
FILL_T m_fill
 
COLOR4D m_fillColor
 
VECTOR2I m_start
 
VECTOR2I m_end
 
VECTOR2I m_arcCenter
 
ARC_MID m_arcMidData
 
VECTOR2I m_bezierC1
 
VECTOR2I m_bezierC2
 
std::vector< VECTOR2Im_bezierPoints
 
SHAPE_POLY_SET m_poly
 
int m_editState
 
bool m_annotationProxy
 

Private Member Functions

int compare (const LIB_ITEM &aOther, int aCompareFlags=0) const override
 Provide the draw object specific comparison called by the == and < operators. More...
 
void print (const RENDER_SETTINGS *aSettings, const VECTOR2I &aOffset, void *aData, const TRANSFORM &aTransform, bool aDimmed) override
 Print the item to aDC. More...
 
EDA_ANGLE getParentOrientation () const override
 
VECTOR2I getParentPosition () const override
 

Private Attributes

KICAD_T m_structType
 Run time identification, keep private so it can never be changed after a ctor sets it. More...
 
VIEW_ITEM_DATA * m_viewPrivData
 

Detailed Description

Definition at line 32 of file lib_shape.h.

Member Enumeration Documentation

◆ COMPARE_FLAGS

enum LIB_ITEM::COMPARE_FLAGS : int
inherited

The list of flags used by the compare function.

  • UNIT This flag relaxes unit, conversion and pin number constraints. It is used for LIB_ITEM object unit comparisons.
  • EQUALITY This flag relaxes ordering contstraints so that fields, etc. don't have to appear in the same order to be considered equal.
  • ERC This flag relaxes constraints on data that is settable in the schematic editor. It compares only symbol-editor-only data.
Enumerator
UNIT 
EQUALITY 
ERC 

Definition at line 82 of file lib_item.h.

83 {
84 UNIT = 0x01,
85 EQUALITY = 0x02,
86 ERC = 0x04
87 };
@ EQUALITY
Definition: lib_item.h:85
@ UNIT
Definition: lib_item.h:84

◆ LIB_CONVERT

enum LIB_ITEM::LIB_CONVERT : int
inherited
Enumerator
BASE 
DEMORGAN 

Definition at line 70 of file lib_item.h.

70: int { BASE = 1, DEMORGAN = 2 };
@ BASE
Definition: lib_item.h:70
@ DEMORGAN
Definition: lib_item.h:70

Constructor & Destructor Documentation

◆ LIB_SHAPE()

LIB_SHAPE::LIB_SHAPE ( LIB_SYMBOL aParent,
SHAPE_T  aShape,
int  aLineWidth = 0,
FILL_T  aFillType = FILL_T::NO_FILL,
KICAD_T  aType = LIB_SHAPE_T 
)

Definition at line 37 of file lib_shape.cpp.

38 :
39 LIB_ITEM( aType, aParent ),
40 EDA_SHAPE( aShape, aLineWidth, aFillType )
41{
42 m_editState = 0;
43}
int m_editState
Definition: eda_shape.h:380
EDA_SHAPE(SHAPE_T aType, int aLineWidth, FILL_T aFill)
Definition: eda_shape.cpp:40
LIB_ITEM(KICAD_T aType, LIB_SYMBOL *aSymbol=nullptr, int aUnit=0, int aConvert=0)
Definition: lib_item.cpp:38

References EDA_SHAPE::m_editState.

Referenced by Clone().

◆ ~LIB_SHAPE()

LIB_SHAPE::~LIB_SHAPE ( )
inline

Definition at line 40 of file lib_shape.h.

40{ }

Member Function Documentation

◆ AddPoint()

void LIB_SHAPE::AddPoint ( const VECTOR2I aPosition)

Definition at line 501 of file lib_shape.cpp.

502{
503 if( GetShape() == SHAPE_T::POLY )
504 {
505 if( m_poly.IsEmpty() )
507
508 m_poly.Outline( 0 ).Append( aPosition, true );
509 }
510 else
511 {
513 }
514}
SHAPE_T GetShape() const
Definition: eda_shape.h:111
wxString SHAPE_T_asString() const
Definition: eda_shape.cpp:75
SHAPE_POLY_SET m_poly
Definition: eda_shape.h:378
void Append(int aX, int aY, bool aAllowDuplication=false)
Append a new point at the end of the line chain.
bool IsEmpty() const
SHAPE_LINE_CHAIN & Outline(int aIndex)
int NewOutline()
Creates a new hole in a given outline.
#define UNIMPLEMENTED_FOR(type)
Definition: macros.h:120

References SHAPE_LINE_CHAIN::Append(), EDA_SHAPE::GetShape(), SHAPE_POLY_SET::IsEmpty(), EDA_SHAPE::m_poly, SHAPE_POLY_SET::NewOutline(), SHAPE_POLY_SET::Outline(), POLY, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), HelperGeneratePowerPortGraphics(), SCH_EAGLE_PLUGIN::loadFrame(), CADSTAR_SCH_ARCHIVE_LOADER::loadLibrarySymbolShapeVertices(), SCH_LEGACY_PLUGIN_CACHE::loadPolyLine(), SCH_EAGLE_PLUGIN::loadSymbolPolyLine(), SCH_EAGLE_PLUGIN::loadSymbolWire(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseLine(), SCH_ALTIUM_PLUGIN::ParsePolygon(), and SCH_ALTIUM_PLUGIN::ParsePolyline().

◆ beginEdit()

void EDA_SHAPE::beginEdit ( const VECTOR2I aStartPoint)
protectedinherited

Definition at line 1210 of file eda_shape.cpp.

1211{
1212 switch( GetShape() )
1213 {
1214 case SHAPE_T::SEGMENT:
1215 case SHAPE_T::CIRCLE:
1216 case SHAPE_T::RECT:
1217 SetStart( aPosition );
1218 SetEnd( aPosition );
1219 break;
1220
1221 case SHAPE_T::ARC:
1222 SetArcGeometry( aPosition, aPosition, aPosition );
1223 m_editState = 1;
1224 break;
1225
1226 case SHAPE_T::POLY:
1228 m_poly.Outline( 0 ).SetClosed( false );
1229
1230 // Start and end of the first segment (co-located for now)
1231 m_poly.Outline( 0 ).Append( aPosition );
1232 m_poly.Outline( 0 ).Append( aPosition, true );
1233 break;
1234
1235 default:
1237 }
1238}
void SetStart(const VECTOR2I &aStart)
Definition: eda_shape.h:120
void SetEnd(const VECTOR2I &aEnd)
Definition: eda_shape.h:145
void SetArcGeometry(const VECTOR2I &aStart, const VECTOR2I &aMid, const VECTOR2I &aEnd)
Set the three controlling points for an arc.
Definition: eda_shape.cpp:508
void SetClosed(bool aClosed)
Mark the line chain as closed (i.e.

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

Referenced by SCH_SHAPE::BeginEdit(), and BeginEdit().

◆ BeginEdit()

void LIB_SHAPE::BeginEdit ( const VECTOR2I aPosition)
inlineoverridevirtual

Begin drawing a symbol library draw item at aPosition.

It typically would be called on a left click when a draw tool is selected in the symbol library editor and one of the graphics tools is selected.

Parameters
aPositionThe position in drawing coordinates where the drawing was started. May or may not be required depending on the item being drawn.

Reimplemented from LIB_ITEM.

Definition at line 72 of file lib_shape.h.

72{ beginEdit( aStartPoint ); }
void beginEdit(const VECTOR2I &aStartPoint)
Definition: eda_shape.cpp:1210

References EDA_SHAPE::beginEdit().

Referenced by SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape().

◆ buildBezierToSegmentsPointsList()

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

Definition at line 384 of file eda_shape.cpp.

385{
386 std::vector<VECTOR2I> bezierPoints;
387
388 // Rebuild the m_BezierPoints vertex list that approximate the Bezier curve
389 std::vector<VECTOR2I> ctrlPoints = { m_start, m_bezierC1, m_bezierC2, m_end };
390 BEZIER_POLY converter( ctrlPoints );
391 converter.GetPoly( bezierPoints, aMinSegLen );
392
393 return bezierPoints;
394}
Bezier curves to polygon converter.
Definition: bezier_curves.h:36
VECTOR2I m_start
Definition: eda_shape.h:368
VECTOR2I m_end
Definition: eda_shape.h:369
VECTOR2I m_bezierC1
Definition: eda_shape.h:374
VECTOR2I m_bezierC2
Definition: eda_shape.h:375

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

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

◆ CalcArcAngles()

void EDA_SHAPE::CalcArcAngles ( EDA_ANGLE aStartAngle,
EDA_ANGLE aEndAngle 
) const
inherited

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

Each may be between -360.0 and 360.0.

Definition at line 455 of file eda_shape.cpp.

456{
457 VECTOR2D startRadial( GetStart() - getCenter() );
458 VECTOR2D endRadial( GetEnd() - getCenter() );
459
460 aStartAngle = EDA_ANGLE( startRadial );
461 aEndAngle = EDA_ANGLE( endRadial );
462
463 if( aEndAngle == aStartAngle )
464 aEndAngle = aStartAngle + ANGLE_360; // ring, not null
465
466 if( aStartAngle > aEndAngle )
467 {
468 if( aEndAngle < ANGLE_0 )
469 aEndAngle.Normalize();
470 else
471 aStartAngle = aStartAngle.Normalize() - ANGLE_360;
472 }
473}
EDA_ANGLE Normalize()
Definition: eda_angle.h:249
VECTOR2I getCenter() const
Definition: eda_shape.cpp:397
const VECTOR2I & GetEnd() const
Return the ending point of the graphic.
Definition: eda_shape.h:141
const VECTOR2I & GetStart() const
Return the starting point of the graphic.
Definition: eda_shape.h:116
static constexpr EDA_ANGLE & ANGLE_360
Definition: eda_angle.h:418
static constexpr EDA_ANGLE & ANGLE_0
Definition: eda_angle.h:412

References ANGLE_0, ANGLE_360, EDA_SHAPE::getCenter(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetStart(), and EDA_ANGLE::Normalize().

Referenced by EDA_SHAPE::computeArcBBox(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), EDA_SHAPE::GetArcAngle(), EDA_SHAPE::hitTest(), Plot(), print(), and SCH_LEGACY_PLUGIN_CACHE::saveArc().

◆ calcEdit()

void EDA_SHAPE::calcEdit ( const VECTOR2I aPosition)
protectedinherited

Definition at line 1268 of file eda_shape.cpp.

1269{
1270#define sq( x ) pow( x, 2 )
1271
1272 switch( GetShape() )
1273 {
1274 case SHAPE_T::SEGMENT:
1275 case SHAPE_T::CIRCLE:
1276 case SHAPE_T::RECT:
1277 SetEnd( aPosition );
1278 break;
1279
1280 case SHAPE_T::ARC:
1281 {
1282 int radius = GetRadius();
1283
1284 // Edit state 0: drawing: place start
1285 // Edit state 1: drawing: place end (center calculated for 90-degree subtended angle)
1286 // Edit state 2: point edit: move start (center calculated for invariant subtended angle)
1287 // Edit state 3: point edit: move end (center calculated for invariant subtended angle)
1288 // Edit state 4: point edit: move center
1289 // Edit state 5: point edit: move arc-mid-point
1290
1291 switch( m_editState )
1292 {
1293 case 0:
1294 SetArcGeometry( aPosition, aPosition, aPosition );
1295 return;
1296
1297 case 1:
1298 m_end = aPosition;
1299 radius = KiROUND( sqrt( sq( GetLineLength( m_start, m_end ) ) / 2.0 ) );
1300 break;
1301
1302 case 2:
1303 case 3:
1304 {
1305 VECTOR2I v = m_start - m_end;
1306 double chordBefore = sq( v.x ) + sq( v.y );
1307
1308 if( m_editState == 2 )
1309 m_start = aPosition;
1310 else
1311 m_end = aPosition;
1312
1313 v = m_start - m_end;
1314 double chordAfter = sq( v.x ) + sq( v.y );
1315 double ratio = chordAfter / chordBefore;
1316
1317 if( ratio != 0 )
1318 {
1319 radius = std::max( int( sqrt( sq( radius ) * ratio ) ) + 1,
1320 int( sqrt( chordAfter ) / 2 ) + 1 );
1321 }
1322 }
1323 break;
1324
1325 case 4:
1326 {
1327 double radialA = GetLineLength( m_start, aPosition );
1328 double radialB = GetLineLength( m_end, aPosition );
1329 radius = int( ( radialA + radialB ) / 2.0 ) + 1;
1330 }
1331 break;
1332
1333 case 5:
1334 SetArcGeometry( GetStart(), aPosition, GetEnd() );
1335 return;
1336 }
1337
1338 // Calculate center based on start, end, and radius
1339 //
1340 // Let 'l' be the length of the chord and 'm' the middle point of the chord
1341 double l = GetLineLength( m_start, m_end );
1342 VECTOR2I m = ( m_start + m_end ) / 2;
1343
1344 // Calculate 'd', the vector from the chord midpoint to the center
1345 VECTOR2I d;
1346 d.x = KiROUND( sqrt( sq( radius ) - sq( l/2 ) ) * ( m_start.y - m_end.y ) / l );
1347 d.y = KiROUND( sqrt( sq( radius ) - sq( l/2 ) ) * ( m_end.x - m_start.x ) / l );
1348
1349 VECTOR2I c1 = m + d;
1350 VECTOR2I c2 = m - d;
1351
1352 // Solution gives us 2 centers; we need to pick one:
1353 switch( m_editState )
1354 {
1355 case 1:
1356 {
1357 // Keep center clockwise from chord while drawing
1358 VECTOR2I chordVector = m_end - m_start;
1359 EDA_ANGLE chordAngle( chordVector );
1360
1361 VECTOR2I c1Test = c1;
1362 RotatePoint( c1Test, m_start, -chordAngle.Normalize() );
1363
1364 m_arcCenter = c1Test.x > 0 ? c2 : c1;
1365 }
1366 break;
1367
1368 case 2:
1369 case 3:
1370 // Pick the one closer to the old center
1372 break;
1373
1374 case 4:
1375 // Pick the one closer to the mouse position
1376 m_arcCenter = GetLineLength( c1, aPosition ) < GetLineLength( c2, aPosition ) ? c1 : c2;
1377
1378 if( GetArcAngle() > ANGLE_180 )
1379 std::swap( m_start, m_end );
1380
1381 break;
1382 }
1383 }
1384 break;
1385
1386 case SHAPE_T::POLY:
1387 m_poly.Outline( 0 ).SetPoint( m_poly.Outline( 0 ).GetPointCount() - 1, aPosition );
1388 break;
1389
1390 default:
1392 }
1393}
EDA_ANGLE GetArcAngle() const
Definition: eda_shape.cpp:538
int GetRadius() const
Definition: eda_shape.cpp:476
VECTOR2I m_arcCenter
Definition: eda_shape.h:371
void SetPoint(int aIndex, const VECTOR2I &aPos)
Move a point to a specific location.
virtual size_t GetPointCount() const override
static constexpr EDA_ANGLE & ANGLE_180
Definition: eda_angle.h:416
#define sq(x)
void RotatePoint(int *pX, int *pY, const EDA_ANGLE &aAngle)
Definition: trigo.cpp:183
double GetLineLength(const VECTOR2I &aPointA, const VECTOR2I &aPointB)
Return the length of a line segment defined by aPointA and aPointB.
Definition: trigo.h:188
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:80

References ANGLE_180, ARC, CIRCLE, EDA_SHAPE::GetArcAngle(), EDA_SHAPE::GetEnd(), GetLineLength(), SHAPE_LINE_CHAIN::GetPointCount(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetShape(), EDA_SHAPE::GetStart(), KiROUND(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_editState, EDA_SHAPE::m_end, EDA_SHAPE::m_poly, EDA_SHAPE::m_start, EDA_ANGLE::Normalize(), SHAPE_POLY_SET::Outline(), POLY, RECT, RotatePoint(), SEGMENT, EDA_SHAPE::SetArcGeometry(), EDA_SHAPE::SetEnd(), SHAPE_LINE_CHAIN::SetPoint(), EDA_SHAPE::SHAPE_T_asString(), sq, UNIMPLEMENTED_FOR, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SCH_SHAPE::CalcEdit(), and CalcEdit().

◆ CalcEdit()

void LIB_SHAPE::CalcEdit ( const VECTOR2I aPosition)
inlineoverridevirtual

Calculate the attributes of an item at aPosition when it is being edited.

This method gets called by the Draw() method when the item is being edited. This probably should be a pure virtual method but bezier curves are not yet editable in the symbol library editor. Therefore, the default method does nothing.

Parameters
aPositionThe current mouse position in drawing coordinates.

Reimplemented from LIB_ITEM.

Definition at line 74 of file lib_shape.h.

74{ calcEdit( aPosition ); }
void calcEdit(const VECTOR2I &aPosition)
Definition: eda_shape.cpp:1268

References EDA_SHAPE::calcEdit().

Referenced by SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), and EE_POINT_EDITOR::updateParentItem().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )
inlineinherited

Definition at line 122 of file eda_item.h.

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:143
#define BRIGHTENED
item is drawn with a bright contour

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ ClearEditFlags()

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS  aMask = EDA_ITEM_ALL_FLAGS)
inlineinherited

Definition at line 143 of file eda_item.h.

143{ m_flags &= ~aMask; }
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:498

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), FOOTPRINT::BuildCourtyardCaches(), 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(), SCH_ITEM::Duplicate(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_SELECTION_TOOL::ExitGroup(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE_ON_MOVE::Init(), EE_COLLECTOR::Inspect(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::RecombinePad(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), DRC_TEST_PROVIDER_DISALLOW::Run(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetIsShownAsBitmap(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and EE_SELECTION_TOOL::unhighlight().

◆ ClearSelected()

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 155 of file eda_item.h.

156 {
158 }
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
#define SELECTED_BY_DRAG
Item was algorithmically selected as a dragged item.
#define DO_NOT_DRAW
Used to disable draw function.
#define SKIP_STRUCT
flag indicating that the structure should be ignored
#define CANDIDATE
flag indicating that the structure is connected

References CANDIDATE, EDA_ITEM::ClearFlags(), DO_NOT_DRAW, IS_LINKED, SELECTED_BY_DRAG, and SKIP_STRUCT.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles(), and SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )
inlineinherited

Definition at line 143 of file view_item.h.

144 {
145 m_viewPrivData = nullptr;
146 }
VIEW_ITEM_DATA * m_viewPrivData
Definition: view_item.h:151

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * LIB_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 LIB_TEXTBOX.

Definition at line 64 of file lib_shape.cpp.

65{
66 return new LIB_SHAPE( *this );
67}
LIB_SHAPE(LIB_SYMBOL *aParent, SHAPE_T aShape, int aLineWidth=0, FILL_T aFillType=FILL_T::NO_FILL, KICAD_T aType=LIB_SHAPE_T)
Definition: lib_shape.cpp:37

References LIB_SHAPE().

Referenced by SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape().

◆ Compare()

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

Definition at line 1451 of file eda_shape.cpp.

1452{
1453#define EPSILON 2 // Should be enough for rounding errors on calculated items
1454
1455#define TEST( a, b ) { if( a != b ) return a - b; }
1456#define TEST_E( a, b ) { if( abs( a - b ) > EPSILON ) return a - b; }
1457#define TEST_PT( a, b ) { TEST_E( a.x, b.x ); TEST_E( a.y, b.y ); }
1458
1459 TEST_PT( m_start, aOther->m_start );
1460 TEST_PT( m_end, aOther->m_end );
1461
1462 TEST( (int) m_shape, (int) aOther->m_shape );
1463
1464 if( m_shape == SHAPE_T::ARC )
1465 {
1466 TEST_PT( m_arcCenter, aOther->m_arcCenter );
1467 }
1468 else if( m_shape == SHAPE_T::BEZIER )
1469 {
1470 TEST_PT( m_bezierC1, aOther->m_bezierC1 );
1471 TEST_PT( m_bezierC2, aOther->m_bezierC2 );
1472 }
1473 else if( m_shape == SHAPE_T::POLY )
1474 {
1476 }
1477
1478 for( size_t ii = 0; ii < m_bezierPoints.size(); ++ii )
1479 TEST_PT( m_bezierPoints[ii], aOther->m_bezierPoints[ii] );
1480
1481 for( int ii = 0; ii < m_poly.TotalVertices(); ++ii )
1482 TEST_PT( m_poly.CVertex( ii ), aOther->m_poly.CVertex( ii ) );
1483
1484 TEST_E( m_stroke.GetWidth(), aOther->m_stroke.GetWidth() );
1485 TEST( (int) m_stroke.GetPlotStyle(), (int) aOther->m_stroke.GetPlotStyle() );
1486 TEST( (int) m_fill, (int) aOther->m_fill );
1487
1488 return 0;
1489}
SHAPE_T m_shape
Definition: eda_shape.h:363
std::vector< VECTOR2I > m_bezierPoints
Definition: eda_shape.h:377
STROKE_PARAMS m_stroke
Definition: eda_shape.h:364
FILL_T m_fill
Definition: eda_shape.h:365
int TotalVertices() const
Delete aIdx-th polygon from the set.
const VECTOR2I & CVertex(int aIndex, int aOutline, int aHole) const
Return the aGlobalIndex-th vertex in the poly set.
int GetWidth() const
Definition: stroke_params.h:98
PLOT_DASH_TYPE GetPlotStyle() const
#define TEST_PT(a, b)
#define TEST(a, b)
#define TEST_E(a, b)

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

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

◆ compare()

int LIB_SHAPE::compare ( const LIB_ITEM aOther,
int  aCompareFlags = 0 
) const
overrideprivatevirtual

Provide the draw object specific comparison called by the == and < operators.

The base object sort order which always proceeds the derived object sort order is as follows:

  • Symbol alternate part (DeMorgan) number.
  • Symbol part number.
  • KICAD_T enum value.
  • Result of derived classes comparison.
Note
Make sure you call down to LIB_ITEM::compare before doing any derived object comparisons or you will break the sorting using the symbol library file format.
Parameters
aOtherA reference to the other LIB_ITEM to compare the arc against.
aCompareFlagsThe flags used to perform the comparison.
Returns
An integer value less than 0 if the object is less than aOther object, zero if the object is equal to aOther object, or greater than 0 if the object is greater than aOther object.

The circle specific sort order is as follows:

  • Circle horizontal (X) position.
  • Circle vertical (Y) position.
  • Circle radius.

Reimplemented from LIB_ITEM.

Reimplemented in LIB_TEXTBOX.

Definition at line 70 of file lib_shape.cpp.

71{
72 int retv = LIB_ITEM::compare( aOther, aCompareFlags );
73
74 if( retv )
75 return retv;
76
77 return EDA_SHAPE::Compare( &static_cast<const LIB_SHAPE&>( aOther ) );
78}
int Compare(const EDA_SHAPE *aOther) const
Definition: eda_shape.cpp:1451
virtual int compare(const LIB_ITEM &aOther, int aCompareFlags=0) const
Provide the draw object specific comparison called by the == and < operators.
Definition: lib_item.cpp:74

References EDA_SHAPE::Compare(), and LIB_ITEM::compare().

◆ computeArcBBox()

void EDA_SHAPE::computeArcBBox ( BOX2I aBBox) const
protectedinherited

Definition at line 1019 of file eda_shape.cpp.

1020{
1021 // Start, end, and each inflection point the arc crosses will enclose the entire arc.
1022 // Only include the center when filled; it's not necessarily inside the BB of an unfilled
1023 // arc with a small included angle.
1024 aBBox.SetOrigin( m_start );
1025 aBBox.Merge( m_end );
1026
1027 if( IsFilled() )
1028 aBBox.Merge( m_arcCenter );
1029
1030 int radius = GetRadius();
1031 EDA_ANGLE t1, t2;
1032
1033 CalcArcAngles( t1, t2 );
1034
1035 t1.Normalize();
1036 t2.Normalize();
1037
1038 if( t2 > t1 )
1039 {
1040 if( t1 < ANGLE_0 && t2 > ANGLE_0 )
1041 aBBox.Merge( VECTOR2I( m_arcCenter.x + radius, m_arcCenter.y ) ); // right
1042
1043 if( t1 < ANGLE_90 && t2 > ANGLE_90 )
1044 aBBox.Merge( VECTOR2I( m_arcCenter.x, m_arcCenter.y + radius ) ); // down
1045
1046 if( t1 < ANGLE_180 && t2 > ANGLE_180 )
1047 aBBox.Merge( VECTOR2I( m_arcCenter.x - radius, m_arcCenter.y ) ); // left
1048
1049 if( t1 < ANGLE_270 && t2 > ANGLE_270 )
1050 aBBox.Merge( VECTOR2I( m_arcCenter.x, m_arcCenter.y - radius ) ); // up
1051 }
1052 else
1053 {
1054 if( t1 < ANGLE_0 || t2 > ANGLE_0 )
1055 aBBox.Merge( VECTOR2I( m_arcCenter.x + radius, m_arcCenter.y ) ); // right
1056
1057 if( t1 < ANGLE_90 || t2 > ANGLE_90 )
1058 aBBox.Merge( VECTOR2I( m_arcCenter.x, m_arcCenter.y + radius ) ); // down
1059
1060 if( t1 < ANGLE_180 || t2 > ANGLE_180 )
1061 aBBox.Merge( VECTOR2I( m_arcCenter.x - radius, m_arcCenter.y ) ); // left
1062
1063 if( t1 < ANGLE_270 || t2 > ANGLE_270 )
1064 aBBox.Merge( VECTOR2I( m_arcCenter.x, m_arcCenter.y - radius ) ); // up
1065 }
1066}
void SetOrigin(const Vec &pos)
Definition: box2.h:202
BOX2< Vec > & Merge(const BOX2< Vec > &aRect)
Modify the position and size of the rectangle in order to contain aRect.
Definition: box2.h:588
bool IsFilled() const
Definition: eda_shape.h:90
void CalcArcAngles(EDA_ANGLE &aStartAngle, EDA_ANGLE &aEndAngle) const
Calc arc start and end angles such that aStartAngle < aEndAngle.
Definition: eda_shape.cpp:455
static constexpr EDA_ANGLE & ANGLE_90
Definition: eda_angle.h:414
static constexpr EDA_ANGLE & ANGLE_270
Definition: eda_angle.h:417
VECTOR2< int > VECTOR2I
Definition: vector2d.h:618

References ANGLE_0, ANGLE_180, ANGLE_270, ANGLE_90, EDA_SHAPE::CalcArcAngles(), EDA_SHAPE::GetRadius(), EDA_SHAPE::IsFilled(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_end, EDA_SHAPE::m_start, BOX2< Vec >::Merge(), EDA_ANGLE::Normalize(), BOX2< Vec >::SetOrigin(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by EDA_SHAPE::getBoundingBox().

◆ continueEdit()

bool EDA_SHAPE::continueEdit ( const VECTOR2I aPosition)
protectedinherited

Definition at line 1241 of file eda_shape.cpp.

1242{
1243 switch( GetShape() )
1244 {
1245 case SHAPE_T::ARC:
1246 case SHAPE_T::SEGMENT:
1247 case SHAPE_T::CIRCLE:
1248 case SHAPE_T::RECT:
1249 return false;
1250
1251 case SHAPE_T::POLY:
1252 {
1253 SHAPE_LINE_CHAIN& poly = m_poly.Outline( 0 );
1254
1255 // do not add zero-length segments
1256 if( poly.CPoint( poly.GetPointCount() - 2 ) != poly.CLastPoint() )
1257 poly.Append( aPosition, true );
1258 }
1259 return true;
1260
1261 default:
1263 return false;
1264 }
1265}
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
const VECTOR2I & CPoint(int aIndex) const
Return a reference to a given point in the line chain.
const VECTOR2I & CLastPoint() const
Return the last point in the line chain.

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

Referenced by SCH_SHAPE::ContinueEdit(), and ContinueEdit().

◆ ContinueEdit()

bool LIB_SHAPE::ContinueEdit ( const VECTOR2I aPosition)
inlineoverridevirtual

Continue an edit in progress at aPosition.

This is used to perform the next action while drawing an item. This would be called for each additional left click when the mouse is captured while the item is being drawn.

Parameters
aPositionThe position of the mouse left click in drawing coordinates.
Returns
True if additional mouse clicks are required to complete the edit in progress.

Reimplemented from LIB_ITEM.

Definition at line 73 of file lib_shape.h.

73{ return continueEdit( aPosition ); }
bool continueEdit(const VECTOR2I &aPosition)
Definition: eda_shape.cpp:1241

References EDA_SHAPE::continueEdit().

Referenced by SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape().

◆ DupPolyPointsList()

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

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

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

Definition at line 1170 of file eda_shape.cpp.

1171{
1172 if( m_poly.OutlineCount() )
1173 {
1174 int pointCount = m_poly.COutline( 0 ).PointCount();
1175
1176 if( pointCount )
1177 {
1178 aBuffer.reserve( pointCount );
1179
1180 for ( auto iter = m_poly.CIterate(); iter; iter++ )
1181 aBuffer.emplace_back( iter->x, iter->y );
1182 }
1183 }
1184}
int PointCount() const
Return the number of points (vertices) in this line chain.
CONST_ITERATOR CIterate(int aFirst, int aLast, bool aIterateHoles=false) const
int OutlineCount() const
Return the number of vertices in a given outline/hole.
const SHAPE_LINE_CHAIN & COutline(int aIndex) const

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

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

◆ EndEdit()

void LIB_SHAPE::EndEdit ( )
inlineoverridevirtual

End an object editing action.

This is used to end or abort an edit action in progress initiated by BeginEdit().

Reimplemented from LIB_ITEM.

Definition at line 76 of file lib_shape.h.

76{ endEdit( false ); }
void endEdit(bool aClosed=true)
Finishes editing the shape.
Definition: eda_shape.cpp:1396

References EDA_SHAPE::endEdit().

Referenced by SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape().

◆ endEdit()

void EDA_SHAPE::endEdit ( bool  aClosed = true)
protectedinherited

Finishes editing the shape.

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

Definition at line 1396 of file eda_shape.cpp.

1397{
1398 switch( GetShape() )
1399 {
1400 case SHAPE_T::ARC:
1401 case SHAPE_T::SEGMENT:
1402 case SHAPE_T::CIRCLE:
1403 case SHAPE_T::RECT:
1404 break;
1405
1406 case SHAPE_T::POLY:
1407 {
1408 SHAPE_LINE_CHAIN& poly = m_poly.Outline( 0 );
1409
1410 // do not include last point twice
1411 if( poly.GetPointCount() > 2 )
1412 {
1413 if( poly.CPoint( poly.GetPointCount() - 2 ) == poly.CLastPoint() )
1414 {
1415 poly.SetClosed( aClosed );
1416 poly.Remove( poly.GetPointCount() - 1 );
1417 }
1418 }
1419 }
1420 break;
1421
1422 default:
1424 }
1425}
void Remove(int aStartIndex, int aEndIndex)
Remove the range of points [start_index, end_index] from the line chain.

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

Referenced by SCH_SHAPE::EndEdit(), and EndEdit().

◆ EndsSwapped()

bool EDA_SHAPE::EndsSwapped ( ) const
inlineinherited

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

Returns
true if they have

Definition at line 191 of file eda_shape.h.

191{ return m_endsSwapped; }
bool m_endsSwapped
Definition: eda_shape.h:362

References EDA_SHAPE::m_endsSwapped.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes().

◆ flip()

void EDA_SHAPE::flip ( const VECTOR2I aCentre,
bool  aFlipLeftRight 
)
protectedinherited

Definition at line 285 of file eda_shape.cpp.

286{
287 switch ( m_shape )
288 {
289 case SHAPE_T::SEGMENT:
290 case SHAPE_T::RECT:
291 if( aFlipLeftRight )
292 {
293 m_start.x = aCentre.x - ( m_start.x - aCentre.x );
294 m_end.x = aCentre.x - ( m_end.x - aCentre.x );
295 }
296 else
297 {
298 m_start.y = aCentre.y - ( m_start.y - aCentre.y );
299 m_end.y = aCentre.y - ( m_end.y - aCentre.y );
300 }
301
302 std::swap( m_start, m_end );
303 break;
304
305 case SHAPE_T::CIRCLE:
306 if( aFlipLeftRight )
307 {
308 m_start.x = aCentre.x - ( m_start.x - aCentre.x );
309 m_end.x = aCentre.x - ( m_end.x - aCentre.x );
310 }
311 else
312 {
313 m_start.y = aCentre.y - ( m_start.y - aCentre.y );
314 m_end.y = aCentre.y - ( m_end.y - aCentre.y );
315 }
316 break;
317
318 case SHAPE_T::ARC:
319 if( aFlipLeftRight )
320 {
321 m_start.x = aCentre.x - ( m_start.x - aCentre.x );
322 m_end.x = aCentre.x - ( m_end.x - aCentre.x );
323 m_arcCenter.x = aCentre.x - ( m_arcCenter.x - aCentre.x );
324 }
325 else
326 {
327 m_start.y = aCentre.y - ( m_start.y - aCentre.y );
328 m_end.y = aCentre.y - ( m_end.y - aCentre.y );
329 m_arcCenter.y = aCentre.y - ( m_arcCenter.y - aCentre.y );
330 }
331
332 std::swap( m_start, m_end );
333 break;
334
335 case SHAPE_T::POLY:
336 m_poly.Mirror( aFlipLeftRight, !aFlipLeftRight, aCentre );
337 break;
338
339 case SHAPE_T::BEZIER:
340 if( aFlipLeftRight )
341 {
342 m_start.x = aCentre.x - ( m_start.x - aCentre.x );
343 m_end.x = aCentre.x - ( m_end.x - aCentre.x );
344 m_bezierC1.x = aCentre.x - ( m_bezierC1.x - aCentre.x );
345 m_bezierC2.x = aCentre.x - ( m_bezierC2.x - aCentre.x );
346 }
347 else
348 {
349 m_start.y = aCentre.y - ( m_start.y - aCentre.y );
350 m_end.y = aCentre.y - ( m_end.y - aCentre.y );
351 m_bezierC1.y = aCentre.y - ( m_bezierC1.y - aCentre.y );
352 m_bezierC2.y = aCentre.y - ( m_bezierC2.y - aCentre.y );
353 }
354
355 // Rebuild the poly points shape
356 {
357 std::vector<VECTOR2I> ctrlPoints = { m_start, m_bezierC1, m_bezierC2, m_end };
358 BEZIER_POLY converter( ctrlPoints );
359 converter.GetPoly( m_bezierPoints, m_stroke.GetWidth() );
360 }
361 break;
362
363 default:
365 break;
366 }
367}
void Mirror(bool aX=true, bool aY=false, const VECTOR2I &aRef={ 0, 0 })
Mirror the line points about y or x (or both)

References ARC, BEZIER, CIRCLE, BEZIER_POLY::GetPoly(), STROKE_PARAMS::GetWidth(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_bezierC1, EDA_SHAPE::m_bezierC2, EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_end, EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, EDA_SHAPE::m_stroke, SHAPE_POLY_SET::Mirror(), POLY, RECT, SEGMENT, EDA_SHAPE::SHAPE_T_asString(), UNIMPLEMENTED_FOR, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PCB_SHAPE::Flip(), MirrorHorizontal(), SCH_SHAPE::MirrorHorizontally(), MirrorVertical(), and SCH_SHAPE::MirrorVertically().

◆ Get() [1/3]

template<typename T >
std::optional< T > INSPECTABLE::Get ( const wxString &  aProperty) const
inlineinherited

Definition at line 104 of file inspectable.h.

105 {
107 TYPE_ID thisType = TYPE_HASH( *this );
108 PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
109 std::optional<T> ret;
110
111 if( prop )
112 {
113 const void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
114
115 if( object )
116 ret = prop->get<T>( object );
117 }
118
119 return ret;
120 }
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.
T get(const void *aObject) const
Definition: property.h:270
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:63
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
PROPERTY_BASE * GetProperty(TYPE_ID aType, const wxString &aProperty) const
Return a property for a specific type.
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
#define TYPE_HASH(x)
Definition: property.h:60
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42

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

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE aProperty) const
inlineinherited

Definition at line 84 of file inspectable.h.

85 {
87 const void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
88 return object ? aProperty->getter( object ) : wxAny();
89 }
virtual wxAny getter(const void *aObject) const =0

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(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), PCB_EXPR_VAR_REF::GetValue(), and PAD_DESC::PAD_DESC().

◆ Get() [3/3]

template<typename T >
T INSPECTABLE::Get ( PROPERTY_BASE aProperty) const
inlineinherited

Definition at line 92 of file inspectable.h.

93 {
95 const void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
96
97 if( !object )
98 throw std::runtime_error( "Could not cast INSPECTABLE to the requested type" );
99
100 return aProperty->get<T>( object );
101 }

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

◆ GetArcAngle()

◆ GetArcMid()

◆ GetBezierC1()

◆ GetBezierC2()

◆ GetBezierPoints()

const std::vector< VECTOR2I > & EDA_SHAPE::GetBezierPoints ( ) const
inlineinherited

◆ GetBotRight()

virtual VECTOR2I EDA_SHAPE::GetBotRight ( ) const
inlinevirtualinherited

Reimplemented in FP_TEXTBOX, and PCB_TEXTBOX.

Definition at line 164 of file eda_shape.h.

164{ return GetEnd(); }

References EDA_SHAPE::GetEnd().

Referenced by KIGFX::PCB_PAINTER::draw(), PCB_POINT_EDITOR::makePoints(), and PCB_POINT_EDITOR::updatePoints().

◆ getBoundingBox()

const BOX2I EDA_SHAPE::getBoundingBox ( ) const
protectedinherited

Definition at line 635 of file eda_shape.cpp.

636{
637 BOX2I bbox;
638
639 switch( m_shape )
640 {
641 case SHAPE_T::RECT:
642 for( VECTOR2I& pt : GetRectCorners() )
643 bbox.Merge( pt );
644
645 break;
646
647 case SHAPE_T::SEGMENT:
648 bbox.SetOrigin( GetStart() );
649 bbox.SetEnd( GetEnd() );
650 break;
651
652 case SHAPE_T::CIRCLE:
653 bbox.SetOrigin( GetStart() );
654 bbox.Inflate( GetRadius() );
655 break;
656
657 case SHAPE_T::ARC:
658 computeArcBBox( bbox );
659 break;
660
661 case SHAPE_T::POLY:
662 if( m_poly.IsEmpty() )
663 break;
664
665 for( auto iter = m_poly.CIterate(); iter; iter++ )
666 {
667 VECTOR2I pt( iter->x, iter->y );
668
670 pt += getParentPosition();
671
672 bbox.Merge( pt );
673 }
674
675 break;
676
677 case SHAPE_T::BEZIER:
678 bbox.SetOrigin( GetStart() );
679 bbox.Merge( GetBezierC1() );
680 bbox.Merge( GetBezierC2() );
681 bbox.Merge( GetEnd() );
682 break;
683
684 default:
686 break;
687 }
688
689 bbox.Inflate( std::max( 0, GetWidth() ) / 2 );
690 bbox.Normalize();
691
692 return bbox;
693}
BOX2< Vec > & Normalize()
Ensure that the height and width are positive.
Definition: box2.h:119
BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Inflates the rectangle horizontally by dx and vertically by dy.
Definition: box2.h:506
void SetEnd(coord_type x, coord_type y)
Definition: box2.h:255
virtual VECTOR2I getParentPosition() const =0
const VECTOR2I & GetBezierC2() const
Definition: eda_shape.h:175
virtual EDA_ANGLE getParentOrientation() const =0
std::vector< VECTOR2I > GetRectCorners() const
Definition: eda_shape.cpp:983
int GetWidth() const
Definition: eda_shape.h:107
void computeArcBBox(BOX2I &aBBox) const
Definition: eda_shape.cpp:1019
const VECTOR2I & GetBezierC1() const
Definition: eda_shape.h:172

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

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

◆ GetBoundingBox()

const BOX2I LIB_SHAPE::GetBoundingBox ( ) const
overridevirtual
Returns
the boundary box for this, in library coordinates

Reimplemented from LIB_ITEM.

Definition at line 434 of file lib_shape.cpp.

435{
436 BOX2I bbox = getBoundingBox();
437
438 bbox.RevertYAxis();
439
440 return bbox;
441}
void RevertYAxis()
Mirror the rectangle from the X axis (negate Y pos and size).
Definition: box2.h:689
const BOX2I getBoundingBox() const
Definition: eda_shape.cpp:635

References EDA_SHAPE::getBoundingBox(), and BOX2< Vec >::RevertYAxis().

Referenced by LIB_TEXTBOX::HitTest().

◆ GetCenter()

VECTOR2I LIB_SHAPE::GetCenter ( ) const
inline

Definition at line 88 of file lib_shape.h.

88{ return getCenter(); }

References EDA_SHAPE::getCenter().

Referenced by SCH_EAGLE_PLUGIN::loadSymbolRectangle(), and SCH_ALTIUM_PLUGIN::ParseArc().

◆ getCenter()

◆ GetClass()

wxString LIB_SHAPE::GetClass ( ) const
inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Reimplemented in LIB_TEXTBOX.

Definition at line 42 of file lib_shape.h.

43 {
44 return wxT( "LIB_SHAPE" );
45 }

◆ GetConvert()

◆ GetDefaultFont()

const wxString & LIB_ITEM::GetDefaultFont ( ) const
inherited

Definition at line 128 of file lib_item.cpp.

129{
130 EESCHEMA_SETTINGS* cfg = Pgm().GetSettingsManager().GetAppSettings<EESCHEMA_SETTINGS>();
131
132 return cfg->m_Appearance.default_font;
133}
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:111

References EESCHEMA_SETTINGS::APPEARANCE::default_font, EESCHEMA_SETTINGS::m_Appearance, and Pgm().

Referenced by LIB_PIN::GetDrawFont(), LIB_FIELD::GetDrawFont(), LIB_TEXT::GetDrawFont(), and LIB_TEXTBOX::GetDrawFont().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 147 of file eda_item.h.

148 {
149 constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVING | IS_RESIZING | IS_DRAGGING
151
152 return m_flags & mask;
153 }
#define IS_PASTED
Modifier on IS_NEW which indicates it came from clipboard.
#define IS_CHANGED
Item was edited, and modified.
#define IS_NEW
New item, just created.
#define IS_DRAGGING
Item being dragged.
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
#define STRUCT_DELETED
flag indication structures to be erased
#define IS_MOVING
Item being moved.
#define IS_RESIZING
Item being resized.

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

Referenced by SCH_EDIT_TOOL::ChangeTextType(), 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_FRAME::SelectUnit(), DIALOG_IMAGE_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow().

◆ GetEffectiveLineStyle()

PLOT_DASH_TYPE LIB_SHAPE::GetEffectiveLineStyle ( ) const
inline

Definition at line 60 of file lib_shape.h.

References DEFAULT, STROKE_PARAMS::GetPlotStyle(), EDA_SHAPE::m_stroke, and SOLID.

Referenced by print().

◆ GetEffectivePenWidth()

virtual int LIB_ITEM::GetEffectivePenWidth ( const RENDER_SETTINGS aSettings) const
inlinevirtualinherited

Definition at line 155 of file lib_item.h.

156 {
157 // For historical reasons, a stored value of 0 means "default width" and negative
158 // numbers meant "don't stroke".
159
160 if( GetPenWidth() < 0 )
161 return 0;
162 else if( GetPenWidth() == 0 )
163 return std::max( aSettings->GetDefaultPenWidth(), aSettings->GetMinPenWidth() );
164 else
165 return std::max( GetPenWidth(), aSettings->GetMinPenWidth() );
166 }
int GetDefaultPenWidth() const
virtual int GetPenWidth() const =0

References KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), KIGFX::RENDER_SETTINGS::GetMinPenWidth(), and LIB_ITEM::GetPenWidth().

Referenced by LIB_FIELD::Plot(), Plot(), LIB_TEXTBOX::Plot(), LIB_PIN::PlotSymbol(), LIB_FIELD::print(), print(), LIB_TEXTBOX::print(), and LIB_PIN::printPinSymbol().

◆ GetEffectiveWidth()

virtual int EDA_SHAPE::GetEffectiveWidth ( ) const
inlinevirtualinherited

Reimplemented in SCH_SHAPE.

Definition at line 108 of file eda_shape.h.

108{ return GetWidth(); }

References EDA_SHAPE::GetWidth().

Referenced by EDA_SHAPE::makeEffectiveShapes().

◆ GetEnd()

const VECTOR2I & EDA_SHAPE::GetEnd ( ) const
inlineinherited

Return the ending point of the graphic.

Definition at line 141 of file eda_shape.h.

141{ return m_end; }

References EDA_SHAPE::m_end.

Referenced by PCB_POINT_EDITOR::addCorner(), BOARD_ADAPTER::addShape(), GRAPHICS_CLEANER::areEquivalent(), EDA_SHAPE::CalcArcAngles(), EDA_SHAPE::calcEdit(), KI_TEST::CheckFpShape(), PCB_GRID_HELPER::computeAnchors(), ConvertOutlineToPolygon(), CreateBoardSection(), MICROWAVE_TOOL::createMicrowaveInductor(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawLine(), PCB_POINT_EDITOR::editArcEndpointKeepTangent(), PCB_PLUGIN::format(), formatArc(), formatBezier(), formatRect(), EDA_SHAPE::GetBotRight(), FP_TEXTBOX::GetBotRight(), PCB_TEXTBOX::GetBotRight(), EDA_SHAPE::getBoundingBox(), EDA_SHAPE::GetLength(), LIB_TEXTBOX::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), EDA_SHAPE::GetRectCorners(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), LIB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), CONVERT_TOOL::getStartEndPoints(), FP_TEXTBOX::GetTopLeft(), PCB_TEXTBOX::GetTopLeft(), hash_fp_item(), EDA_SHAPE::hitTest(), idf_export_outline(), GRAPHICS_CLEANER::isNullShape(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), SCH_EAGLE_PLUGIN::loadSymbolRectangle(), EDIT_POINTS_FACTORY::Make(), EDA_SHAPE::makeEffectiveShapes(), DSN::SPECCTRA_DB::makeIMAGE(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromChainedSegs(), GRAPHICS_CLEANER::mergeRects(), Normalize(), SCH_SHAPE::Normalize(), PCB_SHAPE::NormalizeRect(), PCB_PARSER::parsePAD(), SCH_EDITOR_CONTROL::Paste(), SCH_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotFootprintShape(), BRDITEMS_PLOTTER::PlotPcbShape(), SCH_SHAPE::Print(), SCH_TEXTBOX::Print(), SCH_SHAPE::PrintBackground(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_SEXPR_PLUGIN_CACHE::saveTextBox(), SCH_SEXPR_PLUGIN::saveTextBox(), EDA_SHAPE::ShapeGetMsgPanelInfo(), PLOTTER::ThickArc(), GERBER_PLOTTER::ThickArc(), AR_MATRIX::TraceSegmentPcb(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), EDA_SHAPE::TransformShapeWithClearanceToPolygon(), EE_POINT_EDITOR::updatePoints(), and PCB_POINT_EDITOR::updatePoints().

◆ GetEndX()

◆ GetEndY()

◆ GetFillColor()

◆ GetFillMode()

◆ GetFlags()

◆ GetFocusPosition()

virtual const VECTOR2I EDA_ITEM::GetFocusPosition ( ) const
inlinevirtualinherited

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

Reimplemented in BOARD, PCB_SHAPE, and PCB_TRACK.

Definition at line 256 of file eda_item.h.

256{ return GetPosition(); }
virtual VECTOR2I GetPosition() const
Definition: eda_item.h:249

References EDA_ITEM::GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem().

◆ GetLength()

double EDA_SHAPE::GetLength ( ) const
inherited

Return the length of the track using the hypotenuse calculation.

Returns
the length of the track

Definition at line 110 of file eda_shape.cpp.

111{
112 double length = 0.0;
113
114 switch( m_shape )
115 {
116 case SHAPE_T::BEZIER:
117 for( size_t ii = 1; ii < m_bezierPoints.size(); ++ii )
118 length += GetLineLength( m_bezierPoints[ ii - 1], m_bezierPoints[ii] );
119
120 return length;
121
122 case SHAPE_T::SEGMENT:
123 return GetLineLength( GetStart(), GetEnd() );
124
125 case SHAPE_T::POLY:
126 for( int ii = 0; ii < m_poly.COutline( 0 ).SegmentCount(); ii++ )
127 length += m_poly.COutline( 0 ).CSegment( ii ).Length();
128
129 return length;
130
131 case SHAPE_T::ARC:
132 return GetRadius() * GetArcAngle().AsRadians();
133
134 default:
136 return 0.0;
137 }
138}
double AsRadians() const
Definition: eda_angle.h:153
int Length() const
Return the length (this).
Definition: seg.h:351
const SEG CSegment(int aIndex) const
Return a constant copy of the aIndex segment in the line chain.

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

Referenced by DRAWING_TOOL::drawShape(), and EDA_SHAPE::ShapeGetMsgPanelInfo().

◆ GetMenuImage()

BITMAPS LIB_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 LIB_TEXTBOX.

Definition at line 484 of file lib_shape.cpp.

485{
486 switch( GetShape() )
487 {
489 case SHAPE_T::ARC: return BITMAPS::add_arc;
493
494 default:
497 }
498}
@ question_mark
@ add_rectangle
@ add_graphical_segments

References add_arc, add_circle, add_graphical_segments, add_line, add_rectangle, ARC, CIRCLE, EDA_SHAPE::GetShape(), POLY, question_mark, RECT, SEGMENT, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

◆ GetMsgPanelInfo()

void LIB_SHAPE::GetMsgPanelInfo ( EDA_DRAW_FRAME aFrame,
std::vector< MSG_PANEL_ITEM > &  aList 
)
overridevirtual

Display basic info (type, part and convert) about the current item in message panel.

This base function is used to display the information common to the all library items. Call the base class from the derived class or the common information will not be updated in the message panel.

Parameters
aListis the list to populate.

Reimplemented from LIB_ITEM.

Reimplemented in LIB_TEXTBOX.

Definition at line 444 of file lib_shape.cpp.

445{
446 LIB_ITEM::GetMsgPanelInfo( aFrame, aList );
447
448 ShapeGetMsgPanelInfo( aFrame, aList );
449}
void ShapeGetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList)
Definition: eda_shape.cpp:564
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
Display basic info (type, part and convert) about the current item in message panel.
Definition: lib_item.cpp:47

References LIB_ITEM::GetMsgPanelInfo(), and EDA_SHAPE::ShapeGetMsgPanelInfo().

Referenced by SYMBOL_EDITOR_EDIT_TOOL::editShapeProperties().

◆ GetParent()

◆ getParentOrientation()

EDA_ANGLE LIB_SHAPE::getParentOrientation ( ) const
inlineoverrideprivatevirtual

Implements EDA_SHAPE.

Definition at line 132 of file lib_shape.h.

132{ return ANGLE_0; }

References ANGLE_0.

◆ getParentPosition()

VECTOR2I LIB_SHAPE::getParentPosition ( ) const
inlineoverrideprivatevirtual

Implements EDA_SHAPE.

Definition at line 133 of file lib_shape.h.

133{ return VECTOR2I(); }

◆ GetPenWidth()

int LIB_SHAPE::GetPenWidth ( ) const
overridevirtual

Implements LIB_ITEM.

Definition at line 266 of file lib_shape.cpp.

267{
268 return GetWidth();
269}

References EDA_SHAPE::GetWidth().

◆ GetPointCount()

int EDA_SHAPE::GetPointCount ( ) const
inherited
Returns
the number of corners of the polygonal shape

Definition at line 1199 of file eda_shape.cpp.

1200{
1201 // return the number of corners of the polygonal shape
1202 // this shape is expected to be only one polygon without hole
1203 if( GetPolyShape().OutlineCount() )
1204 return GetPolyShape().VertexCount( 0 );
1205
1206 return 0;
1207}
SHAPE_POLY_SET & GetPolyShape()
Definition: eda_shape.h:243
int VertexCount(int aOutline=-1, int aHole=-1) const
Return the number of points in the shape poly set.

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

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

◆ GetPolyShape() [1/2]

◆ GetPolyShape() [2/2]

const SHAPE_POLY_SET & EDA_SHAPE::GetPolyShape ( ) const
inlineinherited

Definition at line 244 of file eda_shape.h.

244{ return m_poly; }

References EDA_SHAPE::m_poly.

◆ getPosition()

VECTOR2I EDA_SHAPE::getPosition ( ) const
protectedinherited

Definition at line 99 of file eda_shape.cpp.

100{
101 if( m_shape == SHAPE_T::ARC )
102 return getCenter();
103 else if( m_shape == SHAPE_T::POLY )
104 return m_poly.CVertex( 0 );
105 else
106 return m_start;
107}

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

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

◆ GetPosition()

◆ GetRadius()

int EDA_SHAPE::GetRadius ( ) const
inherited

Definition at line 476 of file eda_shape.cpp.

477{
478 double radius = 0.0;
479
480 switch( m_shape )
481 {
482 case SHAPE_T::ARC:
483 radius = GetLineLength( m_arcCenter, m_start );
484 break;
485
486 case SHAPE_T::CIRCLE:
487 radius = GetLineLength( m_start, m_end );
488 break;
489
490 default:
492 }
493
494 // don't allow degenerate circles/arcs
495 return std::max( 1, KiROUND( radius ) );
496}

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

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

◆ GetRectCorners()

std::vector< VECTOR2I > EDA_SHAPE::GetRectCorners ( ) const
inherited

Definition at line 983 of file eda_shape.cpp.

984{
985 std::vector<VECTOR2I> pts;
986 VECTOR2I topLeft = GetStart();
987 VECTOR2I botRight = GetEnd();
988
989 // Un-rotate rect topLeft and botRight
990 if( !getParentOrientation().IsCardinal() )
991 {
992 topLeft -= getParentPosition();
993 RotatePoint( topLeft, -getParentOrientation() );
994
995 botRight -= getParentPosition();
996 RotatePoint( botRight, -getParentOrientation() );
997 }
998
999 // Set up the un-rotated 4 corners
1000 pts.emplace_back( topLeft );
1001 pts.emplace_back( botRight.x, topLeft.y );
1002 pts.emplace_back( botRight );
1003 pts.emplace_back( topLeft.x, botRight.y );
1004
1005 // Now re-rotate the 4 corners to get a diamond
1006 if( !getParentOrientation().IsCardinal() )
1007 {
1008 for( VECTOR2I& pt : pts )
1009 {
1011 pt += getParentPosition();
1012 }
1013 }
1014
1015 return pts;
1016}

References EDA_SHAPE::GetEnd(), EDA_SHAPE::getParentOrientation(), EDA_SHAPE::getParentPosition(), EDA_SHAPE::GetStart(), RotatePoint(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BOARD_ADAPTER::addShape(), ConvertOutlineToPolygon(), KIGFX::PCB_PAINTER::draw(), EDA_SHAPE::getBoundingBox(), PCB_SHAPE::GetCorners(), EDA_SHAPE::hitTest(), EDA_SHAPE::makeEffectiveShapes(), SCH_EDITOR_CONTROL::Paste(), SCH_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotFootprintShape(), BRDITEMS_PLOTTER::PlotPcbShape(), EDA_SHAPE::TransformShapeWithClearanceToPolygon(), FP_TEXTBOX::TransformShapeWithClearanceToPolygon(), and PCB_TEXTBOX::TransformShapeWithClearanceToPolygon().

◆ GetSelectMenuText()

wxString LIB_SHAPE::GetSelectMenuText ( UNITS_PROVIDER aUnitsProvider) 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 LIB_TEXTBOX.

Definition at line 452 of file lib_shape.cpp.

453{
454 switch( GetShape() )
455 {
456 case SHAPE_T::ARC:
457 return wxString::Format( _( "Arc, radius %s" ),
458 aUnitsProvider->MessageTextFromValue( GetRadius() ) );
459
460 case SHAPE_T::CIRCLE:
461 return wxString::Format( _( "Circle, radius %s" ),
462 aUnitsProvider->MessageTextFromValue( GetRadius() ) );
463
464 case SHAPE_T::RECT:
465 return wxString::Format( _( "Rectangle, width %s height %s" ),
466 aUnitsProvider->MessageTextFromValue( std::abs( m_start.x - m_end.x ) ),
467 aUnitsProvider->MessageTextFromValue( std::abs( m_start.y - m_end.y ) ) );
468
469 case SHAPE_T::POLY:
470 return wxString::Format( _( "Polyline, %d points" ),
471 int( m_poly.Outline( 0 ).GetPointCount() ) );
472
473 case SHAPE_T::BEZIER:
474 return wxString::Format( _( "Bezier Curve, %d points" ),
475 int( m_bezierPoints.size() ) );
476
477 default:
479 return wxEmptyString;
480 }
481}
wxString MessageTextFromValue(double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
A lower-precision version of StringFromValue().
#define _(s)
EDA_ANGLE abs(const EDA_ANGLE &aAngle)
Definition: eda_angle.h:401
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200

References _, std::abs(), ARC, BEZIER, CIRCLE, Format(), SHAPE_LINE_CHAIN::GetPointCount(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetShape(), EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_end, EDA_SHAPE::m_poly, EDA_SHAPE::m_start, UNITS_PROVIDER::MessageTextFromValue(), SHAPE_POLY_SET::Outline(), POLY, RECT, EDA_SHAPE::SHAPE_T_asString(), UNIMPLEMENTED_FOR, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetShape()

SHAPE_T EDA_SHAPE::GetShape ( ) const
inlineinherited

Definition at line 111 of file eda_shape.h.

111{ return m_shape; }

References EDA_SHAPE::m_shape.

Referenced by PCB_POINT_EDITOR::addCorner(), EE_POINT_EDITOR::addCornerCondition(), AddPoint(), SCH_SHAPE::AddPoint(), BOARD_ADAPTER::addShape(), GRAPHICS_CLEANER::areEquivalent(), EDA_SHAPE::beginEdit(), EDA_SHAPE::calcEdit(), PCB_POINT_EDITOR::canAddCorner(), KI_TEST::CheckFpShape(), PCB_GRID_HELPER::computeAnchors(), EDA_SHAPE::continueEdit(), ConvertOutlineToPolygon(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), EDA_SHAPE::endEdit(), PAD_TOOL::explodePad(), CADSTAR_SCH_ARCHIVE_LOADER::fixUpLibraryPins(), FP_SHAPE::Flip(), FootprintWriteShape(), PCB_PLUGIN::format(), PCB_SHAPE::GetCorners(), FOOTPRINT::GetCoverageArea(), GetMenuImage(), SCH_SHAPE::GetMenuImage(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), GetSelectMenuText(), SCH_SHAPE::GetSelectMenuText(), CONVERT_TOOL::getStartEndPoints(), EE_SELECTION_TOOL::GuessSelectionCandidates(), hash_fp_item(), idf_export_outline(), GRAPHICS_CLEANER::isNullShape(), EE_POINT_EDITOR::Main(), EDIT_POINTS_FACTORY::Make(), DSN::SPECCTRA_DB::makeIMAGE(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromChainedSegs(), GRAPHICS_CLEANER::mergeRects(), PCB_SHAPE::Mirror(), FP_SHAPE::Mirror(), FP_SHAPE::Move(), Normalize(), SCH_SHAPE::Normalize(), PCB_SHAPE::cmp_drawings::operator()(), FOOTPRINT::cmp_drawings::operator()(), ALTIUM_PCB::Parse(), SCH_EDITOR_CONTROL::Paste(), SCH_SHAPE::Plot(), Plot(), BRDITEMS_PLOTTER::PlotFootprintShape(), BRDITEMS_PLOTTER::PlotPcbShape(), SCH_SHAPE::Print(), print(), SCH_SHAPE::PrintBackground(), PAD_TOOL::RecombinePad(), PCB_POINT_EDITOR::removeCorner(), PCB_POINT_EDITOR::removeCornerCondition(), PCB_TEXTBOX::Rotate(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_SEXPR_PLUGIN::saveShape(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), shapesNeedUpdate(), GERBER_PLOTTER::ThickArc(), AR_MATRIX::TraceSegmentPcb(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), PCB_POINT_EDITOR::updateItem(), EE_POINT_EDITOR::updateParentItem(), EE_POINT_EDITOR::updatePoints(), PCB_POINT_EDITOR::updatePoints(), and DIALOG_GRAPHIC_ITEM_PROPERTIES::Validate().

◆ GetSortPosition()

virtual VECTOR2I EDA_ITEM::GetSortPosition ( ) const
inlinevirtualinherited

Return the coordinates that should be used for sorting this element visually compared to other elements.

For instance, for lines the midpoint might be a better sorting point than either end.

Returns
X,Y coordinate of the sort point

Reimplemented in SCH_LINE.

Definition at line 265 of file eda_item.h.

265{ return GetPosition(); }

References EDA_ITEM::GetPosition().

◆ GetStart()

const VECTOR2I & EDA_SHAPE::GetStart ( ) const
inlineinherited

Return the starting point of the graphic.

Definition at line 116 of file eda_shape.h.

116{ return m_start; }

References EDA_SHAPE::m_start.

Referenced by PCB_POINT_EDITOR::addCorner(), BOARD_ADAPTER::addShape(), GRAPHICS_CLEANER::areEquivalent(), EDA_SHAPE::CalcArcAngles(), EDA_SHAPE::calcEdit(), KI_TEST::CheckFpShape(), PCB_GRID_HELPER::computeAnchors(), ALTIUM_PCB::ConvertArcs6ToBoardItemOnLayer(), ConvertOutlineToPolygon(), CreateBoardSection(), MICROWAVE_TOOL::createMicrowaveInductor(), KIGFX::PCB_PAINTER::draw(), PCB_POINT_EDITOR::editArcEndpointKeepCenter(), PCB_POINT_EDITOR::editArcEndpointKeepTangent(), PCB_PLUGIN::format(), formatArc(), formatBezier(), formatCircle(), formatRect(), FP_TEXTBOX::GetBotRight(), PCB_TEXTBOX::GetBotRight(), EDA_SHAPE::getBoundingBox(), PCB_SHAPE::GetFocusPosition(), EDA_SHAPE::GetLength(), LIB_TEXTBOX::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), EDA_SHAPE::GetRectCorners(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), LIB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), CONVERT_TOOL::getStartEndPoints(), EDA_SHAPE::GetTopLeft(), FP_TEXTBOX::GetTopLeft(), PCB_TEXTBOX::GetTopLeft(), hash_fp_item(), EDA_SHAPE::hitTest(), idf_export_outline(), GRAPHICS_CLEANER::isNullShape(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), EDIT_POINTS_FACTORY::Make(), DSN::SPECCTRA_DB::makeIMAGE(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromChainedSegs(), GRAPHICS_CLEANER::mergeRects(), PCB_SHAPE::NormalizeRect(), PCB_PARSER::parsePAD(), SCH_EDITOR_CONTROL::Paste(), SCH_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotFootprintShape(), BRDITEMS_PLOTTER::PlotPcbShape(), BRDITEMS_PLOTTER::PlotPcbTarget(), SCH_SHAPE::Print(), SCH_TEXTBOX::Print(), SCH_SHAPE::PrintBackground(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_SEXPR_PLUGIN_CACHE::saveTextBox(), SCH_SEXPR_PLUGIN::saveTextBox(), EDA_SHAPE::ShapeGetMsgPanelInfo(), PLOTTER::ThickArc(), GERBER_PLOTTER::ThickArc(), AR_MATRIX::TraceSegmentPcb(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), EDA_SHAPE::TransformShapeWithClearanceToPolygon(), EE_POINT_EDITOR::updatePoints(), and PCB_POINT_EDITOR::updatePoints().

◆ GetStartX()

◆ GetStartY()

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS  type) const
inlineinherited

Definition at line 126 of file eda_item.h.

127 {
128 return m_status & type;
129 }
EDA_ITEM_FLAGS m_status
Definition: eda_item.h:495

References EDA_ITEM::m_status.

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 139 of file eda_item.h.

139{ return m_status; }

References EDA_ITEM::m_status.

◆ GetStroke()

◆ GetTopLeft()

virtual VECTOR2I EDA_SHAPE::GetTopLeft ( ) const
inlinevirtualinherited

Reimplemented in FP_TEXTBOX, and PCB_TEXTBOX.

Definition at line 163 of file eda_shape.h.

163{ return GetStart(); }

References EDA_SHAPE::GetStart().

Referenced by KIGFX::PCB_PAINTER::draw(), PCB_POINT_EDITOR::makePoints(), and PCB_POINT_EDITOR::updatePoints().

◆ GetTypeDesc()

wxString EDA_ITEM::GetTypeDesc ( )
inherited

Return a translated description of the type for this EDA_ITEM for display in user facing messages.

Definition at line 301 of file eda_item.cpp.

302{
303 //@see EDA_ITEM_DESC for definition of ENUM_MAP<KICAD_T>
304 wxString typeDescr = ENUM_MAP<KICAD_T>::Instance().ToString( Type() );
305
306 return wxGetTranslation( typeDescr );
307}
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:97
static ENUM_MAP< T > & Instance()
Definition: property.h:512

References ENUM_MAP< T >::Instance(), and EDA_ITEM::Type().

Referenced by PROPERTIES_PANEL::update().

◆ GetTypeName()

wxString LIB_SHAPE::GetTypeName ( ) const
inlineoverridevirtual

Provide a user-consumable name of the object type.

Perform localization when called so that run-time language selection works.

Implements LIB_ITEM.

Definition at line 47 of file lib_shape.h.

48 {
49 return ShowShape();
50 }
wxString ShowShape() const
Definition: eda_shape.cpp:57

References EDA_SHAPE::ShowShape().

Referenced by DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES().

◆ GetUnit()

◆ GetWidth()

int EDA_SHAPE::GetWidth ( ) const
inlineinherited

Definition at line 107 of file eda_shape.h.

107{ return m_stroke.GetWidth(); }

References STROKE_PARAMS::GetWidth(), and EDA_SHAPE::m_stroke.

Referenced by BOARD_ADAPTER::addShape(), GRAPHICS_CLEANER::areEquivalent(), ConvertOutlineToPolygon(), KIGFX::PCB_PAINTER::draw(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), FP_SHAPE::Flip(), EDA_SHAPE::getBoundingBox(), FOOTPRINT::GetCoverageArea(), FP_TEXTBOX::GetEffectiveShape(), PCB_TEXTBOX::GetEffectiveShape(), EDA_SHAPE::GetEffectiveWidth(), GetPenWidth(), SCH_SHAPE::GetPenWidth(), CONVERT_TOOL::getStartEndPoints(), hash_fp_item(), EDA_SHAPE::hitTest(), GRAPHICS_CLEANER::isNullShape(), SCH_LEGACY_PLUGIN_CACHE::loadBezier(), FABMASTER::loadOutline(), FABMASTER::loadPolygon(), DSN::SPECCTRA_DB::makeIMAGE(), CONVERT_TOOL::makePolysFromChainedSegs(), PCB_SHAPE::Mirror(), FP_SHAPE::Mirror(), FOOTPRINT::cmp_drawings::operator()(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintShape(), BRDITEMS_PLOTTER::PlotPcbShape(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), FP_SHAPE::SetDrawCoord(), PLOTTER::ThickArc(), GERBER_PLOTTER::ThickArc(), AR_MATRIX::TraceSegmentPcb(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::TransferDataToWindow(), EDA_SHAPE::TransformShapeWithClearanceToPolygon(), FP_TEXTBOX::TransformShapeWithClearanceToPolygon(), PCB_TEXTBOX::TransformShapeWithClearanceToPolygon(), PCB_POINT_EDITOR::updateItem(), and PCB_SHAPE::ViewBBox().

◆ HasFlag()

◆ hitTest() [1/2]

bool EDA_SHAPE::hitTest ( const BOX2I aRect,
bool  aContained,
int  aAccuracy = 0 
) const
protectedinherited

Definition at line 810 of file eda_shape.cpp.

811{
812 BOX2I arect = aRect;
813 arect.Normalize();
814 arect.Inflate( aAccuracy );
815
816 BOX2I bbox = getBoundingBox();
817
818 switch( m_shape )
819 {
820 case SHAPE_T::CIRCLE:
821 // Test if area intersects or contains the circle:
822 if( aContained )
823 {
824 return arect.Contains( bbox );
825 }
826 else
827 {
828 // If the rectangle does not intersect the bounding box, this is a much quicker test
829 if( !arect.Intersects( bbox ) )
830 return false;
831 else
832 return arect.IntersectsCircleEdge( getCenter(), GetRadius(), GetWidth() );
833 }
834
835 case SHAPE_T::ARC:
836 // Test for full containment of this arc in the rect
837 if( aContained )
838 {
839 return arect.Contains( bbox );
840 }
841 // Test if the rect crosses the arc
842 else
843 {
844 if( !arect.Intersects( bbox ) )
845 return false;
846
847 if( IsFilled() )
848 {
849 return ( arect.Intersects( getCenter(), GetStart() )
850 || arect.Intersects( getCenter(), GetEnd() )
851 || arect.IntersectsCircleEdge( getCenter(), GetRadius(), GetWidth() ) );
852 }
853 else
854 {
855 return arect.IntersectsCircleEdge( getCenter(), GetRadius(), GetWidth() );
856 }
857 }
858
859 case SHAPE_T::RECT:
860 if( aContained )
861 {
862 return arect.Contains( bbox );
863 }
864 else
865 {
866 std::vector<VECTOR2I> pts = GetRectCorners();
867
868 // Account for the width of the lines
869 arect.Inflate( GetWidth() / 2 );
870 return ( arect.Intersects( pts[0], pts[1] )
871 || arect.Intersects( pts[1], pts[2] )
872 || arect.Intersects( pts[2], pts[3] )
873 || arect.Intersects( pts[3], pts[0] ) );
874 }
875
876 case SHAPE_T::SEGMENT:
877 if( aContained )
878 {
879 return arect.Contains( GetStart() ) && aRect.Contains( GetEnd() );
880 }
881 else
882 {
883 // Account for the width of the line
884 arect.Inflate( GetWidth() / 2 );
885 return arect.Intersects( GetStart(), GetEnd() );
886 }
887
888 case SHAPE_T::POLY:
889 if( aContained )
890 {
891 return arect.Contains( bbox );
892 }
893 else
894 {
895 // Fast test: if aRect is outside the polygon bounding box,
896 // rectangles cannot intersect
897 if( !arect.Intersects( bbox ) )
898 return false;
899
900 // Account for the width of the line
901 arect.Inflate( GetWidth() / 2 );
902
903 // Polygons in footprints use coordinates relative to the footprint.
904 // Therefore, instead of using m_poly, we make a copy which is translated
905 // to the actual location in the board.
906 VECTOR2I offset = getParentPosition();
907
908 SHAPE_LINE_CHAIN poly = m_poly.Outline( 0 );
910 poly.Move( offset );
911
912 int count = poly.GetPointCount();
913
914 for( int ii = 0; ii < count; ii++ )
915 {
916 VECTOR2I vertex = poly.GetPoint( ii );
917
918 // Test if the point is within aRect
919 if( arect.Contains( vertex ) )
920 return true;
921
922 if( ii + 1 < count )
923 {
924 VECTOR2I vertexNext = poly.GetPoint( ii + 1 );
925
926 // Test if this edge intersects aRect
927 if( arect.Intersects( vertex, vertexNext ) )
928 return true;
929 }
930 else if( poly.IsClosed() )
931 {
932 VECTOR2I vertexNext = poly.GetPoint( 0 );
933
934 // Test if this edge intersects aRect
935 if( arect.Intersects( vertex, vertexNext ) )
936 return true;
937 }
938 }
939
940 return false;
941 }
942
943 case SHAPE_T::BEZIER:
944 if( aContained )
945 {
946 return arect.Contains( bbox );
947 }
948 else
949 {
950 // Fast test: if aRect is outside the polygon bounding box,
951 // rectangles cannot intersect
952 if( !arect.Intersects( bbox ) )
953 return false;
954
955 // Account for the width of the line
956 arect.Inflate( GetWidth() / 2 );
957 unsigned count = m_bezierPoints.size();
958
959 for( unsigned ii = 1; ii < count; ii++ )
960 {
961 VECTOR2I vertex = m_bezierPoints[ii - 1];
962 VECTOR2I vertexNext = m_bezierPoints[ii];
963
964 // Test if the point is within aRect
965 if( arect.Contains( vertex ) )
966 return true;
967
968 // Test if this edge intersects aRect
969 if( arect.Intersects( vertex, vertexNext ) )
970 return true;
971 }
972
973 return false;
974 }
975
976 default:
978 return false;
979 }
980}
bool Intersects(const BOX2< Vec > &aRect) const
Definition: box2.h:269
bool IntersectsCircleEdge(const Vec &aCenter, const int aRadius, const int aWidth) const
Definition: box2.h:471
bool Contains(const Vec &aPoint) const
Definition: box2.h:141
void Move(const VECTOR2I &aVector) override
bool IsClosed() const override
virtual const VECTOR2I GetPoint(int aIndex) const override
void Rotate(const EDA_ANGLE &aAngle, const VECTOR2I &aCenter={ 0, 0 }) override
Rotate all vertices by a given angle.

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

◆ HitTest() [1/2]

bool LIB_SHAPE::HitTest ( const BOX2I aRect,
bool  aContained,
int  aAccuracy = 0 
) const
overridevirtual

Test if aRect intersects this item.

Parameters
aRectA reference to a BOX2I object containing the rectangle to test.
aContainedSet to true to test for containment instead of an intersection.
aAccuracyIncrease aRect by this amount.
Returns
True if aRect contains or intersects the item bounding box.

Reimplemented from LIB_ITEM.

Reimplemented in LIB_TEXTBOX.

Definition at line 55 of file lib_shape.cpp.

56{
58 return false;
59
60 return hitTest( DefaultTransform.TransformCoordinate( aRect ), aContained, aAccuracy );
61}
bool hitTest(const VECTOR2I &aPosition, int aAccuracy=0) const
Definition: eda_shape.cpp:696
VECTOR2I TransformCoordinate(const VECTOR2I &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:41
TRANSFORM DefaultTransform
Definition: eeschema.cpp:66

References DefaultTransform, EDA_SHAPE::hitTest(), EDA_ITEM::m_flags, SKIP_STRUCT, STRUCT_DELETED, and TRANSFORM::TransformCoordinate().

◆ hitTest() [2/2]

bool EDA_SHAPE::hitTest ( const VECTOR2I aPosition,
int  aAccuracy = 0 
) const
protectedinherited

Definition at line 696 of file eda_shape.cpp.

697{
698 int maxdist = aAccuracy;
699
700 if( GetWidth() > 0 )
701 maxdist += GetWidth() / 2;
702
703 switch( m_shape )
704 {
705 case SHAPE_T::CIRCLE:
706 {
707 int radius = GetRadius();
708
709 VECTOR2I::extended_type dist = KiROUND<double, VECTOR2I::extended_type>(
710 EuclideanNorm( aPosition - getCenter() ) );
711
712 if( IsFilled() )
713 return dist <= radius + maxdist; // Filled circle hit-test
714 else
715 return abs( radius - dist ) <= maxdist; // Ring hit-test
716 }
717
718 case SHAPE_T::ARC:
719 {
720 if( EuclideanNorm( aPosition - m_start ) <= maxdist )
721 return true;
722
723 if( EuclideanNorm( aPosition - m_end ) <= maxdist )
724 return true;
725
726 VECTOR2I relPos = aPosition - getCenter();
727 int radius = GetRadius();
728
730 KiROUND<double, VECTOR2I::extended_type>( EuclideanNorm( relPos ) );
731
732 if( IsFilled() )
733 {
734 // Check distance from arc center
735 if( dist > radius + maxdist )
736 return false;
737 }
738 else
739 {
740 // Check distance from arc circumference
741 if( abs( radius - dist ) > maxdist )
742 return false;
743 }
744
745 // Finally, check to see if it's within arc's swept angle.
746 EDA_ANGLE startAngle;
747 EDA_ANGLE endAngle;
748 CalcArcAngles( startAngle, endAngle );
749
750 EDA_ANGLE relPosAngle( relPos );
751
752 startAngle.Normalize();
753 endAngle.Normalize();
754 relPosAngle.Normalize();
755
756 if( endAngle > startAngle )
757 return relPosAngle >= startAngle && relPosAngle <= endAngle;
758 else
759 return relPosAngle >= startAngle || relPosAngle <= endAngle;
760 }
761
762 case SHAPE_T::BEZIER:
763 const_cast<EDA_SHAPE*>( this )->RebuildBezierToSegmentsPointsList( GetWidth() );
764
765 for( unsigned int i= 1; i < m_bezierPoints.size(); i++)
766 {
767 if( TestSegmentHit( aPosition, m_bezierPoints[ i - 1], m_bezierPoints[i], maxdist ) )
768 return true;
769 }
770
771 return false;
772
773 case SHAPE_T::SEGMENT:
774 return TestSegmentHit( aPosition, GetStart(), GetEnd(), maxdist );
775
776 case SHAPE_T::RECT:
777 if( IsAnnotationProxy() || IsFilled() ) // Filled rect hit-test
778 {
779 SHAPE_POLY_SET poly;
780 poly.NewOutline();
781
782 for( const VECTOR2I& pt : GetRectCorners() )
783 poly.Append( pt );
784
785 return poly.Collide( aPosition, maxdist );
786 }
787 else // Open rect hit-test
788 {
789 std::vector<VECTOR2I> pts = GetRectCorners();
790
791 return TestSegmentHit( aPosition, pts[0], pts[1], maxdist )
792 || TestSegmentHit( aPosition, pts[1], pts[2], maxdist )
793 || TestSegmentHit( aPosition, pts[2], pts[3], maxdist )
794 || TestSegmentHit( aPosition, pts[3], pts[0], maxdist );
795 }
796
797 case SHAPE_T::POLY:
798 if( IsFilled() )
799 return m_poly.Collide( aPosition, maxdist );
800 else
801 return m_poly.CollideEdge( aPosition, nullptr, maxdist );
802
803 default:
805 return false;
806 }
807}
void RebuildBezierToSegmentsPointsList(int aMinSegLen)
Rebuild the m_bezierPoints vertex list that approximate the Bezier curve by a list of segments.
Definition: eda_shape.cpp:370
bool IsAnnotationProxy() const
Definition: eda_shape.h:87
Represent a set of closed polygons.
bool CollideEdge(const VECTOR2I &aPoint, VERTEX_INDEX *aClosestVertex=nullptr, int aClearance=0) const
Check whether aPoint collides with any edge of any of the contours of the polygon.
bool Collide(const SHAPE *aShape, int aClearance=0, int *aActual=nullptr, VECTOR2I *aLocation=nullptr) const override
Check if the boundary of shape (this) lies closer to the shape aShape than aClearance,...
int Append(int x, int y, int aOutline=-1, int aHole=-1, bool aAllowDuplication=false)
Add a new vertex to the contour indexed by aOutline and aHole (defaults to the outline of the last po...
VECTOR2_TRAITS< int >::extended_type extended_type
Definition: vector2d.h:76
bool TestSegmentHit(const VECTOR2I &aRefPoint, const VECTOR2I &aStart, const VECTOR2I &aEnd, int aDist)
Test if aRefPoint is with aDistance on the line defined by aStart and aEnd.
Definition: trigo.cpp:129
double EuclideanNorm(const VECTOR2I &vector)
Definition: trigo.h:129

References std::abs(), SHAPE_POLY_SET::Append(), ARC, BEZIER, EDA_SHAPE::CalcArcAngles(), CIRCLE, SHAPE_POLY_SET::Collide(), SHAPE_POLY_SET::CollideEdge(), EuclideanNorm(), EDA_SHAPE::getCenter(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetRectCorners(), EDA_SHAPE::GetStart(), EDA_SHAPE::GetWidth(), EDA_SHAPE::IsAnnotationProxy(), EDA_SHAPE::IsFilled(), EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_end, EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, SHAPE_POLY_SET::NewOutline(), EDA_ANGLE::Normalize(), POLY, EDA_SHAPE::RebuildBezierToSegmentsPointsList(), RECT, SEGMENT, EDA_SHAPE::SHAPE_T_asString(), TestSegmentHit(), and UNIMPLEMENTED_FOR.

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

◆ HitTest() [2/2]

bool LIB_SHAPE::HitTest ( const VECTOR2I aPosition,
int  aAccuracy = 0 
) const
overridevirtual

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

Parameters
aPositionA reference to a VECTOR2I object containing the coordinates to test.
aAccuracyIncrease the item bounding box by this amount.
Returns
True if aPosition is within the item bounding box.

Reimplemented from LIB_ITEM.

Reimplemented in LIB_TEXTBOX.

Definition at line 46 of file lib_shape.cpp.

47{
50
51 return hitTest( DefaultTransform.TransformCoordinate( aPosRef ), aAccuracy );
52}
constexpr EDA_IU_SCALE schIUScale
Definition: base_units.h:111
#define MINIMUM_SELECTION_DISTANCE
Definition: lib_item.h:46
constexpr int MilsToIU(int mils) const
Definition: base_units.h:94

References DefaultTransform, EDA_SHAPE::hitTest(), EDA_IU_SCALE::MilsToIU(), MINIMUM_SELECTION_DISTANCE, schIUScale, and TRANSFORM::TransformCoordinate().

Referenced by EE_POINT_EDITOR::addCornerCondition().

◆ IsAnnotationProxy()

◆ IsBrightened()

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 105 of file eda_item.h.

105{ return m_flags & IS_DRAGGING; }

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const
inlineinherited

Definition at line 108 of file eda_item.h.

108{ return m_flags & ENTERED; }
#define ENTERED
indicates a group has been entered

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsFilled()

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const
inlineinherited

Definition at line 203 of file eda_item.h.

203{ return m_forceVisible; }
bool m_forceVisible
Definition: eda_item.h:497

References EDA_ITEM::m_forceVisible.

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

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 102 of file eda_item.h.

102{ return m_flags & IS_CHANGED; }

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

◆ IsNew()

◆ IsPolyShapeValid()

bool EDA_SHAPE::IsPolyShapeValid ( ) const
inherited
Returns
true if the polygonal shape is valid (has more than 2 points)

Definition at line 1187 of file eda_shape.cpp.

1188{
1189 // return true if the polygonal shape is valid (has more than 2 points)
1190 if( GetPolyShape().OutlineCount() == 0 )
1191 return false;
1192
1193 const SHAPE_LINE_CHAIN& outline = static_cast<const SHAPE_POLY_SET&>( GetPolyShape() ).Outline( 0 );
1194
1195 return outline.PointCount() > 2;
1196}

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

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

◆ IsPrivate()

◆ 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 LIB_TEXTBOX, SCH_FIELD, SCH_LABEL, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 420 of file eda_item.h.

420{ return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 109 of file eda_item.h.

109{ return m_flags & IS_RESIZING; }

References IS_RESIZING, and EDA_ITEM::m_flags.

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const
inlineinherited

Definition at line 112 of file eda_item.h.

113 {
114 return ( m_flags & ( IS_ROLLOVER | IS_MOVING ) ) == IS_ROLLOVER;
115 }
#define IS_ROLLOVER
Rollover active. Used for hyperlink highlighting.

References IS_MOVING, IS_ROLLOVER, and EDA_ITEM::m_flags.

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

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const
inlineinherited

Definition at line 107 of file eda_item.h.

107{ return m_flags & SELECTED; }

References EDA_ITEM::m_flags, and SELECTED.

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

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const
inlineinherited

Definition at line 175 of file eda_item.h.

175{ return m_flags & IS_SHOWN_AS_BITMAP; }
#define IS_SHOWN_AS_BITMAP

References IS_SHOWN_AS_BITMAP, and EDA_ITEM::m_flags.

◆ IsType()

virtual bool EDA_ITEM::IsType ( const std::vector< KICAD_T > &  aScanTypes) const
inlinevirtualinherited

Check whether the item is one of the listed types.

Parameters
aScanTypesList of item types
Returns
true if the item type is contained in the list aScanTypes

Reimplemented in SCH_FIELD, SCH_ITEM, SCH_LABEL_BASE, SCH_LINE, FP_SHAPE, FP_TEXT, FP_TEXTBOX, PAD, PCB_DIMENSION_BASE, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, and PCB_VIA.

Definition at line 183 of file eda_item.h.

184 {
185 for( KICAD_T scanType : aScanTypes )
186 {
187 if( scanType == SCH_LOCATE_ANY_T || scanType == m_structType )
188 return true;
189 }
190
191 return false;
192 }
KICAD_T m_structType
Run time identification, keep private so it can never be changed after a ctor sets it.
Definition: eda_item.h:505
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78
@ SCH_LOCATE_ANY_T
Definition: typeinfo.h:182

References EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), ROUTER_TOOL::CanInlineDrag(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), SCH_FIELD::GetCanonicalName(), KIGFX::SCH_PAINTER::getLineWidth(), SCH_FIELD::GetName(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_FIELD::GetShownText(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), SCH_ITEM::IsType(), FP_TEXT::IsType(), FP_TEXTBOX::IsType(), PAD::IsType(), PCB_DIMENSION_BASE::IsType(), PCB_SHAPE::IsType(), PCB_TEXT::IsType(), PCB_TEXTBOX::IsType(), PCB_VIA::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), SCH_FIELD::SetId(), SCH_BASE_FRAME::UpdateItem(), and EDA_ITEM::Visit().

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 106 of file eda_item.h.

106{ return m_flags & IS_WIRE_IMAGE; }

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

◆ IterateForward() [1/2]

template<class T >
static INSPECT_RESULT EDA_ITEM::IterateForward ( std::deque< T > &  aList,
INSPECTOR  inspector,
void *  testData,
const std::vector< KICAD_T > &  scanTypes 
)
inlinestaticinherited

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

Definition at line 302 of file eda_item.h.

304 {
305 for( const auto& it : aList )
306 {
307 if( static_cast<EDA_ITEM*>( it )->Visit( inspector,
308 testData,
309 scanTypes ) == INSPECT_RESULT::QUIT )
310 {
312 }
313 }
314
316 }
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:85
virtual INSPECT_RESULT Visit(INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &aScanTypes)
May be re-implemented for each derived class in order to handle all the types given by its member dat...
Definition: eda_item.cpp:91

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

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >
static INSPECT_RESULT EDA_ITEM::IterateForward ( std::vector< T > &  aList,
INSPECTOR  inspector,
void *  testData,
const std::vector< KICAD_T > &  scanTypes 
)
inlinestaticinherited

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

Definition at line 322 of file eda_item.h.

324 {
325 for( const auto& it : aList )
326 {
327 if( static_cast<EDA_ITEM*>( it )->Visit( inspector,
328 testData,
329 scanTypes ) == INSPECT_RESULT::QUIT )
330 {
332 }
333 }
334
336 }

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

◆ makeEffectiveShapes()

std::vector< SHAPE * > EDA_SHAPE::makeEffectiveShapes ( bool  aEdgeOnly,
bool  aLineChainOnly = false 
) const
protectedinherited

Make a set of SHAPE objects representing the EDA_SHAPE.

Caller owns the objects.

Parameters
aEdgeOnlyindicates only edges should be generated (even if 0 width), and no fill shapes.
aLineChainOnlyindicates SHAPE_POLY_SET is being abused slightly to represent a lineChain rather than a closed polygon

Definition at line 1079 of file eda_shape.cpp.

1080{
1081 std::vector<SHAPE*> effectiveShapes;
1082 int width = GetEffectiveWidth();
1083
1084 switch( m_shape )
1085 {
1086 case SHAPE_T::ARC:
1087 effectiveShapes.emplace_back( new SHAPE_ARC( m_arcCenter, m_start, GetArcAngle(), width ) );
1088 break;
1089
1090 case SHAPE_T::SEGMENT:
1091 effectiveShapes.emplace_back( new SHAPE_SEGMENT( m_start, m_end, width ) );
1092 break;
1093
1094 case SHAPE_T::RECT:
1095 {
1096 std::vector<VECTOR2I> pts = GetRectCorners();
1097
1098 if( ( IsFilled() || IsAnnotationProxy() ) && !aEdgeOnly )
1099 effectiveShapes.emplace_back( new SHAPE_SIMPLE( pts ) );
1100
1101 if( width > 0 || !IsFilled() || aEdgeOnly )
1102 {
1103 effectiveShapes.emplace_back( new SHAPE_SEGMENT( pts[0], pts[1], width ) );
1104 effectiveShapes.emplace_back( new SHAPE_SEGMENT( pts[1], pts[2], width ) );
1105 effectiveShapes.emplace_back( new SHAPE_SEGMENT( pts[2], pts[3], width ) );
1106 effectiveShapes.emplace_back( new SHAPE_SEGMENT( pts[3], pts[0], width ) );
1107 }
1108 }
1109 break;
1110
1111 case SHAPE_T::CIRCLE:
1112 {
1113 if( IsFilled() && !aEdgeOnly )
1114 effectiveShapes.emplace_back( new SHAPE_CIRCLE( getCenter(), GetRadius() ) );
1115
1116 if( width > 0 || !IsFilled() || aEdgeOnly )
1117 effectiveShapes.emplace_back( new SHAPE_ARC( getCenter(), GetEnd(), ANGLE_360, width ) );
1118
1119 break;
1120 }
1121
1122 case SHAPE_T::BEZIER:
1123 {
1124 std::vector<VECTOR2I> bezierPoints = buildBezierToSegmentsPointsList( width );
1125 VECTOR2I start_pt = bezierPoints[0];
1126
1127 for( unsigned int jj = 1; jj < bezierPoints.size(); jj++ )
1128 {
1129 VECTOR2I end_pt = bezierPoints[jj];
1130 effectiveShapes.emplace_back( new SHAPE_SEGMENT( start_pt, end_pt, width ) );
1131 start_pt = end_pt;
1132 }
1133
1134 break;
1135 }
1136
1137 case SHAPE_T::POLY:
1138 {
1139 if( GetPolyShape().OutlineCount() == 0 ) // malformed/empty polygon
1140 break;
1141
1143
1144 if( aLineChainOnly )
1145 l.SetClosed( false );
1146
1148 l.Move( getParentPosition() );
1149
1150 if( IsFilled() && !aEdgeOnly )
1151 effectiveShapes.emplace_back( new SHAPE_SIMPLE( l ) );
1152
1153 if( width > 0 || !IsFilled() || aEdgeOnly )
1154 {
1155 for( int i = 0; i < l.SegmentCount(); i++ )
1156 effectiveShapes.emplace_back( new SHAPE_SEGMENT( l.Segment( i ), width ) );
1157 }
1158 }
1159 break;
1160
1161 default:
1163 break;
1164 }
1165
1166 return effectiveShapes;
1167}
virtual int GetEffectiveWidth() const
Definition: eda_shape.h:108
const std::vector< VECTOR2I > buildBezierToSegmentsPointsList(int aMinSegLen) const
Definition: eda_shape.cpp:384
int SegmentCount() const
Return the number of segments in this line chain.
SEG Segment(int aIndex)
Return a copy of the aIndex-th segment in the line chain.
Represent a simple polygon consisting of a zero-thickness closed chain of connected line segments.
Definition: shape_simple.h:42

References ANGLE_360, ARC, BEZIER, EDA_SHAPE::buildBezierToSegmentsPointsList(), CIRCLE, SHAPE_POLY_SET::COutline(), EDA_SHAPE::GetArcAngle(), EDA_SHAPE::getCenter(), EDA_SHAPE::GetEffectiveWidth(), EDA_SHAPE::GetEnd(), EDA_SHAPE::getParentOrientation(), EDA_SHAPE::getParentPosition(), EDA_SHAPE::GetPolyShape(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetRectCorners(), EDA_SHAPE::IsAnnotationProxy(), EDA_SHAPE::IsFilled(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_end, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, SHAPE_LINE_CHAIN::Move(), POLY, RECT, SHAPE_LINE_CHAIN::Rotate(), SEGMENT, SHAPE_LINE_CHAIN::Segment(), SHAPE_LINE_CHAIN::SegmentCount(), SHAPE_LINE_CHAIN::SetClosed(), EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

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

◆ MakeEffectiveShapes()

virtual std::vector< SHAPE * > LIB_SHAPE::MakeEffectiveShapes ( bool  aEdgeOnly = false) const
inlineoverridevirtual

Make a set of SHAPE objects representing the LIB_SHAPE.

Caller owns the objects.

Parameters
aEdgeOnlyindicates only edges should be generated (even if 0 width), and no fill shapes.

Reimplemented from EDA_SHAPE.

Definition at line 96 of file lib_shape.h.

97 {
98 return makeEffectiveShapes( aEdgeOnly, true );
99 }
std::vector< SHAPE * > makeEffectiveShapes(bool aEdgeOnly, bool aLineChainOnly=false) const
Make a set of SHAPE objects representing the EDA_SHAPE.
Definition: eda_shape.cpp:1079

References EDA_SHAPE::makeEffectiveShapes().

Referenced by KIGFX::SCH_PAINTER::draw(), print(), and LIB_TEXTBOX::print().

◆ Matches() [1/2]

virtual bool EDA_ITEM::Matches ( const EDA_SEARCH_DATA 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
aSearchDataA reference to a wxFindReplaceData object containing the search criteria.
aAuxDataA 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_MARKER, LIB_TEXTBOX, SCH_FIELD, SCH_PIN, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, FP_TEXT, FP_TEXTBOX, NETINFO_ITEM, PCB_MARKER, PCB_TEXT, PCB_TEXTBOX, and ZONE.

Definition at line 382 of file eda_item.h.

383 {
384 return false;
385 }

Referenced by SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_EDITOR_CONTROL::HasMatch(), SCH_MARKER::Matches(), LIB_TEXTBOX::Matches(), SCH_FIELD::Matches(), SCH_PIN::Matches(), SCH_SHEET_PIN::Matches(), SCH_TEXT::Matches(), SCH_TEXTBOX::Matches(), FP_TEXT::Matches(), FP_TEXTBOX::Matches(), NETINFO_ITEM::Matches(), PCB_MARKER::Matches(), PCB_TEXT::Matches(), PCB_TEXTBOX::Matches(), ZONE::Matches(), SCH_EDITOR_CONTROL::ReplaceAndFindNext(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_EDITOR_CONTROL::UpdateFind().

◆ Matches() [2/2]

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

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters
aTextA reference to a wxString object containing the string to test.
aSearchDataThe criteria to search against.
Returns
True if aText matches the search criteria in aSearchData.

Definition at line 117 of file eda_item.cpp.

118{
119 wxString text = aText;
120 wxString searchText = aSearchData.findString;
121
122 // Don't match if searching for replaceable item and the item doesn't support text replace.
123 if( aSearchData.searchAndReplace && !IsReplaceable() )
124 return false;
125
126 if( !aSearchData.matchCase )
127 {
128 text.MakeUpper();
129 searchText.MakeUpper();
130 }
131
133 {
134 int ii = 0;
135
136 while( ii < (int) text.length() )
137 {
138 int next = text.find( searchText, ii );
139
140 if( next == wxNOT_FOUND )
141 return false;
142
143 ii = next;
144 next += searchText.length();
145
146 bool startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
147 bool endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
148
149 if( startOK && endOK )
150 return true;
151 else
152 ii++;
153 }
154
155 return false;
156 }
157 else if( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::WILDCARD )
158 {
159 return text.Matches( searchText );
160 }
161 else
162 {
163 return text.Find( searchText ) != wxNOT_FOUND;
164 }
165}
virtual bool IsReplaceable() const
Override this method in any derived object that supports test find and replace.
Definition: eda_item.h:420
CITER next(CITER it)
Definition: ptree.cpp:126
EDA_SEARCH_MATCH_MODE matchMode

References EDA_SEARCH_DATA::findString, EDA_ITEM::IsReplaceable(), EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), EDA_SEARCH_DATA::searchAndReplace, text, WHOLEWORD, and WILDCARD.

◆ MirrorHorizontal()

void LIB_SHAPE::MirrorHorizontal ( const VECTOR2I aCenter)
overridevirtual

Mirror the draw object along the horizontal (X) axis about aCenter point.

Parameters
aCenterPoint to mirror around.

Implements LIB_ITEM.

Definition at line 114 of file lib_shape.cpp.

115{
116 flip( aCenter, true );
117}
void flip(const VECTOR2I &aCentre, bool aFlipLeftRight)
Definition: eda_shape.cpp:285

References EDA_SHAPE::flip().

◆ MirrorVertical()

void LIB_SHAPE::MirrorVertical ( const VECTOR2I aCenter)
overridevirtual

Mirror the draw object along the MirrorVertical (Y) axis about aCenter point.

Parameters
aCenterPoint to mirror around.

Implements LIB_ITEM.

Definition at line 120 of file lib_shape.cpp.

121{
122 flip( aCenter, false );
123}

References EDA_SHAPE::flip().

◆ move()

void EDA_SHAPE::move ( const VECTOR2I aMoveVector)
protectedinherited

Definition at line 141 of file eda_shape.cpp.

142{
143 switch ( m_shape )
144 {
145 case SHAPE_T::ARC:
146 case SHAPE_T::SEGMENT:
147 case SHAPE_T::RECT:
148 case SHAPE_T::CIRCLE:
149 m_start += aMoveVector;
150 m_end += aMoveVector;
151 m_arcCenter += aMoveVector;
152 break;
153
154 case SHAPE_T::POLY:
155 m_poly.Move( VECTOR2I( aMoveVector ) );
156 break;
157
158 case SHAPE_T::BEZIER:
159 m_start += aMoveVector;
160 m_end += aMoveVector;
161 m_bezierC1 += aMoveVector;
162 m_bezierC2 += aMoveVector;
163
164 for( VECTOR2I& pt : m_bezierPoints )
165 pt += aMoveVector;
166
167 break;
168
169 default:
171 break;
172 }
173}
void Move(const VECTOR2I &aVector) override

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

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

◆ MoveTo()

void LIB_SHAPE::MoveTo ( const VECTOR2I aPosition)
overridevirtual

Move a draw object to aPosition.

Parameters
aPositionPosition to move draw item to.

Implements LIB_ITEM.

Definition at line 87 of file lib_shape.cpp.

88{
89 setPosition( aPosition );
90}
void setPosition(const VECTOR2I &aPos)
Definition: eda_shape.cpp:93

References EDA_SHAPE::setPosition().

◆ Normalize()

void LIB_SHAPE::Normalize ( )

Definition at line 93 of file lib_shape.cpp.

94{
95 if( GetShape() == SHAPE_T::RECT )
96 {
97 VECTOR2I size = GetEnd() - GetPosition();
98
99 if( size.y > 0 )
100 {
101 SetStartY( GetStartY() + size.y );
102 SetEndY( GetStartY() - size.y );
103 }
104
105 if( size.x < 0 )
106 {
107 SetStartX( GetStartX() + size.x );
108 SetEndX( GetStartX() - size.x );
109 }
110 }
111}
void SetStartX(int x)
Definition: eda_shape.h:132
int GetStartY() const
Definition: eda_shape.h:117
void SetEndY(int y)
Definition: eda_shape.h:151
void SetStartY(int y)
Definition: eda_shape.h:126
void SetEndX(int x)
Definition: eda_shape.h:157
int GetStartX() const
Definition: eda_shape.h:118
VECTOR2I GetPosition() const override
Definition: lib_shape.h:85

References EDA_SHAPE::GetEnd(), GetPosition(), EDA_SHAPE::GetShape(), EDA_SHAPE::GetStartX(), EDA_SHAPE::GetStartY(), RECT, EDA_SHAPE::SetEndX(), EDA_SHAPE::SetEndY(), EDA_SHAPE::SetStartX(), EDA_SHAPE::SetStartY(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by EDIT_POINTS_FACTORY::Make().

◆ Offset()

void LIB_SHAPE::Offset ( const VECTOR2I aOffset)
overridevirtual

Set the drawing object by aOffset from the current position.

Parameters
aOffsetCoordinates to offset the item position.

Implements LIB_ITEM.

Definition at line 81 of file lib_shape.cpp.

82{
83 move( aOffset );
84}
void move(const VECTOR2I &aMoveVector)
Definition: eda_shape.cpp:141

References EDA_SHAPE::move().

◆ operator<() [1/2]

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 231 of file eda_item.cpp.

232{
233 wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
234 GetClass() ) );
235
236 return false;
237}
virtual wxString GetClass() const =0
Return the class name.

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

◆ operator<() [2/2]

bool LIB_ITEM::operator< ( const LIB_ITEM aOther) const
inherited

Test if another draw item is less than this draw object.

Parameters
aOther- Draw item to compare against.
Returns
- True if object is less than this object.

Definition at line 102 of file lib_item.cpp.

103{
104 if( Type() != aOther.Type() )
105 return Type() < aOther.Type();
106
107 return ( compare( aOther ) < 0 );
108}

References LIB_ITEM::compare(), and EDA_ITEM::Type().

◆ operator==() [1/2]

bool LIB_ITEM::operator== ( const LIB_ITEM aOther) const
inherited

Test LIB_ITEM objects for equivalence.

Parameters
aOtherObject to test against.
Returns
True if object is identical to this object.

Definition at line 93 of file lib_item.cpp.

94{
95 if( Type() != aOther.Type() )
96 return false;
97
98 return compare( aOther, LIB_ITEM::COMPARE_FLAGS::EQUALITY ) == 0;
99}

References LIB_ITEM::compare(), and EDA_ITEM::Type().

◆ operator==() [2/2]

bool LIB_ITEM::operator== ( const LIB_ITEM aOther) const
inlineinherited

Definition at line 207 of file lib_item.h.

208 {
209 return *this == *aOther;
210 }

◆ Plot()

void LIB_SHAPE::Plot ( PLOTTER aPlotter,
bool  aBackground,
const VECTOR2I aOffset,
const TRANSFORM aTransform,
bool  aDimmed 
) const
overridevirtual

Plot the draw item using the plot object.

Parameters
aPlotterThe plot object to plot to.
aBackgrounda poor-man's Z-order. The routine will get called twice, first with aBackground true and then with aBackground false.
aOffsetPlot offset position.
aFillFlag to indicate whether or not the object is filled.
aTransformThe plot transform.
aDimmedif true, reduce color to background

Implements LIB_ITEM.

Reimplemented in LIB_TEXTBOX.

Definition at line 134 of file lib_shape.cpp.

136{
137 if( IsPrivate() )
138 return;
139
140 VECTOR2I start = aTransform.TransformCoordinate( m_start ) + aOffset;
141 VECTOR2I end = aTransform.TransformCoordinate( m_end ) + aOffset;
142 VECTOR2I center = aTransform.TransformCoordinate( getCenter() ) + aOffset;
143
144 static std::vector<VECTOR2I> cornerList;
145
146 if( GetShape() == SHAPE_T::POLY )
147 {
148 const SHAPE_LINE_CHAIN& poly = m_poly.Outline( 0 );
149 cornerList.clear();
150
151 for( const VECTOR2I& pt : poly.CPoints() )
152 cornerList.push_back( aTransform.TransformCoordinate( pt ) + aOffset );
153 }
154 else if( GetShape() == SHAPE_T::BEZIER )
155 {
156 cornerList.clear();
157
158 for( const VECTOR2I& pt : m_bezierPoints )
159 cornerList.push_back( aTransform.TransformCoordinate( pt ) + aOffset );
160 }
161 else if( GetShape() == SHAPE_T::ARC )
162 {
163 EDA_ANGLE t1, t2;
164
165 CalcArcAngles( t1, t2 );
166
167 // N.B. The order of evaluation is critical here as MapAngles will modify t1, t2
168 // and the Normalize routine depends on these modifications for the correct output
169 bool transformed = aTransform.MapAngles( &t1, &t2 );
170 EDA_ANGLE arc_angle = ( t1 - t2 ).Normalize180();
171 bool transformed2 = ( arc_angle > ANGLE_0 ) && ( arc_angle < ANGLE_180 );
172
173 if( transformed != transformed2 )
174 std::swap( start, end );
175 }
176
177 int penWidth;
179 PLOT_DASH_TYPE lineStyle = GetStroke().GetPlotStyle();
180 FILL_T fill = m_fill;
181
182 if( aBackground )
183 {
184 if( !aPlotter->GetColorMode() )
185 return;
186
187 switch( m_fill )
188 {
190 return;
191
194 break;
195
198 break;
199
200 default:
201 return;
202 }
203
204 penWidth = 0;
205 lineStyle = PLOT_DASH_TYPE::SOLID;
206 }
207 else
208 {
209 if( !aPlotter->GetColorMode() || color == COLOR4D::UNSPECIFIED )
211
212 if( lineStyle == PLOT_DASH_TYPE::DEFAULT )
213 lineStyle = PLOT_DASH_TYPE::SOLID;
214
216 fill = m_fill;
217 else
218 fill = FILL_T::NO_FILL;
219
220 penWidth = GetEffectivePenWidth( aPlotter->RenderSettings() );
221 }
222
223 COLOR4D bg = aPlotter->RenderSettings()->GetBackgroundColor();
224
225 if( bg == COLOR4D::UNSPECIFIED || !aPlotter->GetColorMode() )
226 bg = COLOR4D::WHITE;
227
228 if( aDimmed )
229 color = color.Mix( bg, 0.5f );
230
231 aPlotter->SetColor( color );
232 aPlotter->SetDash( penWidth, lineStyle );
233
234 switch( GetShape() )
235 {
236 case SHAPE_T::ARC:
237 {
238 // In some plotters (not all) the arc is approximated by segments, and
239 // a error max is needed. We try to approximate by 360/5 segments by 360 deg
240 int arc2segment_error = CircleToEndSegmentDeltaRadius( GetRadius(), 360/5 );
241 aPlotter->Arc( center, start, end, fill, penWidth, arc2segment_error );
242 }
243 break;
244
245 case SHAPE_T::CIRCLE:
246 aPlotter->Circle( center, GetRadius() * 2, fill, penWidth );
247 break;
248
249 case SHAPE_T::RECT:
250 aPlotter->Rect( start, end, fill, penWidth );
251 break;
252
253 case SHAPE_T::POLY:
254 case SHAPE_T::BEZIER:
255 aPlotter->PlotPoly( cornerList, fill, penWidth );
256 break;
257
258 default:
260 }
261
262 aPlotter->SetDash( penWidth, PLOT_DASH_TYPE::SOLID );
263}
int color
Definition: DXF_plotter.cpp:57
COLOR4D GetFillColor() const
Definition: eda_shape.h:103
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
const COLOR4D & GetLayerColor(int aLayer) const
Return the color used to draw a layer.
virtual const COLOR4D & GetBackgroundColor() const =0
Return current background color settings.
bool IsPrivate() const
Definition: lib_item.h:279
virtual int GetEffectivePenWidth(const RENDER_SETTINGS *aSettings) const
Definition: lib_item.h:155
STROKE_PARAMS GetStroke() const
Definition: lib_shape.h:52
virtual void SetDash(int aLineWidth, PLOT_DASH_TYPE aLineStyle)=0
virtual void Circle(const VECTOR2I &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)=0
virtual void Arc(const VECTOR2I &aCenter, const VECTOR2I &aStart, const VECTOR2I &aEnd, FILL_T aFill, int aWidth, int aMaxError)
Generic fallback: arc rendered as a polyline.
Definition: plotter.cpp:149
RENDER_SETTINGS * RenderSettings()
Definition: plotter.h:141
bool GetColorMode() const
Definition: plotter.h:138
virtual void PlotPoly(const std::vector< VECTOR2I > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=nullptr)=0
Draw a polygon ( filled or not ).
virtual void Rect(const VECTOR2I &p1, const VECTOR2I &p2, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)=0
virtual void SetColor(const COLOR4D &color)=0
const std::vector< VECTOR2I > & CPoints() const
KIGFX::COLOR4D GetColor() const
bool MapAngles(EDA_ANGLE *aAngle1, EDA_ANGLE *aAngle2) const
Calculate new angles according to the transform.
Definition: transform.cpp:78
@ WHITE
Definition: color4d.h:48
FILL_T
Definition: eda_shape.h:54
@ FILLED_WITH_COLOR
@ FILLED_WITH_BG_BODYCOLOR
@ FILLED_SHAPE
int CircleToEndSegmentDeltaRadius(int aInnerCircleRadius, int aSegCount)
@ LAYER_DEVICE
Definition: layer_ids.h:357
@ LAYER_DEVICE_BACKGROUND
Definition: layer_ids.h:372
PLOT_DASH_TYPE
Dashed line types.
Definition: stroke_params.h:48

References ANGLE_0, ANGLE_180, ARC, PLOTTER::Arc(), BEZIER, EDA_SHAPE::CalcArcAngles(), CIRCLE, PLOTTER::Circle(), CircleToEndSegmentDeltaRadius(), color, SHAPE_LINE_CHAIN::CPoints(), DEFAULT, FILLED_SHAPE, FILLED_WITH_BG_BODYCOLOR, FILLED_WITH_COLOR, KIGFX::RENDER_SETTINGS::GetBackgroundColor(), EDA_SHAPE::getCenter(), STROKE_PARAMS::GetColor(), PLOTTER::GetColorMode(), LIB_ITEM::GetEffectivePenWidth(), EDA_SHAPE::GetFillColor(), KIGFX::RENDER_SETTINGS::GetLayerColor(), STROKE_PARAMS::GetPlotStyle(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetShape(), GetStroke(), LIB_ITEM::IsPrivate(), LAYER_DEVICE, LAYER_DEVICE_BACKGROUND, EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_end, EDA_SHAPE::m_fill, EDA_SHAPE::m_poly, EDA_SHAPE::m_start, TRANSFORM::MapAngles(), NO_FILL, SHAPE_POLY_SET::Outline(), PLOTTER::PlotPoly(), POLY, RECT, PLOTTER::Rect(), PLOTTER::RenderSettings(), PLOTTER::SetColor(), PLOTTER::SetDash(), EDA_SHAPE::SHAPE_T_asString(), SOLID, TRANSFORM::TransformCoordinate(), UNIMPLEMENTED_FOR, and WHITE.

Referenced by LIB_TEXTBOX::Plot().

◆ Print()

void LIB_ITEM::Print ( const RENDER_SETTINGS aSettings,
const VECTOR2I aOffset,
void *  aData,
const TRANSFORM aTransform,
bool  aDimmed 
)
virtualinherited

Draw an item.

Parameters
aDCDevice Context (can be null)
aOffsetOffset to draw
aDataValue or pointer used to pass others parameters, depending on body items. Used for some items to force to force no fill mode ( has meaning only for items what can be filled ). used in printing or moving objects mode or to pass reference to the lib symbol for pins.
aTransformTransform Matrix (rotation, mirror ..)
aDimmedDim the color on the printout

Definition at line 136 of file lib_item.cpp.

138{
139 print( aSettings, aOffset, aData, aTransform, aDimmed );
140}
virtual void print(const RENDER_SETTINGS *aSettings, const VECTOR2I &aOffset, void *aData, const TRANSFORM &aTransform, bool aDimmed)=0
Print the item to aDC.

References LIB_ITEM::print().

Referenced by DIALOG_PIN_PROPERTIES::OnPaintShowPanel(), LIB_SYMBOL::Print(), and LIB_SYMBOL::PrintBackground().

◆ print()

void LIB_SHAPE::print ( const RENDER_SETTINGS aSettings,
const VECTOR2I aOffset,
void *  aData,
const TRANSFORM aTransform,
bool  aDimmed 
)
overrideprivatevirtual

Print the item to aDC.

Parameters
aOffsetA reference to a wxPoint object containing the offset where to draw from the object's current position.
aDataA pointer to any object specific data required to perform the draw.
aTransformA reference to a TRANSFORM object containing drawing transform.

Implements LIB_ITEM.

Reimplemented in LIB_TEXTBOX.

Definition at line 272 of file lib_shape.cpp.

274{
275 if( IsPrivate() )
276 return;
277
278 bool forceNoFill = static_cast<bool>( aData );
279 int penWidth = GetEffectivePenWidth( aSettings );
280
281 if( forceNoFill && IsFilled() && penWidth == 0 )
282 return;
283
284 wxDC* DC = aSettings->GetPrintDC();
285 VECTOR2I pt1 = aTransform.TransformCoordinate( m_start ) + aOffset;
286 VECTOR2I pt2 = aTransform.TransformCoordinate( m_end ) + aOffset;
287 VECTOR2I c;
289
290 if( color == COLOR4D::UNSPECIFIED )
291 color = aSettings->GetLayerColor( LAYER_DEVICE );
292
293 COLOR4D bg = aSettings->GetBackgroundColor();
294
295 if( bg == COLOR4D::UNSPECIFIED || GetGRForceBlackPenState() )
296 bg = COLOR4D::WHITE;
297
298 if( aDimmed )
299 color = color.Mix( bg, 0.5f );
300
301 unsigned ptCount = 0;
302 VECTOR2I* buffer = nullptr;
303
304 if( GetShape() == SHAPE_T::POLY )
305 {
306 const SHAPE_LINE_CHAIN& poly = m_poly.Outline( 0 );
307
308 ptCount = poly.GetPointCount();
309 buffer = new VECTOR2I[ptCount];
310
311 for( unsigned ii = 0; ii < ptCount; ++ii )
312 buffer[ii] = aTransform.TransformCoordinate( poly.CPoint( ii ) ) + aOffset;
313 }
314 else if( GetShape() == SHAPE_T::BEZIER )
315 {
316 ptCount = m_bezierPoints.size();
317 buffer = new VECTOR2I[ptCount];
318
319 for( size_t ii = 0; ii < ptCount; ++ii )
320 buffer[ii] = aTransform.TransformCoordinate( m_bezierPoints[ii] ) + aOffset;
321 }
322 else if( GetShape() == SHAPE_T::ARC )
323 {
324 c = aTransform.TransformCoordinate( getCenter() ) + aOffset;
325
326 EDA_ANGLE t1, t2;
327
328 CalcArcAngles( t1, t2 );
329
330 // N.B. The order of evaluation is critical here as MapAngles will modify t1, t2
331 // and the Normalize routine depends on these modifications for the correct output
332 bool transformed = aTransform.MapAngles( &t1, &t2 );
333 EDA_ANGLE arc_angle = ( t1 - t2 ).Normalize180();
334 bool transformed2 = ( arc_angle > ANGLE_0 ) && ( arc_angle < ANGLE_180 );
335
336 if( transformed == transformed2 )
337 std::swap( pt1, pt2 );
338 }
339
340 COLOR4D fillColor = COLOR4D::UNSPECIFIED;
341
342 if( !forceNoFill )
343 {
345 fillColor = color;
347 fillColor = aSettings->GetLayerColor( LAYER_DEVICE_BACKGROUND );
349 fillColor = GetFillColor();
350 }
351
352 if( fillColor != COLOR4D::UNSPECIFIED )
353 {
354 switch( GetShape() )
355 {
356 case SHAPE_T::ARC:
357 GRFilledArc( DC, pt1, pt2, c, 0, fillColor, fillColor );
358 break;
359
360 case SHAPE_T::CIRCLE:
361 GRFilledCircle( DC, pt1, GetRadius(), 0, fillColor, fillColor );
362 break;
363
364 case SHAPE_T::RECT:
365 GRFilledRect( DC, pt1, pt2, 0, fillColor, fillColor );
366 break;
367
368 case SHAPE_T::POLY:
369 GRPoly( DC, ptCount, buffer, true, 0, fillColor, fillColor );
370 break;
371
372 case SHAPE_T::BEZIER:
373 GRPoly( DC, ptCount, buffer, true, 0, fillColor, fillColor );
374 break;
375
376 default:
378 }
379 }
380
381 penWidth = std::max( penWidth, aSettings->GetDefaultPenWidth() );
382
384 {
385 switch( GetShape() )
386 {
387 case SHAPE_T::ARC:
388 GRArc( DC, pt1, pt2, c, penWidth, color );
389 break;
390
391 case SHAPE_T::CIRCLE:
392 GRCircle( DC, pt1, GetRadius(), penWidth, color );
393 break;
394
395 case SHAPE_T::RECT:
396 GRRect( DC, pt1, pt2, penWidth, color );
397 break;
398
399 case SHAPE_T::POLY:
400 GRPoly( DC, ptCount, buffer, false, penWidth, color, color );
401 break;
402
403 case SHAPE_T::BEZIER:
404 GRPoly( DC, ptCount, buffer, false, penWidth, color, color );
405 break;
406
407 default:
409 }
410 }
411 else
412 {
413 std::vector<SHAPE*> shapes = MakeEffectiveShapes( true );
414
415 for( SHAPE* shape : shapes )
416 {
417 STROKE_PARAMS::Stroke( shape, GetEffectiveLineStyle(), penWidth, aSettings,
418 [&]( const VECTOR2I& a, const VECTOR2I& b )
419 {
420 VECTOR2I pts = aTransform.TransformCoordinate( a ) + aOffset;
421 VECTOR2I pte = aTransform.TransformCoordinate( b ) + aOffset;
422 GRLine( DC, pts.x, pts.y, pte.x, pte.y, penWidth, color );
423 } );
424 }
425
426 for( SHAPE* shape : shapes )
427 delete shape;
428 }
429
430 delete[] buffer;
431}
wxDC * GetPrintDC() const
PLOT_DASH_TYPE GetEffectiveLineStyle() const
Definition: lib_shape.h:60
virtual std::vector< SHAPE * > MakeEffectiveShapes(bool aEdgeOnly=false) const override
Make a set of SHAPE objects representing the LIB_SHAPE.
Definition: lib_shape.h:96
An abstract shape on 2D plane.
Definition: shape.h:123
static void Stroke(const SHAPE *aShape, PLOT_DASH_TYPE aLineStyle, int aWidth, const KIGFX::RENDER_SETTINGS *aRenderSettings, std::function< void(const VECTOR2I &a, const VECTOR2I &b)> aStroker)
void GRRect(wxDC *DC, const VECTOR2I &aStart, const VECTOR2I &aEnd, int aWidth, const COLOR4D &aColor)
Definition: gr_basic.cpp:387
void GRCircle(wxDC *aDC, const VECTOR2I &aPos, int aRadius, int aWidth, const COLOR4D &aColor)
Definition: gr_basic.cpp:348
void GRFilledArc(wxDC *DC, const VECTOR2I &aStart, const VECTOR2I &aEnd, const VECTOR2I &aCenter, int width, const COLOR4D &Color, const COLOR4D &BgColor)
Definition: gr_basic.cpp:378
void GRLine(wxDC *DC, int x1, int y1, int x2, int y2, int width, const COLOR4D &Color, wxPenStyle aStyle)
Definition: gr_basic.cpp:162
void GRFilledRect(wxDC *DC, const VECTOR2I &aStart, const VECTOR2I &aEnd, int aWidth, const COLOR4D &aColor, const COLOR4D &aBgColor)
Definition: gr_basic.cpp:394
void GRArc(wxDC *aDC, const VECTOR2I &aStart, const VECTOR2I &aEnd, const VECTOR2I &aCenter, int aWidth, const COLOR4D &aColor)
Definition: gr_basic.cpp:369
void GRPoly(wxDC *DC, int n, const VECTOR2I *Points, bool Fill, int width, const COLOR4D &Color, const COLOR4D &BgColor)
Draw a new polyline and fill it if Fill, in drawing space.
Definition: gr_basic.cpp:332
bool GetGRForceBlackPenState(void)
Definition: gr_basic.cpp:156
void GRFilledCircle(wxDC *aDC, const VECTOR2I &aPos, int aRadius, int aWidth, const COLOR4D &aStrokeColor, const COLOR4D &aFillColor)
Draw a circle onto the drawing context aDC centered at the user coordinates (x,y).
Definition: gr_basic.cpp:360

References ANGLE_0, ANGLE_180, ARC, BEZIER, EDA_SHAPE::CalcArcAngles(), CIRCLE, color, SHAPE_LINE_CHAIN::CPoint(), FILLED_SHAPE, FILLED_WITH_BG_BODYCOLOR, FILLED_WITH_COLOR, KIGFX::RENDER_SETTINGS::GetBackgroundColor(), EDA_SHAPE::getCenter(), STROKE_PARAMS::GetColor(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), GetEffectiveLineStyle(), LIB_ITEM::GetEffectivePenWidth(), EDA_SHAPE::GetFillColor(), EDA_SHAPE::GetFillMode(), GetGRForceBlackPenState(), KIGFX::RENDER_SETTINGS::GetLayerColor(), SHAPE_LINE_CHAIN::GetPointCount(), KIGFX::RENDER_SETTINGS::GetPrintDC(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetShape(), GetStroke(), GRArc(), GRCircle(), GRFilledArc(), GRFilledCircle(), GRFilledRect(), GRLine(), GRPoly(), GRRect(), EDA_SHAPE::IsFilled(), LIB_ITEM::IsPrivate(), LAYER_DEVICE, LAYER_DEVICE_BACKGROUND, EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_end, EDA_SHAPE::m_poly, EDA_SHAPE::m_start, MakeEffectiveShapes(), TRANSFORM::MapAngles(), SHAPE_POLY_SET::Outline(), POLY, RECT, EDA_SHAPE::SHAPE_T_asString(), SOLID, STROKE_PARAMS::Stroke(), TRANSFORM::TransformCoordinate(), UNIMPLEMENTED_FOR, WHITE, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ RebuildBezierToSegmentsPointsList()

void EDA_SHAPE::RebuildBezierToSegmentsPointsList ( int  aMinSegLen)
inherited

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

Has meaning only for BEZIER shape.

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

Definition at line 370 of file eda_shape.cpp.

371{
372 // Has meaning only for SHAPE_T::BEZIER
373 if( m_shape != SHAPE_T::BEZIER )
374 {
375 m_bezierPoints.clear();
376 return;
377 }
378
379 // Rebuild the m_BezierPoints vertex list that approximate the Bezier curve
381}

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

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

◆ RenderAsBitmap()

virtual bool EDA_ITEM::RenderAsBitmap ( double  aWorldScale) const
inlinevirtualinherited

Reimplemented in SCH_ITEM.

Definition at line 165 of file eda_item.h.

165{ return false; }

◆ Replace() [1/2]

virtual bool EDA_ITEM::Replace ( const EDA_SEARCH_DATA 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
aSearchDataA reference to a wxFindReplaceData object containing the search and replace criteria.
aAuxDataA 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 LIB_TEXTBOX, SCH_PIN, SCH_TEXT, SCH_TEXTBOX, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 409 of file eda_item.h.

410 {
411 return false;
412 }

◆ Replace() [2/2]

bool EDA_ITEM::Replace ( const EDA_SEARCH_DATA 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
aSearchDataA reference to a wxFindReplaceData object containing the search and replace criteria.
aTextA reference to a wxString object containing the text to be replaced.
Returns
True if aText was modified, otherwise false.

Definition at line 168 of file eda_item.cpp.

169{
170 wxString text = aText;
171 wxString searchText = aSearchData.findString;
172 wxString result;
173 bool replaced = false;
174
175 if( !aSearchData.matchCase )
176 {
177 text = text.Upper();
178 searchText = searchText.Upper();
179 }
180
181 int ii = 0;
182
183 while( ii < (int) text.length() )
184 {
185 int next = text.find( searchText, ii );
186
187 if( next == wxNOT_FOUND )
188 {
189 result += aText.Mid( ii, wxString::npos );
190 break;
191 }
192
193 if( next > ii )
194 result += aText.Mid( ii, next - ii );
195
196 ii = next;
197 next += searchText.length();
198
199 bool startOK;
200 bool endOK;
201
203 {
204 startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
205 endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
206 }
207 else
208 {
209 startOK = true;
210 endOK = true;
211 }
212
213 if( startOK && endOK )
214 {
215 result += aSearchData.replaceString;
216 replaced = true;
217 ii = next;
218 }
219 else
220 {
221 result += aText.GetChar( ii );
222 ii++;
223 }
224 }
225
226 aText = result;
227 return replaced;
228}
wxString replaceString

References EDA_SEARCH_DATA::findString, EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), EDA_SEARCH_DATA::replaceString, text, and WHOLEWORD.

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

◆ Rotate()

void LIB_SHAPE::Rotate ( const VECTOR2I aCenter,
bool  aRotateCCW = true 
)
overridevirtual

Rotate the object about aCenter point.

Parameters
aCenterPoint to rotate around.
aRotateCCWTrue to rotate counter clockwise. False to rotate clockwise.

Implements LIB_ITEM.

Reimplemented in LIB_TEXTBOX.

Definition at line 126 of file lib_shape.cpp.

127{
128 EDA_ANGLE rot_angle = aRotateCCW ? -ANGLE_90 : ANGLE_90;
129
130 rotate( aCenter, rot_angle );
131}
void rotate(const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle)
Definition: eda_shape.cpp:228

References ANGLE_90, and EDA_SHAPE::rotate().

Referenced by LIB_TEXTBOX::Rotate().

◆ rotate()

void EDA_SHAPE::rotate ( const VECTOR2I aRotCentre,
const EDA_ANGLE aAngle 
)
protectedinherited

Definition at line 228 of file eda_shape.cpp.

229{
230 switch( m_shape )
231 {
232 case SHAPE_T::SEGMENT:
233 case SHAPE_T::CIRCLE:
234 RotatePoint( m_start, aRotCentre, aAngle );
235 RotatePoint( m_end, aRotCentre, aAngle );
236 break;
237
238 case SHAPE_T::ARC:
239 RotatePoint( m_start, aRotCentre, aAngle );
240 RotatePoint( m_end, aRotCentre, aAngle );
241 RotatePoint( m_arcCenter, aRotCentre, aAngle );
242 break;
243
244 case SHAPE_T::RECT:
245 if( aAngle.IsCardinal() )
246 {
247 RotatePoint( m_start, aRotCentre, aAngle );
248 RotatePoint( m_end, aRotCentre, aAngle );
249 break;
250 }
251
252 // Convert non-cardinally-rotated rect to a diamond
260
262
263 case SHAPE_T::POLY:
264 m_poly.Rotate( aAngle, aRotCentre );
265 break;
266
267 case SHAPE_T::BEZIER:
268 RotatePoint( m_start, aRotCentre, aAngle );
269 RotatePoint( m_end, aRotCentre, aAngle );
270 RotatePoint( m_bezierC1, aRotCentre, aAngle );
271 RotatePoint( m_bezierC2, aRotCentre, aAngle );
272
273 for( VECTOR2I& pt : m_bezierPoints )
274 RotatePoint( pt, aRotCentre, aAngle);
275
276 break;
277
278 default:
280 break;
281 }
282}
bool IsCardinal() const
Definition: eda_angle.cpp:49
void Rotate(const EDA_ANGLE &aAngle, const VECTOR2I &aCenter={ 0, 0 }) override
Rotate all vertices by a given angle.
#define KI_FALLTHROUGH
The KI_FALLTHROUGH macro is to be used when switch statement cases should purposely fallthrough from ...
Definition: macros.h:83

References SHAPE_POLY_SET::Append(), ARC, BEZIER, CIRCLE, EDA_ANGLE::IsCardinal(), KI_FALLTHROUGH, EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_bezierC1, EDA_SHAPE::m_bezierC2, EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_end, EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, SHAPE_POLY_SET::NewOutline(), POLY, RECT, SHAPE_POLY_SET::RemoveAllContours(), SHAPE_POLY_SET::Rotate(), RotatePoint(), SEGMENT, EDA_SHAPE::SHAPE_T_asString(), UNIMPLEMENTED_FOR, VECTOR2< T >::x, and VECTOR2< T >::y.

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

◆ scale()

void EDA_SHAPE::scale ( double  aScale)
protectedinherited

Definition at line 176 of file eda_shape.cpp.

177{
178 auto scalePt = [&]( VECTOR2I& pt )
179 {
180 pt.x = KiROUND( pt.x * aScale );
181 pt.y = KiROUND( pt.y * aScale );
182 };
183
184 switch( m_shape )
185 {
186 case SHAPE_T::ARC:
187 case SHAPE_T::SEGMENT:
188 case SHAPE_T::RECT:
189 scalePt( m_start );
190 scalePt( m_end );
191 scalePt( m_arcCenter );
192 break;
193
194 case SHAPE_T::CIRCLE: // ring or circle
195 scalePt( m_start );
196 m_end.x = m_start.x + KiROUND( GetRadius() * aScale );
197 m_end.y = m_start.y;
198 break;
199
200 case SHAPE_T::POLY: // polygon
201 {
202 std::vector<VECTOR2I> pts;
203
204 for( const VECTOR2I& pt : m_poly.Outline( 0 ).CPoints() )
205 {
206 pts.emplace_back( pt );
207 scalePt( pts.back() );
208 }
209
210 SetPolyPoints( pts );
211 }
212 break;
213
214 case SHAPE_T::BEZIER:
215 scalePt( m_start );
216 scalePt( m_end );
217 scalePt( m_bezierC1 );
218 scalePt( m_bezierC2 );
219 break;
220
221 default:
223 break;
224 }
225}
void SetPolyPoints(const std::vector< VECTOR2I > &aPoints)
Definition: eda_shape.cpp:1069

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

Referenced by PCB_SHAPE::Scale().

◆ Set() [1/3]

template<typename T >
bool INSPECTABLE::Set ( const wxString &  aProperty,
aValue 
)
inlineinherited

Definition at line 66 of file inspectable.h.

67 {
69 TYPE_ID thisType = TYPE_HASH( *this );
70 PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
71 void* object = nullptr;
72
73 if( prop )
74 {
75 object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
76
77 if( object )
78 prop->set<T>( object, aValue );
79 }
80
81 return object != nullptr;
82 }
void set(void *aObject, T aValue)
Definition: property.h:263

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

◆ Set() [2/3]

template<typename T >
bool INSPECTABLE::Set ( PROPERTY_BASE aProperty,
aValue 
)
inlineinherited

Definition at line 54 of file inspectable.h.

55 {
57 void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
58
59 if( object )
60 aProperty->set<T>( object, aValue );
61
62 return object != nullptr;
63 }

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

◆ Set() [3/3]

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

Definition at line 42 of file inspectable.h.

43 {
45 void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
46
47 if( object )
48 aProperty->setter( object, aValue );
49
50 return object != nullptr;
51 }
virtual void setter(void *aObject, wxAny &aValue)=0

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

Referenced by PCB_PROPERTIES_PANEL::valueChanged().

◆ SetArcAngleAndEnd()

void EDA_SHAPE::SetArcAngleAndEnd ( const EDA_ANGLE aAngle,
bool  aCheckNegativeAngle = false 
)
inherited

◆ SetArcGeometry()

void EDA_SHAPE::SetArcGeometry ( const VECTOR2I aStart,
const VECTOR2I aMid,
const VECTOR2I aEnd 
)
inherited

Set the three controlling points for an arc.

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

Definition at line 508 of file eda_shape.cpp.

509{
510 m_arcMidData = {};
511 m_start = aStart;
512 m_end = aEnd;
513 m_arcCenter = CalcArcCenter( aStart, aMid, aEnd );
514 VECTOR2I new_mid = GetArcMid();
515
516 m_endsSwapped = false;
517
518 // Watch the ordering here. GetArcMid above needs to be called prior to initializing the
519 // m_arcMidData structure in order to ensure we get the calculated variant, not the cached
520 SetCachedArcData( aStart, aMid, aEnd, m_arcCenter );
521
522 /*
523 * If the input winding doesn't match our internal winding, the calculated midpoint will end
524 * up on the other side of the arc. In this case, we need to flip the start/end points and
525 * flag this change for the system.
526 */
527 VECTOR2D dist( new_mid - aMid );
528 VECTOR2D dist2( new_mid - m_arcCenter );
529
530 if( dist.SquaredEuclideanNorm() > dist2.SquaredEuclideanNorm() )
531 {
532 std::swap( m_start, m_end );
533 m_endsSwapped = true;
534 }
535}
void SetCachedArcData(const VECTOR2I &aStart, const VECTOR2I &aMid, const VECTOR2I &aEnd, const VECTOR2I &aCenter)
Set the data used for mid point caching.
Definition: eda_shape.cpp:499
VECTOR2I GetArcMid() const
Definition: eda_shape.cpp:441
const VECTOR2I CalcArcCenter(const VECTOR2I &aStart, const VECTOR2I &aMid, const VECTOR2I &aEnd)
Determine the center of an arc or circle given three points on its circumference.
Definition: trigo.cpp:472

References CalcArcCenter(), EDA_SHAPE::GetArcMid(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_arcMidData, EDA_SHAPE::m_end, EDA_SHAPE::m_endsSwapped, EDA_SHAPE::m_start, EDA_SHAPE::SetCachedArcData(), and VECTOR2< T >::SquaredEuclideanNorm().

Referenced by EDA_SHAPE::beginEdit(), EDA_SHAPE::calcEdit(), PCB_POINT_EDITOR::editArcMidKeepEndpoints(), ALTIUM_PCB::HelperCreateBoardOutline(), FABMASTER::loadFootprints(), FABMASTER::loadGraphics(), FABMASTER::loadOutline(), and SCH_EAGLE_PLUGIN::loadSymbolWire().

◆ SetBezierC1()

◆ SetBezierC2()

◆ SetBottom()

virtual void EDA_SHAPE::SetBottom ( int  val)
inlinevirtualinherited

Reimplemented in FP_TEXTBOX, and PCB_TEXTBOX.

Definition at line 169 of file eda_shape.h.

169{ SetEndY( val ); }

References EDA_SHAPE::SetEndY().

Referenced by PCB_POINT_EDITOR::updateItem().

◆ SetBrightened()

◆ SetCachedArcData()

void EDA_SHAPE::SetCachedArcData ( const VECTOR2I aStart,
const VECTOR2I aMid,
const VECTOR2I aEnd,
const VECTOR2I aCenter 
)
inherited

Set the data used for mid point caching.

If the controlling points remain constant, then we keep the midpoint the same as it was when read in. This minimizes VCS churn

Parameters
aStartCached start point
aMidCached mid point
aEndCached end point
aCenterCalculated center point using the preceeding three

Definition at line 499 of file eda_shape.cpp.

500{
501 m_arcMidData.start = aStart;
502 m_arcMidData.end = aEnd;
503 m_arcMidData.center = aCenter;
504 m_arcMidData.mid = aMid;
505}

References ARC_MID::center, ARC_MID::end, EDA_SHAPE::m_arcMidData, ARC_MID::mid, and ARC_MID::start.

Referenced by EDA_SHAPE::SetArcGeometry().

◆ SetCenter()

◆ SetConvert()

◆ SetEditState()

void LIB_SHAPE::SetEditState ( int  aState)
inline

Definition at line 77 of file lib_shape.h.

77{ setEditState( aState ); }
void setEditState(int aState)
Definition: eda_shape.h:348

References EDA_SHAPE::setEditState().

Referenced by EE_POINT_EDITOR::updateParentItem().

◆ setEditState()

void EDA_SHAPE::setEditState ( int  aState)
inlineprotectedinherited

Definition at line 348 of file eda_shape.h.

348{ m_editState = aState; }

References EDA_SHAPE::m_editState.

Referenced by SetEditState(), and SCH_SHAPE::SetEditState().

◆ SetEnd()

void EDA_SHAPE::SetEnd ( const VECTOR2I aEnd)
inlineinherited

Definition at line 145 of file eda_shape.h.

146 {
147 m_end = aEnd;
148 m_endsSwapped = false;
149 }

References EDA_SHAPE::m_end, and EDA_SHAPE::m_endsSwapped.

Referenced by PCB_POINT_EDITOR::addCorner(), PAD::AddPrimitiveAnnotationBox(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), SCH_ALTIUM_PLUGIN::AddTextBox(), PCAD2KICAD::PCB_LINE::AddToBoard(), EDA_SHAPE::beginEdit(), EDA_SHAPE::calcEdit(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertArcs6ToPcbShape(), ALTIUM_PCB::ConvertFills6ToBoardItemOnLayer(), ALTIUM_PCB::ConvertFills6ToFootprintItem(), ALTIUM_PCB::ConvertFills6ToFootprintItemOnLayer(), ALTIUM_PCB::ConvertTracks6ToBoardItem(), ALTIUM_PCB::ConvertTracks6ToBoardItemOnLayer(), ALTIUM_PCB::ConvertTracks6ToFootprintItem(), ALTIUM_PCB::ConvertTracks6ToFootprintItemOnLayer(), MICROWAVE_TOOL::createMicrowaveInductor(), PCB_POINT_EDITOR::editArcEndpointKeepCenter(), PCB_POINT_EDITOR::editArcEndpointKeepTangent(), PCB_POINT_EDITOR::editArcMidKeepCenter(), PAD_TOOL::explodePad(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex(), ALTIUM_PCB::HelperCreateBoardOutline(), HelperGeneratePowerPortGraphics(), ALTIUM_PCB::HelperParseDimensions6Leader(), ALTIUM_PCB::HelperParsePad6NonCopper(), initTextTable(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), SCH_LEGACY_PLUGIN_CACHE::loadBezier(), SCH_LEGACY_PLUGIN_CACHE::loadCircle(), FABMASTER::loadFootprints(), FABMASTER::loadGraphics(), CADSTAR_SCH_ARCHIVE_LOADER::loadLibrarySymbolShapeVertices(), FABMASTER::loadOutline(), EAGLE_PLUGIN::loadPlain(), SCH_LEGACY_PLUGIN_CACHE::loadRect(), SCH_EAGLE_PLUGIN::loadSymbolCircle(), SCH_EAGLE_PLUGIN::loadSymbolRectangle(), GRAPHICS_CLEANER::mergeRects(), PCB_SHAPE::NormalizeRect(), SCH_ALTIUM_PLUGIN::ParseArc(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseEllipse(), SCH_ALTIUM_PLUGIN::ParseRectangle(), SCH_ALTIUM_PLUGIN::ParseRoundRectangle(), DRAWING_TOOL::PlaceCharacteristics(), DRAWING_TOOL::PlaceStackup(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotPcbTarget(), PAD_TOOL::RecombinePad(), PCB_TEXTBOX::Rotate(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow(), PCB_TARGET::TransformShapeWithClearanceToPolygon(), updateArcFromConstructionMgr(), PCB_POINT_EDITOR::updateItem(), EE_POINT_EDITOR::updateParentItem(), and updateSegmentFromGeometryMgr().

◆ SetEndX()

◆ SetEndY()

◆ SetFillColor()

◆ SetFilled()

void EDA_SHAPE::SetFilled ( bool  aFlag)
inlineinherited

Definition at line 95 of file eda_shape.h.

96 {
98 }

References FILLED_SHAPE, EDA_SHAPE::m_fill, and NO_FILL.

Referenced by PAD::AddPrimitiveAnnotationBox(), PAD::AddPrimitiveArc(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitivePoly(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), SCH_ALTIUM_PLUGIN::AddTextBox(), PCAD2KICAD::PCB_ARC::AddToBoard(), ZONE_CREATE_HELPER::commitZone(), ALTIUM_PCB::ConvertFills6ToBoardItemOnLayer(), ALTIUM_PCB::ConvertFills6ToFootprintItemOnLayer(), ALTIUM_PCB::ConvertShapeBasedRegions6ToBoardItemOnLayer(), ALTIUM_PCB::ConvertShapeBasedRegions6ToFootprintItemOnLayer(), MICROWAVE_TOOL::createPolygonShape(), CONVERT_TOOL::CreatePolys(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarShape(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawRectangle(), DRAWING_TOOL::drawShape(), PAD_TOOL::explodePad(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), ALTIUM_PCB::HelperParsePad6NonCopper(), FABMASTER::loadGraphics(), EAGLE_PLUGIN::loadPlain(), FABMASTER::loadPolygon(), CONVERT_TOOL::makePolysFromGraphics(), GRAPHICS_CLEANER::mergeRects(), DIALOG_PAD_PROPERTIES::onAddPrimitive(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), SCH_ALTIUM_PLUGIN::ParseEllipse(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotPcbTarget(), PAD_TOOL::RecombinePad(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow(), and DIALOG_PAD_PRIMITIVE_POLY_PROPS::TransferDataFromWindow().

◆ SetFillMode()

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS  aMask)
inlineinherited

Definition at line 142 of file eda_item.h.

142{ m_flags |= aMask; }

References EDA_ITEM::m_flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddFootprintToBoard(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SCH_ALTIUM_PLUGIN::AddTextBox(), SCH_MOVE_TOOL::AlignElements(), PCB_CONTROL::AppendBoard(), FOOTPRINT::BuildCourtyardCaches(), SCH_EDIT_TOOL::ChangeTextType(), GRAPHICS_CLEANER::cleanupShapes(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::createSheetPin(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), EDIT_TOOL::doMoveSelection(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_SELECTION_TOOL::EnterGroup(), PAD_TOOL::explodePad(), SCH_MOVE_TOOL::getConnectedDragItems(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), EE_COLLECTOR::Inspect(), CONVERT_TOOL::makePolysFromChainedSegs(), SCH_SCREEN::MarkConnections(), TRACKS_CLEANER::mergeCollinearSegments(), SCH_MOVE_TOOL::moveItem(), SYMBOL_EDITOR_MOVE_TOOL::moveItem(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), SCH_MOVE_TOOL::orthoLineDrag(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseBus(), SCH_ALTIUM_PLUGIN::ParseBusEntry(), SCH_ALTIUM_PLUGIN::ParseHarnessConnector(), SCH_ALTIUM_PLUGIN::ParseHarnessPort(), SCH_ALTIUM_PLUGIN::ParseJunction(), SCH_ALTIUM_PLUGIN::ParseLabel(), SCH_ALTIUM_PLUGIN::ParseLine(), SCH_ALTIUM_PLUGIN::ParseNetLabel(), SCH_ALTIUM_PLUGIN::ParseNoERC(), SCH_ALTIUM_PLUGIN::ParsePolygon(), SCH_ALTIUM_PLUGIN::ParsePolyline(), SCH_ALTIUM_PLUGIN::ParsePort(), SCH_ALTIUM_PLUGIN::ParseRectangle(), SCH_ALTIUM_PLUGIN::ParseRoundRectangle(), SCH_ALTIUM_PLUGIN::ParseSheetSymbol(), SCH_ALTIUM_PLUGIN::ParseSignalHarness(), SCH_ALTIUM_PLUGIN::ParseWire(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceText(), SCH_SYMBOL::Plot(), BACK_ANNOTATE::processNetNameChange(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_SELECTION_TOOL::RebuildSelection(), BOARD::Remove(), FOOTPRINT::Remove(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDIT_FRAME::SaveCopyInUndoList(), EE_SELECTION_TOOL::SelectAll(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetBrightened(), EDA_ITEM::SetIsShownAsBitmap(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ 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
aEnableTrue 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 201 of file eda_item.h.

201{ m_forceVisible = aEnable; }

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetIsAnnotationProxy()

void EDA_SHAPE::SetIsAnnotationProxy ( bool  aIsProxy = true)
inlineinherited

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool  aBitmap)
inlineinherited

Definition at line 167 of file eda_item.h.

168 {
169 if( aBitmap )
171 else
173 }

References EDA_ITEM::ClearFlags(), IS_SHOWN_AS_BITMAP, and EDA_ITEM::SetFlags().

◆ SetLeft()

virtual void EDA_SHAPE::SetLeft ( int  val)
inlinevirtualinherited

Reimplemented in FP_TEXTBOX, and PCB_TEXTBOX.

Definition at line 167 of file eda_shape.h.

167{ SetStartX( val ); }

References EDA_SHAPE::SetStartX().

Referenced by PCB_POINT_EDITOR::updateItem().

◆ SetModified()

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM aParent)
inlinevirtualinherited

Reimplemented in LIB_SYMBOL, and PCB_DIMENSION_BASE.

Definition at line 100 of file eda_item.h.

100{ m_parent = aParent; }

References EDA_ITEM::m_parent.

Referenced by BOARD::Add(), FOOTPRINT::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), SCH_SHEET::AddPin(), PAD::AddPrimitive(), PAD::AddPrimitiveAnnotationBox(), 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(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_SYMBOL::Flatten(), FOOTPRINT::FOOTPRINT(), PCB_PLUGIN::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), LIB_SYMBOL::LIB_SYMBOL(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), LIB_SYMBOL::operator=(), FOOTPRINT::operator=(), PCB_PARSER::parseFOOTPRINT_unchecked(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PCB_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BACK_ANNOTATE::processNetNameChange(), BOARD_COMMIT::Push(), SCH_LIB_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(), PIN_TABLE_DATA_MODEL::SetValue(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_LABEL_BASE::SwapData(), SCH_SHEET::SwapData(), SCH_SYMBOL::SwapData(), SwapItemData(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetPolyPoints()

◆ SetPolyShape()

void EDA_SHAPE::SetPolyShape ( const SHAPE_POLY_SET aShape)
inlineinherited

Definition at line 251 of file eda_shape.h.

252 {
253 m_poly = aShape;
254
255 for( int ii = 0; ii < m_poly.OutlineCount(); ++ii )
256 {
257 if( m_poly.HoleCount( ii ) )
258 {
260 break;
261 }
262 }
263 }
void Fracture(POLYGON_MODE aFastMode)
Convert a single outline slitted ("fractured") polygon into a set ouf outlines with holes.
int HoleCount(int aOutline) const
Return the reference to aIndex-th outline in the set.

References SHAPE_POLY_SET::Fracture(), SHAPE_POLY_SET::HoleCount(), EDA_SHAPE::m_poly, SHAPE_POLY_SET::OutlineCount(), and SHAPE_POLY_SET::PM_FAST.

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

◆ setPosition()

void EDA_SHAPE::setPosition ( const VECTOR2I aPos)
protectedinherited

Definition at line 93 of file eda_shape.cpp.

94{
95 move( aPos - getPosition() );
96}

References EDA_SHAPE::getPosition(), and EDA_SHAPE::move().

Referenced by MoveTo(), SCH_SHAPE::SetPosition(), PCB_SHAPE::SetPosition(), and SetPosition().

◆ SetPosition()

◆ SetPrivate()

void LIB_ITEM::SetPrivate ( bool  aPrivate)
inlineinherited

◆ SetRight()

virtual void EDA_SHAPE::SetRight ( int  val)
inlinevirtualinherited

Reimplemented in FP_TEXTBOX, and PCB_TEXTBOX.

Definition at line 168 of file eda_shape.h.

168{ SetEndX( val ); }

References EDA_SHAPE::SetEndX().

Referenced by PCB_POINT_EDITOR::updateItem().

◆ SetSelected()

◆ SetShape()

◆ SetStart()

void EDA_SHAPE::SetStart ( const VECTOR2I aStart)
inlineinherited

Definition at line 120 of file eda_shape.h.

121 {
122 m_start = aStart;
123 m_endsSwapped = false;
124 }

References EDA_SHAPE::m_endsSwapped, and EDA_SHAPE::m_start.

Referenced by PCB_POINT_EDITOR::addCorner(), PAD::AddPrimitiveAnnotationBox(), PAD::AddPrimitiveArc(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), SCH_ALTIUM_PLUGIN::AddTextBox(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToBoard(), EDA_SHAPE::beginEdit(), ALTIUM_PCB::ConvertArcs6ToBoardItemOnLayer(), ALTIUM_PCB::ConvertArcs6ToPcbShape(), ALTIUM_PCB::ConvertFills6ToBoardItemOnLayer(), ALTIUM_PCB::ConvertFills6ToFootprintItem(), ALTIUM_PCB::ConvertFills6ToFootprintItemOnLayer(), ALTIUM_PCB::ConvertTracks6ToBoardItem(), ALTIUM_PCB::ConvertTracks6ToBoardItemOnLayer(), ALTIUM_PCB::ConvertTracks6ToFootprintItem(), ALTIUM_PCB::ConvertTracks6ToFootprintItemOnLayer(), MICROWAVE_TOOL::createMicrowaveInductor(), PCB_POINT_EDITOR::editArcEndpointKeepCenter(), PCB_POINT_EDITOR::editArcEndpointKeepTangent(), PCB_POINT_EDITOR::editArcMidKeepCenter(), PAD_TOOL::explodePad(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex(), ALTIUM_PCB::HelperCreateBoardOutline(), ALTIUM_PCB::HelperParseDimensions6Datum(), ALTIUM_PCB::HelperParseDimensions6Leader(), ALTIUM_PCB::HelperParsePad6NonCopper(), initTextTable(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), SCH_LEGACY_PLUGIN_CACHE::loadBezier(), SCH_LEGACY_PLUGIN_CACHE::loadCircle(), FABMASTER::loadFootprints(), FABMASTER::loadGraphics(), CADSTAR_SCH_ARCHIVE_LOADER::loadLibrarySymbolShapeVertices(), FABMASTER::loadOutline(), EAGLE_PLUGIN::loadPlain(), GRAPHICS_CLEANER::mergeRects(), PCB_SHAPE::NormalizeRect(), SCH_ALTIUM_PLUGIN::ParseArc(), SCH_ALTIUM_PLUGIN::ParseBezier(), DRAWING_TOOL::PlaceCharacteristics(), DRAWING_TOOL::PlaceStackup(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotPcbTarget(), PAD_TOOL::RecombinePad(), PCB_TEXTBOX::Rotate(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow(), PCB_TARGET::TransformShapeWithClearanceToPolygon(), updateArcFromConstructionMgr(), PCB_POINT_EDITOR::updateItem(), and updateSegmentFromGeometryMgr().

◆ SetStartX()

◆ SetStartY()

◆ SetState()

void EDA_ITEM::SetState ( EDA_ITEM_FLAGS  type,
bool  state 
)
inlineinherited

Definition at line 131 of file eda_item.h.

132 {
133 if( state )
134 m_status |= type; // state = ON or OFF
135 else
136 m_status &= ~type;
137 }

References EDA_ITEM::m_status.

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

◆ SetStatus()

void EDA_ITEM::SetStatus ( EDA_ITEM_FLAGS  aStatus)
inlineinherited

Definition at line 140 of file eda_item.h.

140{ m_status = aStatus; }

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetStroke()

void LIB_SHAPE::SetStroke ( const STROKE_PARAMS aStroke)
inline

Definition at line 53 of file lib_shape.h.

53{ m_stroke = aStroke; }

References EDA_SHAPE::m_stroke.

Referenced by