KiCad PCB EDA Suite
DRAWSEGMENT Class Reference

#include <class_drawsegment.h>

Inheritance diagram for DRAWSEGMENT:
BOARD_ITEM EDA_ITEM KIGFX::VIEW_ITEM EDGE_MODULE

Public Member Functions

 DRAWSEGMENT (BOARD_ITEM *aParent=NULL, KICAD_T idtype=PCB_LINE_T)
 
 ~DRAWSEGMENT ()
 
void SetWidth (int aWidth)
 
int GetWidth () const
 
void SetAngle (double aAngle)
 Function SetAngle sets the angle for arcs, and normalizes it within the range 0 - 360 degrees. More...
 
double GetAngle () const
 
void SetType (int aType)
 
int GetType () const
 
void SetShape (STROKE_T aShape)
 
STROKE_T GetShape () const
 
void SetBezControl1 (const wxPoint &aPoint)
 
const wxPointGetBezControl1 () const
 
void SetBezControl2 (const wxPoint &aPoint)
 
const wxPointGetBezControl2 () const
 
void SetPosition (const wxPoint &aPos) override
 
const wxPoint GetPosition () const override
 
const wxPointGetStart () const
 Function GetStart returns the starting point of the graphic. More...
 
void SetStart (const wxPoint &aStart)
 
void SetStartY (int y)
 
void SetStartX (int x)
 
const wxPointGetEnd () const
 Function GetEnd returns the ending point of the graphic. More...
 
void SetEnd (const wxPoint &aEnd)
 
void SetEndY (int y)
 
void SetEndX (int x)
 
const wxPoint GetCenter () const override
 Function GetCenter() More...
 
const wxPointGetArcStart () const
 
const wxPoint GetArcEnd () const
 
double GetArcAngleStart () const
 function GetArcAngleStart() More...
 
int GetRadius () const
 Function GetRadius returns the radius of this item Has meaning only for arc and circle. More...
 
void SetArcStart (const wxPoint &aArcStartPoint)
 Initialize the start arc point. More...
 
void SetCenter (const wxPoint &aCenterPoint)
 For arcs and circles: More...
 
MODULEGetParentModule () const
 Function GetParentModule returns a pointer to the parent module, or NULL if DRAWSEGMENT does not belong to a module. More...
 
const std::vector< wxPoint > & GetBezierPoints () const
 
const std::vector< wxPointBuildPolyPointsList () const
 Build and return the list of corners in a std::vector<wxPoint> It must be used only to convert the SHAPE_POLY_SET internal corner buffer to a list of wxPoints, and nothing else, because it duplicates the buffer, that is inefficient to know for instance the corner count. More...
 
int GetPointCount () const
 
SHAPE_POLY_SETGetPolyShape ()
 
const SHAPE_POLY_SETGetPolyShape () const
 
bool IsPolyShapeValid () const
 
void SetPolyShape (const SHAPE_POLY_SET &aShape)
 
void SetBezierPoints (const std::vector< wxPoint > &aPoints)
 
void RebuildBezierToSegmentsPointsList (int aMinSegLen)
 Rebuild the m_BezierPoints vertex list that approximate the Bezier curve by a list of segments Has meaning only for S_CURVE DRAW_SEGMENT shape. More...
 
void SetPolyPoints (const std::vector< wxPoint > &aPoints)
 
void Draw (EDA_DRAW_PANEL *panel, wxDC *DC, GR_DRAWMODE aDrawMode, const wxPoint &aOffset=ZeroOffset) override
 Function Draw BOARD_ITEMs have their own color information. More...
 
virtual void GetMsgPanelInfo (EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM > &aList) override
 Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
 
virtual const EDA_RECT GetBoundingBox () const override
 Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes. More...
 
virtual bool HitTest (const wxPoint &aPosition) const override
 Function HitTest tests if aPosition is contained within or on the bounding area of an item. More...
 
bool HitTest (const EDA_RECT &aRect, bool aContained=true, int aAccuracy=0) const override
 Function HitTest tests if the aRect intersects or contains this object (depending on aContained). More...
 
wxString GetClass () const override
 Function GetClass returns the class name. More...
 
double GetLength () const
 Function GetLength returns the length of the track using the hypotenuse calculation. More...
 
virtual void Move (const wxPoint &aMoveVector) override
 Function Move move this object. More...
 
virtual void Rotate (const wxPoint &aRotCentre, double aAngle) override
 Function Rotate Rotate this object. More...
 
virtual void Flip (const wxPoint &aCentre) override
 Function Flip Flip this object, i.e. More...
 
void TransformShapeWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, int aClearanceValue, int aCircleToSegmentsCount, double aCorrectionFactor) const override
 Function TransformShapeWithClearanceToPolygon Convert the track shape to a closed polygon Used in filling zones calculations Circles and arcs are approximated by segments. More...
 
virtual wxString GetSelectMenuText (EDA_UNITS_T aUnits) const override
 Function GetSelectMenuText returns the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
 
virtual BITMAP_DEF GetMenuImage () const override
 Function GetMenuImage returns a pointer to an image to be used in menus. More...
 
virtual EDA_ITEMClone () const override
 Function Clone creates a duplicate of this item with linked list members set to NULL. More...
 
virtual const BOX2I ViewBBox () const override
 Function ViewBBox() returns the bounding box of the item covering all its layers. More...
 
virtual void SwapData (BOARD_ITEM *aImage) override
 Swap data between aItem and aImage. More...
 
virtual bool IsConnected () const
 Function IsConnected() Returns information if the object is derived from BOARD_CONNECTED_ITEM. More...
 
BOARD_ITEMNext () const
 
BOARD_ITEMBack () const
 
BOARD_ITEM_CONTAINERGetParent () const
 
virtual PCB_LAYER_ID GetLayer () const
 Function GetLayer returns the primary layer this item is on. More...
 
virtual LSET GetLayerSet () const
 Function GetLayerSet returns a "layer mask", which is a bitmap of all layers on which the TRACK segment or VIA physically resides. More...
 
virtual void SetLayer (PCB_LAYER_ID aLayer)
 Function SetLayer sets the layer this item is on. More...
 
virtual bool IsOnLayer (PCB_LAYER_ID aLayer) const
 Function IsOnLayer tests to see if this object is on the given layer. More...
 
bool IsTrack () const
 Function IsTrack tests to see if this object is a track or via (or microvia). More...
 
virtual bool IsLocked () const
 Function IsLocked. More...
 
virtual void SetLocked (bool aLocked)
 Function SetLocked modifies 'lock' status for of the item. More...
 
virtual void UnLink ()
 Function UnLink detaches this object from its owner. More...
 
void DeleteStructure ()
 Function DeleteStructure deletes this object after UnLink()ing it from its owner if it has one. More...
 
void Move (const VECTOR2I &aMoveVector)
 
void Rotate (const VECTOR2I &aRotCentre, double aAngle)
 
void Flip (const VECTOR2I &aCentre)
 
virtual BOARDGetBoard () const
 Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none. More...
 
wxString GetLayerName () const
 Function GetLayerName returns the name of the PCB layer on which the item resides. More...
 
virtual void ViewGetLayers (int aLayers[], int &aCount) const override
 Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on. More...
 
KICAD_T Type () const
 Function Type() More...
 
void SetTimeStamp (timestamp_t aNewTimeStamp)
 
timestamp_t GetTimeStamp () const
 
DHEADGetList () const
 
void SetNext (EDA_ITEM *aNext)
 
void SetBack (EDA_ITEM *aBack)
 
void SetParent (EDA_ITEM *aParent)
 
void SetList (DHEAD *aList)
 
bool IsNew () const
 
bool IsModified () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsResized () const
 
bool IsHighlighted () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetHighlighted ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearHighlighted ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (int type) const
 
void SetState (int type, int state)
 
STATUS_FLAGS GetStatus () const
 
void SetStatus (STATUS_FLAGS aStatus)
 
void SetFlags (STATUS_FLAGS aMask)
 
void ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
STATUS_FLAGS GetFlags () const
 
bool IsType (const KICAD_T aScanTypes[])
 Function IsType Checks whether the item is one of the listed types. More...
 
void SetForceVisible (bool aEnable)
 Function SetForceVisible is used to set and cleag force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
 
virtual SEARCH_RESULT Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 Function Visit may be re-implemented for each derived class in order to handle all the types given by its member data. More...
 
virtual bool Matches (wxFindReplaceData &aSearchData, void *aAuxData, wxPoint *aFindLocation)
 Function Matches compares the item against the search criteria in aSearchData. More...
 
bool Replace (wxFindReplaceData &aSearchData, wxString &aText)
 Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool Replace (wxFindReplaceData &aSearchData, void *aAuxData=NULL)
 Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool IsReplaceable () const
 Function IsReplaceable. More...
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Function ViewDraw() Draws the parts of the object belonging to layer aLayer. More...
 
virtual unsigned int ViewGetLOD (int aLayer, VIEW *aView) const
 Function ViewGetLOD() Returns the level of detail (LOD) of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 

Static Public Member Functions

static bool ClassOf (const EDA_ITEM *aItem)
 
static wxString ShowShape (STROKE_T aShape)
 Function ShowShape converts the enum STROKE_T integer value to a wxString. More...
 
static std::string FormatInternalUnits (int aValue)
 Function FormatInternalUnits converts aValue from board internal units to a string appropriate for writing to file. More...
 
static std::string FormatInternalUnits (const wxPoint &aPoint)
 
static std::string FormatInternalUnits (const VECTOR2I &aPoint)
 
static std::string FormatInternalUnits (const wxSize &aSize)
 
static std::string FormatAngle (double aAngle)
 Function FormatAngle converts aAngle from board units to a string appropriate for writing to file. More...
 
static SEARCH_RESULT IterateForward (EDA_ITEM *listStart, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 Function IterateForward walks through the object tree calling the inspector() on each object type requested in scanTypes. More...
 
static bool Sort (const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
 Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...
 

Static Public Attributes

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

Protected Member Functions

void computeArcBBox (EDA_RECT &aBBox) const
 
bool Matches (const wxString &aText, wxFindReplaceData &aSearchData)
 Function Matches compares aText against search criteria in aSearchData. More...
 

Static Protected Member Functions

static int getTrailingInt (const wxString &aStr)
 
static int getNextNumberInSequence (const std::set< int > &aSeq, bool aFillSequenceGaps)
 

Protected Attributes

int m_Width
 thickness of lines ... More...
 
wxPoint m_Start
 Line start point or Circle and Arc center. More...
 
wxPoint m_End
 Line end point or circle and arc start point. More...
 
STROKE_T m_Shape
 Shape: line, Circle, Arc. More...
 
int m_Type
 Used in complex associations ( Dimensions.. ) More...
 
double m_Angle
 Used only for Arcs: Arc angle in 1/10 deg. More...
 
wxPoint m_BezierC1
 Bezier Control Point 1. More...
 
wxPoint m_BezierC2
 Bezier Control Point 2. More...
 
std::vector< wxPointm_BezierPoints
 
SHAPE_POLY_SET m_Poly
 Stores the S_POLYGON shape. More...
 
PCB_LAYER_ID m_Layer
 
EDA_ITEMPnext
 next in linked list More...
 
EDA_ITEMPback
 previous in linked list More...
 
DHEADm_List
 which DLIST I am on. More...
 
EDA_ITEMm_Parent
 Linked list: Link (parent struct) More...
 
timestamp_t m_TimeStamp
 Time stamp used for logical links. More...
 
bool m_forceVisible
 Set to true to override the visibility setting of the item. More...
 
STATUS_FLAGS m_Flags
 Flag bits for editing and other uses. More...
 

Detailed Description

Definition at line 47 of file class_drawsegment.h.

Constructor & Destructor Documentation

DRAWSEGMENT::DRAWSEGMENT ( BOARD_ITEM aParent = NULL,
KICAD_T  idtype = PCB_LINE_T 
)

Definition at line 52 of file class_drawsegment.cpp.

References DEFAULT_LINE_WIDTH, m_Angle, EDA_ITEM::m_Flags, m_Shape, m_Type, m_Width, and S_SEGMENT.

Referenced by Clone().

52  :
53  BOARD_ITEM( aParent, idtype )
54 {
55  m_Type = 0;
56  m_Angle = 0;
57  m_Flags = 0;
59  m_Width = Millimeter2iu( DEFAULT_LINE_WIDTH );
60 }
#define DEFAULT_LINE_WIDTH
usual segment : line with rounded ends
double m_Angle
Used only for Arcs: Arc angle in 1/10 deg.
STROKE_T m_Shape
Shape: line, Circle, Arc.
BOARD_ITEM(BOARD_ITEM *aParent, KICAD_T idtype)
int m_Type
Used in complex associations ( Dimensions.. )
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
int m_Width
thickness of lines ...
DRAWSEGMENT::~DRAWSEGMENT ( )

Definition at line 63 of file class_drawsegment.cpp.

64 {
65 }

Member Function Documentation

BOARD_ITEM* BOARD_ITEM::Back ( ) const
inlineinherited

Definition at line 117 of file class_board_item.h.

References EDA_ITEM::Pback.

Referenced by SwapItemData().

117 { return static_cast<BOARD_ITEM*>( Pback ); }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:168
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
const std::vector< wxPoint > DRAWSEGMENT::BuildPolyPointsList ( ) const

Build and return the list of corners in a std::vector<wxPoint> It must be used only to convert the SHAPE_POLY_SET internal corner buffer to a list of wxPoints, and nothing else, because it duplicates the buffer, that is inefficient to know for instance the corner count.

Definition at line 922 of file class_drawsegment.cpp.

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

Referenced by GRID_HELPER::computeAnchors(), KIGFX::PCB_PAINTER::draw(), GetBezierPoints(), DIALOG_PAD_PROPERTIES::OnPaintShowPanel(), PCB_PARSER::parseD_PAD(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), and POINT_EDITOR::updatePoints().

923 {
924  std::vector<wxPoint> rv;
925 
926  if( m_Poly.OutlineCount() )
927  {
928  if( m_Poly.COutline( 0 ).PointCount() )
929  {
930  for ( auto iter = m_Poly.CIterate(); iter; iter++ )
931  {
932  rv.push_back( wxPoint( iter->x, iter->y ) );
933  }
934  }
935  }
936 
937  return rv;
938 }
int PointCount() const
Function PointCount()
SHAPE_POLY_SET m_Poly
Stores the S_POLYGON shape.
CONST_ITERATOR CIterate(int aFirst, int aLast, bool aIterateHoles=false) const
int OutlineCount() const
Returns the number of outlines in the set
const SHAPE_LINE_CHAIN & COutline(int aIndex) const
static bool DRAWSEGMENT::ClassOf ( const EDA_ITEM aItem)
inlinestatic

Definition at line 74 of file class_drawsegment.h.

References PCB_LINE_T, and EDA_ITEM::Type().

75  {
76  return aItem && PCB_LINE_T == aItem->Type();
77  }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
class DRAWSEGMENT, a segment not on copper layers
Definition: typeinfo.h:91
void EDA_ITEM::ClearBrightened ( )
inlineinherited

Definition at line 236 of file base_struct.h.

References BRIGHTENED, EDA_ITEM::ClearFlags(), and EDA_ITEM::SetModified().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), and SELECTION_TOOL::unhighlight().

236 { ClearFlags( BRIGHTENED ); }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:138
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:257
void EDA_ITEM::ClearFlags ( STATUS_FLAGS  aMask = EDA_ITEM_ALL_FLAGS)
inlineinherited

Definition at line 257 of file base_struct.h.

Referenced by Abort_Edit_Pcb_Text(), Abort_EditEdge(), Abort_Move_ModuleOutline(), Abort_Move_Pad(), Abort_MoveOrCopyModule(), Abort_MoveTrack(), Abort_Zone_Create_Outline(), Abort_Zone_Move_Corner_Or_Outlines(), AbortMoveAndEditTarget(), AbortMoveDimensionText(), abortMoveItem(), AbortMoveTextModule(), AbortPinMove(), SCH_SCREEN::addConnectedItemsToBlock(), SCH_EDIT_FRAME::addCurrentItemToScreen(), PNS_KICAD_IFACE::AddItem(), PCB_EDIT_FRAME::AppendBoardFile(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Zone(), SCH_EDIT_FRAME::BeginSegment(), PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Block_Flip(), PCB_EDIT_FRAME::Block_Move(), LIB_EDIT_FRAME::BlockCopySelectedItems(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_SCREEN::ClearAnnotation(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearHighlighted(), DRAG_LIST::ClearList(), ClearMarkItems(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), MWAVE::CreateMicrowaveInductor(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), PCB_EDIT_FRAME::Delete_LastCreatedCorner(), PCB_EDIT_FRAME::Delete_Segment_Edge(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), PCB_EDIT_FRAME::EditDimension(), PCB_EDIT_FRAME::End_Edge(), FOOTPRINT_EDIT_FRAME::End_Edge_Module(), PCB_EDIT_FRAME::End_Move_Zone_Corner_Or_Outlines(), PCB_EDIT_FRAME::End_Route(), PCB_EDIT_FRAME::End_Zone(), EraseDragList(), PCB_EDIT_FRAME::Exchange_Module(), ExitSheet(), SCH_SCREEN::GetConnection(), PCB_BASE_FRAME::Import_Pad_Settings(), SCH_JUNCTION::IsSelectStateChanged(), SCH_NO_CONNECT::IsSelectStateChanged(), SCH_MARKER::IsSelectStateChanged(), SCH_BUS_ENTRY_BASE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), SCH_COMPONENT::IsSelectStateChanged(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), FOOTPRINT_EDIT_FRAME::LoadModuleFromLibrary(), MarkItemsInBloc(), MirrorX(), MirrorY(), LIB_EDIT_FRAME::OnEditPin(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnOrient(), LIB_EDIT_FRAME::OnRotate(), SCH_EDIT_FRAME::OnSelectUnit(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), SCH_FIELD::Place(), PCB_EDIT_FRAME::Place_DrawItem(), FOOTPRINT_EDIT_FRAME::Place_EdgeMod(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCB_EDIT_FRAME::PlaceDimensionText(), PCB_EDIT_FRAME::PlaceDraggedOrMovedTrackSegment(), PCB_BASE_FRAME::PlaceModule(), PCB_BASE_FRAME::PlacePad(), PCB_EDIT_FRAME::PlaceTarget(), DRAWING_TOOL::PlaceText(), PCB_BASE_FRAME::PlaceTexteModule(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), LIB_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), BOARD_COMMIT::Revert(), PCB_BASE_FRAME::Rotate_Module(), RotateListOfItems(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_EDIT_FRAME::SetRepeatItem(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

257 { m_Flags &= ~aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
void EDA_ITEM::ClearHighlighted ( )
inlineinherited

Definition at line 235 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

235 { ClearFlags( HIGHLIGHTED ); }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:137
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:257
void EDA_ITEM::ClearSelected ( )
inlineinherited

Definition at line 234 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by POINT_EDITOR::addCorner(), EDIT_TOOL::Duplicate(), GAL_ARRAY_CREATOR::prePushAction(), SELECTION_TOOL::unhighlight(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

234 { ClearFlags( SELECTED ); }
#define SELECTED
Definition: base_struct.h:121
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:257
EDA_ITEM * DRAWSEGMENT::Clone ( ) const
overridevirtual

Function Clone creates 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 EDGE_MODULE.

Definition at line 814 of file class_drawsegment.cpp.

References DRAWSEGMENT().

Referenced by GetLength().

815 {
816  return new DRAWSEGMENT( *this );
817 }
DRAWSEGMENT(BOARD_ITEM *aParent=NULL, KICAD_T idtype=PCB_LINE_T)
void DRAWSEGMENT::computeArcBBox ( EDA_RECT aBBox) const
protected

Definition at line 836 of file class_drawsegment.cpp.

References PNS::angle(), GetArcAngleStart(), GetRadius(), m_Angle, m_End, m_Start, EDA_RECT::Merge(), RotatePoint(), EDA_RECT::SetOrigin(), wxPoint::x, and wxPoint::y.

Referenced by GetBoundingBox(), and ViewBBox().

837 {
838  // Do not include the center, which is not necessarily
839  // inside the BB of a arc with a small angle
840  aBBox.SetOrigin( m_End );
841 
842  wxPoint end = m_End;
843  RotatePoint( &end, m_Start, -m_Angle );
844  aBBox.Merge( end );
845 
846  // Determine the starting quarter
847  // 0 right-bottom
848  // 1 left-bottom
849  // 2 left-top
850  // 3 right-top
851  unsigned int quarter = 0; // assume right-bottom
852 
853  if( m_End.x < m_Start.x )
854  {
855  if( m_End.y <= m_Start.y )
856  quarter = 2;
857  else // ( m_End.y > m_Start.y )
858  quarter = 1;
859  }
860  else if( m_End.x >= m_Start.x )
861  {
862  if( m_End.y < m_Start.y )
863  quarter = 3;
864  else if( m_End.x == m_Start.x )
865  quarter = 1;
866  }
867 
868  int radius = GetRadius();
869  int angle = (int) GetArcAngleStart() % 900 + m_Angle;
870  bool directionCW = ( m_Angle > 0 ); // Is the direction of arc clockwise?
871 
872  // Make the angle positive, so we go clockwise and merge points belonging to the arc
873  if( !directionCW )
874  {
875  angle = 900 - angle;
876  quarter = ( quarter + 3 ) % 4; // -1 modulo arithmetic
877  }
878 
879  while( angle > 900 )
880  {
881  switch( quarter )
882  {
883  case 0:
884  aBBox.Merge( wxPoint( m_Start.x, m_Start.y + radius ) ); // down
885  break;
886 
887  case 1:
888  aBBox.Merge( wxPoint( m_Start.x - radius, m_Start.y ) ); // left
889  break;
890 
891  case 2:
892  aBBox.Merge( wxPoint( m_Start.x, m_Start.y - radius ) ); // up
893  break;
894 
895  case 3:
896  aBBox.Merge( wxPoint( m_Start.x + radius, m_Start.y ) ); // right
897  break;
898  }
899 
900  if( directionCW )
901  ++quarter;
902  else
903  quarter += 3; // -1 modulo arithmetic
904 
905  quarter %= 4;
906  angle -= 900;
907  }
908 }
void Merge(const EDA_RECT &aRect)
Function Merge modifies the position and size of the rectangle in order to contain aRect...
double GetArcAngleStart() const
function GetArcAngleStart()
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:124
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:216
double m_Angle
Used only for Arcs: Arc angle in 1/10 deg.
wxPoint m_Start
Line start point or Circle and Arc center.
wxPoint m_End
Line end point or circle and arc start point.
static DIRECTION_45::AngleType angle(const VECTOR2I &a, const VECTOR2I &b)
int GetRadius() const
Function GetRadius returns the radius of this item Has meaning only for arc and circle.
void DRAWSEGMENT::Draw ( EDA_DRAW_PANEL panel,
wxDC *  DC,
GR_DRAWMODE  aDrawMode,
const wxPoint offset = ZeroOffset 
)
overridevirtual

Function Draw BOARD_ITEMs have their own color information.

Implements BOARD_ITEM.

Reimplemented in EDGE_MODULE.

Definition at line 289 of file class_drawsegment.cpp.

References ArcTangente(), color, DARKDARKGRAY, Distance(), Edge_Cuts, FILLED, FORCE_SKETCH, BOARD_ITEM::GetBoard(), EDA_DRAW_PANEL::GetClipBox(), EDA_DRAW_PANEL::GetDisplayOptions(), BOARD_ITEM::GetLayer(), EDA_DRAW_PANEL::GetParent(), GetPolyShape(), EDA_DRAW_PANEL::GetPrintMirrored(), EDA_DRAW_PANEL::GetScreen(), GetWidth(), GR_ALLOW_HIGHCONTRAST, GRArc(), GRCircle(), GRClosedPoly(), GRCSegm(), GRFillCSegm(), GRFilledSegment(), GRSetDrawMode(), i, BOARD::IsLayerVisible(), BOARD_ITEM::IsOnLayer(), KiROUND(), m_Angle, m_BezierPoints, m_End, EDA_ITEM::m_Flags, m_Shape, m_Start, m_Width, SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), SHAPE_LINE_CHAIN::Point(), SHAPE_LINE_CHAIN::PointCount(), RebuildBezierToSegmentsPointsList(), S_ARC, S_CIRCLE, S_CURVE, S_POLYGON, SKETCH, wxPoint::x, and wxPoint::y.

Referenced by Abort_EditEdge(), PCB_EDIT_FRAME::Begin_DrawSegment(), PCB_EDIT_FRAME::Delete_Segment_Edge(), DrawSegment(), PCB_EDIT_FRAME::End_Edge(), Move_Segment(), PCB_EDIT_FRAME::Place_DrawItem(), SetBezierPoints(), and PCB_EDIT_FRAME::Start_Move_DrawItem().

291 {
292  int ux0, uy0, dx, dy;
293  int l_trace;
294  int radius;
295 
296  PCB_LAYER_ID curr_layer = ( (PCB_SCREEN*) panel->GetScreen() )->m_Active_Layer;
297 
298  BOARD * brd = GetBoard( );
299 
300  if( brd->IsLayerVisible( GetLayer() ) == false )
301  return;
302 
303  auto frame = static_cast<PCB_EDIT_FRAME*> ( panel->GetParent() );
304  auto color = frame->Settings().Colors().GetLayerColor( GetLayer() );
305 
306  auto displ_opts = (PCB_DISPLAY_OPTIONS*) panel->GetDisplayOptions();
307 
308  if( ( draw_mode & GR_ALLOW_HIGHCONTRAST ) && displ_opts && displ_opts->m_ContrastModeDisplay )
309  {
310  if( !IsOnLayer( curr_layer ) && !IsOnLayer( Edge_Cuts ) )
312  }
313 
314  GRSetDrawMode( DC, draw_mode );
315  l_trace = m_Width >> 1; // half trace width
316 
317  // Line start point or Circle and Arc center
318  ux0 = m_Start.x + aOffset.x;
319  uy0 = m_Start.y + aOffset.y;
320 
321  // Line end point or circle and arc start point
322  dx = m_End.x + aOffset.x;
323  dy = m_End.y + aOffset.y;
324 
325  bool filled = displ_opts ? displ_opts->m_DisplayDrawItemsFill : FILLED;
326 
327  if( m_Flags & FORCE_SKETCH )
328  filled = SKETCH;
329 
330  switch( m_Shape )
331  {
332  case S_CIRCLE:
333  radius = KiROUND( Distance( ux0, uy0, dx, dy ) );
334 
335  if( filled )
336  {
337  GRCircle( panel->GetClipBox(), DC, ux0, uy0, radius, m_Width, color );
338  }
339  else
340  {
341  GRCircle( panel->GetClipBox(), DC, ux0, uy0, radius - l_trace, color );
342  GRCircle( panel->GetClipBox(), DC, ux0, uy0, radius + l_trace, color );
343  }
344 
345  break;
346 
347  case S_ARC:
348  double StAngle, EndAngle;
349  radius = KiROUND( Distance( ux0, uy0, dx, dy ) );
350  StAngle = ArcTangente( dy - uy0, dx - ux0 );
351  EndAngle = StAngle + m_Angle;
352 
353  if( !panel->GetPrintMirrored() )
354  {
355  if( StAngle > EndAngle )
356  std::swap( StAngle, EndAngle );
357  }
358  else // Mirrored mode: arc orientation is reversed
359  {
360 #ifdef __WXMAC__ // wxWidgets OSX print driver handles arc mirroring for us
361  if( StAngle > EndAngle )
362  std::swap( StAngle, EndAngle );
363 #else
364  if( StAngle < EndAngle )
365  std::swap( StAngle, EndAngle );
366 #endif
367  }
368 
369  if( filled )
370  {
371  GRArc( panel->GetClipBox(), DC, ux0, uy0, StAngle, EndAngle,
372  radius, m_Width, color );
373  }
374  else
375  {
376  GRArc( panel->GetClipBox(), DC, ux0, uy0, StAngle, EndAngle,
377  radius - l_trace, color );
378  GRArc( panel->GetClipBox(), DC, ux0, uy0, StAngle, EndAngle,
379  radius + l_trace, color );
380  }
381 
382  break;
383 
384  case S_CURVE:
385  {
387 
388  wxPoint& startp = m_BezierPoints[0];
389 
390  for( unsigned int i = 1; i < m_BezierPoints.size(); i++ )
391  {
392  wxPoint& endp = m_BezierPoints[i];
393 
394  if( filled )
395  GRFilledSegment( panel->GetClipBox(), DC,
396  startp+aOffset, endp+aOffset, m_Width, color );
397  else
398  GRCSegm( panel->GetClipBox(), DC,
399  startp+aOffset, endp+aOffset, m_Width, color );
400 
401  startp = m_BezierPoints[i];
402  }
403  }
404  break;
405 
406  case S_POLYGON:
407  {
408  SHAPE_POLY_SET& outline = GetPolyShape();
409  // Draw the polygon: only one polygon is expected
410  // However we provide a multi polygon shape drawing
411  // ( for the future or to show a non expected shape )
412  for( int jj = 0; jj < outline.OutlineCount(); ++jj )
413  {
414  SHAPE_LINE_CHAIN& poly = outline.Outline( jj );
415 
416  GRClosedPoly( panel->GetClipBox(), DC, poly.PointCount(),
417  (wxPoint*)&poly.Point( 0 ), FILLED, GetWidth(),
418  color, color );
419  }
420  }
421  break;
422 
423  default:
424  if( filled )
425  {
426  GRFillCSegm( panel->GetClipBox(), DC, ux0, uy0, dx, dy, m_Width, color );
427  }
428  else
429  {
430  GRCSegm( panel->GetClipBox(), DC, ux0, uy0, dx, dy, m_Width, color );
431  }
432 
433  break;
434  }
435 }
virtual BASE_SCREEN * GetScreen()=0
void GRSetDrawMode(wxDC *DC, GR_DRAWMODE draw_mode)
Definition: gr_basic.cpp:223
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:120
virtual bool IsOnLayer(PCB_LAYER_ID aLayer) const
Function IsOnLayer tests to see if this object is on the given layer.
virtual PCB_LAYER_ID GetLayer() const
Function GetLayer returns the primary layer this item is on.
int PointCount() const
Function PointCount()
int color
Definition: DXF_plotter.cpp:62
polygon (not yet used for tracks, but could be in microwave apps)
void RebuildBezierToSegmentsPointsList(int aMinSegLen)
Rebuild the m_BezierPoints vertex list that approximate the Bezier curve by a list of segments Has me...
void GRCSegm(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, int width, int aPenSize, COLOR4D Color)
Definition: gr_basic.cpp:415
virtual EDA_RECT * GetClipBox()
double m_Angle
Used only for Arcs: Arc angle in 1/10 deg.
int OutlineCount() const
Returns the number of outlines in the set
void GRClosedPoly(EDA_RECT *ClipBox, wxDC *DC, int n, wxPoint Points[], bool Fill, COLOR4D Color, COLOR4D BgColor)
Function GRClosedPoly draws a closed polygon onto the drawing context aDC and optionally fills and/or...
Definition: gr_basic.cpp:711
virtual EDA_DRAW_FRAME * GetParent() const =0
Class PCB_DISPLAY_OPTIONS handles display options like enable/disable some optional drawings...
PCB_LAYER_ID
A quick note on layer IDs:
wxPoint m_Start
Line start point or Circle and Arc center.
double ArcTangente(int dy, int dx)
Definition: trigo.cpp:170
wxPoint m_End
Line end point or circle and arc start point.
Class SHAPE_POLY_SET.
SHAPE_LINE_CHAIN & Outline(int aIndex)
Returns the reference to aIndex-th outline in the set
void GRFillCSegm(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, int width, COLOR4D Color)
Definition: gr_basic.cpp:518
Arcs (with rounded ends)
void GRArc(EDA_RECT *ClipBox, wxDC *DC, int xc, int yc, double StAngle, double EndAngle, int r, COLOR4D Color)
Definition: gr_basic.cpp:908
STROKE_T m_Shape
Shape: line, Circle, Arc.
SHAPE_POLY_SET & GetPolyShape()
Bezier Curve.
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:170
Class SHAPE_LINE_CHAIN.
void GRFilledSegment(EDA_RECT *aClipBox, wxDC *aDC, wxPoint aStart, wxPoint aEnd, int aWidth, COLOR4D aColor)
Definition: gr_basic.cpp:526
void GRCircle(EDA_RECT *ClipBox, wxDC *DC, int xc, int yc, int r, int width, COLOR4D Color)
Definition: gr_basic.cpp:755
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
size_t i
Definition: json11.cpp:597
Class PCB_EDIT_FRAME is the main frame for Pcbnew.
int GetWidth() const
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
VECTOR2I & Point(int aIndex)
Function Point()
int m_Width
thickness of lines ...
virtual void * GetDisplayOptions()
Function GetDisplayOptions A way to pass info to draw functions.
double Distance(double x1, double y1, double x2, double y2)
#define FORCE_SKETCH
Definition: pcbnew.h:73
bool IsLayerVisible(PCB_LAYER_ID aLayer) const
Function IsLayerVisible is a proxy function that calls the correspondent function in m_BoardSettings ...
Definition: class_board.h:457
std::vector< wxPoint > m_BezierPoints
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39
void DRAWSEGMENT::Flip ( const wxPoint aCentre)
overridevirtual

Function Flip Flip this object, i.e.

change the board side for this object

Parameters
aCentre- the rotation point.

Reimplemented from BOARD_ITEM.

Reimplemented in EDGE_MODULE.

Definition at line 151 of file class_drawsegment.cpp.

References FlipLayer(), BOARD_ITEM::GetLayer(), BEZIER_POLY::GetPoly(), SHAPE_POLY_SET::Iterate(), m_Angle, m_BezierC1, m_BezierC2, m_BezierPoints, m_End, m_Poly, m_Shape, m_Start, m_Width, S_ARC, S_CURVE, S_POLYGON, BOARD_ITEM::SetLayer(), and wxPoint::y.

Referenced by GetLength().

152 {
153  m_Start.y = aCentre.y - (m_Start.y - aCentre.y);
154  m_End.y = aCentre.y - (m_End.y - aCentre.y);
155 
156  switch ( m_Shape )
157  {
158  case S_ARC:
159  m_Angle = -m_Angle;
160  break;
161 
162  case S_POLYGON:
163  for( auto iter = m_Poly.Iterate(); iter; iter++ )
164  {
165  iter->y = aCentre.y - (iter->y - aCentre.y);
166  }
167  break;
168 
169  case S_CURVE:
170  {
171  m_BezierC1.y = aCentre.y - (m_BezierC1.y - aCentre.y);
172  m_BezierC2.y = aCentre.y - (m_BezierC2.y - aCentre.y);
173 
174  // Rebuild the poly points shape
175  std::vector<wxPoint> ctrlPoints = { m_Start, m_BezierC1, m_BezierC2, m_End };
176  BEZIER_POLY converter( ctrlPoints );
177  converter.GetPoly( m_BezierPoints, m_Width );
178  }
179  break;
180 
181  default:
182  break;
183  }
184 
185  // DRAWSEGMENT items are not allowed on copper layers, so
186  // copper layers count is not taken in account in Flip transform
187  SetLayer( FlipLayer( GetLayer() ) );
188 }
virtual void SetLayer(PCB_LAYER_ID aLayer)
Function SetLayer sets the layer this item is on.
virtual PCB_LAYER_ID GetLayer() const
Function GetLayer returns the primary layer this item is on.
SHAPE_POLY_SET m_Poly
Stores the S_POLYGON shape.
polygon (not yet used for tracks, but could be in microwave apps)
PCB_LAYER_ID FlipLayer(PCB_LAYER_ID aLayerId, int aCopperLayersCount)
Function FlippedLayerNumber.
Definition: lset.cpp:472
double m_Angle
Used only for Arcs: Arc angle in 1/10 deg.
ITERATOR Iterate(int aFirst, int aLast, bool aIterateHoles=false)
Function Iterate returns an object to iterate through the points of the polygons between aFirst and a...
wxPoint m_BezierC1
Bezier Control Point 1.
wxPoint m_Start
Line start point or Circle and Arc center.
wxPoint m_End
Line end point or circle and arc start point.
Arcs (with rounded ends)
STROKE_T m_Shape
Shape: line, Circle, Arc.
Bezier Curve.
Bezier curves to polygon converter.
Definition: bezier_curves.h:35
wxPoint m_BezierC2
Bezier Control Point 2.
int m_Width
thickness of lines ...
std::vector< wxPoint > m_BezierPoints
void BOARD_ITEM::Flip ( const VECTOR2I aCentre)
inlineinherited

Definition at line 271 of file class_board_item.h.

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

272  {
273  Flip( wxPoint( aCentre.x, aCentre.y ) );
274  }
virtual void Flip(const wxPoint &aCentre)
Function Flip Flip this object, i.e.
std::string BOARD_ITEM::FormatAngle ( double  aAngle)
staticinherited

Function FormatAngle converts aAngle from board units to a string appropriate for writing to file.

Note
Internal angles for board items can be either degrees or tenths of degree on how KiCad is built.
Parameters
aAngleA angle value to convert.
Returns
A std::string object containing the converted angle.

Definition at line 171 of file class_board_item.cpp.

Referenced by BOARD_ITEM::HitTest().

172 {
173  char temp[50];
174 
175  int len = snprintf( temp, sizeof(temp), "%.10g", aAngle / 10.0 );
176 
177  return std::string( temp, len );
178 }
std::string BOARD_ITEM::FormatInternalUnits ( int  aValue)
staticinherited

Function FormatInternalUnits converts aValue from board internal units to a string appropriate for writing to file.

Note
Internal units for board items can be either deci-mils or nanometers depending on how KiCad is build.
Parameters
aValueA coordinate value to convert.
Returns
A std::string object containing the converted value.

Definition at line 90 of file class_board_item.cpp.

Referenced by checkConnectedTo(), BOARD_ITEM::FormatInternalUnits(), BOARD_ITEM::HitTest(), and BOARD::TracksInNetBetweenPoints().

91 {
92 #if 1
93 
94  char buf[50];
95  int len;
96  double mm = aValue / IU_PER_MM;
97 
98  if( mm != 0.0 && fabs( mm ) <= 0.0001 )
99  {
100  len = sprintf( buf, "%.10f", mm );
101 
102  while( --len > 0 && buf[len] == '0' )
103  buf[len] = '\0';
104 
105  if( buf[len] == '.' )
106  buf[len] = '\0';
107  else
108  ++len;
109  }
110  else
111  {
112  len = sprintf( buf, "%.10g", mm );
113  }
114 
115  return std::string( buf, len );
116 
117 #else
118 
119  // Assume aValue is in nanometers, and that we want the result in millimeters,
120  // and that int is 32 bits wide. Then perform an alternative algorithm.
121  // Can be used to verify that the above algorithm is correctly generating text.
122  // Convert aValue into an integer string, then insert a decimal point manually.
123  // Results are the same as above general purpose algorithm.
124 
125  wxASSERT( sizeof(int) == 4 );
126 
127  if( aValue == 0 )
128  return std::string( 1, '0' );
129  else
130  {
131  char buf[50];
132  int len = sprintf( buf, aValue > 0 ? "%06d" : "%07d", aValue ); // optionally pad w/leading zeros
133 
134  std::string ret( buf, len );
135 
136  std::string::iterator it = ret.end() - 1; // last byte
137 
138  // insert '.' at 6 positions from end, dividing by 10e6 (a million), nm => mm
139  std::string::iterator decpoint = ret.end() - 6;
140 
141  // truncate trailing zeros, up to decimal point position
142  for( ; *it=='0' && it >= decpoint; --it )
143  ret.erase( it ); // does not invalidate iterators it or decpoint
144 
145  if( it >= decpoint )
146  {
147  ret.insert( decpoint, '.' );
148 
149  // decpoint is invalidated here, after insert()
150 
151 #if 1 // want a leading zero when decimal point is in first position?
152  if( ret[0] == '.' )
153  {
154  // insert leading zero ahead of decimal point.
155  ret.insert( ret.begin(), '0' );
156  }
157  else if( ret[0]=='-' && ret[1]=='.' )
158  {
159  ret.insert( ret.begin() + 1, '0' );
160  }
161 #endif
162  }
163 
164  return ret;
165  }
166 
167 #endif
168 }
std::string BOARD_ITEM::FormatInternalUnits ( const wxPoint aPoint)
staticinherited

Definition at line 181 of file class_board_item.cpp.

References BOARD_ITEM::FormatInternalUnits(), wxPoint::x, and wxPoint::y.

182 {
183  return FormatInternalUnits( aPoint.x ) + " " + FormatInternalUnits( aPoint.y );
184 }
static std::string FormatInternalUnits(int aValue)
Function FormatInternalUnits converts aValue from board internal units to a string appropriate for wr...
std::string BOARD_ITEM::FormatInternalUnits ( const VECTOR2I aPoint)
staticinherited

Definition at line 187 of file class_board_item.cpp.

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

188 {
189  return FormatInternalUnits( aPoint.x ) + " " + FormatInternalUnits( aPoint.y );
190 }
static std::string FormatInternalUnits(int aValue)
Function FormatInternalUnits converts aValue from board internal units to a string appropriate for wr...
std::string BOARD_ITEM::FormatInternalUnits ( const wxSize &  aSize)
staticinherited

Definition at line 193 of file class_board_item.cpp.

References BOARD_ITEM::FormatInternalUnits().

194 {
195  return FormatInternalUnits( aSize.GetWidth() ) + " " + FormatInternalUnits( aSize.GetHeight() );
196 }
static std::string FormatInternalUnits(int aValue)
Function FormatInternalUnits converts aValue from board internal units to a string appropriate for wr...
double DRAWSEGMENT::GetArcAngleStart ( ) const

function GetArcAngleStart()

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

Definition at line 258 of file class_drawsegment.cpp.

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

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

259 {
260  // due to the Y axis orient atan2 needs - y value
261  double angleStart = ArcTangente( GetArcStart().y - GetCenter().y,
262  GetArcStart().x - GetCenter().x );
263 
264  // Normalize it to 0 ... 360 deg, to avoid discontinuity for angles near 180 deg
265  // because 180 deg and -180 are very near angles when ampping betewwen -180 ... 180 deg.
266  // and this is not easy to handle in calculations
267  NORMALIZE_ANGLE_POS( angleStart );
268 
269  return angleStart;
270 }
const wxPoint GetCenter() const override
Function GetCenter()
void NORMALIZE_ANGLE_POS(T &Angle)
Definition: trigo.h:241
const wxPoint & GetArcStart() const
double ArcTangente(int dy, int dx)
Definition: trigo.cpp:170
const wxPoint DRAWSEGMENT::GetArcEnd ( ) const

Definition at line 237 of file class_drawsegment.cpp.

References m_Angle, m_End, m_Shape, m_Start, RotatePoint(), and S_ARC.

Referenced by GRID_HELPER::computeAnchors(), ConvertOutlineToPolygon(), findPoint(), GetArcStart(), EDIT_POINTS_FACTORY::Make(), DIALOG_PAD_PROPERTIES::OnPaintShowPanel(), POINT_EDITOR::updateItem(), and POINT_EDITOR::updatePoints().

238 {
239  wxPoint endPoint; // start of arc
240 
241  switch( m_Shape )
242  {
243  case S_ARC:
244  // rotate the starting point of the arc, given by m_End, through the
245  // angle m_Angle to get the ending point of the arc.
246  // m_Start is the arc centre
247  endPoint = m_End; // m_End = start point of arc
248  RotatePoint( &endPoint, m_Start, -m_Angle );
249  break;
250 
251  default:
252  break;
253  }
254 
255  return endPoint; // after rotation, the end of the arc.
256 }
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:216
double m_Angle
Used only for Arcs: Arc angle in 1/10 deg.
wxPoint m_Start
Line start point or Circle and Arc center.
wxPoint m_End
Line end point or circle and arc start point.
Arcs (with rounded ends)
STROKE_T m_Shape
Shape: line, Circle, Arc.
const wxPoint& DRAWSEGMENT::GetBezControl1 ( ) const
inline
const wxPoint& DRAWSEGMENT::GetBezControl2 ( ) const
inline
const std::vector<wxPoint>& DRAWSEGMENT::GetBezierPoints ( ) const
inline
BOARD * BOARD_ITEM::GetBoard ( ) const
virtualinherited

Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.

Definition at line 64 of file class_board_item.cpp.

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

Referenced by DIALOG_GEN_FOOTPRINT_POSITION::CreateFiles(), DeleteMarkedItems(), TEXTE_PCB::Draw(), PCB_TARGET::Draw(), EDGE_MODULE::Draw(), ZONE_CONTAINER::Draw(), TEXTE_MODULE::Draw(), TRACK::Draw(), DIMENSION::Draw(), Draw(), MODULE::Draw(), SEGZONE::Draw(), VIA::Draw(), MODULE::DrawAncre(), ZONE_CONTAINER::DrawFilledArea(), TEXTE_PCB::Flip(), TRACK::Flip(), BOARD_ITEM::Flip(), ZONE_CONTAINER::Flip(), VIA::Flip(), BOARD_ITEM::GetBoard(), GAL_ARRAY_CREATOR::getBoard(), LEGACY_ARRAY_CREATOR::getBoard(), MODULE::GetBoundingPoly(), BOARD_ITEM::GetLayerName(), TRACK::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), D_PAD::GetMsgPanelInfo(), TRACK::GetMsgPanelInfoBase(), SEGZONE::GetMsgPanelInfoBase(), VIA::GetMsgPanelInfoBase(), TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetClass(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), VIA::GetSelectMenuText(), D_PAD::GetSelectMenuText(), D_PAD::GetSolderMaskMargin(), D_PAD::GetSolderPasteMargin(), PushTrack(), BOARD_CONNECTED_ITEM::SetNet(), BOARD_CONNECTED_ITEM::SetNetCode(), MODULE::ViewBBox(), VIA::ViewGetLOD(), and D_PAD::ViewGetLOD().

65 {
66  if( Type() == PCB_T )
67  return (BOARD*) this;
68 
69  BOARD_ITEM* parent = GetParent();
70 
71  if( parent )
72  return parent->GetBoard();
73 
74  return NULL;
75 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
BOARD_ITEM_CONTAINER * GetParent() const
Definition: typeinfo.h:85
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:170
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
const EDA_RECT DRAWSEGMENT::GetBoundingBox ( ) const
overridevirtual

Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.

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

Reimplemented from EDA_ITEM.

Definition at line 499 of file class_drawsegment.cpp.

References SHAPE_POLY_SET::CIterate(), computeArcBBox(), MODULE::GetOrientation(), GetParentModule(), MODULE::GetPosition(), GetRadius(), EDA_RECT::GetX(), EDA_RECT::GetY(), EDA_RECT::Inflate(), SHAPE_POLY_SET::IsEmpty(), m_BezierPoints, m_End, m_Poly, m_Shape, m_Start, m_Width, max, EDA_RECT::Merge(), min, EDA_RECT::Normalize(), RotatePoint(), S_ARC, S_CIRCLE, S_CURVE, S_POLYGON, S_SEGMENT, EDA_RECT::SetEnd(), EDA_RECT::SetOrigin(), EDA_RECT::SetX(), EDA_RECT::SetY(), wxPoint::x, and wxPoint::y.

Referenced by CINFO3D_VISU::AddShapeWithClearanceToContainer(), GetCenter(), HitTest(), SetBezierPoints(), and CINFO3D_VISU::transformGraphicModuleEdgeToPolygonSet().

500 {
501  EDA_RECT bbox;
502 
503  bbox.SetOrigin( m_Start );
504 
505  switch( m_Shape )
506  {
507  case S_SEGMENT:
508  bbox.SetEnd( m_End );
509  break;
510 
511  case S_CIRCLE:
512  bbox.Inflate( GetRadius() );
513  break;
514 
515  case S_ARC:
516  computeArcBBox( bbox );
517  break;
518 
519  case S_POLYGON:
520  if( m_Poly.IsEmpty() )
521  break;
522  {
523  wxPoint p_end;
524  MODULE* module = GetParentModule();
525  bool first = true;
526 
527  for( auto iter = m_Poly.CIterate(); iter; iter++ )
528  {
529  wxPoint pt ( iter->x, iter->y );
530 
531  if( module ) // Transform, if we belong to a module
532  {
533  RotatePoint( &pt, module->GetOrientation() );
534  pt += module->GetPosition();
535  }
536 
537 
538  if( first )
539  {
540  p_end = pt;
541  bbox.SetX( pt.x );
542  bbox.SetY( pt.y );
543  first = false;
544  }
545  else
546  {
547 
548  bbox.SetX( std::min( bbox.GetX(), pt.x ) );
549  bbox.SetY( std::min( bbox.GetY(), pt.y ) );
550 
551  p_end.x = std::max( p_end.x, pt.x );
552  p_end.y = std::max( p_end.y, pt.y );
553  }
554  }
555 
556  bbox.SetEnd( p_end );
557  break;
558  }
559 
560  case S_CURVE:
561  // Rebuild the poly points shape
562  ((DRAWSEGMENT*)this)->RebuildBezierToSegmentsPointsList( m_Width );
563 
564  for( unsigned ii = 0; ii < m_BezierPoints.size(); ++ii )
565  bbox.Merge( m_BezierPoints[ii] );
566  break;
567 
568  default:
569  break;
570  }
571 
572  bbox.Inflate( ((m_Width+1) / 2) + 1 );
573  bbox.Normalize();
574 
575  return bbox;
576 }
void Merge(const EDA_RECT &aRect)
Function Merge modifies the position and size of the rectangle in order to contain aRect...
SHAPE_POLY_SET m_Poly
Stores the S_POLYGON shape.
polygon (not yet used for tracks, but could be in microwave apps)
CONST_ITERATOR CIterate(int aFirst, int aLast, bool aIterateHoles=false) const
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:124
usual segment : line with rounded ends
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:216
wxPoint m_Start
Line start point or Circle and Arc center.
wxPoint m_End
Line end point or circle and arc start point.
double GetOrientation() const
Definition: class_module.h:189
void SetEnd(int x, int y)
Definition: eda_rect.h:134
Arcs (with rounded ends)
void SetX(int val)
Definition: eda_rect.h:130
STROKE_T m_Shape
Shape: line, Circle, Arc.
Bezier Curve.
void computeArcBBox(EDA_RECT &aBBox) const
void SetY(int val)
Definition: eda_rect.h:131
void Normalize()
Function Normalize ensures that the height ant width are positive.
#define max(a, b)
Definition: auxiliary.h:86
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
int GetX() const
Definition: eda_rect.h:109
int GetY() const
Definition: eda_rect.h:110
MODULE * GetParentModule() const
Function GetParentModule returns a pointer to the parent module, or NULL if DRAWSEGMENT does not belo...
int m_Width
thickness of lines ...
bool IsEmpty() const
Returns true if the set is empty (no polygons at all)
int GetRadius() const
Function GetRadius returns the radius of this item Has meaning only for arc and circle.
const wxPoint GetPosition() const override
Definition: class_module.h:184
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
#define min(a, b)
Definition: auxiliary.h:85
std::vector< wxPoint > m_BezierPoints
const wxPoint DRAWSEGMENT::GetCenter ( ) const
overridevirtual

Function GetCenter()

This defaults to the same point as returned by GetPosition(), unless overridden

Returns
centre point of the item

Reimplemented from BOARD_ITEM.

Definition at line 206 of file class_drawsegment.cpp.

References EDA_RECT::Centre(), GetBoundingBox(), GetEnd(), GetShape(), GetStart(), m_Shape, m_Start, S_ARC, S_CIRCLE, S_CURVE, S_POLYGON, S_RECT, S_SEGMENT, and BOARD_ITEM::ShowShape().

Referenced by CINFO3D_VISU::AddShapeWithClearanceToContainer(), GRID_HELPER::computeAnchors(), ConvertOutlineToPolygon(), export_vrml_drawsegment(), GetArcAngleStart(), HitTest(), idf_export_outline(), EDIT_POINTS_FACTORY::Make(), DIALOG_PAD_PROPERTIES::OnPaintShowPanel(), EAGLE_PLUGIN::packageRectangle(), PCB_PARSER::parseD_PAD(), DIALOG_PAD_PROPERTIES::redraw(), SetEndX(), PNS_KICAD_IFACE::syncGraphicalItem(), DRC::testCopperDrawItem(), POINT_EDITOR::updateItem(), and POINT_EDITOR::updatePoints().

207 {
208  wxPoint c;
209 
210  switch( m_Shape )
211  {
212  case S_ARC:
213  case S_CIRCLE:
214  c = m_Start;
215  break;
216 
217  case S_SEGMENT:
218  // Midpoint of the line
219  c = ( GetStart() + GetEnd() ) / 2;
220  break;
221 
222  case S_POLYGON:
223  case S_RECT:
224  case S_CURVE:
225  c = GetBoundingBox().Centre();
226  break;
227 
228  default:
229  wxASSERT_MSG( false, "DRAWSEGMENT::GetCentre not implemented for shape"
230  + ShowShape( GetShape() ) );
231  break;
232  }
233 
234  return c;
235 }
static wxString ShowShape(STROKE_T aShape)
Function ShowShape converts the enum STROKE_T integer value to a wxString.
polygon (not yet used for tracks, but could be in microwave apps)
usual segment : line with rounded ends
segment with non rounded ends
STROKE_T GetShape() const
wxPoint m_Start
Line start point or Circle and Arc center.
const wxPoint & GetEnd() const
Function GetEnd returns the ending point of the graphic.
Arcs (with rounded ends)
STROKE_T m_Shape
Shape: line, Circle, Arc.
Bezier Curve.
wxPoint Centre() const
Definition: eda_rect.h:60
const wxPoint & GetStart() const
Function GetStart returns the starting point of the graphic.
virtual const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes...
wxString DRAWSEGMENT::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Implements EDA_ITEM.

Reimplemented in EDGE_MODULE.

Definition at line 222 of file class_drawsegment.h.

223  {
224  return wxT( "DRAWSEGMENT" );
225  }
STATUS_FLAGS EDA_ITEM::GetFlags ( ) const
inlineinherited

Definition at line 258 of file base_struct.h.

References EDA_ITEM::m_Flags.

Referenced by AbortMoveAndEditTarget(), SCH_SCREEN::addConnectedItemsToBlock(), AddMenusForBitmap(), AddMenusForBusEntry(), AddMenusForComponent(), AddMenusForComponentField(), AddMenusForEditComponent(), AddMenusForGLabel(), AddMenusForHierchicalSheet(), AddMenusForHLabel(), AddMenusForLabel(), AddMenusForSheetPin(), AddMenusForText(), SCH_EDIT_FRAME::BeginSegment(), SCH_EDIT_FRAME::ChangeTextOrient(), Collect_TrackSegmentsToDrag(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), LIB_EDIT_FRAME::copySelectedItems(), LIB_EDIT_FRAME::CreatePin(), PCB_EDIT_FRAME::createPopUpMenuForFootprints(), PCB_EDIT_FRAME::createPopUpMenuForFpPads(), PCB_EDIT_FRAME::createPopUpMenuForFpTexts(), PCB_EDIT_FRAME::createPopUpMenuForTexts(), PCB_EDIT_FRAME::createPopupMenuForTracks(), PCB_EDIT_FRAME::createPopUpMenuForZones(), PCB_EDIT_FRAME::Delete_Segment_Edge(), SCH_EDIT_FRAME::DeleteItem(), SCH_EDIT_FRAME::DeleteItemsInList(), SCH_EDIT_FRAME::DeleteJunction(), PCB_BASE_FRAME::DeleteTextModule(), BOARD::Draw(), PCB_EDIT_FRAME::Edit_TrackSegm_Width(), SCH_EDIT_FRAME::EditComponentFieldText(), SCH_EDIT_FRAME::EditImage(), PCB_EDIT_FRAME::FlipTextePcb(), LIB_VIEW_FRAME::GeneralControl(), SCH_EDIT_FRAME::GeneralControl(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_SCREEN::GetConnection(), InitialiseDragParameters(), EDA_DRAW_FRAME::isBusy(), Magnetize(), SCH_EDIT_FRAME::MirrorImage(), SCH_EDIT_FRAME::MirrorSheet(), SCH_EDIT_FRAME::OnAutoplaceFields(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), SCH_EDIT_FRAME::OnDragItem(), SCH_EDIT_FRAME::OnEditItem(), LIB_EDIT_FRAME::OnEditPin(), FOOTPRINT_EDIT_FRAME::OnHotKey(), SCH_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotkeyBeginRoute(), PCB_EDIT_FRAME::OnHotkeyCopyItem(), PCB_EDIT_FRAME::OnHotkeyDeleteItem(), PCB_EDIT_FRAME::OnHotkeyDuplicateOrArrayItem(), PCB_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyFlipItem(), PCB_EDIT_FRAME::OnHotkeyMoveItem(), PCB_EDIT_FRAME::OnHotkeyPlaceItem(), PCB_EDIT_FRAME::OnHotkeyRotateItem(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), EDA_DRAW_PANEL::OnMouseEvent(), SCH_EDIT_FRAME::OnMoveItem(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_EDIT_FRAME::OnOrient(), FOOTPRINT_EDIT_FRAME::OnRightClick(), GERBVIEW_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), SCH_EDIT_FRAME::OnSelectUnit(), SCH_EDIT_FRAME::OrientComponent(), PCB_EDIT_FRAME::PlaceTarget(), FOOTPRINT_EDIT_FRAME::PrepareItemForHotkey(), LIB_EDIT_FRAME::Process_Special_Functions(), TRACKS_CLEANER::removeDuplicatesOfTrack(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), SCH_EDIT_FRAME::RotateField(), SCH_EDIT_FRAME::RotateHierarchicalSheet(), SCH_EDIT_FRAME::RotateImage(), PCB_BASE_FRAME::RotateTextModule(), LIB_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_SCREEN::SelectBlockItems(), SCH_EDIT_FRAME::SetBusEntryShape(), Show_Drag_Track_Segment_With_Cte_Slope(), Show_MoveNode(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), and DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow().

258 { return m_Flags; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
virtual PCB_LAYER_ID BOARD_ITEM::GetLayer ( ) const
inlinevirtualinherited

Function GetLayer returns the primary layer this item is on.

Reimplemented in ZONE_CONTAINER.

Definition at line 124 of file class_board_item.h.

References BOARD_ITEM::m_Layer.

Referenced by Abort_MoveOrCopyModule(), DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), CN_CONNECTIVITY_ALGO::Add(), CN_LIST::Add(), CINFO3D_VISU::AddGraphicsShapesWithClearanceToContainer(), DIMENSION::AdjustDimensionDetails(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Change_Side_Module(), checkConnectedTo(), MODULE::CopyNetlistSettings(), CreateBoardSection(), MWAVE::CreateMicrowaveInductor(), CreateRoutesSection(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PCB_EDIT_FRAME::DoGenFootprintsPositionFile(), DRC::doTrackKeepoutDrc(), TEXTE_MODULE::Draw(), Draw(), KIGFX::PCB_PAINTER::draw(), FOOTPRINT_EDIT_FRAME::Edit_Edge_Layer(), FOOTPRINT_EDIT_FRAME::Edit_Edge_Width(), export_vrml_drawsegment(), export_vrml_edge_module(), export_vrml_module(), export_vrml_pcbtext(), export_vrml_text_module(), PCB_EDIT_FRAME::ExportToGenCAD(), TEXTE_PCB::Flip(), PCB_TARGET::Flip(), EDGE_MODULE::Flip(), TEXTE_MODULE::Flip(), TRACK::Flip(), DIMENSION::Flip(), MODULE::Flip(), Flip(), PCB_IO::FootprintSave(), FootprintWriteShape(), PCB_IO::formatLayer(), DSN::SPECCTRA_DB::FromBOARD(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), AR_AUTOPLACER::genPlacementRoutingMatrix(), BOARD::GetFootprint(), ZONE_CONTAINER::GetLayer(), AR_AUTOPLACER::getOptimalModulePlacement(), BOARD::GetPad(), TEXT_MOD_GRID_TABLE::GetValueAsLong(), BOARD::GetVisibleTrack(), SELECTION_TOOL::guessSelectionCandidates(), idf_export_module(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), D_PAD::IsFlipped(), EDGE_MODULE::IsParentFlipped(), TEXTE_MODULE::IsParentFlipped(), itemIsIncludedByFilter(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), BOARD::MarkTrace(), DIALOG_FOOTPRINT_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAddField(), PCB_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::PlaceDraggedOrMovedTrackSegment(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), BRDITEMS_PLOTTER::Plot_Edges_Modules(), BRDITEMS_PLOTTER::PlotAllTextsModule(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotDrawSegment(), BRDITEMS_PLOTTER::PlotPcbTarget(), BRDITEMS_PLOTTER::PlotTextePcb(), processBoardItem(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), processTextItem(), TRACKS_CLEANER::removeDuplicatesOfTrack(), PCB_BASE_FRAME::ResetTextSize(), SELECTION_TOOL::selectable(), TEXT_MOD_GRID_TABLE::SetValueAsLong(), ShowClearance(), PNS_KICAD_IFACE::syncGraphicalItem(), PNS_KICAD_IFACE::syncTrack(), DRC::testCopperDrawItem(), DRC::testCopperTextItem(), DRC::testDisabledLayers(), AR_AUTOPLACER::testModuleOnBoard(), TEXTE_MODULE::TEXTE_MODULE(), AR_MATRIX::TraceSegmentPcb(), TraceSegmentPcb(), TrackListSortByNetcode(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), CINFO3D_VISU::transformGraphicModuleEdgeToPolygonSet(), MODULE::TransformGraphicShapesWithClearanceToPolygonSet(), MODULE::TransformGraphicTextWithClearanceToPolygonSet(), TEXTE_MODULE::ViewGetLayers(), TRACK::ViewGetLayers(), TEXTE_MODULE::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

124 { return m_Layer; }
PCB_LAYER_ID m_Layer
wxString BOARD_ITEM::GetLayerName ( ) const
inherited

Function GetLayerName returns the name of the PCB layer on which the item resides.

Returns
wxString containing the layer name associated with this item.

Definition at line 78 of file class_board_item.cpp.

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

Referenced by BOARD_ITEM::Flip(), PCB_IO::format(), PCB_IO::formatLayer(), TEXTE_PCB::GetMsgPanelInfo(), ZONE_CONTAINER::GetMsgPanelInfo(), TEXTE_MODULE::GetMsgPanelInfo(), GetMsgPanelInfo(), TEXTE_PCB::GetSelectMenuText(), EDGE_MODULE::GetSelectMenuText(), TEXTE_MODULE::GetSelectMenuText(), DIMENSION::GetSelectMenuText(), GetSelectMenuText(), TRACK::GetSelectMenuText(), SEGZONE::GetSelectMenuText(), ZONE_CONTAINER::GetSelectMenuText(), MODULE::GetSelectMenuText(), TEXT_MOD_GRID_TABLE::GetValue(), and main().

79 {
80  BOARD* board = GetBoard();
81 
82  if( board )
83  return board->GetLayerName( m_Layer );
84 
85  // If no parent, return standard name
87 }
PCB_LAYER_ID m_Layer
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Function GetLayerName returns the name of a layer given by aLayer.
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:170
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
static wxString GetStandardLayerName(PCB_LAYER_ID aLayerId)
Function GetStandardLayerName returns an "English Standard" name of a PCB layer when given aLayerNumb...
Definition: class_board.h:653
virtual LSET BOARD_ITEM::GetLayerSet ( ) const
inlinevirtualinherited

Function GetLayerSet returns a "layer mask", which is a bitmap of all layers on which the TRACK segment or VIA physically resides.

Returns
int - a layer mask, see layers_id_colors_visibility.h.

Reimplemented in D_PAD, VIA, and ZONE_CONTAINER.

Definition at line 132 of file class_board_item.h.

Referenced by GRID_HELPER::BestSnapAnchor(), build_pad_testpoints(), BOARD::chainMarkedSegments(), VIA::ClassOf(), Collect_TrackSegmentsToDrag(), DRC::doTrackDrc(), DRC::doTrackKeepoutDrc(), PCB_EDIT_FRAME::EraseRedundantTrack(), find_vias_and_tracks_at(), TRACK::GetEndSegments(), TRACK::GetTrack(), hash_board_item(), CN_ANCHOR::IsDangling(), BOARD::MarkTrace(), POINT_EDITOR::OnSelectionChange(), and PCB_EDIT_FRAME::StartMoveOneNodeOrSegment().

132 { return LSET( m_Layer ); }
PCB_LAYER_ID m_Layer
Class LSET is a set of PCB_LAYER_IDs.
double DRAWSEGMENT::GetLength ( ) const
inline

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

Returns
double - the length of the track

Definition at line 232 of file class_drawsegment.h.

References Clone(), Flip(), GetEnd(), GetLineLength(), GetMenuImage(), GetSelectMenuText(), GetStart(), Move(), Rotate(), SwapData(), TransformShapeWithClearanceToPolygon(), and ViewBBox().

Referenced by GetSelectMenuText().

233  {
234  return GetLineLength( GetStart(), GetEnd() );
235  }
double GetLineLength(const wxPoint &aPointA, const wxPoint &aPointB)
Function GetLineLength returns the length of a line segment defined by aPointA and aPointB...
Definition: trigo.h:191
const wxPoint & GetEnd() const
Function GetEnd returns the ending point of the graphic.
const wxPoint & GetStart() const
Function GetStart returns the starting point of the graphic.
DHEAD* EDA_ITEM::GetList ( ) const
inlineinherited
BITMAP_DEF DRAWSEGMENT::GetMenuImage ( ) const
overridevirtual

Function GetMenuImage returns 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 EDGE_MODULE.

Definition at line 808 of file class_drawsegment.cpp.

Referenced by GetLength().

809 {
810  return add_dashed_line_xpm;
811 }
void DRAWSEGMENT::GetMsgPanelInfo ( EDA_UNITS_T  aUnits,
std::vector< MSG_PANEL_ITEM > &  aList 
)
overridevirtual

Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

Note
This method replaces DisplayInfo() so that KiCad objects no longer have any knowledge of wxWidgets UI objects.
Parameters
aListis the list to populate.

Reimplemented from EDA_ITEM.

Reimplemented in EDGE_MODULE.

Definition at line 437 of file class_drawsegment.cpp.

References DARKBROWN, DARKCYAN, DARKGREEN, Format(), GetEnd(), BOARD_ITEM::GetLayerName(), GetLineLength(), GetStart(), m_Angle, m_End, m_Shape, m_Start, m_Width, MessageTextFromValue(), RAD2DEG(), RED, S_ARC, S_CIRCLE, S_CURVE, wxPoint::x, and wxPoint::y.

Referenced by EDGE_MODULE::GetMsgPanelInfo(), and SetBezierPoints().

438 {
439  wxString msg;
440 
441  msg = _( "Drawing" );
442 
443  aList.push_back( MSG_PANEL_ITEM( _( "Type" ), msg, DARKCYAN ) );
444 
445  wxString shape = _( "Shape" );
446 
447  switch( m_Shape )
448  {
449  case S_CIRCLE:
450  aList.push_back( MSG_PANEL_ITEM( shape, _( "Circle" ), RED ) );
451 
452  msg = MessageTextFromValue( aUnits, GetLineLength( m_Start, m_End ) );
453  aList.push_back( MSG_PANEL_ITEM( _( "Radius" ), msg, RED ) );
454  break;
455 
456  case S_ARC:
457  aList.push_back( MSG_PANEL_ITEM( shape, _( "Arc" ), RED ) );
458  msg.Printf( wxT( "%.1f" ), m_Angle / 10.0 );
459  aList.push_back( MSG_PANEL_ITEM( _( "Angle" ), msg, RED ) );
460 
461  msg = MessageTextFromValue( aUnits, GetLineLength( m_Start, m_End ) );
462  aList.push_back( MSG_PANEL_ITEM( _( "Radius" ), msg, RED ) );
463  break;
464 
465  case S_CURVE:
466  aList.push_back( MSG_PANEL_ITEM( shape, _( "Curve" ), RED ) );
467  break;
468 
469  default:
470  {
471  aList.push_back( MSG_PANEL_ITEM( shape, _( "Segment" ), RED ) );
472 
473  msg = MessageTextFromValue( aUnits, GetLineLength( m_Start, m_End ) );
474  aList.push_back( MSG_PANEL_ITEM( _( "Length" ), msg, DARKGREEN ) );
475 
476  // angle counter-clockwise from 3'o-clock
477  const double deg = RAD2DEG( atan2( (double)( m_Start.y - m_End.y ),
478  (double)( m_End.x - m_Start.x ) ) );
479  msg.Printf( wxT( "%.1f" ), deg );
480  aList.push_back( MSG_PANEL_ITEM( _( "Angle" ), msg, DARKGREEN ) );
481  }
482  }
483 
484  wxString start = wxString::Format( "@(%s, %s)",
485  MessageTextFromValue( aUnits, GetStart().x ),
486  MessageTextFromValue( aUnits, GetStart().y ) );
487  wxString end = wxString::Format( "@(%s, %s)",
488  MessageTextFromValue( aUnits, GetEnd().x ),
489  MessageTextFromValue( aUnits, GetEnd().y ) );
490 
491  aList.push_back( MSG_PANEL_ITEM( start, end, DARKGREEN ) );
492  aList.push_back( MSG_PANEL_ITEM( _( "Layer" ), GetLayerName(), DARKBROWN ) );
493 
494  msg = MessageTextFromValue( aUnits, m_Width, true );
495  aList.push_back( MSG_PANEL_ITEM( _( "Width" ), msg, DARKCYAN ) );
496 }
double GetLineLength(const wxPoint &aPointA, const wxPoint &aPointB)
Function GetLineLength returns the length of a line segment defined by aPointA and aPointB...
Definition: trigo.h:191
double RAD2DEG(double rad)
Definition: trigo.h:200
double m_Angle
Used only for Arcs: Arc angle in 1/10 deg.
wxString GetLayerName() const
Function GetLayerName returns the name of the PCB layer on which the item resides.
wxString MessageTextFromValue(EDA_UNITS_T aUnits, int aValue, bool aUseMils)
Definition: base_units.cpp:125
wxPoint m_Start
Line start point or Circle and Arc center.
const wxPoint & GetEnd() const
Function GetEnd returns the ending point of the graphic.
wxPoint m_End
Line end point or circle and arc start point.
Arcs (with rounded ends)
STROKE_T m_Shape
Shape: line, Circle, Arc.
Definition: colors.h:60
Bezier Curve.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
int m_Width
thickness of lines ...
Class EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
const wxPoint & GetStart() const
Function GetStart returns the starting point of the graphic.
int BOARD_ITEM::getNextNumberInSequence ( const std::set< int > &  aSeq,
bool  aFillSequenceGaps 
)
staticprotectedinherited

Definition at line 230 of file class_board_item.cpp.

Referenced by MODULE::GetNextPadName().

231 {
232  if( aSeq.empty() )
233  return 1;
234 
235  // By default go to the end of the sequence
236  int candidate = *aSeq.rbegin();
237 
238  // Filling in gaps in pad numbering
239  if( aFillSequenceGaps )
240  {
241  // start at the beginning
242  candidate = *aSeq.begin();
243 
244  for( auto it : aSeq )
245  {
246  if( it - candidate > 1 )
247  break;
248 
249  candidate = it;
250  }
251  }
252 
253  ++candidate;
254 
255  return candidate;
256 }
BOARD_ITEM_CONTAINER* BOARD_ITEM::GetParent ( void  ) const
inlineinherited

Definition at line 118 of file class_board_item.h.

References EDA_ITEM::m_Parent.

Referenced by Abort_Move_ModuleOutline(), AbortMoveTextModule(), POINT_EDITOR::addCorner(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), CmpHoleSorting(), PCB_EDIT_FRAME::createPopUpMenuForFpTexts(), FOOTPRINT_EDIT_FRAME::Delete_Edge_Module(), BOARD_ITEM::DeleteStructure(), PCB_BASE_FRAME::DeleteTextModule(), 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::PCB_PAINTER::draw(), TEXTE_MODULE::DrawUmbilical(), PCB_EDIT_FRAME::duplicateItems(), EditToolSelectionFilter(), PCB_IO::format(), FormatProbeItem(), BOARD_ITEM::GetBoard(), EDGE_MODULE::GetMsgPanelInfo(), EDGE_MODULE::GetSelectMenuText(), TEXTE_MODULE::GetSelectMenuText(), TEXTE_MODULE::GetShownText(), SELECTION_TOOL::guessSelectionCandidates(), GENERAL_COLLECTOR::Inspect(), EDGE_MODULE::IsParentFlipped(), TEXTE_MODULE::IsParentFlipped(), LEGACY_PLUGIN::loadMODULE_TEXT(), PCB_EDIT_FRAME::moveExact(), FOOTPRINT_EDIT_FRAME::OnRightClick(), FOOTPRINT_EDIT_FRAME::Place_EdgeMod(), PCB_BASE_FRAME::PlaceTexteModule(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), BRDITEMS_PLOTTER::PlotTextModule(), PCB_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), PAD_TOOL::pushPadSettings(), PCB_BASE_FRAME::ResetTextSize(), PCB_BASE_FRAME::RotateTextModule(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SELECTION_TOOL::select(), ShowCurrentOutlineWhileMoving(), ShowNewEdgeModule(), PCB_BASE_FRAME::StartMoveTexteModule(), SwapItemData(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

118 { return (BOARD_ITEM_CONTAINER*) m_Parent; }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:171
Abstract interface for BOARD_ITEMs capable of storing other items inside.
MODULE * DRAWSEGMENT::GetParentModule ( ) const

Function GetParentModule returns a pointer to the parent module, or NULL if DRAWSEGMENT does not belong to a module.

Returns
MODULE* - pointer to the parent module or NULL.

Definition at line 280 of file class_drawsegment.cpp.

References EDA_ITEM::m_Parent, PCB_MODULE_T, and EDA_ITEM::Type().

Referenced by KIGFX::PCB_PAINTER::draw(), GetBoundingBox(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), and SetCenter().

281 {
282  if( !m_Parent || m_Parent->Type() != PCB_MODULE_T )
283  return NULL;
284 
285  return (MODULE*) m_Parent;
286 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:171
class MODULE, a footprint
Definition: typeinfo.h:89
int DRAWSEGMENT::GetPointCount ( ) const
Returns
the number of corners of the polygonal shape

Definition at line 953 of file class_drawsegment.cpp.

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

Referenced by GetBezierPoints().

954 {
955  // return the number of corners of the polygonal shape
956  // this shape is expected to be only one polygon without hole
957  if( GetPolyShape().OutlineCount() )
958  return GetPolyShape().VertexCount( 0 );
959 
960  return 0;
961 }
SHAPE_POLY_SET & GetPolyShape()
int VertexCount(int aOutline=-1, int aHole=-1) const
Returns the number of vertices in a given outline/hole
const SHAPE_POLY_SET& DRAWSEGMENT::GetPolyShape ( ) const
inline

Definition at line 183 of file class_drawsegment.h.

References IsPolyShapeValid(), and m_Poly.

183 { return m_Poly; }
SHAPE_POLY_SET m_Poly
Stores the S_POLYGON shape.
const wxPoint DRAWSEGMENT::GetPosition ( ) const
overridevirtual

Implements BOARD_ITEM.

Definition at line 72 of file class_drawsegment.cpp.

References SHAPE_POLY_SET::CVertex(), m_Poly, m_Shape, m_Start, and S_POLYGON.

Referenced by GetBezControl2().

73 {
74  if( m_Shape == S_POLYGON )
75  return (wxPoint) m_Poly.CVertex( 0 );
76  else
77  return m_Start;
78 }
const VECTOR2I & CVertex(int aIndex, int aOutline, int aHole) const
Returns the index-th vertex in a given hole outline within a given outline
SHAPE_POLY_SET m_Poly
Stores the S_POLYGON shape.
polygon (not yet used for tracks, but could be in microwave apps)
wxPoint m_Start
Line start point or Circle and Arc center.
STROKE_T m_Shape
Shape: line, Circle, Arc.
int DRAWSEGMENT::GetRadius ( ) const
inline

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

Definition at line 142 of file class_drawsegment.h.

References GetLineLength(), and KiROUND().

Referenced by CINFO3D_VISU::AddShapeWithClearanceToContainer(), computeArcBBox(), ConvertOutlineToPolygon(), KIGFX::PCB_PAINTER::draw(), GetBoundingBox(), hash_eda(), HitTest(), idf_export_outline(), PCB_PARSER::parseD_PAD(), and DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow().

143  {
144  double radius = GetLineLength( m_Start, m_End );
145  return KiROUND( radius );
146  }
double GetLineLength(const wxPoint &aPointA, const wxPoint &aPointB)
Function GetLineLength returns the length of a line segment defined by aPointA and aPointB...
Definition: trigo.h:191
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:120
wxPoint m_Start
Line start point or Circle and Arc center.
wxPoint m_End
Line end point or circle and arc start point.
wxString DRAWSEGMENT::GetSelectMenuText ( EDA_UNITS_T  aUnits) const
overridevirtual

Function GetSelectMenuText returns 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 EDGE_MODULE.

Definition at line 799 of file class_drawsegment.cpp.

References Format(), BOARD_ITEM::GetLayerName(), GetLength(), m_Shape, MessageTextFromValue(), and BOARD_ITEM::ShowShape().

Referenced by GetLength().

800 {
801  return wxString::Format( _( "Pcb Graphic %s, length %s on %s" ),
802  ShowShape( m_Shape ),
803  MessageTextFromValue( aUnits, GetLength() ),
804  GetLayerName() );
805 }
static wxString ShowShape(STROKE_T aShape)
Function ShowShape converts the enum STROKE_T integer value to a wxString.
double GetLength() const
Function GetLength returns the length of the track using the hypotenuse calculation.
wxString GetLayerName() const
Function GetLayerName returns the name of the PCB layer on which the item resides.
wxString MessageTextFromValue(EDA_UNITS_T aUnits, int aValue, bool aUseMils)
Definition: base_units.cpp:125
STROKE_T m_Shape
Shape: line, Circle, Arc.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
const wxPoint& DRAWSEGMENT::GetStart ( ) const
inline
STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 253 of file base_struct.h.

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format(), and GERBER_DRAW_ITEM::HitTest().

253 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:164
timestamp_t EDA_ITEM::GetTimeStamp ( ) const
inlineinherited

Definition at line 207 of file base_struct.h.

References EDA_ITEM::m_TimeStamp.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), SCH_COMPONENT::AddSheetPathReferenceEntryIfMissing(), SCH_EDIT_FRAME::AnnotateComponents(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), PCB_EDIT_FRAME::Delete_OldZone_Fill(), PCB_EDIT_FRAME::Delete_Zone_Contour(), DuplicateStruct(), DIALOG_FOOTPRINT_BOARD_EDITOR::EditFootprint(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::format(), FormatProbeItem(), NETLIST_OBJECT::GetShortNetName(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), NETLIST_EXPORTER_GENERIC::makeComponents(), mapExistingAnnotation(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), SCH_SHEET_PATH::Path(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_LEGACY_PLUGIN::saveComponent(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_REFERENCE::SCH_REFERENCE(), ZONE_FILLER_TOOL::SegzoneDeleteFill(), SortByTimeStamp(), SwapItemData(), DIALOG_SCH_SHEET_PROPS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataToWindow(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::~DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS().

207 { return m_TimeStamp; }
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:172
int BOARD_ITEM::getTrailingInt ( const wxString &  aStr)
staticprotectedinherited

Definition at line 207 of file class_board_item.cpp.

Referenced by MODULE::GetNextPadName(), and MODULE::IncrementReference().

208 {
209  int number = 0;
210  int base = 1;
211 
212  // Trim and extract the trailing numeric part
213  int index = aStr.Len() - 1;
214  while( index >= 0 )
215  {
216  const char chr = aStr.GetChar( index );
217 
218  if( chr < '0' || chr > '9' )
219  break;
220 
221  number += ( chr - '0' ) * base;
222  base *= 10;
223  index--;
224  }
225 
226  return number;
227 }
int DRAWSEGMENT::GetType ( ) const
inline

Definition at line 91 of file class_drawsegment.h.

References m_Type.

Referenced by PCB_EDIT_FRAME::Begin_DrawSegment(), hash_eda(), and DRAWING_TOOL::PlaceDXF().

91 { return m_Type; }
int m_Type
Used in complex associations ( Dimensions.. )
bool DRAWSEGMENT::HitTest ( const wxPoint aPosition) const
overridevirtual

Function HitTest tests if aPosition is contained within or on the bounding area of an item.

Parameters
aPositionA reference to a wxPoint object containing the coordinates to test.
Returns
True if aPosition is within or on the item bounding area.

Reimplemented from BOARD_ITEM.

Definition at line 579 of file class_drawsegment.cpp.

References abs, ArcTangente(), SHAPE_POLY_SET::Collide(), dist, EuclideanNorm(), Format(), GetAngle(), GetArcAngleStart(), GetCenter(), GetRadius(), i, KiROUND(), m_BezierPoints, m_End, m_Poly, m_Shape, m_Start, m_Width, max, MAX_DIST_IN_MM, NORMALIZE_ANGLE_POS(), S_ARC, S_CIRCLE, S_CURVE, S_POLYGON, S_SEGMENT, TestSegmentHit(), wxPoint::x, and wxPoint::y.

Referenced by SetBezierPoints().

580 {
581  switch( m_Shape )
582  {
583  case S_CIRCLE:
584  case S_ARC:
585  {
586  wxPoint relPos = aPosition - GetCenter();
587  int radius = GetRadius();
588  int dist = KiROUND( EuclideanNorm( relPos ) );
589 
590  if( abs( radius - dist ) <= ( m_Width / 2 ) )
591  {
592  if( m_Shape == S_CIRCLE )
593  return true;
594 
595  // For arcs, the test point angle must be >= arc angle start
596  // and <= arc angle end
597  // However angle values > 360 deg are not easy to handle
598  // so we calculate the relative angle between arc start point and teast point
599  // this relative arc should be < arc angle if arc angle > 0 (CW arc)
600  // and > arc angle if arc angle < 0 (CCW arc)
601  double arc_angle_start = GetArcAngleStart(); // Always 0.0 ... 360 deg, in 0.1 deg
602 
603  double arc_hittest = ArcTangente( relPos.y, relPos.x );
604 
605  // Calculate relative angle between the starting point of the arc, and the test point
606  arc_hittest -= arc_angle_start;
607 
608  // Normalise arc_hittest between 0 ... 360 deg
609  NORMALIZE_ANGLE_POS( arc_hittest );
610 
611  // Check angle: inside the arc angle when it is > 0
612  // and outside the not drawn arc when it is < 0
613  if( GetAngle() >= 0.0 )
614  {
615  if( arc_hittest <= GetAngle() )
616  return true;
617  }
618  else
619  {
620  if( arc_hittest >= (3600.0 + GetAngle()) )
621  return true;
622  }
623  }
624  }
625  break;
626 
627  case S_CURVE:
628  ((DRAWSEGMENT*)this)->RebuildBezierToSegmentsPointsList( m_Width );
629 
630  for( unsigned int i= 1; i < m_BezierPoints.size(); i++)
631  {
632  if( TestSegmentHit( aPosition, m_BezierPoints[i-1], m_BezierPoints[i-1], m_Width / 2 ) )
633  return true;
634  }
635  break;
636 
637  case S_SEGMENT:
638  if( TestSegmentHit( aPosition, m_Start, m_End, m_Width / 2 ) )
639  return true;
640  break;
641 
642  case S_POLYGON: // not yet handled
643  {
644  #define MAX_DIST_IN_MM 0.25
645  int distmax = std::max( m_Width, Millimeter2iu( MAX_DIST_IN_MM ) );
646 
647  if( m_Poly.Collide( VECTOR2I( aPosition ), distmax ) )
648  return true;
649  }
650  break;
651 
652  default:
653  wxASSERT_MSG( 0, wxString::Format( "unknown DRAWSEGMENT shape: %d", m_Shape ) );
654  break;
655  }
656 
657  return false;
658 }
double EuclideanNorm(const wxPoint &vector)
Euclidean norm of a 2D vector.
Definition: trigo.h:112
static const int dist[10][10]
Definition: ar_matrix.cpp:320
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:120
const wxPoint GetCenter() const override
Function GetCenter()
SHAPE_POLY_SET m_Poly
Stores the S_POLYGON shape.
polygon (not yet used for tracks, but could be in microwave apps)
double GetArcAngleStart() const
function GetArcAngleStart()
usual segment : line with rounded ends
void NORMALIZE_ANGLE_POS(T &Angle)
Definition: trigo.h:241
#define abs(a)
Definition: auxiliary.h:84
#define MAX_DIST_IN_MM
wxPoint m_Start
Line start point or Circle and Arc center.
double ArcTangente(int dy, int dx)
Definition: trigo.cpp:170
wxPoint m_End
Line end point or circle and arc start point.
Arcs (with rounded ends)
STROKE_T m_Shape
Shape: line, Circle, Arc.
bool Collide(const VECTOR2I &aP, int aClearance=0) const override
Function Collide Checks whether the point aP collides with the inside of the polygon set; if the poin...
Bezier Curve.
double GetAngle() const
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
#define max(a, b)
Definition: auxiliary.h:86
size_t i
Definition: json11.cpp:597
int m_Width
thickness of lines ...
bool TestSegmentHit(const wxPoint &aRefPoint, wxPoint aStart, wxPoint aEnd, int aDist)
Function TestSegmentHit test for hit on line segment i.e.
Definition: trigo.cpp:122
int GetRadius() const
Function GetRadius returns the radius of this item Has meaning only for arc and circle.
std::vector< wxPoint > m_BezierPoints
bool DRAWSEGMENT::HitTest ( const EDA_RECT aRect,
bool  aContained = true,
int  aAccuracy = 0 
) const
overridevirtual

Function HitTest tests if the aRect intersects or contains this object (depending on aContained).

Parameters
aRectA reference to an EDA_RECT object containg the area to test.
aContainedTest if aRect contains this object completly.
aAccuracyIncrease the item bounding box by this amount.
Returns
bool - True if aRect contains this object completly or if aRect intersects the object and aContained is False, otherwise false.

Reimplemented from BOARD_ITEM.

Definition at line 661 of file class_drawsegment.cpp.

References EDA_RECT::Common(), EDA_RECT::Contains(), SHAPE_POLY_SET::CVertex(), Format(), GetBoundingBox(), GetCenter(), GetEnd(), GetRadius(), GetStart(), GetWidth(), EDA_RECT::Inflate(), EDA_RECT::Intersects(), EDA_RECT::IntersectsCircleEdge(), m_BezierPoints, m_Poly, m_Shape, EDA_RECT::Normalize(), S_ARC, S_CIRCLE, S_CURVE, S_POLYGON, S_SEGMENT, and SHAPE_POLY_SET::TotalVertices().

662 {
663  EDA_RECT arect = aRect;
664  arect.Normalize();
665  arect.Inflate( aAccuracy );
666 
667  EDA_RECT arcRect;
668  EDA_RECT bb = GetBoundingBox();
669 
670  switch( m_Shape )
671  {
672  case S_CIRCLE:
673  // Test if area intersects or contains the circle:
674  if( aContained )
675  return arect.Contains( bb );
676  else
677  {
678  // If the rectangle does not intersect the bounding box, this is a much quicker test
679  if( !aRect.Intersects( bb ) )
680  {
681  return false;
682  }
683  else
684  {
685  return arect.IntersectsCircleEdge( GetCenter(), GetRadius(), GetWidth() );
686  }
687 
688  }
689  break;
690 
691  case S_ARC:
692  // Test for full containment of this arc in the rect
693  if( aContained )
694  {
695  return arect.Contains( bb );
696  }
697  // Test if the rect crosses the arc
698  else
699  {
700  arcRect = bb.Common( arect );
701 
702  /* All following tests must pass:
703  * 1. Rectangle must intersect arc BoundingBox
704  * 2. Rectangle must cross the outside of the arc
705  */
706  return arcRect.Intersects( arect ) &&
708  }
709  break;
710 
711  case S_SEGMENT:
712  if( aContained )
713  {
714  return arect.Contains( GetStart() ) && aRect.Contains( GetEnd() );
715  }
716  else
717  {
718  // Account for the width of the line
719  arect.Inflate( GetWidth() / 2 );
720  return arect.Intersects( GetStart(), GetEnd() );
721  }
722 
723  break;
724 
725  case S_POLYGON:
726  if( aContained )
727  {
728  return arect.Contains( bb );
729  }
730  else
731  {
732  // Fast test: if aRect is outside the polygon bounding box,
733  // rectangles cannot intersect
734  if( !arect.Intersects( bb ) )
735  return false;
736 
737  // Account for the width of the line
738  arect.Inflate( GetWidth() / 2 );
739  int count = m_Poly.TotalVertices();
740 
741  for( int ii = 0; ii < count; ii++ )
742  {
743  auto vertex = m_Poly.CVertex( ii );
744  auto vertexNext = m_Poly.CVertex( ( ii + 1 ) % count );
745 
746  // Test if the point is within aRect
747  if( arect.Contains( ( wxPoint ) vertex ) )
748  return true;
749 
750  // Test if this edge intersects aRect
751  if( arect.Intersects( ( wxPoint ) vertex, ( wxPoint ) vertexNext ) )
752  return true;
753  }
754  }
755  break;
756 
757  case S_CURVE: // not yet handled
758  if( aContained )
759  {
760  return arect.Contains( bb );
761  }
762  else
763  {
764  // Fast test: if aRect is outside the polygon bounding box,
765  // rectangles cannot intersect
766  if( !arect.Intersects( bb ) )
767  return false;
768 
769  // Account for the width of the line
770  arect.Inflate( GetWidth() / 2 );
771  unsigned count = m_BezierPoints.size();
772 
773  for( unsigned ii = 1; ii < count; ii++ )
774  {
775  wxPoint vertex = m_BezierPoints[ii-1];
776  wxPoint vertexNext = m_BezierPoints[ii];
777 
778  // Test if the point is within aRect
779  if( arect.Contains( ( wxPoint ) vertex ) )
780  return true;
781 
782  // Test if this edge intersects aRect
783  if( arect.Intersects( vertex, vertexNext ) )
784  return true;
785  }
786  }
787  break;
788 
789 
790  default:
791  wxASSERT_MSG( 0, wxString::Format( "unknown DRAWSEGMENT shape: %d", m_Shape ) );
792  break;
793  }
794 
795  return false;
796 }
const VECTOR2I & CVertex(int aIndex, int aOutline, int aHole) const
Returns the index-th vertex in a given hole outline within a given outline
bool IntersectsCircleEdge(const wxPoint &aCenter, const int aRadius, const int aWidth) const
IntersectsCircleEdge Tests for intersection between this rect and the edge (radius) of a circle...
const wxPoint GetCenter() const override
Function GetCenter()
bool Contains(const wxPoint &aPoint) const
Function Contains.
SHAPE_POLY_SET m_Poly
Stores the S_POLYGON shape.
polygon (not yet used for tracks, but could be in microwave apps)
EDA_RECT Common(const EDA_RECT &aRect) const
Function Common returns the area that is common with another rectangle.
int TotalVertices() const
Returns total number of vertices stored in the set.
usual segment : line with rounded ends
const wxPoint & GetEnd() const
Function GetEnd returns the ending point of the graphic.
Arcs (with rounded ends)
STROKE_T m_Shape
Shape: line, Circle, Arc.
Bezier Curve.
void Normalize()
Function Normalize ensures that the height ant width are positive.
bool Intersects(const EDA_RECT &aRect) const
Function Intersects tests for a common area between rectangles.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
int GetWidth() const
const wxPoint & GetStart() const
Function GetStart returns the starting point of the graphic.
int GetRadius() const
Function GetRadius returns the radius of this item Has meaning only for arc and circle.
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
std::vector< wxPoint > m_BezierPoints
virtual const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes...
bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

Definition at line 227 of file base_struct.h.

References BRIGHTENED.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), KIGFX::GERBVIEW_PAINTER::draw(), and KIGFX::PCB_RENDER_SETTINGS::GetColor().

227 { return m_Flags & BRIGHTENED; }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:138
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
virtual bool BOARD_ITEM::IsConnected ( ) const
inlinevirtualinherited

Function IsConnected() Returns information if the object is derived from BOARD_CONNECTED_ITEM.

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

Reimplemented in BOARD_CONNECTED_ITEM.

Definition at line 106 of file class_board_item.h.

Referenced by CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), and CONNECTIVITY_DATA::MarkItemNetAsDirty().

107  {
108  return false;
109  }
bool EDA_ITEM::IsDragging ( ) const
inlineinherited
bool EDA_ITEM::IsHighlighted ( ) const
inlineinherited

Definition at line 226 of file base_struct.h.

References HIGHLIGHTED.

226 { return m_Flags & HIGHLIGHTED; }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:137
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
virtual bool BOARD_ITEM::IsLocked ( ) const
inlinevirtualinherited

Function IsLocked.

Returns
bool - true if the object is locked, else false

Reimplemented in MODULE, and TRACK.

Definition at line 194 of file class_board_item.h.

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), EditToolSelectionFilter(), GENERAL_COLLECTOR::Inspect(), PCB_EDITOR_CONTROL::modifyLockSelected(), and PCB_EDIT_FRAME::OnHotkeyDeleteItem().

195  {
196  // only MODULEs & TRACKs can be locked at this time.
197  return false;
198  }
bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 220 of file base_struct.h.

References IS_CHANGED.

Referenced by LIB_EDIT_FRAME::OnEditPin().

220 { return m_Flags & IS_CHANGED; }
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:110
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
bool EDA_ITEM::IsNew ( ) const
inlineinherited

Definition at line 219 of file base_struct.h.

References IS_NEW.

Referenced by Abort_Edit_Pcb_Text(), Abort_EditEdge(), Abort_Move_ModuleOutline(), Abort_MoveOrCopyModule(), Abort_Zone_Create_Outline(), AbortBuildDimension(), AbortMoveAndEditTarget(), abortMoveItem(), AbortPinMove(), AbortSymbolTraceOn(), SCH_EDIT_FRAME::addCurrentItemToScreen(), SCH_EDIT_FRAME::addJunctionMenuEntries(), AddMenusForBus(), AddMenusForWire(), PCB_EDIT_FRAME::Delete_Segment(), PCB_EDIT_FRAME::Delete_Segment_Edge(), SCH_EDIT_FRAME::DeleteCurrentSegment(), LIB_ARC::drawEditGraphics(), LIB_ARC::drawGraphic(), LIB_PIN::EnableEditMode(), LIB_EDIT_FRAME::EndDrawGraphicItem(), SCH_EDIT_FRAME::EndSegment(), ExitSheet(), LIB_PART::LIB_PART(), EDIT_TOOL::MoveExact(), SCH_EDIT_FRAME::OnAutoplaceFields(), SCH_EDIT_FRAME::OnConvertTextType(), LIB_EDIT_FRAME::OnEditPin(), SCH_EDIT_FRAME::OnHotKey(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), LIB_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnRightClick(), LIB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCB_BASE_FRAME::PlaceModule(), LIB_EDIT_FRAME::PlacePin(), PCB_EDIT_FRAME::PlaceTarget(), SCH_EDIT_FRAME::PrepareMoveItem(), SCH_EDIT_FRAME::ReSizeSheet(), ShowClearance(), PCB_EDIT_FRAME::StartMoveTextePcb(), PCB_EDIT_FRAME::SwitchLayer(), DIALOG_SCH_EDIT_SHEET_PIN::TransferDataFromWindow(), and DIALOG_LABEL_EDITOR::TransferDataFromWindow().

219 { return m_Flags & IS_NEW; }
#define IS_NEW
New item, just created.
Definition: base_struct.h:114
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
virtual bool BOARD_ITEM::IsOnLayer ( PCB_LAYER_ID  aLayer) const
inlinevirtualinherited

Function IsOnLayer tests to see if this object is on the given layer.

Is virtual so objects like D_PAD, which reside on multiple layers can do their own form of testing.

Parameters
aLayerThe layer to test for.
Returns
bool - true if on given layer, else false.

Reimplemented in D_PAD, VIA, ZONE_CONTAINER, and MARKER_PCB.

Definition at line 174 of file class_board_item.h.

Referenced by VIA::ClassOf(), CINFO3D_VISU::createLayers(), TEXTE_PCB::Draw(), EDGE_MODULE::Draw(), TEXTE_MODULE::Draw(), Draw(), GENERAL_COLLECTOR::Inspect(), ZONE_CONTAINER::IsOnLayer(), AR_MATRIX::TraceSegmentPcb(), and TraceSegmentPcb().

175  {
176  return m_Layer == aLayer;
177  }
PCB_LAYER_ID m_Layer
bool DRAWSEGMENT::IsPolyShapeValid ( ) const
Returns
true if the polygonal shape is valid (has more than 2 points)

Definition at line 941 of file class_drawsegment.cpp.

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

Referenced by export_vrml_polygon(), PCB_IO::format(), GetPolyShape(), and BRDITEMS_PLOTTER::Plot_1_EdgeModule().

942 {
943  // return true if the polygonal shape is valid (has more than 2 points)
944  if( GetPolyShape().OutlineCount() == 0 )
945  return false;
946 
947  const SHAPE_LINE_CHAIN& outline = ((SHAPE_POLY_SET&)GetPolyShape()).Outline( 0 );
948 
949  return outline.PointCount() > 2;
950 }
int PointCount() const
Function PointCount()
Class SHAPE_POLY_SET.
SHAPE_POLY_SET & GetPolyShape()
Class SHAPE_LINE_CHAIN.
virtual bool EDA_ITEM::IsReplaceable ( ) const
inlinevirtualinherited

Function IsReplaceable.

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

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

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

Definition at line 464 of file base_struct.h.

References EDA_ITEM::operator<().

Referenced by EDA_ITEM::Matches(), and EDA_ITEM::Replace().

464 { return false; }
bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 225 of file base_struct.h.

References IS_RESIZED.

Referenced by ExitSheet().

225 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:115
bool EDA_ITEM::IsSelected ( ) const
inlineinherited
bool BOARD_ITEM::IsTrack ( ) const
inlineinherited

Function IsTrack tests to see if this object is a track or via (or microvia).

form of testing.

Returns
bool - true if a track or via, else false.

Definition at line 185 of file class_board_item.h.

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

Referenced by PCB_EDIT_FRAME::OnHotKey(), and PCB_EDIT_FRAME::OnHotkeyDeleteItem().

186  {
187  return ( Type() == PCB_TRACE_T ) || ( Type() == PCB_VIA_T );
188  }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:95
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
bool EDA_ITEM::IsType ( const KICAD_T  aScanTypes[])
inlineinherited

Function IsType Checks 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

Definition at line 266 of file base_struct.h.

References EOT.

267  {
268  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
269  {
270  if( m_StructType == *p )
271  return true;
272  }
273 
274  return false;
275  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it...
Definition: base_struct.h:163
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 223 of file base_struct.h.

References IS_WIRE_IMAGE.

Referenced by SCH_FIELD::Draw().

223 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:118
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
SEARCH_RESULT EDA_ITEM::IterateForward ( EDA_ITEM listStart,
INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
staticinherited

Function IterateForward walks through the object tree calling the inspector() on each object type requested in scanTypes.

Parameters
listStartThe first in a list of EDA_ITEMs to iterate over.
inspectorIs an INSPECTOR to call on each object that is one of the requested scanTypes.
testDataIs an aid to testFunc, and should be sufficient to allow it to fully determine if an item meets the match criteria, but it may also be used to collect output.
scanTypesA KICAD_T array that is EOT terminated, and provides both the order and interest level of of the types of objects to be iterated over.
Returns
SEARCH_RESULT SEARCH_QUIT if the called INSPECTOR returned SEARCH_QUIT, else SCAN_CONTINUE;

Definition at line 130 of file base_struct.cpp.

References EDA_ITEM::Pnext, SEARCH_CONTINUE, SEARCH_QUIT, and EDA_ITEM::Visit().

Referenced by SCH_COLLECTOR::Collect(), SCH_FIND_COLLECTOR::Collect(), SCH_TYPE_COLLECTOR::Collect(), SCH_FIND_COLLECTOR::GetItem(), EDA_ITEM::HitTest(), GERBER_FILE_IMAGE::Visit(), MODULE::Visit(), and BOARD::Visit().

134 {
135  EDA_ITEM* p = listStart;
136 
137  for( ; p; p = p->Pnext )
138  {
139  if( SEARCH_QUIT == p->Visit( inspector, testData, scanTypes ) )
140  return SEARCH_QUIT;
141  }
142 
143  return SEARCH_CONTINUE;
144 }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:154
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:167
virtual bool EDA_ITEM::Matches ( wxFindReplaceData &  aSearchData,
void *  aAuxData,
wxPoint aFindLocation 
)
inlinevirtualinherited

Function Matches compares 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.
aFindLocationA pointer to a wxPoint object to store the location of matched item. The pointer can be NULL if it is not used.
Returns
True if the item's text matches the search criteria in aSearchData.

Reimplemented in SCH_COMPONENT, SCH_SHEET, SCH_SHEET_PIN, SCH_FIELD, SCH_TEXT, LIB_PIN, and SCH_MARKER.

Definition at line 420 of file base_struct.h.

References EDA_ITEM::Replace().

Referenced by SCH_FIND_COLLECTOR::Inspect(), SCH_MARKER::Matches(), LIB_PIN::Matches(), SCH_TEXT::Matches(), SCH_FIELD::Matches(), SCH_SHEET_PIN::Matches(), SCH_SHEET::Matches(), and EDA_ITEM::Sort().

421  {
422  return false;
423  }
bool EDA_ITEM::Matches ( const wxString &  aText,
wxFindReplaceData &  aSearchData 
)
protectedinherited

Function Matches compares 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 182 of file base_struct.cpp.

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

183 {
184  wxString text = aText;
185  wxString searchText = aSearchData.GetFindString();
186 
187  // Don't match if searching for replaceable item and the item doesn't support text replace.
188  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
189  return false;
190 
191  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
192  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
193 
194  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
195  {
196  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
197  return text.Matches( searchText );
198 
199  return text.MakeUpper().Matches( searchText.MakeUpper() );
200  }
201 
202  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
203  return aText.Find( searchText ) != wxNOT_FOUND;
204 
205  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
206 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:464
Perform search using simple wild card matching (* & ?).
Perform a search for a item that has replaceable text.
void DRAWSEGMENT::Move ( const wxPoint aMoveVector)
overridevirtual

Function Move move this object.

Parameters
aMoveVector- the move vector for this object.

Reimplemented from BOARD_ITEM.

Reimplemented in EDGE_MODULE.

Definition at line 80 of file class_drawsegment.cpp.

References SHAPE_POLY_SET::Iterate(), m_BezierC1, m_BezierC2, m_BezierPoints, m_End, m_Poly, m_Shape, m_Start, S_CURVE, and S_POLYGON.

Referenced by GetLength(), Move_Segment(), DIALOG_PAD_PROPERTIES::redraw(), and POINT_EDITOR::updateItem().

81 {
82  m_Start += aMoveVector;
83  m_End += aMoveVector;
84 
85  switch ( m_Shape )
86  {
87  case S_POLYGON:
88  for( auto iter = m_Poly.Iterate(); iter; iter++ )
89  {
90  (*iter) += VECTOR2I( aMoveVector );
91  }
92  break;
93 
94  case S_CURVE:
95  m_BezierC1 += aMoveVector;
96  m_BezierC2 += aMoveVector;
97 
98  for( unsigned int ii = 0; ii < m_BezierPoints.size(); ii++ )
99  {
100  m_BezierPoints[ii] += aMoveVector;
101  }
102 
103  break;
104 
105  default:
106  break;
107  }
108 }
SHAPE_POLY_SET m_Poly
Stores the S_POLYGON shape.
polygon (not yet used for tracks, but could be in microwave apps)
ITERATOR Iterate(int aFirst, int aLast, bool aIterateHoles=false)
Function Iterate returns an object to iterate through the points of the polygons between aFirst and a...
VECTOR2< int > VECTOR2I
Definition: vector2d.h:587
wxPoint m_BezierC1
Bezier Control Point 1.
wxPoint m_Start
Line start point or Circle and Arc center.
wxPoint m_End
Line end point or circle and arc start point.
STROKE_T m_Shape
Shape: line, Circle, Arc.
Bezier Curve.
wxPoint m_BezierC2
Bezier Control Point 2.
std::vector< wxPoint > m_BezierPoints
void BOARD_ITEM::Move ( const VECTOR2I aMoveVector)
inlineinherited

Definition at line 240 of file class_board_item.h.

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

241  {
242  Move( wxPoint( aMoveVector.x, aMoveVector.y ) );
243  }
virtual void Move(const wxPoint &aMoveVector)
Function Move move this object.
BOARD_ITEM* BOARD_ITEM::Next ( ) const
inlineinherited

Definition at line 116 of file class_board_item.h.

References EDA_ITEM::Pnext.

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), CINFO3D_VISU::AddGraphicsShapesWithClearanceToContainer(), PCB_EDIT_FRAME::AppendBoardFile(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), MODULE::BuildPolyCourtyard(), BOARD::ComputeBoundingBox(), BOARD::ConvertBrdLayerToPolygonalContours(), CopyMarkedItems(), DeleteMarkedItems(), PYTHON_ACTION_PLUGINS::deregister_action(), PCB_EDIT_FRAME::DoGenFootprintsReport(), MODULE::Draw(), BOARD::Draw(), MODULE::DrawEdgesOnly(), DrawMovingBlockOutlines(), FOOTPRINT_EDIT_FRAME::Edit_Edge_Layer(), FOOTPRINT_EDIT_FRAME::Edit_Edge_Width(), PCB_EDIT_FRAME::Exchange_Module(), export_vrml_module(), MODULE::Flip(), PCB_IO::format(), MODULE::GetAllDrawingLayers(), MODULE::GetBoundingBox(), PCB_BASE_FRAME::GetFootprintFromBoardByReference(), MODULE::GetFootprintRect(), getMatchingTextItem(), MODULE::HitTest(), PCB_EDIT_FRAME::ImportSpecctraSession(), MirrorMarkedItems(), MODULE::MODULE(), MODULE::MoveAnchorPosition(), MODULE::operator=(), BRDITEMS_PLOTTER::Plot_Edges_Modules(), BRDITEMS_PLOTTER::PlotAllTextsModule(), PlotSolderMaskLayer(), PlotStandardLayer(), FOOTPRINT_EDIT_FRAME::RedrawActiveWindow(), RotateMarkedItems(), MODULE::RunOnChildren(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), MODULE::SetOrientation(), MODULE::SetPosition(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::Swap_Layers(), SwapItemData(), DRC::testCopperTextAndGraphics(), TestForExistingItem(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), CINFO3D_VISU::transformGraphicModuleEdgeToPolygonSet(), and MODULE::ViewGetLayers().

116 { return static_cast<BOARD_ITEM*>( Pnext ); }
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:167
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 239 of file base_struct.cpp.

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

Referenced by EDA_ITEM::IsReplaceable(), and LIB_ALIAS::operator==().

240 {
241  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
242  GetChars( GetClass() ) ) );
243 
244  return false;
245 }
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
virtual wxString GetClass() const =0
Function GetClass returns the class name.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
void DRAWSEGMENT::RebuildBezierToSegmentsPointsList ( int  aMinSegLen)

Rebuild the m_BezierPoints vertex list that approximate the Bezier curve by a list of segments Has meaning only for S_CURVE DRAW_SEGMENT shape.

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

Definition at line 191 of file class_drawsegment.cpp.

References BEZIER_POLY::GetPoly(), m_BezierC1, m_BezierC2, m_BezierPoints, m_End, m_Shape, m_Start, and S_CURVE.

Referenced by ConvertOutlineToPolygon(), EDGE_MODULE::Draw(), Draw(), EDGE_MODULE::Flip(), DXF2BRD_CONVERTER::insertSpline(), SetBezierPoints(), EDGE_MODULE::SetDrawCoord(), PNS_KICAD_IFACE::syncGraphicalItem(), DRC::testCopperDrawItem(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), and POINT_EDITOR::updateItem().

192 {
193  // Has meaning only for S_CURVE DRAW_SEGMENT shape
194  if( m_Shape != S_CURVE )
195  {
196  m_BezierPoints.clear();
197  return;
198  }
199  // Rebuild the m_BezierPoints vertex list that approximate the Bezier curve
200  std::vector<wxPoint> ctrlPoints = { m_Start, m_BezierC1, m_BezierC2, m_End };
201  BEZIER_POLY converter( ctrlPoints );
202  converter.GetPoly( m_BezierPoints, aMinSegLen );
203 }
wxPoint m_BezierC1
Bezier Control Point 1.
wxPoint m_Start
Line start point or Circle and Arc center.
wxPoint m_End
Line end point or circle and arc start point.
STROKE_T m_Shape
Shape: line, Circle, Arc.
Bezier Curve.
Bezier curves to polygon converter.
Definition: bezier_curves.h:35
wxPoint m_BezierC2
Bezier Control Point 2.
std::vector< wxPoint > m_BezierPoints
bool EDA_ITEM::Replace ( wxFindReplaceData &  aSearchData,
wxString &  aText 
)
inherited

Helper function used in search and replace dialog Function Replace performs 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 209 of file base_struct.cpp.

References GetChars(), EDA_ITEM::GetClass(), EDA_ITEM::IsReplaceable(), and traceFindReplace.

Referenced by EDA_ITEM::Matches(), SCH_TEXT::Replace(), SCH_FIELD::Replace(), SCH_SHEET_PIN::Replace(), SCH_SHEET::Replace(), and SCH_FIND_COLLECTOR::ReplaceItem().

210 {
211  wxCHECK_MSG( IsReplaceable(), false,
212  wxT( "Attempt to replace text in <" ) + GetClass() + wxT( "> item." ) );
213 
214  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
215 
216  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
217  aSearchData.GetFindString() :
218  aSearchData.GetFindString().Upper() );
219 
220  if( result == wxNOT_FOUND )
221  return false;
222 
223  wxString prefix = aText.Left( result );
224  wxString suffix;
225 
226  if( aSearchData.GetFindString().length() + result < aText.length() )
227  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
228 
229  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
230  GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
231  GetChars( suffix ) );
232 
233  aText = prefix + aSearchData.GetReplaceString() + suffix;
234 
235  return true;
236 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:464
const wxChar *const traceFindReplace
Flag to enable find and replace debug tracing.
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
virtual wxString GetClass() const =0
Function GetClass returns the class name.
virtual bool EDA_ITEM::Replace ( wxFindReplaceData &  aSearchData,
void *  aAuxData = NULL 
)
inlinevirtualinherited

Function Replace performs 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 SCH_SHEET, SCH_SHEET_PIN, SCH_FIELD, and SCH_TEXT.

Definition at line 452 of file base_struct.h.

452 { return false; }
void DRAWSEGMENT::Rotate ( const wxPoint aRotCentre,
double  aAngle 
)
overridevirtual

Function Rotate Rotate this object.

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

Reimplemented from BOARD_ITEM.

Reimplemented in EDGE_MODULE.

Definition at line 111 of file class_drawsegment.cpp.

References SHAPE_POLY_SET::Iterate(), m_BezierC1, m_BezierC2, m_BezierPoints, m_End, m_Poly, m_Shape, m_Start, RotatePoint(), S_ARC, S_CIRCLE, S_CURVE, S_POLYGON, S_RECT, S_SEGMENT, and BOARD_ITEM::ShowShape().

Referenced by GetLength(), DIALOG_PAD_PROPERTIES::OnPaintShowPanel(), DIALOG_PAD_PROPERTIES::redraw(), and EDGE_MODULE::Rotate().

112 {
113  switch( m_Shape )
114  {
115  case S_ARC:
116  case S_SEGMENT:
117  case S_CIRCLE:
118  // these can all be done by just rotating the start and end points
119  RotatePoint( &m_Start, aRotCentre, aAngle);
120  RotatePoint( &m_End, aRotCentre, aAngle);
121  break;
122 
123  case S_POLYGON:
124  for( auto iter = m_Poly.Iterate(); iter; iter++ )
125  {
126  RotatePoint( *iter, VECTOR2I(aRotCentre), aAngle);
127  }
128  break;
129 
130  case S_CURVE:
131  RotatePoint( &m_Start, aRotCentre, aAngle);
132  RotatePoint( &m_End, aRotCentre, aAngle);
133  RotatePoint( &m_BezierC1, aRotCentre, aAngle);
134  RotatePoint( &m_BezierC2, aRotCentre, aAngle);
135 
136  for( unsigned int ii = 0; ii < m_BezierPoints.size(); ii++ )
137  {
138  RotatePoint( &m_BezierPoints[ii], aRotCentre, aAngle);
139  }
140  break;
141 
142  case S_RECT:
143  default:
144  // un-handled edge transform
145  wxASSERT_MSG( false, wxT( "DRAWSEGMENT::Rotate not implemented for "
146  + ShowShape( m_Shape ) ) );
147  break;
148  }
149 }
static wxString ShowShape(STROKE_T aShape)
Function ShowShape converts the enum STROKE_T integer value to a wxString.
SHAPE_POLY_SET m_Poly
Stores the S_POLYGON shape.
polygon (not yet used for tracks, but could be in microwave apps)
usual segment : line with rounded ends
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:216
ITERATOR Iterate(int aFirst, int aLast, bool aIterateHoles=false)
Function Iterate returns an object to iterate through the points of the polygons between aFirst and a...
VECTOR2< int > VECTOR2I
Definition: vector2d.h:587
wxPoint m_BezierC1
Bezier Control Point 1.
segment with non rounded ends
wxPoint m_Start
Line start point or Circle and Arc center.
wxPoint m_End
Line end point or circle and arc start point.
Arcs (with rounded ends)
STROKE_T m_Shape
Shape: line, Circle, Arc.
Bezier Curve.
wxPoint m_BezierC2
Bezier Control Point 2.
std::vector< wxPoint > m_BezierPoints
void BOARD_ITEM::Rotate ( const VECTOR2I aRotCentre,
double  aAngle 
)
inlineinherited

Definition at line 256 of file class_board_item.h.

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

257  {
258  Rotate( wxPoint( aRotCentre.x, aRotCentre.y ), aAngle );
259  }
virtual void Rotate(const wxPoint &aRotCentre, double aAngle)
Function Rotate Rotate this object.
void DRAWSEGMENT::SetAngle ( double  aAngle)

Function SetAngle sets the angle for arcs, and normalizes it within the range 0 - 360 degrees.

Parameters
aAngleis tenths of degrees, but will soon be degrees.

Definition at line 273 of file class_drawsegment.cpp.

References m_Angle, and NormalizeAngle360Max().

Referenced by DXF2BRD_CONVERTER::addArc(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_ARC::AddToModule(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PAD_CS_PRIMITIVE::ExportTo(), EDGE_MODULE::Flip(), GetWidth(), DXF2BRD_CONVERTER::insertArc(), EAGLE_PLUGIN::loadPlain(), EDGE_MODULE::Mirror(), EAGLE_PLUGIN::packageWire(), DRAWING_TOOL::PlaceDXF(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), updateArcFromConstructionMgr(), and POINT_EDITOR::updateItem().

274 {
275  // m_Angle must be >= -360 and <= +360 degrees
276  m_Angle = NormalizeAngle360Max( aAngle );
277 }
T NormalizeAngle360Max(T Angle)
Normalize angle to be >=-360.0 and <= 360.0 Angle can be equal to -360 or +360.
Definition: trigo.h:211
double m_Angle
Used only for Arcs: Arc angle in 1/10 deg.
void DRAWSEGMENT::SetArcStart ( const wxPoint aArcStartPoint)
inline

Initialize the start arc point.

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

Definition at line 152 of file class_drawsegment.h.

Referenced by DXF2BRD_CONVERTER::addArc(), DXF2BRD_CONVERTER::addCircle(), DXF2BRD_CONVERTER::insertArc(), updateArcFromConstructionMgr(), and POINT_EDITOR::updateItem().

153  { m_End = aArcStartPoint; }
wxPoint m_End
Line end point or circle and arc start point.
void EDA_ITEM::SetBack ( EDA_ITEM aBack)
inlineinherited

Definition at line 215 of file base_struct.h.

Referenced by DHEAD::append(), DHEAD::insert(), SCH_EDIT_FRAME::PutDataInPreviousState(), DHEAD::remove(), and SwapItemData().

215 { Pback = aBack; }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:168
void DRAWSEGMENT::SetBezControl1 ( const wxPoint aPoint)
inline
void DRAWSEGMENT::SetBezControl2 ( const wxPoint aPoint)
inline
void DRAWSEGMENT::SetBezierPoints ( const std::vector< wxPoint > &  aPoints)
inline

Definition at line 192 of file class_drawsegment.h.

References Draw(), GetBoundingBox(), GetMsgPanelInfo(), HitTest(), RebuildBezierToSegmentsPointsList(), SetPolyPoints(), and BOARD_ITEM::ZeroOffset.

Referenced by DRAWING_TOOL::PlaceDXF().

193  {
194  m_BezierPoints = aPoints;
195  }
std::vector< wxPoint > m_BezierPoints
void EDA_ITEM::SetBrightened ( )
inlineinherited

Definition at line 232 of file base_struct.h.

References BRIGHTENED, and EDA_ITEM::SetFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), and SELECTION_TOOL::highlight().

232 { SetFlags( BRIGHTENED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:256
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:138
void DRAWSEGMENT::SetCenter ( const wxPoint aCenterPoint)
inline

For arcs and circles:

Definition at line 157 of file class_drawsegment.h.

References GetParentModule().

Referenced by DXF2BRD_CONVERTER::addArc(), DXF2BRD_CONVERTER::addCircle(), DXF2BRD_CONVERTER::insertArc(), and updateArcFromConstructionMgr().

157 { m_Start = aCenterPoint; }
wxPoint m_Start
Line start point or Circle and Arc center.
void DRAWSEGMENT::SetEndX ( int  x)
inline

Definition at line 121 of file class_drawsegment.h.

References GetCenter(), and wxPoint::x.

Referenced by DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow().

121 { m_End.x = x; }
wxPoint m_End
Line end point or circle and arc start point.
void DRAWSEGMENT::SetEndY ( int  y)
inline

Definition at line 120 of file class_drawsegment.h.

References wxPoint::y.

Referenced by DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow().

120 { m_End.y = y; }
wxPoint m_End
Line end point or circle and arc start point.
void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 256 of file base_struct.h.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), SCH_SCREEN::addConnectedItemsToBlock(), PCB_BASE_FRAME::AddModuleToBoard(), AddSegmentToDragList(), PCBNEW_CONTROL::AppendBoard(), PCB_EDIT_FRAME::AppendBoardFile(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Route(), PCB_EDIT_FRAME::Begin_Zone(), PCB_EDIT_FRAME::BeginMoveDimensionText(), PCB_EDIT_FRAME::BeginMoveTarget(), SCH_EDIT_FRAME::BeginSegment(), LIB_EDIT_FRAME::BlockCopySelectedItems(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), LIB_EDIT_FRAME::copySelectedItems(), SCH_EDIT_FRAME::CreateBusBusEntry(), SCH_EDIT_FRAME::CreateBusWireEntry(), SCH_EDIT_FRAME::CreateNewImage(), SCH_EDIT_FRAME::CreateNewText(), LIB_EDIT_FRAME::CreatePin(), SCH_EDIT_FRAME::CreateSheet(), SCH_EDIT_FRAME::CreateSheetPin(), PCB_EDIT_FRAME::CreateTarget(), PCB_EDIT_FRAME::CreateTextePcb(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), SCH_EDIT_FRAME::DeleteItem(), DrawMovingBlockOutlines(), PCB_EDIT_FRAME::EditDimension(), PCB_EDIT_FRAME::FlipTextePcb(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_SCREEN::GetConnection(), FOOTPRINT_EDIT_FRAME::HandleBlockEnd(), SCH_EDIT_FRAME::HandleBlockPlace(), PCB_BASE_FRAME::Import_Pad_Settings(), SCH_EDIT_FRAME::ImportSheetPin(), SCH_JUNCTION::IsSelectStateChanged(), SCH_NO_CONNECT::IsSelectStateChanged(), SCH_MARKER::IsSelectStateChanged(), SCH_BUS_ENTRY_BASE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), SCH_COMPONENT::IsSelectStateChanged(), SCH_EDIT_FRAME::Load_Component(), EDIT_TOOL::Main(), SCH_SCREEN::MarkConnections(), MarkItemsInBloc(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), LIB_EDIT_FRAME::OnEditPin(), SCH_EDIT_FRAME::OnSelectUnit(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), PCB_EDIT_FRAME::Other_Layer_Route(), DRAWING_TOOL::PlaceText(), SCH_EDIT_FRAME::PrepareMoveItem(), LIB_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), SCH_EDIT_FRAME::ReSizeSheet(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), LIB_EDIT_FRAME::SaveCopyInUndoList(), SCH_SCREEN::SelectBlockItems(), EDA_ITEM::SetBrightened(), LIB_PIN::SetConversion(), BLOCK_SELECTOR::SetFlags(), EDA_ITEM::SetHighlighted(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::Start_Move_DrawItem(), FOOTPRINT_EDIT_FRAME::Start_Move_EdgeMod(), PCB_EDIT_FRAME::Start_Move_Zone_Corner(), PCB_EDIT_FRAME::Start_Move_Zone_Drag_Outline_Edge(), PCB_EDIT_FRAME::Start_Move_Zone_Outlines(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), PCB_BASE_FRAME::StartMovePad(), LIB_EDIT_FRAME::StartMovePin(), PCB_BASE_FRAME::StartMoveTexteModule(), PCB_EDIT_FRAME::StartMoveTextePcb(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and UndrawAndMarkSegmentsToDrag().

256 { m_Flags |= aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
void EDA_ITEM::SetForceVisible ( bool  aEnable)
inlineinherited

Function SetForceVisible is used to set and cleag 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 285 of file base_struct.h.

Referenced by SCH_EDIT_FRAME::OnFindSchematicItem(), and SCH_EDIT_FRAME::updateFindReplaceView().

285 { m_forceVisible = aEnable; }
bool m_forceVisible
Set to true to override the visibility setting of the item.
Definition: base_struct.h:175
void EDA_ITEM::SetHighlighted ( )
inlineinherited

Definition at line 231 of file base_struct.h.

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

231 { SetFlags( HIGHLIGHTED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:256
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:137
virtual void BOARD_ITEM::SetLayer ( PCB_LAYER_ID  aLayer)
inlinevirtualinherited

Function SetLayer sets the layer this item is on.

Parameters
aLayerThe layer number. is virtual because some items (in fact: class DIMENSION) have a slightly different initialization

Reimplemented in ZONE_CONTAINER, and DIMENSION.

Definition at line 141 of file class_board_item.h.

References BOARD_ITEM::Draw(), and BOARD_ITEM::SwapData().

Referenced by DXF2BRD_CONVERTER::addArc(), DXF2BRD_CONVERTER::addCircle(), PNS_KICAD_IFACE::AddItem(), DXF2BRD_CONVERTER::addLine(), DXF2BRD_CONVERTER::addMText(), DXF2BRD_CONVERTER::addText(), PCAD2KICAD::PCB_TEXT::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToBoard(), PCAD2KICAD::PCB_MODULE::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToModule(), PCAD2KICAD::PCB_ARC::AddToModule(), PCAD2KICAD::PCB_POLYGON::AddToModule(), DIMENSION::AdjustDimensionDetails(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Route(), PCB_EDIT_FRAME::Create_MuWavePolygonShape(), MWAVE::CreateMicrowaveInductor(), PCB_BASE_FRAME::CreateNewModule(), PCB_EDIT_FRAME::CreateTarget(), PCB_EDIT_FRAME::CreateTextePcb(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::drawSegment(), FOOTPRINT_EDIT_FRAME::Edit_Edge_Layer(), TEXTE_PCB::Flip(), PCB_TARGET::Flip(), EDGE_MODULE::Flip(), TEXTE_MODULE::Flip(), TRACK::Flip(), MODULE::Flip(), Flip(), AR_AUTOPLACER::genPlacementRoutingMatrix(), DXF2BRD_CONVERTER::insertArc(), DXF2BRD_CONVERTER::insertLine(), DXF2BRD_CONVERTER::insertSpline(), LEGACY_PLUGIN::loadMODULE(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), DSN::SPECCTRA_DB::makeTRACK(), DIALOG_FOOTPRINT_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAddField(), PCB_EDIT_FRAME::Other_Layer_Route(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), EAGLE_PLUGIN::packageSMD(), EAGLE_PLUGIN::packageText(), EAGLE_PLUGIN::packageWire(), GPCB_FPL_CACHE::parseMODULE(), DRAWING_TOOL::PlaceDXF(), DRAWING_TOOL::PlaceText(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotPcbTarget(), processBoardItem(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), processTextItem(), DIALOG_PAD_PROPERTIES::redraw(), DIMENSION::SetLayer(), TEXT_MOD_GRID_TABLE::SetValueAsLong(), ShowNewTrackWhenMovingCursor(), TEXTE_MODULE::TEXTE_MODULE(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow().

142  {
143  // trap any invalid layers, then go find the caller and fix it.
144  // wxASSERT( unsigned( aLayer ) < unsigned( NB_PCB_LAYERS ) );
145  m_Layer = aLayer;
146  }
PCB_LAYER_ID m_Layer
void EDA_ITEM::SetList ( DHEAD aList)
inlineinherited

Definition at line 217 of file base_struct.h.

Referenced by DHEAD::append(), DHEAD::insert(), DHEAD::remove(), and SwapItemData().

217 { m_List = aList; }
DHEAD * m_List
which DLIST I am on.
Definition: base_struct.h:169
virtual void BOARD_ITEM::SetLocked ( bool  aLocked)
inlinevirtualinherited

Function SetLocked modifies 'lock' status for of the item.

Reimplemented in MODULE, and TRACK.

Definition at line 204 of file class_board_item.h.

References BOARD_ITEM::DeleteStructure(), BOARD_ITEM::ShowShape(), and BOARD_ITEM::UnLink().

205  {
206  // only MODULEs & TRACKs can be locked at this time.
207  }
void EDA_ITEM::SetModified ( )
inherited
void EDA_ITEM::SetNext ( EDA_ITEM aNext)
inlineinherited

Definition at line 214 of file base_struct.h.

Referenced by DHEAD::append(), DHEAD::insert(), SCH_EDIT_FRAME::PutDataInPreviousState(), DHEAD::remove(), and SwapItemData().

214 { Pnext = aNext; }
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:167
void DRAWSEGMENT::SetPolyPoints ( const std::vector< wxPoint > &  aPoints)

Definition at line 910 of file class_drawsegment.cpp.

References SHAPE_POLY_SET::Append(), m_Poly, SHAPE_POLY_SET::NewOutline(), and SHAPE_POLY_SET::RemoveAllContours().

Referenced by PCAD2KICAD::PCB_POLYGON::AddToModule(), PCB_EDIT_FRAME::Create_MuWavePolygonShape(), PAD_CS_PRIMITIVE::ExportTo(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), and SetBezierPoints().

911 {
913  m_Poly.NewOutline();
914 
915  for ( auto p : aPoints )
916  {
917  m_Poly.Append( p.x, p.y );
918  }
919 }
SHAPE_POLY_SET m_Poly
Stores the S_POLYGON shape.
int NewOutline()
Creates a new empty polygon in the set and returns its index
void RemoveAllContours()
Removes all outlines & holes (clears) the polygon set.
int Append(int x, int y, int aOutline=-1, int aHole=-1, bool aAllowDuplication=false)
Appends a vertex at the end of the given outline/hole (default: the last outline) ...
void DRAWSEGMENT::SetPolyShape ( const SHAPE_POLY_SET aShape)
inline

Definition at line 190 of file class_drawsegment.h.

Referenced by DRAWING_TOOL::PlaceDXF().

190 { m_Poly = aShape; }
SHAPE_POLY_SET m_Poly
Stores the S_POLYGON shape.
void DRAWSEGMENT::SetPosition ( const wxPoint aPos)
overridevirtual

Implements BOARD_ITEM.

Definition at line 67 of file class_drawsegment.cpp.

References m_Start.

Referenced by GetBezControl2().

68 {
69  m_Start = aPos;
70 }
wxPoint m_Start
Line start point or Circle and Arc center.
void EDA_ITEM::SetSelected ( )
inlineinherited

Definition at line 230 of file base_struct.h.

References SELECTED, and EDA_ITEM::SetFlags().

Referenced by SELECTION_TOOL::highlight(), LIB_EDIT_FRAME::pasteClipboard(), and GERBVIEW_SELECTION_TOOL::selectVisually().

230 { SetFlags( SELECTED ); }
#define SELECTED
Definition: base_struct.h:121
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:256
void DRAWSEGMENT::SetStartX ( int  x)
inline

Definition at line 112 of file class_drawsegment.h.

References wxPoint::x.

Referenced by DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow().

112 { m_Start.x = x; }
wxPoint m_Start
Line start point or Circle and Arc center.
void DRAWSEGMENT::SetStartY ( int  y)
inline

Definition at line 111 of file class_drawsegment.h.

References wxPoint::y.

Referenced by DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow().

111 { m_Start.y = y; }
wxPoint m_Start
Line start point or Circle and Arc center.
void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited
void EDA_ITEM::SetTimeStamp ( timestamp_t  aNewTimeStamp)
inlineinherited

Definition at line 206 of file base_struct.h.

Referenced by PCB_BASE_FRAME::AddModuleToBoard(), BOARD_NETLIST_UPDATER::addNewComponent(), PCAD2KICAD::PCB_TEXT::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToBoard(), PCAD2KICAD::PCB_POLYGON::AddToBoard(), PCAD2KICAD::PCB_MODULE::AddToBoard(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::Begin_Zone(), SCH_EDIT_FRAME::CreateSheet(), Diagnose(), SCH_EDIT_FRAME::DuplicateItemsInList(), DuplicateStruct(), DIALOG_FOOTPRINT_BOARD_EDITOR::EditFootprint(), EDIT_TOOL::editFootprintInFpEditor(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::FootprintSave(), EDA_ITEM::initVars(), BOARD::InsertArea(), LEGACY_PLUGIN::loadMODULE(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadPolygon(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), EDA_ITEM::operator=(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), EAGLE_PLUGIN::packageText(), PCB_PARSER::parseDIMENSION(), SCH_EDIT_FRAME::PasteListOfItems(), PCB_EDIT_FRAME::Process_Special_Functions(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), BOARD::ReplaceNetlist(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SHEET::SCH_SHEET(), SCH_COMPONENT::SetTimeStamp(), SimilarLabelsDiagnose(), SwapItemData(), TestDuplicateSheetNames(), and DIALOG_ERC::TestErc().

206 { m_TimeStamp = aNewTimeStamp; }
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:172
void DRAWSEGMENT::SetType ( int  aType)
inline

Definition at line 90 of file class_drawsegment.h.

Referenced by PCB_EDIT_FRAME::Begin_DrawSegment(), and DRAWING_TOOL::PlaceDXF().

90 { m_Type = aType; }
int m_Type
Used in complex associations ( Dimensions.. )
void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 229 of file base_struct.h.

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

229 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:256
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:118
wxString BOARD_ITEM::ShowShape ( STROKE_T  aShape)
staticinherited

Function ShowShape converts the enum STROKE_T integer value to a wxString.

Definition at line 39 of file class_board_item.cpp.

References S_ARC, S_CIRCLE, S_CURVE, S_POLYGON, S_RECT, and S_SEGMENT.

Referenced by ConvertOutlineToPolygon(), GetCenter(), EDGE_MODULE::GetSelectMenuText(), GetSelectMenuText(), DSN::SPECCTRA_DB::makeIMAGE(), Rotate(), and BOARD_ITEM::SetLocked().

40 {
41  switch( aShape )
42  {
43  case S_SEGMENT: return _( "Line" );
44  case S_RECT: return _( "Rect" );
45  case S_ARC: return _( "Arc" );
46  case S_CIRCLE: return _( "Circle" );
47  case S_CURVE: return _( "Bezier Curve" );
48  case S_POLYGON: return _( "Polygon" );
49  default: return wxT( "??" );
50  }
51 }
polygon (not yet used for tracks, but could be in microwave apps)
usual segment : line with rounded ends
segment with non rounded ends
Arcs (with rounded ends)
Bezier Curve.
static bool EDA_ITEM::Sort ( const EDA_ITEM aLeft,
const EDA_ITEM aRight 
)
inlinestaticinherited

Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers.

Parameters
aLeftThe left hand item to compare.
aRightThe right hand item to compare.
Returns
True if aLeft is less than aRight.

Definition at line 483 of file base_struct.h.

References EDA_ITEM::Matches(), EDA_ITEM::operator=(), EDA_ITEM::ViewBBox(), and EDA_ITEM::ViewGetLayers().

Referenced by PART_LIB::GetEntryTypePowerNames().

483 { return *aLeft < *aRight; }
void DRAWSEGMENT::SwapData ( BOARD_ITEM aImage)
overridevirtual

Swap data between aItem and aImage.

aItem and aImage should have the same type Used in undo redo command to swap values between an item and its copy Only values like layer, size .. which are modified by editing are swapped, not the pointers like Pnext and Pback because aItem is not changed in the linked list

Parameters
aImage= the item image which contains data to swap

Reimplemented from BOARD_ITEM.

Definition at line 964 of file class_drawsegment.cpp.

References PCB_LINE_T, and EDA_ITEM::Type().

Referenced by GetLength().

965 {
966  assert( aImage->Type() == PCB_LINE_T );
967 
968  std::swap( *((DRAWSEGMENT*) this), *((DRAWSEGMENT*) aImage) );
969 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
class DRAWSEGMENT, a segment not on copper layers
Definition: typeinfo.h:91
void DRAWSEGMENT::TransformShapeWithClearanceToPolygon ( SHAPE_POLY_SET aCornerBuffer,
int  aClearanceValue,
int  aCircleToSegmentsCount,
double  aCorrectionFactor 
) const
overridevirtual

Function TransformShapeWithClearanceToPolygon Convert the track shape to a closed polygon Used in filling zones calculations Circles and arcs are approximated by segments.

Parameters
aCornerBuffer= a buffer to store the polygon
aClearanceValue= the clearance around the pad
aCircleToSegmentsCount= the number of segments to approximate a circle
aCorrectionFactor= the correction to apply to circles radius to keep clearance when the circle is approximated by segment bigger or equal to the real clearance value (usually near from 1.0)
aCornerBuffer= a buffer to store the polygon
aClearanceValue= the clearance around the pad
aCircleToSegmentsCount= the number of segments to approximate a circle
aCorrectionFactor= the correction to apply to circles radius to keep clearance when the circle is approxiamted by segment bigger or equal to the real clearance value (usually near from 1.0)

Reimplemented from BOARD_ITEM.

Definition at line 514 of file board_items_to_polygon_shape_transform.cpp.

References SHAPE_POLY_SET::Append(), GetArcToSegmentCount(), MODULE::GetOrientation(), BEZIER_POLY::GetPoly(), MODULE::GetPosition(), SHAPE_POLY_SET::NewOutline(), RotatePoint(), S_ARC, S_CIRCLE, S_CURVE, s_error_max, S_POLYGON, S_SEGMENT, TransformArcToPolygon(), TransformOvalClearanceToPolygon(), TransformRingToPolygon(), and TransformRoundedEndsSegmentToPolygon().

Referenced by CINFO3D_VISU::AddShapeWithClearanceToContainer(), GetLength(), CINFO3D_VISU::transformGraphicModuleEdgeToPolygonSet(), and MODULE::TransformGraphicShapesWithClearanceToPolygonSet().

518 {
519  // The full width of the lines to create:
520  int linewidth = m_Width + (2 * aClearanceValue);
521 
522  // Creating a reliable clearance shape for circles and arcs is not so easy, due to
523  // the error created by segment approximation.
524  // for a cicle this is not so hard: create a polygon from a circle slightly bigger:
525  // thickness = linewidth + s_error_max, and radius = initial radius + s_error_max/2
526  // giving a shape with a suitable internal radius and external radius
527  // For an arc this is more tricky: TODO
528  if( m_Shape == S_CIRCLE || m_Shape == S_ARC )
529  {
530  int segCount = GetArcToSegmentCount( GetRadius(), s_error_max, 360.0 );
531 
532  if( segCount > aCircleToSegmentsCount )
533  aCircleToSegmentsCount = segCount;
534  }
535 
536  switch( m_Shape )
537  {
538  case S_CIRCLE:
539  TransformRingToPolygon( aCornerBuffer, GetCenter(), GetRadius() + (s_error_max/2),
540  aCircleToSegmentsCount, linewidth + s_error_max ) ;
541  break;
542 
543  case S_ARC:
544  TransformArcToPolygon( aCornerBuffer, GetCenter(),
545  GetArcStart(), m_Angle,
546  aCircleToSegmentsCount, linewidth );
547  break;
548 
549  case S_SEGMENT:
550  TransformOvalClearanceToPolygon( aCornerBuffer, m_Start, m_End, linewidth,
551  aCircleToSegmentsCount, aCorrectionFactor );
552  break;
553 
554  case S_POLYGON:
555  if( IsPolyShapeValid() )
556  {
557  // The polygon is expected to be a simple polygon
558  // not self intersecting, no hole.
559  MODULE* module = GetParentModule(); // NULL for items not in footprints
560  double orientation = module ? module->GetOrientation() : 0.0;
561  wxPoint offset;
562 
563  if( module )
564  offset = module->GetPosition();
565 
566  // Build the polygon with the actual position and orientation:
567  std::vector< wxPoint> poly;
568  poly = BuildPolyPointsList();
569 
570  for( unsigned ii = 0; ii < poly.size(); ii++ )
571  {
572  RotatePoint( &poly[ii], orientation );
573  poly[ii] += offset;
574  }
575 
576  // Generate polygons for the outline + clearance
577  // This code is compatible with a polygon with holes linked to external outline
578  // by overlapping segments.
579 
580  // Insert the initial polygon:
581  aCornerBuffer.NewOutline();
582 
583  for( unsigned ii = 0; ii < poly.size(); ii++ )
584  aCornerBuffer.Append( poly[ii].x, poly[ii].y );
585 
586  if( linewidth ) // Add thick outlines
587  {
588  wxPoint corner1( poly[poly.size()-1] );
589 
590  for( unsigned ii = 0; ii < poly.size(); ii++ )
591  {
592  wxPoint corner2( poly[ii] );
593 
594  if( corner2 != corner1 )
595  {
597  corner1, corner2, aCircleToSegmentsCount, linewidth );
598  }
599 
600  corner1 = corner2;
601  }
602  }
603  }
604  break;
605 
606  case S_CURVE: // Bezier curve
607  {
608  std::vector<wxPoint> ctrlPoints = { m_Start, m_BezierC1, m_BezierC2, m_End };
609  BEZIER_POLY converter( ctrlPoints );
610  std::vector< wxPoint> poly;
611  converter.GetPoly( poly, m_Width );
612 
613  for( unsigned ii = 1; ii < poly.size(); ii++ )
614  {
616  poly[ii-1], poly[ii], aCircleToSegmentsCount, linewidth );
617  }
618  }
619  break;
620 
621  default:
622  break;
623  }
624 }
void TransformRoundedEndsSegmentToPolygon(SHAPE_POLY_SET &aCornerBuffer, wxPoint aStart, wxPoint aEnd, int aCircleToSegmentsCount, int aWidth)
Function TransformRoundedEndsSegmentToPolygon convert a segment with rounded ends to a polygon Conver...
const std::vector< wxPoint > BuildPolyPointsList() const
Build and return the list of corners in a std::vector<wxPoint> It must be used only to convert the SH...
int GetArcToSegmentCount(int aRadius, int aErrorMax, double aArcAngleDegree)
const wxPoint GetCenter() const override
Function GetCenter()
polygon (not yet used for tracks, but could be in microwave apps)
usual segment : line with rounded ends
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:216
double m_Angle
Used only for Arcs: Arc angle in 1/10 deg.
void TransformOvalClearanceToPolygon(SHAPE_POLY_SET &aCornerBuffer, wxPoint aStart, wxPoint aEnd, int aWidth, int aCircleToSegmentsCount, double aCorrectionFactor)
convert a oblong shape to a polygon, using multiple segments It is similar to TransformRoundedEndsSeg...
bool IsPolyShapeValid() const
wxPoint m_BezierC1
Bezier Control Point 1.
const wxPoint & GetArcStart() const
wxPoint m_Start
Line start point or Circle and Arc center.
wxPoint m_End
Line end point or circle and arc start point.
double GetOrientation() const
Definition: class_module.h:189
Arcs (with rounded ends)
STROKE_T m_Shape
Shape: line, Circle, Arc.
Bezier Curve.
int NewOutline()
Creates a new empty polygon in the set and returns its index
void TransformRingToPolygon(SHAPE_POLY_SET &aCornerBuffer, wxPoint aCentre, int aRadius, int aCircleToSegmentsCount, int aWidth)
Function TransformRingToPolygon Creates a polygon from a ring Convert arcs to multiple straight segme...
Bezier curves to polygon converter.
Definition: bezier_curves.h:35
void TransformArcToPolygon(SHAPE_POLY_SET &aCornerBuffer, wxPoint aCentre, wxPoint aStart, double aArcAngle, int aCircleToSegmentsCount, int aWidth)
Function TransformArcToPolygon Creates a polygon from an Arc Convert arcs to multiple straight segmen...
wxPoint m_BezierC2
Bezier Control Point 2.
MODULE * GetParentModule() const
Function GetParentModule returns a pointer to the parent module, or NULL if DRAWSEGMENT does not belo...
int m_Width
thickness of lines ...
int GetRadius() const
Function GetRadius returns the radius of this item Has meaning only for arc and circle.
const wxPoint GetPosition() const override
Definition: class_module.h:184
int Append(int x, int y, int aOutline=-1, int aHole=-1, bool aAllowDuplication=false)
Appends a vertex at the end of the given outline/hole (default: the last outline) ...
KICAD_T EDA_ITEM::Type ( ) const
inlineinherited

Function Type()

returns the type of object. This attribute should never be changed after a constructor sets it, so there is no public "setter" method.

Returns
KICAD_T - the type of object.

Definition at line 201 of file base_struct.h.

References EDA_ITEM::m_StructType.

Referenced by Abort_Move_ModuleOutline(), abortMoveItem(), AbortPinMove(), MODULE::Add(), CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), CN_CLUSTER::Add(), PCB_EDIT_FRAME::Add45DegreeSegment(), SCH_SCREEN::addConnectedItemsToBlock(), POINT_EDITOR::addCorner(), SCH_EDIT_FRAME::addCurrentItemToScreen(), AddMenusForComponent(), AddMenusForEditComponent(), SCH_SHEET::AddPin(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), CN_ITEM::AnchorCount(), PCB_EDIT_FRAME::Attribut_Track(), PCB_EDIT_FRAME::Begin_Route(), SCH_EDIT_FRAME::BeginSegment(), PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Block_Duplicate(), PCB_EDIT_FRAME::Block_Flip(), PCB_EDIT_FRAME::Block_Move(), PCB_EDIT_FRAME::Block_Rotate(), LIB_EDIT_FRAME::BlockCopySelectedItems(), HIERARCHY_NAVIG_DLG::buildHierarchyTree(), SCH_SCREENS::buildScreenList(), SCH_SHEET_LIST::BuildSheetList(), calcArea(), calcMaxArea(), POINT_EDITOR::canAddCorner(), SCH_NO_CONNECT::CanConnect(), SCH_JUNCTION::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LABEL::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SHEET::CanConnect(), SCH_COMPONENT::CanConnect(), ROUTER_TOOL::CanInlineDrag(), SCH_SCREENS::ChangeSymbolLibNickname(), SCH_EDIT_FRAME::CheckListConnections(), CN_VISITOR::checkZoneItemConnection(), TEXTE_PCB::ClassOf(), EDGE_MODULE::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), PCB_TARGET::ClassOf(), TEXTE_MODULE::ClassOf(), ClassOf(), ZONE_CONTAINER::ClassOf(), MARKER_PCB::ClassOf(), TRACK::ClassOf(), DIMENSION::ClassOf(), NETINFO_ITEM::ClassOf(), MODULE::ClassOf(), D_PAD::ClassOf(), BOARD::ClassOf(), VIA::ClassOf(), SCH_SHEET::CleanupSheet(), Collect_TrackSegmentsToDrag(), LIB_BEZIER::compare(), LIB_CIRCLE::compare(), LIB_RECTANGLE::compare(), LIB_POLYLINE::compare(), LIB_TEXT::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), SCH_SHEET::ComponentCount(), GRID_HELPER::computeAnchors(), SCH_SCREEN::CountConnectedItems(), SCH_SHEET::CountSheets(), MODULE::CoverageRatio(), LIB_EDIT_FRAME::CreateGraphicItem(), CINFO3D_VISU::createLayers(), BOARD::CreateLockPoint(), SCH_EDIT_FRAME::CreateNewText(), CINFO3D_VISU::createNewTrack(), PCB_EDIT_FRAME::createPopupMenuForTracks(), CreateRoutesSection(), PCB_EDITOR_CONTROL::CrossProbeSchToPcb(), D_PAD::D_PAD(), FOOTPRINT_EDIT_FRAME::Delete_Edge_Module(), SCH_SCREENS::DeleteAllMarkers(), SCH_SCREEN::DeleteItem(), LIB_EDIT_FRAME::deleteItem(), SCH_EDIT_FRAME::DeleteItem(), DeleteNullTrackSegments(), PYTHON_ACTION_PLUGINS::deregister_action(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_ERC::DisplayERC_MarkersList(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), DRC::doTrackDrc(), DRC::doTrackKeepoutDrc(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), DrawMovePin(), DrawMovingBlockOutlines(), drawPickedItems(), CN_ITEM::Dump(), BOARD::Duplicate(), MODULE::Duplicate(), PCB_EDIT_FRAME::duplicateItems(), SCH_EDIT_FRAME::DuplicateItemsInList(), SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_FRAME::EditSymbolText(), EditToolSelectionFilter(), SCH_EDIT_FRAME::EndSegment(), PCB_EDIT_FRAME::EraseRedundantTrack(), ExitSheet(), find_vias_and_tracks_at(), SCH_EDIT_FRAME::FindComponentAndItem(), NETLIST_EXPORTER::findNextComponent(), NETLIST_EXPORTER::findNextComponentAndCreatePinList(), SCH_SHEET_PATH::FindNextItem(), SCH_SHEET_LIST::FindNextItem(), SCH_SHEET_PATH::FindPreviousItem(), SCH_SHEET_LIST::FindPreviousItem(), EDIT_TOOL::FootprintFilter(), FootprintWriteShape(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), TRACK::GetBestInsertPoint(), BOARD_ITEM::GetBoard(), TRACK::GetBoundingBox(), BOARD_CONNECTED_ITEM::GetClearance(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), NETLIST_OBJECT::GetComponentParent(), SCH_SCREEN::GetConnection(), SCH_TEXT::GetConnectionPoints(), SCH_TEXT::GetEndPoints(), SCH_SHEET::GetEndPoints(), GetFirstTrack(), GetFirstVia(), SCH_SCREEN::GetHierarchicalItems(), SCH_SCREENS::GetLibNicknames(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), BOARD_CONNECTED_ITEM::GetNetClass(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), GetParentModule(), SCH_SCREEN::GetPin(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), getRect(), SELECTION::GetTopLeftItem(), LIB_EDIT_FRAME::GlobalSetPins(), SELECTION_TOOL::guessSelectionCandidates(), hash_eda(), SCH_SCREENS::HasNoFullyDefinedLibIds(), SCH_SHEET::HasUndefinedPins(), SELECTION_TOOL::highlight(), SCH_EDIT_FRAME::ImportSheetPin(), ROUTER_TOOL::InlineDrag(), SCH_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), SCH_FIND_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), CN_ANCHOR::IsDangling(), SCH_COLLECTOR::IsNode(), TRACK::IsNull(), SCH_LINE::IsParallel(), SCH_SCREEN::IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), CLIPBOARD_IO::Load(), PNS_PCBNEW_RULE_RESOLVER::localPadClearance(), SCH_EDIT_FRAME::LocateAndShowItem(), SCH_EDIT_FRAME::LocateItem(), SCH_SHEET::LocatePathOfScreen(), Magnetize(), EDIT_POINTS_FACTORY::Make(), SCH_SCREEN::MarkConnections(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), MarkItemsInBloc(), BOARD::MarkTrace(), TRACKS_CLEANER::mergeCollinearSegmentIfPossible(), TRACKS_CLEANER::MergeCollinearTracks(), SCH_LINE::MergeOverlap(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), moveItemWithMouseCursor(), MoveMarkedItems(), MoveMarkedItemsExactly(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), SCH_EDIT_FRAME::OnDragItem(), LIB_EDIT_FRAME::OnEditComponentProperties(), SCH_EDIT_FRAME::OnEditItem(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), SCH_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotkeyCopyItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyDeleteItem(), PCB_EDIT_FRAME::OnHotkeyDeleteItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyDuplicateItem(), PCB_EDIT_FRAME::OnHotkeyDuplicateOrArrayItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyFlipItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyMoveItem(), PCB_EDIT_FRAME::OnHotkeyMoveItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyMoveItemExact(), PCB_EDIT_FRAME::OnHotkeyPlaceItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyRotateItem(), PCB_EDIT_FRAME::OnHotkeyRotateItem(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftDClick(), LIB_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnMoveItem(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_EDIT_FRAME::OnOrient(), FOOTPRINT_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), LIB_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), POINT_EDITOR::OnSelectionChange(), SCH_LINE::operator<(), LIB_ITEM::operator<(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_COMPONENT::operator=(), LIB_ITEM::operator==(), OrCell_Trace(), BOARD_COMMIT::parentObject(), PCBNEW_CONTROL::PasteItemsFromClipboard(), SCH_EDIT_FRAME::PasteListOfItems(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), LIB_EDIT_FRAME::PlacePin(), SCH_FIELD::Plot(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), SCH_EDIT_FRAME::PrepareMoveItem(), GAL_ARRAY_CREATOR::prePushAction(), LIB_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_FRAME::Process_Special_Functions(), PCB_EDIT_FRAME::Process_Special_Functions(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), DIALOG_EXCHANGE_FOOTPRINTS::processMatchingModules(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_BASE_FRAME::RefreshItem(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), MODULE::Remove(), CN_CONNECTIVITY_ALGO::Remove(), BOARD::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), TRACKS_CLEANER::removeDuplicatesOfTrack(), SCH_SHEET::RemovePin(), FOOTPRINT_EDIT_FRAME::RemoveStruct(), PCB_EDIT_FRAME::RemoveStruct(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_SCREEN::ReplaceWires(), PCB_BASE_FRAME::ResetTextSize(), SCH_EDIT_FRAME::ReSizeSheet(), BOARD_COMMIT::Revert(), SCH_TEXT::Rotate(), SCH_EDIT_FRAME::RotateField(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_EDIT_FRAME::SaveUndoItemInUndoList(), SCH_EDIT_FRAME::SaveWireImage(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_SHEET::SearchHierarchy(), SELECTION_TOOL::select(), SELECTION_TOOL::selectable(), SCH_SCREEN::SelectBlockItems(), PCB_EDIT_FRAME::SelectHighLight(), ITEM_PICKER::SetItem(), SetSchItemParent(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), PCB_EDIT_FRAME::Show_1_Ratsnest(), Show_MoveNode(), ShowClearance(), ShowNewTrackWhenMovingCursor(), SortByTimeStamp(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), LIB_EDIT_FRAME::StartMoveDrawSymbol(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), PCB_TARGET::SwapData(), SCH_BITMAP::SwapData(), SCH_FIELD::SwapData(), SCH_SHEET_PIN::SwapData(), TEXTE_PCB::SwapData(), DIMENSION::SwapData(), SwapData(), TRACK::SwapData(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), VIA::SwapData(), ZONE_CONTAINER::SwapData(), MODULE::SwapData(), D_PAD::SwapData(), SwapItemData(), PCB_EDIT_FRAME::SwitchLayer(), TestDuplicateSheetNames(), TRACKS_CLEANER::testTrackEndpointDangling(), TEXTE_MODULE::TEXTE_MODULE(), AR_MATRIX::TraceSegmentPcb(), TraceSegmentPcb(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), SELECTION_TOOL::unhighlight(), SCH_SHEET_PATH::UpdateAllScreenReferences(), SCH_TEXT::UpdateDanglingState(), POINT_EDITOR::updateItem(), POINT_EDITOR::updatePoints(), PCB_BRIGHT_BOX::ViewDraw(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), EDA_ITEM::Visit(), SCH_SHEET::Visit(), and SCH_COMPONENT::Visit().

202  {
203  return m_StructType;
204  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it...
Definition: base_struct.h:163
void BOARD_ITEM::UnLink ( )
virtualinherited

Function UnLink detaches this object from its owner.

This base class implementation should work for all derived classes which are held in a DLIST<>.

Definition at line 54 of file class_board_item.cpp.

References EDA_ITEM::GetList().

Referenced by PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Delete_Segment_Edge(), PCB_EDIT_FRAME::Delete_Texte_Pcb(), PCB_EDIT_FRAME::DeleteDimension(), PCB_EDIT_FRAME::DeleteTarget(), PCB_EDIT_FRAME::EraseRedundantTrack(), BOARD::MarkTrace(), and BOARD_ITEM::SetLocked().

55 {
57  wxASSERT( list );
58 
59  if( list )
60  list->Remove( this );
61 }
DHEAD * GetList() const
Definition: base_struct.h:212
const BOX2I DRAWSEGMENT::ViewBBox ( ) const
overridevirtual

Function ViewBBox() returns the bounding box of the item covering all its layers.

Returns
BOX2I - the current bounding box

Reimplemented from EDA_ITEM.

Definition at line 820 of file class_drawsegment.cpp.

References computeArcBBox(), EDA_RECT::GetOrigin(), EDA_RECT::GetSize(), m_End, m_Shape, S_ARC, EDA_RECT::SetOrigin(), and EDA_ITEM::ViewBBox().

Referenced by GetLength().

821 {
822  // For arcs - do not include the center point in the bounding box,
823  // it is redundant for displaying an arc
824  if( m_Shape == S_ARC )
825  {
826  EDA_RECT bbox;
827  bbox.SetOrigin( m_End );
828  computeArcBBox( bbox );
829  return BOX2I( bbox.GetOrigin(), bbox.GetSize() );
830  }
831 
832  return EDA_ITEM::ViewBBox();
833 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:520
const wxPoint GetOrigin() const
Definition: eda_rect.h:112
const wxSize GetSize() const
Definition: eda_rect.h:101
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:124
wxPoint m_End
Line end point or circle and arc start point.
Arcs (with rounded ends)
STROKE_T m_Shape
Shape: line, Circle, Arc.
void computeArcBBox(EDA_RECT &aBBox) const
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
virtual const BOX2I ViewBBox() const override
Function ViewBBox() returns the bounding box of the item covering all its layers. ...
virtual void KIGFX::VIEW_ITEM::ViewDraw ( int  aLayer,
VIEW aView 
) const
inlinevirtualinherited

Function ViewDraw() Draws the parts of the object belonging to layer aLayer.

viewDraw() is an alternative way for drawing objects if if there is no PAINTER assigned for the view or if the PAINTER doesn't know how to paint this particular implementation of VIEW_ITEM. The preferred way of drawing is to design an appropriate PAINTER object, the method below is intended only for quick hacks and debugging purposes.

Parameters
aLayercurrent drawing layer
aViewpointer to the VIEW device we are drawing on

Reimplemented in EDIT_POINTS, KIGFX::WORKSHEET_VIEWITEM, ROUTER_PREVIEW_ITEM, KIGFX::VIEW_GROUP, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, KIGFX::VIEW_OVERLAY, KIGFX::ORIGIN_VIEWITEM, BRIGHT_BOX, KIGFX::PREVIEW::RULER_ITEM, KIGFX::RATSNEST_VIEWITEM, KIGFX::PREVIEW::ARC_ASSISTANT, and PCB_BRIGHT_BOX.

Definition at line 116 of file view_item.h.

References KIGFX::VIEW_ITEM::ViewGetLayers().

Referenced by KIGFX::VIEW::draw(), and KIGFX::VIEW::updateItemGeometry().

117  {}
void BOARD_ITEM::ViewGetLayers ( int  aLayers[],
int &  aCount 
) const
overridevirtualinherited

Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on.

For instance, a D_PAD spans zero or more copper layers and a few technical layers. ViewDraw() or PAINTER::Draw() is repeatedly called for each of the layers returned by ViewGetLayers(), depending on the rendering order.

Parameters
aLayers[]output layer index array
aCountnumber of layer indices in aLayers[]

Reimplemented from EDA_ITEM.

Reimplemented in D_PAD, MODULE, VIA, TRACK, TEXTE_MODULE, ZONE_CONTAINER, MARKER_PCB, and KIGFX::ORIGIN_VIEWITEM.

Definition at line 199 of file class_board_item.cpp.

References BOARD_ITEM::m_Layer.

Referenced by BOARD_ITEM::HitTest(), and SELECTION_TOOL::selectable().

200 {
201  // Basic fallback
202  aCount = 1;
203  aLayers[0] = m_Layer;
204 }
PCB_LAYER_ID m_Layer
virtual unsigned int KIGFX::VIEW_ITEM::ViewGetLOD ( int  aLayer,
VIEW aView 
) const
inlinevirtualinherited

Function ViewGetLOD() Returns the level of detail (LOD) of the item.

A level of detail is the minimal VIEW scale that is sufficient for an item to be shown on a given layer.

Parameters
aLayercurrent drawing layer
aViewpointer to the VIEW device we are drawing on
Returns
the level of detail. 0 always show the item, because the actual zoom level (or VIEW scale) is always > 0

Reimplemented in D_PAD, MODULE, VIA, GERBER_DRAW_ITEM, TRACK, TEXTE_MODULE, and EDGE_MODULE.

Definition at line 140 of file view_item.h.

Referenced by KIGFX::VIEW::drawItem::operator()().

141  {
142  // By default always show the item
143  return 0;
144  }
SEARCH_RESULT EDA_ITEM::Visit ( INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
virtualinherited

Function Visit may be re-implemented for each derived class in order to handle all the types given by its member data.

Implementations should call inspector->Inspect() on types in scanTypes[], and may use IterateForward() to do so on lists of such data.

Parameters
inspectorAn INSPECTOR instance to use in the inspection.
testDataArbitrary data used by the inspector.
scanTypesWhich KICAD_T types are of interest and the order is significant too, terminated by EOT.
Returns
SEARCH_RESULT SEARCH_QUIT if the Iterator is to stop the scan, else SCAN_CONTINUE, and determined by the inspector.

Reimplemented in BOARD, MODULE, SCH_COMPONENT, SCH_SHEET, GERBER_FILE_IMAGE, GERBER_DRAW_ITEM, TRACK, and GBR_LAYOUT.

Definition at line 149 of file base_struct.cpp.

References EOT, EDA_ITEM::GetClass(), SEARCH_CONTINUE, SEARCH_QUIT, and EDA_ITEM::Type().

Referenced by SCH_SHEET::CanConnect(), GERBER_COLLECTOR::Collect(), GENERAL_COLLECTOR::Collect(), PCB_TYPE_COLLECTOR::Collect(), PCB_LAYER_COLLECTOR::Collect(), EDA_ITEM::HitTest(), and EDA_ITEM::IterateForward().

150 {
151  KICAD_T stype;
152 
153 #if 0 && defined(DEBUG)
154  std::cout << GetClass().mb_str() << ' ';
155 #endif
156 
157  for( const KICAD_T* p = scanTypes; (stype = *p) != EOT; ++p )
158  {
159  // If caller wants to inspect my type
160  if( stype == Type() )
161  {
162  if( SEARCH_QUIT == inspector( this, testData ) )
163  return SEARCH_QUIT;
164 
165  break;
166  }
167  }
168 
169  return SEARCH_CONTINUE;
170 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
virtual wxString GetClass() const =0
Function GetClass returns the class name.

Member Data Documentation

double DRAWSEGMENT::m_Angle
protected

Used only for Arcs: Arc angle in 1/10 deg.

Definition at line 56 of file class_drawsegment.h.

Referenced by computeArcBBox(), EDGE_MODULE::Draw(), Draw(), DRAWSEGMENT(), EDGE_MODULE::EDGE_MODULE(), Flip(), GetAngle(), GetArcEnd(), GetMsgPanelInfo(), and SetAngle().

wxPoint DRAWSEGMENT::m_BezierC1
protected
wxPoint DRAWSEGMENT::m_BezierC2
protected
std::vector<wxPoint> DRAWSEGMENT::m_BezierPoints
protected
STATUS_FLAGS EDA_ITEM::m_Flags
protectedinherited

Flag bits for editing and other uses.

Definition at line 178 of file base_struct.h.

Referenced by LIB_CIRCLE::BeginEdit(), LIB_RECTANGLE::BeginEdit(), LIB_POLYLINE::BeginEdit(), LIB_TEXT::BeginEdit(), LIB_ARC::BeginEdit(), LIB_FIELD::BeginEdit(), LIB_CIRCLE::CalcEdit(), LIB_POLYLINE::CalcEdit(), LIB_RECTANGLE::CalcEdit(), LIB_TEXT::CalcEdit(), LIB_ARC::CalcEdit(), LIB_FIELD::CalcEdit(), LIB_PIN::CalcEdit(), LIB_TEXT::Clone(), LIB_CIRCLE::ContinueEdit(), LIB_RECTANGLE::ContinueEdit(), LIB_POLYLINE::ContinueEdit(), LIB_TEXT::ContinueEdit(), LIB_ARC::ContinueEdit(), LIB_FIELD::ContinueEdit(), SCH_LINE::Draw(), TRACK::Draw(), Draw(), MODULE::Draw(), SEGZONE::Draw(), LIB_CIRCLE::drawGraphic(), LIB_POLYLINE::drawGraphic(), LIB_RECTANGLE::drawGraphic(), LIB_BEZIER::drawGraphic(), LIB_ARC::drawGraphic(), DRAWSEGMENT(), LIB_CIRCLE::EndEdit(), LIB_RECTANGLE::EndEdit(), LIB_POLYLINE::EndEdit(), LIB_TEXT::EndEdit(), LIB_ARC::EndEdit(), LIB_ITEM::EndEdit(), LIB_FIELD::EndEdit(), EDA_ITEM::GetFlags(), TRACK::GetMsgPanelInfoBase_Common(), SCH_JUNCTION::HitTest(), SCH_LINE::HitTest(), GERBER_DRAW_ITEM::HitTest(), SCH_COMPONENT::HitTest(), LIB_ITEM::InEditMode(), EDA_ITEM::initVars(), SCH_ITEM::IsConnected(), SCH_LINE::Move(), EDA_ITEM::operator=(), SCH_COMPONENT::SCH_COMPONENT(), LIB_PIN::SetConversion(), LIB_PIN::SetLength(), LIB_PIN::SetName(), LIB_PIN::SetNameTextSize(), LIB_PIN::SetNumberTextSize(), LIB_PIN::SetOrientation(), LIB_PIN::SetPartNumber(), LIB_PIN::SetPinPosition(), LIB_PIN::SetShape(), LIB_PIN::SetType(), and LIB_PIN::SetVisible().

bool EDA_ITEM::m_forceVisible
protectedinherited

Set to true to override the visibility setting of the item.

Definition at line 175 of file base_struct.h.

Referenced by SCH_FIELD::Draw(), EDA_ITEM::initVars(), and EDA_ITEM::operator=().

DHEAD* EDA_ITEM::m_List
protectedinherited

which DLIST I am on.

Definition at line 169 of file base_struct.h.

Referenced by EDA_ITEM::GetList(), and EDA_ITEM::initVars().

timestamp_t EDA_ITEM::m_TimeStamp
protectedinherited
int DRAWSEGMENT::m_Type
protected

Used in complex associations ( Dimensions.. )

Definition at line 55 of file class_drawsegment.h.

Referenced by DRAWSEGMENT(), and GetType().

int DRAWSEGMENT::m_Width
protected
EDA_ITEM* EDA_ITEM::Pback
protectedinherited

previous in linked list

Definition at line 168 of file base_struct.h.

Referenced by SCH_LINE::Back(), TRACK::Back(), BOARD_ITEM::Back(), EDA_ITEM::Back(), EDA_ITEM::initVars(), and TRACK::SetBack().


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