KiCad PCB EDA Suite
GERBER_FILE_IMAGE Class Reference

GERBER_FILE_IMAGE holds the Image data and parameters for one gerber file and layer parameters (TODO: move them in GERBER_LAYER class. More...

#include <gerber_file_image.h>

Inheritance diagram for GERBER_FILE_IMAGE:
EDA_ITEM KIGFX::VIEW_ITEM EXCELLON_IMAGE

Public Member Functions

 GERBER_FILE_IMAGE (int layer)
 
virtual ~GERBER_FILE_IMAGE ()
 
wxString GetClass () const override
 Function GetClass returns the class name. More...
 
bool LoadGerberFile (const wxString &aFullFileName)
 Read and load a gerber file. More...
 
const wxArrayString & GetMessages () const
 
int GetDcodesCount ()
 
virtual void ResetDefaultValues ()
 
COLOR4D GetPositiveDrawColor () const
 
GERBER_DRAW_ITEMSGetItems ()
 
int GetItemsCount ()
 
void AddItemToList (GERBER_DRAW_ITEM *aItem)
 Add a new GERBER_DRAW_ITEM item to the drawings list. More...
 
GERBER_DRAW_ITEMGetLastItemInList () const
 
GERBER_LAYERGetLayerParams ()
 Function GetLayerParams. More...
 
bool HasNegativeItems ()
 Function HasNegativeItems. More...
 
void ClearMessageList ()
 Function ClearMessageList Clear the message list Call it before reading a Gerber file. More...
 
void AddMessageToList (const wxString &aMessage)
 Function AddMessageToList Add a message to the message list. More...
 
void InitToolTable ()
 Function InitToolTable. More...
 
wxPoint ReadXYCoord (char *&aText, bool aExcellonMode=false)
 Function ReadXYCoord Returns the current coordinate type pointed to by XnnYnn Text (XnnnnYmmmm) More...
 
wxPoint ReadIJCoord (char *&Text)
 Returns the current coordinate type pointed to by InnJnn Text (InnnnJmmmm) These coordinates are relative, so if coordinate is absent, it's value defaults to 0. More...
 
int GCodeNumber (char *&Text)
 
int DCodeNumber (char *&Text)
 
D_CODEGetDCODEOrCreate (int aDCODE, bool aCreateIfNoExist=true)
 Function GetDCODEOrCreate returns a pointer to the D_CODE within this GERBER for the given aDCODE. More...
 
D_CODEGetDCODE (int aDCODE) const
 Function GetDCODE returns a pointer to the D_CODE within this GERBER for the given aDCODE. More...
 
APERTURE_MACROFindApertureMacro (const APERTURE_MACRO &aLookup)
 Function FindApertureMacro looks up a previously read in aperture macro. More...
 
void StepAndRepeatItem (const GERBER_DRAW_ITEM &aItem)
 Function StepAndRepeatItem Gerber format has a command Step an Repeat This function must be called when reading a gerber file and after creating a new gerber item that must be repeated (i.e when m_XRepeatCount or m_YRepeatCount are > 1) More...
 
void DisplayImageInfo (GERBVIEW_FRAME *aMainFrame)
 Function DisplayImageInfo has knowledge about the frame and how and where to put status information about this object into the frame's message panel. More...
 
void RemoveAttribute (X2_ATTRIBUTE &aAttribute)
 Function RemoveAttribute. More...
 
SEARCH_RESULT Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[]) override
 

More...
 
KICAD_T Type () const
 Function Type() More...
 
EDA_ITEMGetParent () const
 
void SetParent (EDA_ITEM *aParent)
 
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 HasFlag (STATUS_FLAGS aFlag)
 
STATUS_FLAGS GetEditFlags () const
 
void ClearTempFlags ()
 
void ClearEditFlags ()
 
virtual bool IsType (const KICAD_T aScanTypes[]) const
 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 void GetMsgPanelInfo (EDA_UNITS aUnits, std::vector< MSG_PANEL_ITEM > &aList)
 Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
 
virtual bool HitTest (const wxPoint &aPosition, int aAccuracy=0) const
 Function HitTest tests if aPosition is contained within or on the bounding box of an item. More...
 
virtual bool HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const
 Function HitTest tests if aRect intersects or is contained within the bounding box of an item. More...
 
virtual const EDA_RECT GetBoundingBox () const
 Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes. More...
 
virtual EDA_ITEMClone () const
 Function Clone creates a duplicate of this item with linked list members set to NULL. More...
 
virtual wxString GetSelectMenuText (EDA_UNITS aUnits) const
 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
 Function GetMenuImage returns a pointer to an image to be used in menus. More...
 
virtual bool Matches (wxFindReplaceData &aSearchData, void *aAuxData)
 Function Matches compares the item against the search criteria in aSearchData. 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 const BOX2I ViewBBox () const override
 Function ViewBBox() returns the bounding box of the item covering all its layers. 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...
 
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
 
void ClearViewPrivData ()
 

Static Public Member Functions

template<class T >
static SEARCH_RESULT IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T ) More...
 
template<class T >
static SEARCH_RESULT IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T ) More...
 
static 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...
 
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...
 

Public Attributes

bool m_InUse
 
bool m_IsVisible
 
COLOR4D m_PositiveDrawColor
 
wxString m_FileName
 
wxString m_ImageName
 
bool m_IsX2_file
 
X2_ATTRIBUTE_FILEFUNCTIONm_FileFunction
 
wxString m_MD5_value
 
wxString m_PartString
 
int m_GraphicLayer
 
bool m_ImageNegative
 
bool m_ImageJustifyXCenter
 
bool m_ImageJustifyYCenter
 
wxPoint m_ImageJustifyOffset
 
bool m_GerbMetric
 
bool m_Relative
 
bool m_NoTrailingZeros
 
wxPoint m_ImageOffset
 
wxSize m_FmtScale
 
wxSize m_FmtLen
 
int m_ImageRotation
 
double m_LocalRotation
 
wxPoint m_Offset
 
wxRealPoint m_Scale
 
bool m_SwapAxis
 
bool m_MirrorA
 
bool m_MirrorB
 
int m_Iterpolation
 
int m_Current_Tool
 
int m_Last_Pen_Command
 
int m_CommandState
 
int m_LineNum
 
wxPoint m_CurrentPos
 
wxPoint m_PreviousPos
 
wxPoint m_IJPos
 
bool m_LastCoordIsIJPos
 
int m_ArcRadius
 
LAST_EXTRA_ARC_DATA_TYPE m_LastArcDataType
 
FILE * m_Current_File
 
int m_Selected_Tool
 
bool m_Has_DCode
 
bool m_Has_MissingDCode
 
bool m_360Arc_enbl
 
bool m_PolygonFillMode
 
int m_PolygonFillModeState
 
APERTURE_MACRO_SET m_aperture_macros
 a collection of APERTURE_MACROS, sorted by name More...
 
GBR_NETLIST_METADATA m_NetAttributeDict
 
wxString m_AperFunction
 
std::map< wxString, int > m_ComponentsList
 
std::map< wxString, int > m_NetnamesList
 
const KIID m_Uuid
 

Protected Member Functions

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

Protected Attributes

EDA_ITEMm_Parent
 Linked list: Link (parent struct) 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...
 

Private Member Functions

char * GetNextLine (char *aBuff, unsigned int aBuffSize, char *aText, FILE *aFile)
 test for an end of line if a end of line is found: read a new line More...
 
bool GetEndOfBlock (char *aBuff, unsigned int aBuffSize, char *&aText, FILE *aGerberFile)
 
bool ReadRS274XCommand (char *aBuff, unsigned int aBuffSize, char *&aText)
 reads a single RS274X command terminated with a % More...
 
bool ExecuteRS274XCommand (int aCommand, char *aBuff, unsigned int aBuffSize, char *&aText)
 executes a RS274X command More...
 
int ReadXCommandID (char *&text)
 reads two bytes of data and assembles them into an int with the first byte in the sequence put into the most significant part of a 16 bit value to build a RS274X command identifier. More...
 
bool ReadApertureMacro (char *aBuff, unsigned int aBuffSize, char *&text, FILE *gerber_file)
 reads in an aperture macro and saves it in m_aperture_macros. More...
 
bool Execute_G_Command (char *&text, int G_command)
 
bool Execute_DCODE_Command (char *&text, int D_command)
 

Private Attributes

D_CODEm_Aperture_List [TOOLS_MAX_COUNT]
 Dcode (Aperture) List for this layer (max TOOLS_MAX_COUNT: see dcode.h) More...
 
bool m_Exposure
 whether an aperture macro tool is flashed on or off More...
 
GERBER_LAYER m_GBRLayerParams
 
GERBER_DRAW_ITEMS m_drawings
 
wxArrayString m_messagesList
 
int m_hasNegativeItems
 

Detailed Description

GERBER_FILE_IMAGE holds the Image data and parameters for one gerber file and layer parameters (TODO: move them in GERBER_LAYER class.

Definition at line 109 of file gerber_file_image.h.

Constructor & Destructor Documentation

◆ GERBER_FILE_IMAGE()

GERBER_FILE_IMAGE::GERBER_FILE_IMAGE ( int  layer)

Definition at line 89 of file gerber_file_image.cpp.

89  :
91 {
92  m_GraphicLayer = aLayer; // Graphic layer Number
93  m_IsVisible = true; // must be drawn
94  m_PositiveDrawColor = WHITE; // The color used to draw positive items for this image
95 
96  m_Selected_Tool = 0;
97  m_FileFunction = NULL; // file function parameters
98 
100 
101  for( unsigned ii = 0; ii < arrayDim( m_Aperture_List ); ii++ )
102  m_Aperture_List[ii] = 0;
103 }
X2_ATTRIBUTE_FILEFUNCTION * m_FileFunction
D_CODE * m_Aperture_List[TOOLS_MAX_COUNT]
Dcode (Aperture) List for this layer (max TOOLS_MAX_COUNT: see dcode.h)
#define NULL
EDA_ITEM(EDA_ITEM *parent, KICAD_T idType)
Definition: base_struct.cpp:62
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Definition: macros.h:108
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:166
Definition: colors.h:49
virtual void ResetDefaultValues()

References arrayDim(), m_Aperture_List, m_FileFunction, m_GraphicLayer, m_IsVisible, m_PositiveDrawColor, m_Selected_Tool, NULL, ResetDefaultValues(), and WHITE.

◆ ~GERBER_FILE_IMAGE()

GERBER_FILE_IMAGE::~GERBER_FILE_IMAGE ( )
virtual

Definition at line 106 of file gerber_file_image.cpp.

107 {
108 
109  for( auto item : GetItems() )
110  delete item;
111 
112  m_drawings.clear();
113 
114  for( unsigned ii = 0; ii < arrayDim( m_Aperture_List ); ii++ )
115  {
116  delete m_Aperture_List[ii];
117  }
118 
119  delete m_FileFunction;
120 }
X2_ATTRIBUTE_FILEFUNCTION * m_FileFunction
GERBER_DRAW_ITEMS & GetItems()
D_CODE * m_Aperture_List[TOOLS_MAX_COUNT]
Dcode (Aperture) List for this layer (max TOOLS_MAX_COUNT: see dcode.h)
GERBER_DRAW_ITEMS m_drawings
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Definition: macros.h:108

References arrayDim(), GetItems(), m_Aperture_List, m_drawings, and m_FileFunction.

Member Function Documentation

◆ AddItemToList()

void GERBER_FILE_IMAGE::AddItemToList ( GERBER_DRAW_ITEM aItem)
inline

Add a new GERBER_DRAW_ITEM item to the drawings list.

Parameters
aItemis the GERBER_DRAW_ITEM to add to list

Definition at line 288 of file gerber_file_image.h.

289  {
290  m_drawings.push_back( aItem );
291  }
GERBER_DRAW_ITEMS m_drawings

References m_drawings.

Referenced by Execute_DCODE_Command(), EXCELLON_IMAGE::Execute_Drill_Command(), EXCELLON_IMAGE::FinishRouteCommand(), and StepAndRepeatItem().

◆ AddMessageToList()

void GERBER_FILE_IMAGE::AddMessageToList ( const wxString &  aMessage)
inline

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )
inlineinherited

Definition at line 237 of file base_struct.h.

237 { ClearFlags( BRIGHTENED ); }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:143
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:258

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PCB_BASE_FRAME::FocusOnItem(), SCH_BASE_FRAME::FocusOnItem(), EE_SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlight(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )
inlineinherited

◆ ClearFlags()

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

Definition at line 258 of file base_struct.h.

258 { m_Flags &= ~aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189

References EDA_ITEM::m_Flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_COMPONENT::ClearAllHighlightFlags(), SCH_SCREEN::ClearAnnotation(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearHighlighted(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), SCH_EDIT_FRAME::ConvertPart(), LIB_EDIT_TOOL::Copy(), MWAVE::CreateMicrowaveInductor(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), LIB_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::Exchange_Module(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), KIGFX::SCH_VIEW::HighlightItem(), MODULE_EDITOR_TOOLS::ImportFootprint(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), FOOTPRINT_EDIT_FRAME::LoadModuleFromLibrary(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceModule(), LIB_PIN_TOOL::PlacePin(), DRAWING_TOOL::PlaceText(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), LIB_EDIT_FRAME::RollbackPartFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), EE_SELECTION_TOOL::SelectPoint(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ ClearHighlighted()

void EDA_ITEM::ClearHighlighted ( )
inlineinherited

Definition at line 236 of file base_struct.h.

236 { ClearFlags( HIGHLIGHTED ); }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:142
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:258

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

◆ ClearMessageList()

void GERBER_FILE_IMAGE::ClearMessageList ( )
inline

Function ClearMessageList Clear the message list Call it before reading a Gerber file.

Definition at line 323 of file gerber_file_image.h.

324  {
325  m_messagesList.Clear();
326  }
wxArrayString m_messagesList

References m_messagesList.

Referenced by EXCELLON_IMAGE::LoadFile(), and LoadGerberFile().

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )
inlineinherited

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 270 of file base_struct.h.

271  {
273  }
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: base_struct.h:117
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:131
#define CANDIDATE
flag indicating that the structure is connected
Definition: base_struct.h:130
#define ENDPOINT
ends. (Used to support dragging.)
Definition: base_struct.h:126
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:258
#define DO_NOT_DRAW
Used to disable draw function.
Definition: base_struct.h:132
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: base_struct.h:125

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

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )
inlineinherited

Definition at line 153 of file view_item.h.

154  {
156  }
VIEW_ITEM_DATA * m_viewPrivData
Definition: view_item.h:161
#define NULL

References KIGFX::VIEW_ITEM::m_viewPrivData, and NULL.

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

◆ Clone()

EDA_ITEM * EDA_ITEM::Clone ( ) const
virtualinherited

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 in MODULE_ZONE_CONTAINER, D_PAD, ZONE_CONTAINER, SCH_COMPONENT, MODULE, SCH_SHEET, SCH_HIERLABEL, LIB_PIN, SCH_GLOBALLABEL, VIA, SCH_LABEL, ARC, SCH_TEXT, DRAWSEGMENT, DIMENSION, SCH_LINE, TEXTE_MODULE, TRACK, SCH_SHEET_PIN, SCH_BUS_BUS_ENTRY, SCH_FIELD, LIB_FIELD, SCH_BUS_WIRE_ENTRY, SCH_BITMAP, LIB_ARC, EDGE_MODULE, TEXTE_PCB, SCH_NO_CONNECT, LIB_POLYLINE, SCH_JUNCTION, SCH_MARKER, LIB_TEXT, PCB_TARGET, LIB_BEZIER, LIB_CIRCLE, LIB_RECTANGLE, and KIGFX::ORIGIN_VIEWITEM.

Definition at line 117 of file base_struct.cpp.

118 {
119  wxCHECK_MSG( false, NULL, wxT( "Clone not implemented in derived class " ) + GetClass() +
120  wxT( ". Bad programmer!" ) );
121 }
#define NULL
virtual wxString GetClass() const =0
Function GetClass returns the class name.

References EDA_ITEM::GetClass(), and NULL.

Referenced by LIB_DRAWING_TOOLS::DrawShape(), LIB_EDIT_TOOL::Duplicate(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), LIB_PART::LIB_PART(), LIB_EDIT_FRAME::LoadOneSymbol(), new_clone(), LIB_PART::operator=(), LIB_EDIT_TOOL::Paste(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), LIB_PART::SetConversion(), LIB_PART::SetUnitCount(), SCH_DRAWING_TOOLS::SingleClickPlace(), COMMIT::Stage(), LIB_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ DCodeNumber()

int GERBER_FILE_IMAGE::DCodeNumber ( char *&  Text)

Definition at line 434 of file rs274d.cpp.

435 {
436  int ii = 0;
437  char* text;
438  char line[1024];
439 
440  if( Text == NULL )
441  return 0;
442 
443  Text++;
444  text = line;
445  while( IsNumber( *Text ) )
446  *(text++) = *(Text++);
447 
448  *text = 0;
449  ii = atoi( line );
450  return ii;
451 }
#define NULL
#define IsNumber(x)

References IsNumber, and NULL.

Referenced by Execute_G_Command(), LoadGerberFile(), and EXCELLON_IMAGE::TCodeNumber().

◆ DisplayImageInfo()

void GERBER_FILE_IMAGE::DisplayImageInfo ( GERBVIEW_FRAME aMainFrame)

Function DisplayImageInfo has knowledge about the frame and how and where to put status information about this object into the frame's message panel.

Display info about Image Parameters.

Parameters
aMainFrame= the GERBVIEW_FRAME to display messages

Display info about Image Parameters. These parameters are valid for the entire file, and must set only once (If more than once, only the last value is used)

Definition at line 333 of file gerber_file_image.cpp.

334 {
335  wxString msg;
336 
337  aMainFrame->ClearMsgPanel();
338 
339  // Display Image name (Image specific)
340  aMainFrame->AppendMsgPanel( _( "Image name" ), m_ImageName, CYAN );
341 
342  // Display graphic layer number used to draw this Image
343  // (not a Gerber parameter but is also image specific)
344  msg.Printf( wxT( "%d" ), m_GraphicLayer + 1 );
345  aMainFrame->AppendMsgPanel( _( "Graphic layer" ), msg, BROWN );
346 
347  // Display Image rotation (Image specific)
348  msg.Printf( wxT( "%d" ), m_ImageRotation );
349  aMainFrame->AppendMsgPanel( _( "Img Rot." ), msg, CYAN );
350 
351  // Display Image polarity (Image specific)
352  msg = m_ImageNegative ? _("Negative") : _("Normal");
353  aMainFrame->AppendMsgPanel( _( "Polarity" ), msg, BROWN );
354 
355  // Display Image justification and offset for justification (Image specific)
356  msg = m_ImageJustifyXCenter ? _("Center") : _("Normal");
357  aMainFrame->AppendMsgPanel( _( "X Justify" ), msg, DARKRED );
358 
359  msg = m_ImageJustifyYCenter ? _("Center") : _("Normal");
360  aMainFrame->AppendMsgPanel( _( "Y Justify" ), msg, DARKRED );
361 
362  if( aMainFrame->GetUserUnits() == EDA_UNITS::INCHES )
363  msg.Printf( wxT( "X=%f Y=%f" ), Iu2Mils( m_ImageJustifyOffset.x ) / 1000.0,
364  Iu2Mils( m_ImageJustifyOffset.y ) / 1000.0 );
365  else
366  msg.Printf( wxT( "X=%f Y=%f" ), Iu2Millimeter( m_ImageJustifyOffset.x ),
367  Iu2Millimeter( m_ImageJustifyOffset.y ) );
368 
369  aMainFrame->AppendMsgPanel( _( "Image Justify Offset" ), msg, DARKRED );
370 }
Definition: colors.h:54
Definition: colors.h:59
virtual void ClearMsgPanel()
Clear all messages from the message panel.
void AppendMsgPanel(const wxString &textUpper, const wxString &textLower, COLOR4D color, int pad=6)
Append a message to the message panel.
#define _(s)
Definition: 3d_actions.cpp:33
EDA_UNITS GetUserUnits() const
Return the user units currently in use.
Definition: colors.h:62

References _, EDA_DRAW_FRAME::AppendMsgPanel(), BROWN, EDA_DRAW_FRAME::ClearMsgPanel(), CYAN, DARKRED, EDA_BASE_FRAME::GetUserUnits(), INCHES, m_GraphicLayer, m_ImageJustifyOffset, m_ImageJustifyXCenter, m_ImageJustifyYCenter, m_ImageName, m_ImageNegative, m_ImageRotation, wxPoint::x, and wxPoint::y.

Referenced by GERBVIEW_FRAME::UpdateTitleAndInfo().

◆ Execute_DCODE_Command()

bool GERBER_FILE_IMAGE::Execute_DCODE_Command ( char *&  text,
int  D_command 
)
private

Definition at line 582 of file rs274d.cpp.

583 {
584  wxSize size( 15, 15 );
585 
586  APERTURE_T aperture = APT_CIRCLE;
587  GERBER_DRAW_ITEM* gbritem;
588 
589  int dcode = 0;
590  D_CODE* tool = NULL;
591  wxString msg;
592 
593  if( D_commande >= FIRST_DCODE ) // This is a "Set tool" command
594  {
595  if( D_commande > (TOOLS_MAX_COUNT - 1) )
596  D_commande = TOOLS_MAX_COUNT - 1;
597 
598  // remember which tool is selected, nothing is done with it in this
599  // call
600  m_Current_Tool = D_commande;
601 
602  D_CODE* pt_Dcode = GetDCODE( D_commande );
603 
604  if( pt_Dcode )
605  pt_Dcode->m_InUse = true;
606  else
607  m_Has_MissingDCode = true;
608 
609  return true;
610  }
611  else // D_commande = 0..9: this is a pen command (usually D1, D2 or D3)
612  {
613  m_Last_Pen_Command = D_commande;
614  }
615 
616  if( m_PolygonFillMode ) // Enter a polygon description:
617  {
618  switch( D_commande )
619  {
620  case 1: // code D01 Draw line, exposure ON
621  if( !m_Exposure ) // Start a new polygon outline:
622  {
623  m_Exposure = true;
624  gbritem = new GERBER_DRAW_ITEM( this );
625  AddItemToList( gbritem );
626  gbritem->m_Shape = GBR_POLYGON;
627  gbritem->m_Flashed = false;
628  gbritem->m_DCode = 0; // No DCode for a Polygon (Region in Gerber dialect)
629 
630 
631  if( gbritem->m_GerberImageFile )
632  {
634  gbritem->m_AperFunction = gbritem->m_GerberImageFile->m_AperFunction;
635  }
636  }
637 
638  switch( m_Iterpolation )
639  {
642  gbritem = GetLastItemInList();
643 
644  fillArcPOLY( gbritem, m_PreviousPos,
646  ( m_Iterpolation == GERB_INTERPOL_ARC_NEG ) ? false : true,
647  m_360Arc_enbl, GetLayerParams().m_LayerNegative );
648  break;
649 
650  default:
651  gbritem = GetLastItemInList();
652 
653  gbritem->m_Start = m_PreviousPos; // m_Start is used as temporary storage
654  if( gbritem->m_Polygon.OutlineCount() == 0 )
655  {
656  gbritem->m_Polygon.NewOutline();
657  gbritem->m_Polygon.Append( VECTOR2I( gbritem->m_Start ) );
658  }
659 
660  gbritem->m_End = m_CurrentPos; // m_End is used as temporary storage
661  gbritem->m_Polygon.Append( VECTOR2I( gbritem->m_End ) );
662  break;
663  }
664 
667  break;
668 
669  case 2: // code D2: exposure OFF (i.e. "move to")
670  if( m_Exposure && GetLastItemInList() ) // End of polygon
671  {
672  gbritem = GetLastItemInList();
673  gbritem->m_Polygon.Append( gbritem->m_Polygon.CVertex( 0 ) );
674  StepAndRepeatItem( *gbritem );
675  }
676  m_Exposure = false;
679  break;
680 
681  default:
682  return false;
683  }
684  }
685  else
686  {
687  switch( D_commande )
688  {
689  case 1: // code D01 Draw line, exposure ON
690  m_Exposure = true;
691 
692  tool = GetDCODE( m_Current_Tool );
693 
694  if( tool )
695  {
696  size = tool->m_Size;
697  dcode = tool->m_Num_Dcode;
698  aperture = tool->m_Shape;
699  }
700 
701  switch( m_Iterpolation )
702  {
704  gbritem = new GERBER_DRAW_ITEM( this );
705  AddItemToList( gbritem );
706 
707  fillLineGBRITEM( gbritem, dcode, m_PreviousPos,
708  m_CurrentPos, size, GetLayerParams().m_LayerNegative );
709  StepAndRepeatItem( *gbritem );
710  break;
711 
714  gbritem = new GERBER_DRAW_ITEM( this );
715  AddItemToList( gbritem );
716 
717  if( m_LastCoordIsIJPos )
718  {
719  fillArcGBRITEM( gbritem, dcode, m_PreviousPos,
720  m_CurrentPos, m_IJPos, size,
722  false : true, m_360Arc_enbl, GetLayerParams().m_LayerNegative );
723  m_LastCoordIsIJPos = false;
724  }
725  else
726  {
727  fillLineGBRITEM( gbritem, dcode, m_PreviousPos,
728  m_CurrentPos, size, GetLayerParams().m_LayerNegative );
729  }
730 
731  StepAndRepeatItem( *gbritem );
732 
733  break;
734 
735  default:
736  msg.Printf( wxT( "RS274D: DCODE Command: interpol error (type %X)" ),
737  m_Iterpolation );
738  AddMessageToList( msg );
739  break;
740  }
741 
743  break;
744 
745  case 2: // code D2: exposure OFF (i.e. "move to")
746  m_Exposure = false;
748  break;
749 
750  case 3: // code D3: flash aperture
751  tool = GetDCODE( m_Current_Tool );
752  if( tool )
753  {
754  size = tool->m_Size;
755  dcode = tool->m_Num_Dcode;
756  aperture = tool->m_Shape;
757  }
758 
759  gbritem = new GERBER_DRAW_ITEM( this );
760  AddItemToList( gbritem );
761  fillFlashedGBRITEM( gbritem, aperture, dcode, m_CurrentPos,
762  size, GetLayerParams().m_LayerNegative );
763  StepAndRepeatItem( *gbritem );
765  break;
766 
767  default:
768  return false;
769  }
770  }
771 
772  return true;
773 }
void AddMessageToList(const wxString &aMessage)
Function AddMessageToList Add a message to the message list.
int OutlineCount() const
Returns the number of outlines in the set
wxSize m_Size
Horizontal and vertical dimensions.
Definition: dcode.h:94
static void fillArcPOLY(GERBER_DRAW_ITEM *aGbrItem, const wxPoint &aStart, const wxPoint &aEnd, const wxPoint &rel_center, bool aClockwise, bool aMultiquadrant, bool aLayerNegative)
Function fillArcPOLY creates an arc G code when found in poly outlines.
Definition: rs274d.cpp:334
bool m_InUse
false if the aperure (previously defined) is not used to draw something
Definition: dcode.h:102
APERTURE_T m_Shape
shape ( Line, rectangle, circle , oval .. )
Definition: dcode.h:95
const VECTOR2I & CVertex(int aIndex, int aOutline, int aHole) const
Returns the index-th vertex in a given hole outline within a given outline
D_CODE * GetDCODE(int aDCODE) const
Function GetDCODE returns a pointer to the D_CODE within this GERBER for the given aDCODE.
void SetNetAttributes(const GBR_NETLIST_METADATA &aNetAttributes)
void fillLineGBRITEM(GERBER_DRAW_ITEM *aGbrItem, int Dcode_index, const wxPoint &aStart, const wxPoint &aEnd, wxSize aPenSize, bool aLayerNegative)
Function fillLineGBRITEM initializes a given GBRITEM so that it can draw a linear D code.
Definition: rs274d.cpp:158
VECTOR2< int > VECTOR2I
Definition: vector2d.h:594
SHAPE_POLY_SET m_Polygon
GERBER_DRAW_ITEM * GetLastItemInList() const
void AddItemToList(GERBER_DRAW_ITEM *aItem)
Add a new GERBER_DRAW_ITEM item to the drawings list.
#define NULL
#define FIRST_DCODE
Definition: dcode.h:71
APERTURE_T
Enum APERTURE_T is the set of all gerber aperture types allowed, according to page 16 of http://gerbv...
Definition: dcode.h:50
int m_Num_Dcode
D code value ( >= 10 )
Definition: dcode.h:96
int NewOutline()
Creates a new empty polygon in the set and returns its index
void fillArcGBRITEM(GERBER_DRAW_ITEM *aGbrItem, int Dcode_index, const wxPoint &aStart, const wxPoint &aEnd, const wxPoint &aRelCenter, wxSize aPenSize, bool aClockwise, bool aMultiquadrant, bool aLayerNegative)
Function fillArcGBRITEM initializes a given GBRITEM so that it can draw an arc G code.
Definition: rs274d.cpp:207
bool m_Exposure
whether an aperture macro tool is flashed on or off
D_CODE holds a gerber DCODE (also called Aperture) definition.
Definition: dcode.h:82
void fillFlashedGBRITEM(GERBER_DRAW_ITEM *aGbrItem, APERTURE_T aAperture, int Dcode_index, const wxPoint &aPos, wxSize aSize, bool aLayerNegative)
Function fillFlashedGBRITEM initializes a given GBRITEM so that it can draw a circle which is filled ...
Definition: rs274d.cpp:103
GBR_NETLIST_METADATA m_NetAttributeDict
#define TOOLS_MAX_COUNT
Definition: dcode.h:73
void StepAndRepeatItem(const GERBER_DRAW_ITEM &aItem)
Function StepAndRepeatItem Gerber format has a command Step an Repeat This function must be called wh...
GERBER_FILE_IMAGE * m_GerberImageFile
GERBER_LAYER & GetLayerParams()
Function GetLayerParams.
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)

References AddItemToList(), AddMessageToList(), SHAPE_POLY_SET::Append(), APT_CIRCLE, SHAPE_POLY_SET::CVertex(), fillArcGBRITEM(), fillArcPOLY(), fillFlashedGBRITEM(), fillLineGBRITEM(), FIRST_DCODE, GBR_POLYGON, GERB_INTERPOL_ARC_NEG, GERB_INTERPOL_ARC_POS, GERB_INTERPOL_LINEAR_1X, GetDCODE(), GetLastItemInList(), GetLayerParams(), m_360Arc_enbl, GERBER_DRAW_ITEM::m_AperFunction, m_AperFunction, m_Current_Tool, m_CurrentPos, GERBER_DRAW_ITEM::m_DCode, GERBER_DRAW_ITEM::m_End, m_Exposure, GERBER_DRAW_ITEM::m_Flashed, GERBER_DRAW_ITEM::m_GerberImageFile, m_Has_MissingDCode, m_IJPos, D_CODE::m_InUse, m_Iterpolation, m_Last_Pen_Command, m_LastCoordIsIJPos, m_NetAttributeDict, D_CODE::m_Num_Dcode, GERBER_DRAW_ITEM::m_Polygon, m_PolygonFillMode, m_PolygonFillModeState, m_PreviousPos, GERBER_DRAW_ITEM::m_Shape, D_CODE::m_Shape, D_CODE::m_Size, GERBER_DRAW_ITEM::m_Start, SHAPE_POLY_SET::NewOutline(), NULL, SHAPE_POLY_SET::OutlineCount(), GERBER_DRAW_ITEM::SetNetAttributes(), StepAndRepeatItem(), and TOOLS_MAX_COUNT.

Referenced by LoadGerberFile().

◆ Execute_G_Command()

bool GERBER_FILE_IMAGE::Execute_G_Command ( char *&  text,
int  G_command 
)
private

Definition at line 454 of file rs274d.cpp.

455 {
456 // D( printf( "%22s: G_CODE<%d>\n", __func__, G_command ); )
457 
458  switch( G_command )
459  {
460  case GC_PHOTO_MODE: // can starts a D03 flash command: redundant, can
461  // be safely ignored
462  break;
463 
466  break;
467 
470  break;
471 
474  break;
475 
476  case GC_COMMENT:
477  // Skip comment, but only if the line does not start by "G04 #@! "
478  // which is a metadata, i.e. a X2 command inside the comment.
479  // this comment is called a "structured comment"
480  if( strncmp( text, " #@! ", 5 ) == 0 )
481  {
482  text += 5;
483  // The string starting at text is the same as the X2 attribute,
484  // but a X2 attribute ends by '%'. So we build the X2 attribute string
485  std::string x2buf;
486 
487  while( *text && (*text != '*') )
488  {
489  x2buf += *text;
490  text++;
491  }
492  // add the end of X2 attribute string
493  x2buf += "*%";
494  x2buf += '\0';
495 
496  char* cptr = (char*)x2buf.data();
497  int code_command = ReadXCommandID( cptr );
498  ExecuteRS274XCommand( code_command, NULL, 0, cptr );
499  }
500 
501  while( *text && (*text != '*') )
502  text++;
503  break;
504 
505  case GC_SELECT_TOOL:
506  {
507  int D_commande = DCodeNumber( text );
508 
509  if( D_commande < FIRST_DCODE )
510  return false;
511  if( D_commande > (TOOLS_MAX_COUNT - 1) )
512  D_commande = TOOLS_MAX_COUNT - 1;
513  m_Current_Tool = D_commande;
514  D_CODE* pt_Dcode = GetDCODE( D_commande );
515 
516  if( pt_Dcode )
517  pt_Dcode->m_InUse = true;
518 
519  break;
520  }
521 
522  case GC_SPECIFY_INCHES:
523  m_GerbMetric = false; // false = Inches, true = metric
524  break;
525 
527  m_GerbMetric = true; // false = Inches, true = metric
528  break;
529 
530  case GC_TURN_OFF_360_INTERPOL: // disable Multi cadran arc and Arc interpol
531  m_360Arc_enbl = false;
532  m_Iterpolation = GERB_INTERPOL_LINEAR_1X; // not sure it should be done
533  break;
534 
536  m_360Arc_enbl = true;
537  break;
538 
540  m_Relative = false; // false = absolute Coord, true = relative
541  // Coord
542  break;
543 
545  m_Relative = true; // false = absolute Coord, true = relative
546  // Coord
547  break;
548 
550  m_PolygonFillMode = true;
551  m_Exposure = false;
552  break;
553 
555  if( m_Exposure && GetLastItemInList() ) // End of polygon
556  {
557  GERBER_DRAW_ITEM * gbritem = GetLastItemInList();
558  gbritem->m_Polygon.Append( gbritem->m_Polygon.CVertex( 0 ) );
559  StepAndRepeatItem( *gbritem );
560  }
561  m_Exposure = false;
562  m_PolygonFillMode = false;
564  m_Iterpolation = GERB_INTERPOL_LINEAR_1X; // not sure it should be done
565  break;
566 
567  case GC_MOVE: // Non existent
568  default:
569  {
570  wxString msg;
571  msg.Printf( wxT( "G%0.2d command not handled" ), G_command );
572  AddMessageToList( msg );
573  return false;
574  }
575  }
576 
577 
578  return true;
579 }
void AddMessageToList(const wxString &aMessage)
Function AddMessageToList Add a message to the message list.
bool m_InUse
false if the aperure (previously defined) is not used to draw something
Definition: dcode.h:102
const VECTOR2I & CVertex(int aIndex, int aOutline, int aHole) const
Returns the index-th vertex in a given hole outline within a given outline
D_CODE * GetDCODE(int aDCODE) const
Function GetDCODE returns a pointer to the D_CODE within this GERBER for the given aDCODE.
SHAPE_POLY_SET m_Polygon
int ReadXCommandID(char *&text)
reads two bytes of data and assembles them into an int with the first byte in the sequence put into t...
Definition: rs274x.cpp:116
bool ExecuteRS274XCommand(int aCommand, char *aBuff, unsigned int aBuffSize, char *&aText)
executes a RS274X command
Definition: rs274x.cpp:199
GERBER_DRAW_ITEM * GetLastItemInList() const
#define NULL
#define FIRST_DCODE
Definition: dcode.h:71
int DCodeNumber(char *&Text)
Definition: rs274d.cpp:434
bool m_Exposure
whether an aperture macro tool is flashed on or off
D_CODE holds a gerber DCODE (also called Aperture) definition.
Definition: dcode.h:82
#define TOOLS_MAX_COUNT
Definition: dcode.h:73
void StepAndRepeatItem(const GERBER_DRAW_ITEM &aItem)
Function StepAndRepeatItem Gerber format has a command Step an Repeat This function must be called wh...
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)

References AddMessageToList(), SHAPE_POLY_SET::Append(), SHAPE_POLY_SET::CVertex(), DCodeNumber(), ExecuteRS274XCommand(), FIRST_DCODE, GC_CIRCLE_NEG_INTERPOL, GC_CIRCLE_POS_INTERPOL, GC_COMMENT, GC_LINEAR_INTERPOL_1X, GC_MOVE, GC_PHOTO_MODE, GC_SELECT_TOOL, GC_SPECIFY_ABSOLUES_COORD, GC_SPECIFY_INCHES, GC_SPECIFY_MILLIMETERS, GC_SPECIFY_RELATIVEES_COORD, GC_TURN_OFF_360_INTERPOL, GC_TURN_OFF_POLY_FILL, GC_TURN_ON_360_INTERPOL, GC_TURN_ON_POLY_FILL, GERB_INTERPOL_ARC_NEG, GERB_INTERPOL_ARC_POS, GERB_INTERPOL_LINEAR_1X, GetDCODE(), GetLastItemInList(), m_360Arc_enbl, m_Current_Tool, m_Exposure, m_GerbMetric, D_CODE::m_InUse, m_Iterpolation, GERBER_DRAW_ITEM::m_Polygon, m_PolygonFillMode, m_PolygonFillModeState, m_Relative, NULL, ReadXCommandID(), StepAndRepeatItem(), and TOOLS_MAX_COUNT.

Referenced by LoadGerberFile().

◆ ExecuteRS274XCommand()

bool GERBER_FILE_IMAGE::ExecuteRS274XCommand ( int  aCommand,
char *  aBuff,
unsigned int  aBuffSize,
char *&  aText 
)
private

executes a RS274X command

Definition at line 199 of file rs274x.cpp.

201 {
202  int code;
203  int seq_len; // not used, just provided
204  int seq_char;
205  bool ok = true;
206  wxString msg;
207  double fcoord;
208  bool x_fmt_known = false;
209  bool y_fmt_known = false;
210 
211  // conv_scale = scaling factor from inch to Internal Unit
212  double conv_scale = IU_PER_MILS * 1000;
213 
214  if( m_GerbMetric )
215  conv_scale /= 25.4;
216 
217  switch( aCommand )
218  {
219  case FORMAT_STATEMENT:
220  seq_len = 2;
221 
222  while( *aText != '*' )
223  {
224  switch( *aText )
225  {
226  case ' ':
227  aText++;
228  break;
229 
230  case 'D': // Non-standard option for all zeros (leading + tailing)
231  msg.Printf( _( "RS274X: Invalid GERBER format command '%c' at line %d: \"%s\"" ),
232  'D', m_LineNum, aBuff );
233  AddMessageToList( msg );
234  msg.Printf( _("GERBER file \"%s\" may not display as intended." ),
235  m_FileName.ToAscii() );
236  AddMessageToList( msg );
237  // Fallthrough
238 
239  case 'L': // No Leading 0
240  m_NoTrailingZeros = false;
241  aText++;
242  break;
243 
244  case 'T': // No trailing 0
245  m_NoTrailingZeros = true;
246  aText++;
247  break;
248 
249  case 'A': // Absolute coord
250  m_Relative = false;
251  aText++;
252  break;
253 
254  case 'I': // Relative coord
255  m_Relative = true;
256  aText++;
257  break;
258 
259  case 'G':
260  case 'N': // Sequence code (followed by one digit: the sequence len)
261  // (sometimes found before the X,Y sequence)
262  // Obscure option
263  aText++;
264  seq_char = *aText++;
265  if( (seq_char >= '0') && (seq_char <= '9') )
266  seq_len = seq_char - '0';
267  break;
268 
269  case 'M': // Sequence code (followed by one digit: the sequence len)
270  // (sometimes found after the X,Y sequence)
271  // Obscure option
272  code = *aText++;
273  if( ( *aText >= '0' ) && ( *aText<= '9' ) )
274  aText++; // skip the digit
275  break;
276 
277  case 'X':
278  case 'Y':
279  {
280  code = *(aText++);
281  char ctmp = *(aText++) - '0';
282  if( code == 'X' )
283  {
284  x_fmt_known = true;
285  // number of digits after the decimal point (0 to 7 allowed)
286  m_FmtScale.x = *aText - '0';
287  m_FmtLen.x = ctmp + m_FmtScale.x;
288 
289  // m_FmtScale is 0 to 7
290  // (Old Gerber specification was 0 to 6)
291  if( m_FmtScale.x < 0 )
292  m_FmtScale.x = 0;
293  if( m_FmtScale.x > 7 )
294  m_FmtScale.x = 7;
295  }
296  else
297  {
298  y_fmt_known = true;
299  m_FmtScale.y = *aText - '0';
300  m_FmtLen.y = ctmp + m_FmtScale.y;
301  if( m_FmtScale.y < 0 )
302  m_FmtScale.y = 0;
303  if( m_FmtScale.y > 7 )
304  m_FmtScale.y = 7;
305  }
306  aText++;
307  }
308  break;
309 
310  case '*':
311  break;
312 
313  default:
314  msg.Printf( wxT( "Unknown id (%c) in FS command" ),
315  *aText );
316  AddMessageToList( msg );
317  GetEndOfBlock( aBuff, aBuffSize, aText, m_Current_File );
318  ok = false;
319  break;
320  }
321  }
322  if( !x_fmt_known || !y_fmt_known )
323  AddMessageToList( wxT( "RS274X: Format Statement (FS) without X or Y format" ) );
324 
325  break;
326 
327  case AXIS_SELECT: // command ASAXBY*% or %ASAYBX*%
328  m_SwapAxis = false;
329  if( strncasecmp( aText, "AYBX", 4 ) == 0 )
330  m_SwapAxis = true;
331  break;
332 
333  case MIRROR_IMAGE: // command %MIA0B0*%, %MIA0B1*%, %MIA1B0*%, %MIA1B1*%
334  m_MirrorA = m_MirrorB = 0;
335  while( *aText && *aText != '*' )
336  {
337  switch( *aText )
338  {
339  case 'A': // Mirror A axis ?
340  aText++;
341  if( *aText == '1' )
342  m_MirrorA = true;
343  break;
344 
345  case 'B': // Mirror B axis ?
346  aText++;
347  if( *aText == '1' )
348  m_MirrorB = true;
349  break;
350 
351  default:
352  aText++;
353  break;
354  }
355  }
356  break;
357 
358  case MODE_OF_UNITS:
359  code = ReadXCommandID( aText );
360  if( code == INCH )
361  m_GerbMetric = false;
362  else if( code == MILLIMETER )
363  m_GerbMetric = true;
364  conv_scale = m_GerbMetric ? IU_PER_MILS / 25.4 : IU_PER_MILS;
365  break;
366 
367  case FILE_ATTRIBUTE: // Command %TF ...
368  m_IsX2_file = true;
369  {
371  dummy.ParseAttribCmd( m_Current_File, aBuff, aBuffSize, aText, m_LineNum );
372 
373  if( dummy.IsFileFunction() )
374  {
375  delete m_FileFunction;
377  }
378  else if( dummy.IsFileMD5() )
379  {
380  m_MD5_value = dummy.GetPrm( 1 );
381  }
382  else if( dummy.IsFilePart() )
383  {
384  m_PartString = dummy.GetPrm( 1 );
385  }
386  }
387  break;
388 
389  case APERTURE_ATTRIBUTE: // Command %TA
390  {
392  dummy.ParseAttribCmd( m_Current_File, aBuff, aBuffSize, aText, m_LineNum );
393 
394  if( dummy.GetAttribute() == ".AperFunction" )
395  {
396  m_AperFunction = dummy.GetPrm( 1 );
397 
398  // A few function values can have other parameters. Add them
399  for( int ii = 2; ii < dummy.GetPrmCount(); ii++ )
400  m_AperFunction << "," << dummy.GetPrm( ii );
401  }
402  }
403  break;
404 
405  case NET_ATTRIBUTE: // Command %TO currently %TO.P %TO.N and %TO.C
406  {
408 
409  dummy.ParseAttribCmd( m_Current_File, aBuff, aBuffSize, aText, m_LineNum );
410 
411  if( dummy.GetAttribute() == ".N" )
412  {
415  }
416  else if( dummy.GetAttribute() == ".C" )
417  {
420  }
421  else if( dummy.GetAttribute() == ".P" )
422  {
425  m_NetAttributeDict.m_Padname.SetField( FormatStringFromGerber( dummy.GetPrm( 2 ) ), true, true );
426 
427  if( dummy.GetPrmCount() > 3 )
429  FormatStringFromGerber( dummy.GetPrm( 3 ) ), true, true );
430  else
432  }
433  }
434  break;
435 
436  case REMOVE_APERTURE_ATTRIBUTE: // Command %TD ...
437  {
439  dummy.ParseAttribCmd( m_Current_File, aBuff, aBuffSize, aText, m_LineNum );
441  }
442  break;
443 
444  case OFFSET: // command: OFAnnBnn (nn = float number) = layer Offset
445  m_Offset.x = m_Offset.y = 0;
446  while( *aText != '*' )
447  {
448  switch( *aText )
449  {
450  case 'A': // A axis offset in current unit (inch or mm)
451  aText++;
452  fcoord = ReadDouble( aText );
453  m_Offset.x = KiROUND( fcoord * conv_scale );
454  break;
455 
456  case 'B': // B axis offset in current unit (inch or mm)
457  aText++;
458  fcoord = ReadDouble( aText );
459  m_Offset.y = KiROUND( fcoord * conv_scale );
460  break;
461  }
462  }
463  break;
464 
465  case SCALE_FACTOR:
466  m_Scale.x = m_Scale.y = 1.0;
467  while( *aText != '*' )
468  {
469  switch( *aText )
470  {
471  case 'A': // A axis scale
472  aText++;
473  m_Scale.x = ReadDouble( aText );
474  break;
475 
476  case 'B': // B axis scale
477  aText++;
478  m_Scale.y = ReadDouble( aText );
479  break;
480  }
481  }
482  break;
483 
484  case IMAGE_OFFSET: // command: IOAnnBnn (nn = float number) = Image Offset
486  while( *aText != '*' )
487  {
488  switch( *aText )
489  {
490  case 'A': // A axis offset in current unit (inch or mm)
491  aText++;
492  fcoord = ReadDouble( aText );
493  m_ImageOffset.x = KiROUND( fcoord * conv_scale );
494  break;
495 
496  case 'B': // B axis offset in current unit (inch or mm)
497  aText++;
498  fcoord = ReadDouble( aText );
499  m_ImageOffset.y = KiROUND( fcoord * conv_scale );
500  break;
501  }
502  }
503  break;
504 
505  case IMAGE_ROTATION: // command IR0* or IR90* or IR180* or IR270*
506  if( strncasecmp( aText, "0*", 2 ) == 0 )
507  m_ImageRotation = 0;
508  else if( strncasecmp( aText, "90*", 3 ) == 0 )
509  m_ImageRotation = 90;
510  else if( strncasecmp( aText, "180*", 4 ) == 0 )
511  m_ImageRotation = 180;
512  else if( strncasecmp( aText, "270*", 4 ) == 0 )
513  m_ImageRotation = 270;
514  else
515  AddMessageToList( _( "RS274X: Command \"IR\" rotation value not allowed" ) );
516  break;
517 
518  case STEP_AND_REPEAT: // command SR, like %SRX3Y2I5.0J2*%
519  m_Iterpolation = GERB_INTERPOL_LINEAR_1X; // Start a new Gerber layer
521  GetLayerParams().m_StepForRepeat.x = 0.0; // offset for Step and Repeat command
523  GetLayerParams().m_YRepeatCount = 1; // The repeat count
524  GetLayerParams().m_StepForRepeatMetric = m_GerbMetric; // the step units
525  while( *aText && *aText != '*' )
526  {
527  switch( *aText )
528  {
529  case 'I': // X axis offset
530  aText++;
532  break;
533 
534  case 'J': // Y axis offset
535  aText++;
537  break;
538 
539  case 'X': // X axis repeat count
540  aText++;
542  break;
543 
544  case 'Y': // Y axis offset
545  aText++;
547  break;
548  default:
549  aText++;
550  break;
551  }
552  }
553  break;
554 
555  case IMAGE_JUSTIFY: // Command IJAnBn*
556  m_ImageJustifyXCenter = false; // Image Justify Center on X axis (default = false)
557  m_ImageJustifyYCenter = false; // Image Justify Center on Y axis (default = false)
558  m_ImageJustifyOffset = wxPoint(0,0); // Image Justify Offset on XY axis (default = 0,0)
559  while( *aText && *aText != '*' )
560  {
561  // IJ command is (for A or B axis) AC or AL or A<coordinate>
562  switch( *aText )
563  {
564  case 'A': // A axis justify
565  aText++;
566  if( *aText == 'C' )
567  {
568  m_ImageJustifyXCenter = true;
569  aText++;
570  }
571  else if( *aText == 'L' )
572  {
573  m_ImageJustifyXCenter = true;
574  aText++;
575  }
576  else m_ImageJustifyOffset.x = KiROUND( ReadDouble( aText ) * conv_scale);
577  break;
578 
579  case 'B': // B axis justify
580  aText++;
581  if( *aText == 'C' )
582  {
583  m_ImageJustifyYCenter = true;
584  aText++;
585  }
586  else if( *aText == 'L' )
587  {
588  m_ImageJustifyYCenter = true;
589  aText++;
590  }
591  else m_ImageJustifyOffset.y = KiROUND( ReadDouble( aText ) * conv_scale);
592  break;
593  default:
594  aText++;
595  break;
596  }
597  }
602  break;
603 
604  case KNOCKOUT:
605  m_Iterpolation = GERB_INTERPOL_LINEAR_1X; // Start a new Gerber layer
606  msg = _( "RS274X: Command KNOCKOUT ignored by GerbView" ) ;
607  AddMessageToList( msg );
608  break;
609 
610  case ROTATE: // Layer rotation: command like %RO45*%
611  m_Iterpolation = GERB_INTERPOL_LINEAR_1X; // Start a new Gerber layer
612  m_LocalRotation =ReadDouble( aText ); // Store layer rotation in degrees
613  break;
614 
615  case IMAGE_NAME:
616  m_ImageName.Empty();
617  while( *aText != '*' )
618  {
619  m_ImageName.Append( *aText++ );
620  }
621 
622  break;
623 
624  case LOAD_NAME:
625  // %LN is a (deprecated) equivalentto G04: a comment
626  while( *aText && *aText != '*' )
627  {
628  aText++; // Skip text
629  }
630 
631  break;
632 
633  case IMAGE_POLARITY:
634  if( strncasecmp( aText, "NEG", 3 ) == 0 )
635  m_ImageNegative = true;
636  else
637  m_ImageNegative = false;
638 
639  break;
640 
641  case LOAD_POLARITY:
642  if( *aText == 'C' )
644  else
646 
647  break;
648 
649  case AP_MACRO: // lines like %AMMYMACRO*
650  // 5,1,8,0,0,1.08239X$1,22.5*
651  // %
652  /*ok = */ReadApertureMacro( aBuff, aBuffSize, aText, m_Current_File );
653  break;
654 
655  case AP_DEFINITION:
656  /* input example: %ADD30R,0.081800X0.101500*%
657  * Aperture definition has 4 options: C, R, O, P
658  * (Circle, Rect, Oval, regular Polygon)
659  * and shapes can have a hole (round or rectangular).
660  * All optional parameters values start by X
661  * at this point, text points to 2nd 'D'
662  */
663  if( *aText++ != 'D' )
664  {
665  ok = false;
666  break;
667  }
668 
669  m_Has_DCode = true;
670 
671  code = ReadInt( aText );
672 
673  D_CODE* dcode;
674  dcode = GetDCODEOrCreate( code );
675 
676  if( dcode == NULL )
677  break;
678 
680 
681  // at this point, text points to character after the ADD<num>,
682  // i.e. R in example above. If aText[0] is one of the usual
683  // apertures: (C,R,O,P), there is a comma after it.
684  if( aText[1] == ',' )
685  {
686  char stdAperture = *aText;
687 
688  aText += 2; // skip "C," for example
689 
690  dcode->m_Size.x = KiROUND( ReadDouble( aText ) * conv_scale );
691  dcode->m_Size.y = dcode->m_Size.x;
692 
693  switch( stdAperture ) // Aperture desceiption has optional parameters. Read them
694  {
695  case 'C': // Circle
696  dcode->m_Shape = APT_CIRCLE;
697  while( *aText == ' ' )
698  aText++;
699 
700  if( *aText == 'X' )
701  {
702  aText++;
703  dcode->m_Drill.x = dcode->m_Drill.y =
704  KiROUND( ReadDouble( aText ) * conv_scale );
706  }
707 
708  while( *aText == ' ' )
709  aText++;
710 
711  if( *aText == 'X' )
712  {
713  aText++;
714  dcode->m_Drill.y =
715  KiROUND( ReadDouble( aText ) * conv_scale );
716 
718  }
719  dcode->m_Defined = true;
720  break;
721 
722  case 'O': // oval
723  case 'R': // rect
724  dcode->m_Shape = (stdAperture == 'O') ? APT_OVAL : APT_RECT;
725 
726  while( *aText == ' ' )
727  aText++;
728 
729  if( *aText == 'X' )
730  {
731  aText++;
732  dcode->m_Size.y =
733  KiROUND( ReadDouble( aText ) * conv_scale );
734  }
735 
736  while( *aText == ' ' )
737  aText++;
738 
739  if( *aText == 'X' )
740  {
741  aText++;
742  dcode->m_Drill.x = KiROUND( ReadDouble( aText ) * conv_scale );
743  dcode->m_Drill.y = dcode->m_Drill.x;
745  }
746 
747  while( *aText == ' ' )
748  aText++;
749 
750  if( *aText == 'X' )
751  {
752  aText++;
753  dcode->m_Drill.y =
754  KiROUND( ReadDouble( aText ) * conv_scale );
756  }
757  dcode->m_Defined = true;
758  break;
759 
760  case 'P':
761 
762  /* Regular polygon: a command line like %ADD12P,0.040X10X25X0.025X0.025X0.0150*%
763  * params are: <diameter>, X<edge count>, X<Rotation>, X<X hole dim>, X<Y hole dim>
764  */
765  dcode->m_Shape = APT_POLYGON;
766  while( *aText == ' ' )
767  aText++;
768 
769  if( *aText == 'X' )
770  {
771  aText++;
772  dcode->m_EdgesCount = ReadInt( aText );
773  }
774 
775  while( *aText == ' ' )
776  aText++;
777 
778  if( *aText == 'X' )
779  {
780  aText++;
781  dcode->m_Rotation = ReadDouble( aText );
782  }
783 
784  while( *aText == ' ' )
785  aText++;
786 
787  if( *aText == 'X' )
788  {
789  aText++;
790  dcode->m_Drill.x = KiROUND( ReadDouble( aText ) * conv_scale );
791  dcode->m_Drill.y = dcode->m_Drill.x;
793  }
794 
795  while( *aText == ' ' )
796  aText++;
797 
798  if( *aText == 'X' )
799  {
800  aText++;
801  dcode->m_Drill.y = KiROUND( ReadDouble( aText ) * conv_scale );
803  }
804  dcode->m_Defined = true;
805  break;
806  }
807  }
808  else // aText[0] starts an aperture macro name
809  {
810  APERTURE_MACRO am_lookup;
811 
812  while( *aText && *aText != '*' && *aText != ',' )
813  am_lookup.name.Append( *aText++ );
814 
815  // When an aperture definition is like %AMLINE2* 22,1,$1,$2,0,0,-45*
816  // the ADDxx<MACRO_NAME> command has parameters, like %ADD14LINE2,0.8X0.5*%
817  if( *aText == ',' )
818  { // Read aperture macro parameters and store them
819  aText++; // aText points the first parameter
820 
821  while( *aText && *aText != '*' )
822  {
823  double param = ReadDouble( aText );
824  dcode->AppendParam( param );
825 
826  while( isspace( *aText ) )
827  aText++;
828 
829  // Skip 'X' separator:
830  if( *aText == 'X' || *aText == 'x' )
831  aText++;
832  }
833  }
834 
835  // lookup the aperture macro here.
836  APERTURE_MACRO* pam = FindApertureMacro( am_lookup );
837 
838  if( !pam )
839  {
840  msg.Printf( wxT( "RS274X: aperture macro %s not found\n" ),
841  TO_UTF8( am_lookup.name ) );
842  AddMessageToList( msg );
843  ok = false;
844  break;
845  }
846 
847  dcode->m_Shape = APT_MACRO;
848  dcode->SetMacro( pam );
849  }
850 
851  break;
852 
853  default:
854  ok = false;
855  break;
856  }
857 
858  (void) seq_len; // quiet g++, or delete the unused variable.
859 
860  ok = GetEndOfBlock( aBuff, aBuffSize, aText, m_Current_File );
861 
862  return ok;
863 }
X2_ATTRIBUTE_FILEFUNCTION ( from TF.FileFunction in Gerber file) Example file function: TF....
void AddMessageToList(const wxString &aMessage)
Function AddMessageToList Add a message to the message list.
X2_ATTRIBUTE_FILEFUNCTION * m_FileFunction
X2_ATTRIBUTE The attribute value consists of a number of substrings separated by a comma.
wxString name
The name of the aperture macro.
Definition: am_primitive.h:165
print info associated to a component (TO.C attribute)
wxSize m_Size
Horizontal and vertical dimensions.
Definition: dcode.h:94
int ReadInt(char *&text, bool aSkipSeparator=true)
Function ReadInt reads an int from an ASCII character buffer.
Definition: dcode.h:53
APERTURE_T m_Shape
shape ( Line, rectangle, circle , oval .. )
Definition: dcode.h:95
double m_Rotation
shape rotation in degrees
Definition: dcode.h:99
wxSize m_Drill
dimension of the hole (if any) (draill file)
Definition: dcode.h:97
wxRealPoint m_StepForRepeat
wxString m_Cmpref
the component reference parent of the data
int ReadXCommandID(char *&text)
reads two bytes of data and assembles them into an int with the first byte in the sequence put into t...
Definition: rs274x.cpp:116
Definition: dcode.h:52
GBR_DATA_FIELD m_PadPinFunction
for a pad: the pin function (defined in schematic)
void SetField(const wxString &aField, bool aUseUTF8, bool aEscapeString)
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:48
double ReadDouble(char *&text, bool aSkipSeparator=true)
Function ReadDouble reads a double from an ASCII character buffer.
bool m_Defined
false if the aperture is not defined in the header
Definition: dcode.h:104
void AppendParam(double aValue)
AppendParam() Add a parameter to the D_CODE parameter list.
Definition: dcode.h:122
#define NULL
GBR_DATA_FIELD m_Padname
for a flashed pad: the pad name ((TO.P attribute)
wxString m_Netname
for items associated to a net: the netname
APERTURE_MACRO * FindApertureMacro(const APERTURE_MACRO &aLookup)
Function FindApertureMacro looks up a previously read in aperture macro.
bool m_StepForRepeatMetric
bool ReadApertureMacro(char *aBuff, unsigned int aBuffSize, char *&text, FILE *gerber_file)
reads in an aperture macro and saves it in m_aperture_macros.
Definition: rs274x.cpp:920
wxString m_AperFunction
the aperture attribute (created by a TA.AperFunction command) attached to the D_CODE
Definition: dcode.h:105
void RemoveAttribute(X2_ATTRIBUTE &aAttribute)
Function RemoveAttribute.
APERTURE_DEF_HOLETYPE m_DrillShape
shape of the hole (0 = no hole, round = 1, rect = 2) */
Definition: dcode.h:98
D_CODE holds a gerber DCODE (also called Aperture) definition.
Definition: dcode.h:82
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
Definition: rs274x.cpp:64
#define _(s)
Definition: 3d_actions.cpp:33
GBR_NETLIST_METADATA m_NetAttributeDict
void SetMacro(APERTURE_MACRO *aMacro)
Definition: dcode.h:151
bool GetEndOfBlock(char *aBuff, unsigned int aBuffSize, char *&aText, FILE *aGerberFile)
Definition: rs274x.cpp:866
#define IU_PER_MILS
Definition: plotter.cpp:137
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:61
int m_EdgesCount
in aperture definition Polygon only: number of edges for the polygon
Definition: dcode.h:100
print info associated to a flashed pad (TO.P attribute)
wxString FormatStringFromGerber(const wxString &aString)
This helper function make the inverse conversion of FormatStringToGerber() It converts a "normalized"...
Struct APERTURE_MACRO helps support the "aperture macro" defined within standard RS274X.
Definition: am_primitive.h:163
print info associated to a net (TO.N attribute)
D_CODE * GetDCODEOrCreate(int aDCODE, bool aCreateIfNoExist=true)
Function GetDCODEOrCreate returns a pointer to the D_CODE within this GERBER for the given aDCODE.
GERBER_LAYER & GetLayerParams()
Function GetLayerParams.
int m_NetAttribType
the type of net info (used to define the gerber string to create)

References _, AddMessageToList(), AP_DEFINITION, AP_MACRO, APERTURE_ATTRIBUTE, D_CODE::AppendParam(), APT_CIRCLE, APT_DEF_RECT_HOLE, APT_DEF_ROUND_HOLE, APT_MACRO, APT_OVAL, APT_POLYGON, APT_RECT, AXIS_SELECT, GBR_DATA_FIELD::Clear(), dummy(), FILE_ATTRIBUTE, FindApertureMacro(), FORMAT_STATEMENT, FormatStringFromGerber(), GBR_NETLIST_METADATA::GBR_NETINFO_CMP, GBR_NETLIST_METADATA::GBR_NETINFO_NET, GBR_NETLIST_METADATA::GBR_NETINFO_PAD, GERB_INTERPOL_LINEAR_1X, GetDCODEOrCreate(), GetEndOfBlock(), GetLayerParams(), IMAGE_JUSTIFY, IMAGE_NAME, IMAGE_OFFSET, IMAGE_POLARITY, IMAGE_ROTATION, INCH, IU_PER_MILS, KiROUND(), KNOCKOUT, LOAD_NAME, LOAD_POLARITY, D_CODE::m_AperFunction, m_AperFunction, GBR_NETLIST_METADATA::m_Cmpref, m_Current_File, D_CODE::m_Defined, D_CODE::m_Drill, D_CODE::m_DrillShape, D_CODE::m_EdgesCount, m_FileFunction, m_FileName, m_FmtLen, m_FmtScale, m_GerbMetric, m_Has_DCode, m_ImageJustifyOffset, m_ImageJustifyXCenter, m_ImageJustifyYCenter, m_ImageName, m_ImageNegative, m_ImageOffset, m_ImageRotation, m_IsX2_file, m_Iterpolation, GERBER_LAYER::m_LayerNegative, m_LineNum, m_LocalRotation, m_MD5_value, m_MirrorA, m_MirrorB, GBR_NETLIST_METADATA::m_NetAttribType, m_NetAttributeDict, GBR_NETLIST_METADATA::m_Netname, m_NoTrailingZeros, m_Offset, GBR_NETLIST_METADATA::m_Padname, GBR_NETLIST_METADATA::m_PadPinFunction, m_PartString, m_Relative, D_CODE::m_Rotation, m_Scale, D_CODE::m_Shape, D_CODE::m_Size, GERBER_LAYER::m_StepForRepeat, GERBER_LAYER::m_StepForRepeatMetric, m_SwapAxis, GERBER_LAYER::m_XRepeatCount, GERBER_LAYER::m_YRepeatCount, MILLIMETER, MIRROR_IMAGE, MODE_OF_UNITS, APERTURE_MACRO::name, NET_ATTRIBUTE, NULL, OFFSET, ReadApertureMacro(), ReadDouble(), ReadInt(), ReadXCommandID(), REMOVE_APERTURE_ATTRIBUTE, RemoveAttribute(), ROTATE, SCALE_FACTOR, GBR_DATA_FIELD::SetField(), D_CODE::SetMacro(), STEP_AND_REPEAT, TO_UTF8, wxPoint::x, and wxPoint::y.

Referenced by Execute_G_Command(), and ReadRS274XCommand().

◆ FindApertureMacro()

APERTURE_MACRO * GERBER_FILE_IMAGE::FindApertureMacro ( const APERTURE_MACRO aLookup)

Function FindApertureMacro looks up a previously read in aperture macro.

Parameters
aLookupA dummy APERTURE_MACRO with [only] the name field set.
Returns
APERTURE_MACRO* - the one with a matching name, or NULL if not found.

Definition at line 156 of file gerber_file_image.cpp.

157 {
158  APERTURE_MACRO_SET::iterator iter = m_aperture_macros.find( aLookup );
159 
160  if( iter != m_aperture_macros.end() )
161  {
162  APERTURE_MACRO* pam = (APERTURE_MACRO*) &(*iter);
163  return pam;
164  }
165 
166  return NULL; // not found
167 }
APERTURE_MACRO_SET m_aperture_macros
a collection of APERTURE_MACROS, sorted by name
#define NULL
Struct APERTURE_MACRO helps support the "aperture macro" defined within standard RS274X.
Definition: am_primitive.h:163

References m_aperture_macros, and NULL.

Referenced by ExecuteRS274XCommand().

◆ GCodeNumber()

int GERBER_FILE_IMAGE::GCodeNumber ( char *&  Text)

Definition at line 411 of file rs274d.cpp.

412 {
413  int ii = 0;
414  char* text;
415  char line[1024];
416 
417  if( Text == NULL )
418  return 0;
419  Text++;
420  text = line;
421  while( IsNumber( *Text ) )
422  {
423  *(text++) = *(Text++);
424  }
425 
426  *text = 0;
427  ii = atoi( line );
428  return ii;
429 }
#define NULL
#define IsNumber(x)

References IsNumber, and NULL.

Referenced by LoadGerberFile().

◆ GetBoundingBox()

const EDA_RECT EDA_ITEM::GetBoundingBox ( ) const
virtualinherited

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 in D_PAD, BOARD, SCH_HIERLABEL, SCH_SHEET, SCH_GLOBALLABEL, SCH_LABEL, SCH_COMPONENT, WS_DRAW_ITEM_BITMAP, WS_DRAW_ITEM_TEXT, SCH_TEXT, WS_DRAW_ITEM_PAGE, DIMENSION, GERBER_DRAW_ITEM, LIB_PART, DRAWSEGMENT, WS_DRAW_ITEM_RECT, LIB_ITEM, TEXTE_MODULE, WS_DRAW_ITEM_POLYPOLYGONS, MODULE, LIB_FIELD, MARKER_PCB, SCH_LINE, LIB_PIN, ZONE_CONTAINER, WS_DRAW_ITEM_LINE, TRACK, SCH_FIELD, TEXTE_PCB, PCB_TARGET, SCH_BITMAP, SCH_BUS_ENTRY_BASE, WS_DRAW_ITEM_BASE, SCH_PIN, GBR_LAYOUT, LIB_POLYLINE, LIB_ARC, LIB_BEZIER, SCH_NO_CONNECT, LIB_TEXT, SCH_MARKER, SCH_JUNCTION, LIB_CIRCLE, and LIB_RECTANGLE.

Definition at line 104 of file base_struct.cpp.

105 {
106 #if defined(DEBUG)
107  printf( "Missing GetBoundingBox()\n" );
108  Show( 0, std::cout ); // tell me which classes still need GetBoundingBox support
109 #endif
110 
111  // return a zero-sized box per default. derived classes should override
112  // this
113  return EDA_RECT( wxPoint( 0, 0 ), wxSize( 0, 0 ) );
114 }
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

Referenced by CN_ITEM::BBox(), EE_RTREE::contains(), MODULE::CoverageRatio(), SELECTION::GetBoundingBox(), LIB_ITEM::GetBoundingBox(), GetBoundingBoxes(), GERBVIEW_SELECTION::GetCenter(), getRect(), EE_RTREE::insert(), SCH_EDIT_TOOL::Mirror(), SCH_EAGLE_PLUGIN::moveLabels(), EE_RTREE::remove(), GERBVIEW_SELECTION::ViewBBox(), and EDA_ITEM::ViewBBox().

◆ GetClass()

wxString GERBER_FILE_IMAGE::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Implements EDA_ITEM.

Definition at line 249 of file gerber_file_image.h.

250  {
251  return wxT( "GERBER_FILE_IMAGE" );
252  }

◆ GetDCODE()

D_CODE * GERBER_FILE_IMAGE::GetDCODE ( int  aDCODE) const

Function GetDCODE returns a pointer to the D_CODE within this GERBER for the given aDCODE.

Parameters
aDCODEThe numeric value of the D_CODE to look up.
Returns
D_CODE* - the one implied by the given aDCODE, or NULL if the requested aDCODE is out of range.

Definition at line 143 of file gerber_file_image.cpp.

144 {
145  unsigned ndx = aDCODE - FIRST_DCODE;
146 
147  if( ndx < (unsigned) arrayDim( m_Aperture_List ) )
148  {
149  return m_Aperture_List[ndx];
150  }
151 
152  return NULL;
153 }
D_CODE * m_Aperture_List[TOOLS_MAX_COUNT]
Dcode (Aperture) List for this layer (max TOOLS_MAX_COUNT: see dcode.h)
#define NULL
#define FIRST_DCODE
Definition: dcode.h:71
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Definition: macros.h:108

References arrayDim(), FIRST_DCODE, m_Aperture_List, and NULL.

Referenced by Execute_DCODE_Command(), EXCELLON_IMAGE::Execute_Drill_Command(), Execute_G_Command(), EXCELLON_IMAGE::FinishRouteCommand(), GERBER_DRAW_ITEM::GetDcodeDescr(), GERBVIEW_FRAME::Liste_D_Codes(), EXCELLON_IMAGE::Select_Tool(), GERBVIEW_FRAME::updateAperAttributesSelectBox(), and GERBVIEW_FRAME::updateDCodeSelectBox().

◆ GetDCODEOrCreate()

D_CODE * GERBER_FILE_IMAGE::GetDCODEOrCreate ( int  aDCODE,
bool  aCreateIfNoExist = true 
)

Function GetDCODEOrCreate returns a pointer to the D_CODE within this GERBER for the given aDCODE.

Parameters
aDCODEThe numeric value of the D_CODE to look up.
aCreateIfNoExistIf true, then create the D_CODE if it does not exist in list.
Returns
D_CODE* - the one implied by the given aDCODE, or NULL if the requested aDCODE is out of range.

Definition at line 123 of file gerber_file_image.cpp.

124 {
125  unsigned ndx = aDCODE - FIRST_DCODE;
126 
127  if( ndx < (unsigned) arrayDim( m_Aperture_List ) )
128  {
129  // lazily create the D_CODE if it does not exist.
130  if( aCreateIfNoExist )
131  {
132  if( m_Aperture_List[ndx] == NULL )
133  m_Aperture_List[ndx] = new D_CODE( ndx + FIRST_DCODE );
134  }
135 
136  return m_Aperture_List[ndx];
137  }
138 
139  return NULL;
140 }
D_CODE * m_Aperture_List[TOOLS_MAX_COUNT]
Dcode (Aperture) List for this layer (max TOOLS_MAX_COUNT: see dcode.h)
#define NULL
#define FIRST_DCODE
Definition: dcode.h:71
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Definition: macros.h:108
D_CODE holds a gerber DCODE (also called Aperture) definition.
Definition: dcode.h:82

References arrayDim(), FIRST_DCODE, m_Aperture_List, and NULL.

Referenced by ExecuteRS274XCommand(), EXCELLON_IMAGE::readToolInformation(), and EXCELLON_IMAGE::Select_Tool().

◆ GetDcodesCount()

int GERBER_FILE_IMAGE::GetDcodesCount ( )
Returns
the count of Dcode tools in use in the image

Definition at line 258 of file gerber_file_image.cpp.

259 {
260  int count = 0;
261 
262  for( unsigned ii = 0; ii < arrayDim( m_Aperture_List ); ii++ )
263  {
264  if( m_Aperture_List[ii] )
265  if( m_Aperture_List[ii]->m_InUse || m_Aperture_List[ii]->m_Defined )
266  ++count;
267  }
268 
269  return count;
270 }
D_CODE * m_Aperture_List[TOOLS_MAX_COUNT]
Dcode (Aperture) List for this layer (max TOOLS_MAX_COUNT: see dcode.h)
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Definition: macros.h:108

References arrayDim(), m_Aperture_List, and m_InUse.

Referenced by GERBVIEW_FRAME::Liste_D_Codes(), GERBVIEW_FRAME::updateAperAttributesSelectBox(), and GERBVIEW_FRAME::updateDCodeSelectBox().

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 262 of file base_struct.h.

263  {
267  return m_Flags & mask;
268  }
#define TEMP_SELECTED
flag indicating that the structure has already selected
Definition: base_struct.h:128
#define END_ONPAD
Pcbnew: flag set for track segment ending on a pad.
Definition: base_struct.h:139
#define BEGIN_ONPAD
Pcbnew: flag set for track segment starting on a pad.
Definition: base_struct.h:138
#define EDA_ITEM_ALL_FLAGS
Definition: base_struct.h:157
#define SELECTED
Definition: base_struct.h:127
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:143
#define DP_COUPLED
item is coupled with another item making a differential pair
Definition: base_struct.h:145
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:142
#define IS_DANGLING
indicates a pin is dangling
Definition: base_struct.h:149
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
#define ENDPOINT
ends. (Used to support dragging.)
Definition: base_struct.h:126
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: base_struct.h:125

References BEGIN_ONPAD, BRIGHTENED, DP_COUPLED, EDA_ITEM_ALL_FLAGS, END_ONPAD, ENDPOINT, HIGHLIGHTED, IS_DANGLING, EDA_ITEM::m_Flags, SELECTED, STARTPOINT, and TEMP_SELECTED.

Referenced by SCH_EDIT_TOOL::ChangeShape(), EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::ConvertTextType(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), SCH_EDITOR_CONTROL::EditWithLibEdit(), LIB_MOVE_TOOL::Main(), POINT_EDITOR::OnSelectionChange(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_EDIT_PIN::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), and SCH_EDIT_FRAME::TrimWire().

◆ GetEndOfBlock()

bool GERBER_FILE_IMAGE::GetEndOfBlock ( char *  aBuff,
unsigned int  aBuffSize,
char *&  aText,
FILE *  aGerberFile 
)
private

Definition at line 866 of file rs274x.cpp.

867 {
868  for( ; ; )
869  {
870  while( (aText < aBuff + aBuffSize) && *aText )
871  {
872  if( *aText == '*' )
873  return true;
874 
875  if( *aText == '%' )
876  return true;
877 
878  aText++;
879  }
880 
881  if( fgets( aBuff, aBuffSize, gerber_file ) == NULL )
882  break;
883 
884  m_LineNum++;
885  aText = aBuff;
886  }
887 
888  return false;
889 }
#define NULL

References m_LineNum, and NULL.

Referenced by ExecuteRS274XCommand().

◆ GetFlags()

◆ GetItems()

GERBER_DRAW_ITEMS& GERBER_FILE_IMAGE::GetItems ( )
inline

◆ GetItemsCount()

int GERBER_FILE_IMAGE::GetItemsCount ( )
inline
Returns
the count of GERBER_DRAW_ITEMS in the image

Definition at line 282 of file gerber_file_image.h.

282 { return m_drawings.size(); }
GERBER_DRAW_ITEMS m_drawings

References m_drawings.

Referenced by GERBVIEW_FRAME::Read_GERBER_File().

◆ GetLastItemInList()

GERBER_DRAW_ITEM* GERBER_FILE_IMAGE::GetLastItemInList ( ) const
inline
Returns
the last GERBER_DRAW_ITEM* item of the items list

Definition at line 296 of file gerber_file_image.h.

297  {
298  return m_drawings.back();
299  }
GERBER_DRAW_ITEMS m_drawings

References m_drawings.

Referenced by Execute_DCODE_Command(), and Execute_G_Command().

◆ GetLayerParams()

GERBER_LAYER& GERBER_FILE_IMAGE::GetLayerParams ( )
inline

Function GetLayerParams.

Returns
the current layers params

Definition at line 305 of file gerber_file_image.h.

306  {
307  return m_GBRLayerParams;
308  }
GERBER_LAYER m_GBRLayerParams

References m_GBRLayerParams.

Referenced by Execute_DCODE_Command(), ExecuteRS274XCommand(), GERBER_DRAW_ITEM::SetLayerParameters(), StepAndRepeatItem(), and GERBVIEW_FRAME::UpdateTitleAndInfo().

◆ GetMenuImage()

BITMAP_DEF EDA_ITEM::GetMenuImage ( ) const
virtualinherited

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 in D_PAD, ZONE_CONTAINER, SCH_COMPONENT, MODULE, SCH_SHEET, SCH_HIERLABEL, LIB_PIN, SCH_GLOBALLABEL, VIA, SCH_LABEL, SCH_TEXT, GERBER_DRAW_ITEM, DRAWSEGMENT, DIMENSION, TEXTE_MODULE, TRACK, SCH_BUS_BUS_ENTRY, SCH_LINE, SCH_SHEET_PIN, LIB_FIELD, SCH_FIELD, SCH_BUS_WIRE_ENTRY, MARKER_PCB, LIB_ARC, SCH_BITMAP, EDGE_MODULE, TEXTE_PCB, LIB_POLYLINE, SCH_NO_CONNECT, LIB_TEXT, PCB_TARGET, SCH_MARKER, LIB_CIRCLE, SCH_JUNCTION, and LIB_RECTANGLE.

Definition at line 242 of file base_struct.cpp.

243 {
244  return dummy_xpm;
245 }
static const BITMAP_OPAQUE dummy_xpm[1]
Definition: base_struct.cpp:54

References dummy_xpm.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EE_SELECTION_TOOL::doSelectionMenu(), and SELECTION_TOOL::doSelectionMenu().

◆ GetMessages()

const wxArrayString& GERBER_FILE_IMAGE::GetMessages ( ) const
inline

Definition at line 263 of file gerber_file_image.h.

263 { return m_messagesList; }
wxArrayString m_messagesList

References m_messagesList.

Referenced by GERBVIEW_FRAME::Read_EXCELLON_File(), and GERBVIEW_FRAME::Read_GERBER_File().

◆ GetMsgPanelInfo()

virtual void EDA_ITEM::GetMsgPanelInfo ( EDA_UNITS  aUnits,
std::vector< MSG_PANEL_ITEM > &  aList 
)
inlinevirtualinherited

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 in BOARD, D_PAD, MODULE, SCH_SHEET, SCH_TEXT, SCH_COMPONENT, GERBER_DRAW_ITEM, NETINFO_ITEM, DIMENSION, SCH_LINE, DRAWSEGMENT, LIB_ITEM, TEXTE_MODULE, TRACK, LIB_FIELD, SCH_BITMAP, MARKER_PCB, EDGE_MODULE, LIB_PIN, SCH_BUS_ENTRY_BASE, ZONE_CONTAINER, LIB_BEZIER, SCH_MARKER, TEXTE_PCB, LIB_POLYLINE, LIB_ARC, LIB_TEXT, LIB_CIRCLE, and LIB_RECTANGLE.

Definition at line 320 of file base_struct.h.

321  {
322  }

Referenced by EDA_DRAW_FRAME::SetMsgPanel(), EE_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PCBNEW_CONTROL::UpdateMessagePanel(), and FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel().

◆ GetNextLine()

char * GERBER_FILE_IMAGE::GetNextLine ( char *  aBuff,
unsigned int  aBuffSize,
char *  aText,
FILE *  aFile 
)
private

test for an end of line if a end of line is found: read a new line

Parameters
aBuff= buffer (size = GERBER_BUFZ) to fill with a new line
aText= pointer to the last useful char in aBuff on return: points the beginning of the next line.
aBuffSize= the size in bytes of aBuff
aFile= the opened GERBER file to read
Returns
a pointer to the beginning of the next line or NULL if end of file

Definition at line 892 of file rs274x.cpp.

893 {
894  for( ; ; )
895  {
896  switch (*aText )
897  {
898  case ' ': // skip blanks
899  case '\n':
900  case '\r': // Skip line terminators
901  ++aText;
902  break;
903 
904  case 0: // End of text found in aBuff: Read a new string
905  if( fgets( aBuff, aBuffSize, aFile ) == NULL )
906  return NULL;
907 
908  m_LineNum++;
909  aText = aBuff;
910  return aText;
911 
912  default:
913  return aText;
914  }
915  }
916  return aText;
917 }
#define NULL

References m_LineNum, and NULL.

Referenced by ReadApertureMacro().

◆ GetParent()

◆ GetPositiveDrawColor()

COLOR4D GERBER_FILE_IMAGE::GetPositiveDrawColor ( ) const
inline

Definition at line 272 of file gerber_file_image.h.

272 { return m_PositiveDrawColor; }

References m_PositiveDrawColor.

Referenced by GERBER_DRAW_ITEM::Print().

◆ GetSelectMenuText()

wxString EDA_ITEM::GetSelectMenuText ( EDA_UNITS  aUnits) const
virtualinherited

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 in D_PAD, ZONE_CONTAINER, SCH_COMPONENT, MODULE, SCH_SHEET, BOARD, SCH_HIERLABEL, LIB_PIN, SCH_GLOBALLABEL, VIA, SCH_LABEL, WS_DRAW_ITEM_BITMAP, SCH_TEXT, WS_DRAW_ITEM_TEXT, GERBER_DRAW_ITEM, WS_DRAW_ITEM_PAGE, DRAWSEGMENT, DIMENSION, WS_DRAW_ITEM_RECT, TEXTE_MODULE, TRACK, SCH_LINE, SCH_BUS_BUS_ENTRY, SCH_SHEET_PIN, LIB_FIELD, SCH_FIELD, WS_DRAW_ITEM_POLYPOLYGONS, SCH_BUS_WIRE_ENTRY, MARKER_PCB, LIB_ARC, WS_DRAW_ITEM_LINE, SCH_BITMAP, EDGE_MODULE, TEXTE_PCB, LIB_POLYLINE, LIB_TEXT, SCH_NO_CONNECT, PCB_TARGET, LIB_CIRCLE, SCH_MARKER, LIB_RECTANGLE, SCH_JUNCTION, SCH_PIN, and DELETED_BOARD_ITEM.

Definition at line 143 of file base_struct.cpp.

144 {
145  wxFAIL_MSG( wxT( "GetSelectMenuText() was not overridden for schematic item type " ) +
146  GetClass() );
147 
148  return wxString( wxT( "Undefined menu text for " ) + GetClass() );
149 }
virtual wxString GetClass() const =0
Function GetClass returns the class name.

References EDA_ITEM::GetClass().

Referenced by CONNECTION_GRAPH::buildConnectionGraph(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), RC_ITEM::SetData(), and DIALOG_POSITION_RELATIVE::UpdateAnchor().

◆ GetState()

int EDA_ITEM::GetState ( int  type) const
inlineinherited

Definition at line 241 of file base_struct.h.

242  {
243  return m_Status & type;
244  }
STATUS_FLAGS m_Status
Definition: base_struct.h:179

References EDA_ITEM::m_Status.

Referenced by SELECTION_TOOL::expandConnection(), TRACK::GetMsgPanelInfoBase_Common(), TRACK::IsLocked(), TRACK::Print(), and ZONE_CONTAINER::PrintFilledArea().

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 254 of file base_struct.h.

254 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:179

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format().

◆ HasFlag()

◆ HasNegativeItems()

bool GERBER_FILE_IMAGE::HasNegativeItems ( )

Function HasNegativeItems.

Returns
true if at least one item must be drawn in background color used to optimize screen refresh (when no items are in background color refresh can be faster)

Definition at line 234 of file gerber_file_image.cpp.

235 {
236  if( m_hasNegativeItems < 0 ) // negative items are not yet searched: find them if any
237  {
238  if( m_ImageNegative ) // A negative layer is expected having always negative objects.
239  m_hasNegativeItems = 1;
240  else
241  {
242  m_hasNegativeItems = 0;
243  for( GERBER_DRAW_ITEM* item : GetItems() )
244  {
245  if( item->GetLayer() != m_GraphicLayer )
246  continue;
247  if( item->HasNegativeItems() )
248  {
249  m_hasNegativeItems = 1;
250  break;
251  }
252  }
253  }
254  }
255  return m_hasNegativeItems == 1;
256 }
GERBER_DRAW_ITEMS & GetItems()

References GetItems(), m_GraphicLayer, m_hasNegativeItems, and m_ImageNegative.

◆ HitTest() [1/2]

virtual bool EDA_ITEM::HitTest ( const wxPoint aPosition,
int  aAccuracy = 0 
) const
inlinevirtualinherited

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

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

Reimplemented in D_PAD, SCH_COMPONENT, SCH_SHEET, MODULE, VIA, WS_DRAW_ITEM_BITMAP, SCH_TEXT, ARC, WS_DRAW_ITEM_TEXT, ZONE_CONTAINER, GERBER_DRAW_ITEM, WS_DRAW_ITEM_PAGE, DIMENSION, DRAWSEGMENT, WS_DRAW_ITEM_RECT, SCH_LINE, SCH_SHEET_PIN, TEXTE_MODULE, SCH_FIELD, LIB_ITEM, TRACK, WS_DRAW_ITEM_POLYPOLYGONS, LIB_FIELD, SCH_BITMAP, WS_DRAW_ITEM_LINE, MARKER_PCB, LIB_PIN, SCH_NO_CONNECT, SCH_BUS_ENTRY_BASE, SCH_MARKER, SCH_JUNCTION, PCB_TARGET, WS_DRAW_ITEM_BASE, SCH_PIN, TEXTE_PCB, LIB_POLYLINE, LIB_ARC, LIB_BEZIER, LIB_TEXT, LIB_RECTANGLE, LIB_CIRCLE, and KIGFX::RATSNEST_VIEWITEM.

Definition at line 332 of file base_struct.h.

333  {
334  return false; // derived classes should override this function
335  }

Referenced by SCH_MOVE_TOOL::getConnectedDragItems(), EE_SELECTION_TOOL::GuessSelectionCandidates(), WS_DRAW_ITEM_BASE::HitTest(), LIB_ITEM::HitTest(), EE_COLLECTOR::Inspect(), GERBER_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), EE_SELECTION_TOOL::selectMultiple(), and SELECTION_TOOL::selectMultiple().

◆ HitTest() [2/2]

virtual bool EDA_ITEM::HitTest ( const EDA_RECT aRect,
bool  aContained,
int  aAccuracy = 0 
) const
inlinevirtualinherited

Function HitTest tests if aRect intersects or is contained within the bounding box of an item.

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

Reimplemented in D_PAD, SCH_COMPONENT, SCH_SHEET, MODULE, VIA, ZONE_CONTAINER, WS_DRAW_ITEM_BITMAP, SCH_TEXT, ARC, WS_DRAW_ITEM_TEXT, GERBER_DRAW_ITEM, DIMENSION, DRAWSEGMENT, SCH_LINE, TEXTE_MODULE, LIB_ITEM, SCH_FIELD, TRACK, WS_DRAW_ITEM_POLYPOLYGONS, SCH_BITMAP, SCH_NO_CONNECT, SCH_BUS_ENTRY_BASE, SCH_JUNCTION, WS_DRAW_ITEM_BASE, PCB_TARGET, TEXTE_PCB, LIB_POLYLINE, LIB_ARC, LIB_BEZIER, LIB_TEXT, and LIB_CIRCLE.

Definition at line 346 of file base_struct.h.

347  {
348  return false; // derived classes should override this function
349  }

◆ InitToolTable()

void GERBER_FILE_IMAGE::InitToolTable ( )

Function InitToolTable.

Definition at line 273 of file gerber_file_image.cpp.

274 {
275  for( int count = 0; count < TOOLS_MAX_COUNT; count++ )
276  {
277  if( m_Aperture_List[count] == NULL )
278  continue;
279 
280  m_Aperture_List[count]->m_Num_Dcode = count + FIRST_DCODE;
282  }
283 
284  m_aperture_macros.clear();
285 }
APERTURE_MACRO_SET m_aperture_macros
a collection of APERTURE_MACROS, sorted by name
D_CODE * m_Aperture_List[TOOLS_MAX_COUNT]
Dcode (Aperture) List for this layer (max TOOLS_MAX_COUNT: see dcode.h)
#define NULL
#define FIRST_DCODE
Definition: dcode.h:71
int m_Num_Dcode
D code value ( >= 10 )
Definition: dcode.h:96
#define TOOLS_MAX_COUNT
Definition: dcode.h:73
void Clear_D_CODE_Data()
Definition: dcode.cpp:77

References D_CODE::Clear_D_CODE_Data(), FIRST_DCODE, m_Aperture_List, m_aperture_macros, D_CODE::m_Num_Dcode, NULL, and TOOLS_MAX_COUNT.

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 223 of file base_struct.h.

223 { return m_Flags & IS_DRAGGED; }
#define IS_DRAGGED
Item being dragged.
Definition: base_struct.h:122
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189

References IS_DRAGGED, and EDA_ITEM::m_Flags.

Referenced by DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::DIALOG_EDIT_COMPONENT_IN_SCHEMATIC(), KIGFX::SCH_PAINTER::setDeviceColors(), and ShowClearance().

◆ IsHighlighted()

bool EDA_ITEM::IsHighlighted ( ) const
inlineinherited

Definition at line 227 of file base_struct.h.

227 { return m_Flags & HIGHLIGHTED; }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:142
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189

References HIGHLIGHTED, and EDA_ITEM::m_Flags.

Referenced by SCH_COMPONENT::ClearAllHighlightFlags(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), and KIGFX::SCH_VIEW::HighlightItem().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 221 of file base_struct.h.

221 { return m_Flags & IS_CHANGED; }
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:116
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189

References IS_CHANGED, and EDA_ITEM::m_Flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

◆ IsNew()

◆ IsReplaceable()

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_TEXT, SCH_SHEET_PIN, and SCH_FIELD.

Definition at line 517 of file base_struct.h.

517 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 226 of file base_struct.h.

226 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:121

References IS_RESIZED, and EDA_ITEM::m_Flags.

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

◆ IsSelected()

◆ IsType()

virtual bool EDA_ITEM::IsType ( const KICAD_T  aScanTypes[]) const
inlinevirtualinherited

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

Reimplemented in SCH_LABEL, SCH_FIELD, and SCH_LINE.

Definition at line 286 of file base_struct.h.

287  {
288  if( aScanTypes[0] == SCH_LOCATE_ANY_T )
289  return true;
290 
291  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
292  {
293  if( m_StructType == *p )
294  return true;
295  }
296 
297  return false;
298  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it.
Definition: base_struct.h:178
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

References EOT, EDA_ITEM::m_StructType, and SCH_LOCATE_ANY_T.

Referenced by SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), SCH_LINE::IsType(), SCH_FIELD::IsType(), SCH_LABEL::IsType(), EE_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EDA_ITEM::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 224 of file base_struct.h.

224 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:124
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189

References IS_WIRE_IMAGE, and EDA_ITEM::m_Flags.

◆ IterateForward() [1/2]

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

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

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

Definition at line 399 of file base_struct.h.

403  {
404  for( auto it : aList )
405  {
406  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
408  return SEARCH_RESULT::QUIT;
409  }
410 
412  }
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...

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

Referenced by Visit(), and BOARD::Visit().

◆ IterateForward() [2/2]

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

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

This changes first parameter to avoid the DList and use std::vector instead

Definition at line 420 of file base_struct.h.

422  {
423  for( auto it : aList )
424  {
425  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
427  return SEARCH_RESULT::QUIT;
428  }
429 
431  }
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...

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

◆ LoadGerberFile()

bool GERBER_FILE_IMAGE::LoadGerberFile ( const wxString &  aFullFileName)

Read and load a gerber file.

Parameters
aFullFileName= the full filename of the Gerber file when the file cannot be loaded Warning and info messages are stored in m_messagesList
Returns
bool if OK, false if the gerber file was not loaded

Definition at line 117 of file readgerb.cpp.

118 {
119  int G_command = 0; // command number for G commands like G04
120  int D_commande = 0; // command number for D commands like D02
121  char* text;
122 
123  ClearMessageList( );
125 
126  // Read the gerber file */
127  m_Current_File = wxFopen( aFullFileName, wxT( "rt" ) );
128 
129  if( m_Current_File == 0 )
130  return false;
131 
132  m_FileName = aFullFileName;
133 
134  LOCALE_IO toggleIo;
135 
136  wxString msg;
137 
138  while( true )
139  {
140  if( fgets( lineBuffer, GERBER_BUFZ, m_Current_File ) == NULL )
141  break;
142 
143  m_LineNum++;
144  text = StrPurge( lineBuffer );
145 
146  while( text && *text )
147  {
148  switch( *text )
149  {
150  case ' ':
151  case '\r':
152  case '\n':
153  text++;
154  break;
155 
156  case '*': // End command
158  text++;
159  break;
160 
161  case 'M': // End file
163  while( *text )
164  text++;
165  break;
166 
167  case 'G': /* Line type Gxx : command */
168  G_command = GCodeNumber( text );
169  Execute_G_Command( text, G_command );
170  break;
171 
172  case 'D': /* Line type Dxx : Tool selection (xx > 0) or
173  * command if xx = 0..9 */
174  D_commande = DCodeNumber( text );
175  Execute_DCODE_Command( text, D_commande );
176  break;
177 
178  case 'X':
179  case 'Y': /* Move or draw command */
180  m_CurrentPos = ReadXYCoord( text );
181  if( *text == '*' ) // command like X12550Y19250*
182  {
184  }
185  break;
186 
187  case 'I':
188  case 'J': /* Auxiliary Move command */
189  m_IJPos = ReadIJCoord( text );
190 
191  if( *text == '*' ) // command like X35142Y15945J504*
192  {
194  }
195  break;
196 
197  case '%':
199  {
202  }
203  else //Error
204  {
205  AddMessageToList( "Expected RS274X Command" );
207  text++;
208  }
209  break;
210 
211  default:
212  msg.Printf( "Unexpected char 0x%2.2X &lt;%c&lt;", *text, *text );
213  AddMessageToList( msg );
214  text++;
215  break;
216  }
217  }
218  }
219 
220  fclose( m_Current_File );
221 
222  m_InUse = true;
223 
224  return true;
225 }
void AddMessageToList(const wxString &aMessage)
Function AddMessageToList Add a message to the message list.
bool Execute_DCODE_Command(char *&text, int D_command)
Definition: rs274d.cpp:582
char * StrPurge(char *text)
Remove leading and training spaces, tabs and end of line chars in text.
Definition: string.cpp:310
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:202
wxPoint ReadIJCoord(char *&Text)
Returns the current coordinate type pointed to by InnJnn Text (InnnnJmmmm) These coordinates are rela...
void ClearMessageList()
Function ClearMessageList Clear the message list Call it before reading a Gerber file.
int GCodeNumber(char *&Text)
Definition: rs274d.cpp:411
static char lineBuffer[GERBER_BUFZ+1]
Definition: readgerb.cpp:115
#define NULL
int DCodeNumber(char *&Text)
Definition: rs274d.cpp:434
#define GERBER_BUFZ
Definition: readgerb.cpp:113
wxPoint ReadXYCoord(char *&aText, bool aExcellonMode=false)
Function ReadXYCoord Returns the current coordinate type pointed to by XnnYnn Text (XnnnnYmmmm)
bool Execute_G_Command(char *&text, int G_command)
Definition: rs274d.cpp:454
bool ReadRS274XCommand(char *aBuff, unsigned int aBuffSize, char *&aText)
reads a single RS274X command terminated with a %
Definition: rs274x.cpp:144
virtual void ResetDefaultValues()

References AddMessageToList(), ClearMessageList(), CMD_IDLE, DCodeNumber(), END_BLOCK, ENTER_RS274X_CMD, Execute_DCODE_Command(), Execute_G_Command(), GCodeNumber(), GERBER_BUFZ, lineBuffer, m_CommandState, m_Current_File, m_CurrentPos, m_FileName, m_IJPos, m_InUse, m_Last_Pen_Command, m_LineNum, NULL, ReadIJCoord(), ReadRS274XCommand(), ReadXYCoord(), ResetDefaultValues(), and StrPurge().

Referenced by GERBVIEW_FRAME::Read_GERBER_File().

◆ Matches() [1/2]

virtual bool EDA_ITEM::Matches ( wxFindReplaceData &  aSearchData,
void *  aAuxData 
)
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.
Returns
True if the item's text matches the search criteria in aSearchData.

Reimplemented in SCH_COMPONENT, SCH_SHEET, SCH_TEXT, SCH_SHEET_PIN, SCH_FIELD, MARKER_PCB, LIB_PIN, SCH_PIN, SCH_MARKER, TEXTE_MODULE, and TEXTE_PCB.

Definition at line 473 of file base_struct.h.

474  {
475  return false;
476  }

Referenced by SCH_EDITOR_CONTROL::HasMatch(), TEXTE_PCB::Matches(), TEXTE_MODULE::Matches(), SCH_MARKER::Matches(), LIB_PIN::Matches(), MARKER_PCB::Matches(), SCH_FIELD::Matches(), SCH_SHEET_PIN::Matches(), SCH_TEXT::Matches(), and SCH_EDITOR_CONTROL::ReplaceAndFindNext().

◆ Matches() [2/2]

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 152 of file base_struct.cpp.

153 {
154  wxString text = aText;
155  wxString searchText = aSearchData.GetFindString();
156 
157  // Don't match if searching for replaceable item and the item doesn't support text replace.
158  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
159  return false;
160 
161  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
162  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
163 
164  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
165  {
166  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
167  return text.Matches( searchText );
168 
169  return text.MakeUpper().Matches( searchText.MakeUpper() );
170  }
171 
172  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
173  return aText.Find( searchText ) != wxNOT_FOUND;
174 
175  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
176 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:517

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

◆ operator<()

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

Test if another item is less than this object.

Parameters
aItem- Item to compare against.
Returns
- True if aItem is less than the item.

Definition at line 206 of file base_struct.cpp.

207 {
208  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
209  GetChars( GetClass() ) ) );
210 
211  return false;
212 }
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:101
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

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

◆ ReadApertureMacro()

bool GERBER_FILE_IMAGE::ReadApertureMacro ( char *  aBuff,
unsigned int  aBuffSize,
char *&  text,
FILE *  gerber_file 
)
private

reads in an aperture macro and saves it in m_aperture_macros.

Parameters
aBuffa character buffer at least GERBER_BUFZ long that can be used to read successive lines from the gerber file.
textA reference to a character pointer which gives the initial text to read from.
aBuffSizeis the size of aBuff
gerber_fileWhich file to read from for continuation.
Returns
bool - true if a macro was read in successfully, else false.

Definition at line 920 of file rs274x.cpp.

923 {
924  wxString msg;
925  APERTURE_MACRO am;
926 
927  // read macro name
928  while( *aText )
929  {
930  if( *aText == '*' )
931  {
932  ++aText;
933  break;
934  }
935 
936  am.name.Append( *aText++ );
937  }
938 
939  // Read aperture macro parameters
940  for( ; ; )
941  {
942  if( *aText == '*' )
943  ++aText;
944 
945  aText = GetNextLine( aBuff, aBuffSize, aText, gerber_file );
946 
947  if( aText == NULL ) // End of File
948  return false;
949 
950  // aText points the beginning of a new line.
951 
952  // Test for the last line in aperture macro lis:
953  // last line is % or *% sometime found.
954  if( *aText == '*' )
955  ++aText;
956 
957  if( *aText == '%' )
958  break; // exit with aText still pointing at %
959 
960  int paramCount = 0; // will be set to the minimal parameters count,
961  // depending on the actual primitive
962  int primitive_type = AMP_UNKNOWN;
963  // Test for a valid symbol at the beginning of a description:
964  // it can be: a parameter declaration like $1=$2/4
965  // or a digit (macro primitive selection)
966  // all other symbols are illegal.
967  if( *aText == '$' ) // local parameter declaration, inside the aperture macro
968  {
969  am.m_localparamStack.push_back( AM_PARAM() );
970  AM_PARAM& param = am.m_localparamStack.back();
971  aText = GetNextLine( aBuff, aBuffSize, aText, gerber_file );
972  if( aText == NULL) // End of File
973  return false;
974  param.ReadParam( aText );
975  continue;
976  }
977  else if( !isdigit(*aText) ) // Ill. symbol
978  {
979  msg.Printf( wxT( "RS274X: Aperture Macro \"%s\": ill. symbol, line: \"%s\"" ),
980  GetChars( am.name ), GetChars( FROM_UTF8( aBuff ) ) );
981  AddMessageToList( msg );
982  primitive_type = AMP_COMMENT;
983  }
984  else
985  primitive_type = ReadInt( aText );
986 
987  bool is_comment = false;
988 
989  switch( primitive_type )
990  {
991  case AMP_COMMENT: // lines starting by 0 are a comment
992  paramCount = 0;
993  is_comment = true;
994  // Skip comment
995  while( *aText && ( *aText != '*' ) )
996  aText++;
997  break;
998 
999  case AMP_CIRCLE:
1000  paramCount = 4; // minimal count. can have a optional parameter (rotation)
1001  break;
1002 
1003  case AMP_LINE2:
1004  case AMP_LINE20:
1005  paramCount = 7;
1006  break;
1007 
1008  case AMP_LINE_CENTER:
1009  case AMP_LINE_LOWER_LEFT:
1010  paramCount = 6;
1011  break;
1012 
1013  case AMP_EOF:
1014  paramCount = 0;
1015  break;
1016 
1017  case AMP_OUTLINE:
1018  paramCount = 4; // partial count. other parameters are vertices and rotation
1019  // Second parameter is vertice (coordinate pairs) count.
1020  break;
1021 
1022  case AMP_POLYGON:
1023  paramCount = 6;
1024  break;
1025 
1026  case AMP_MOIRE:
1027  paramCount = 9;
1028  break;
1029 
1030  case AMP_THERMAL:
1031  paramCount = 6;
1032  break;
1033 
1034  default:
1035  msg.Printf( wxT( "RS274X: Aperture Macro \"%s\": Invalid primitive id code %d, line %d: \"%s\"" ),
1036  GetChars( am.name ), primitive_type, m_LineNum, GetChars( FROM_UTF8( aBuff ) ) );
1037  AddMessageToList( msg );
1038  return false;
1039  }
1040 
1041  if( is_comment )
1042  continue;
1043 
1044  AM_PRIMITIVE prim( m_GerbMetric );
1045  prim.primitive_id = (AM_PRIMITIVE_ID) primitive_type;
1046  int ii;
1047 
1048  for( ii = 0; ii < paramCount && *aText && *aText != '*'; ++ii )
1049  {
1050  prim.params.push_back( AM_PARAM() );
1051 
1052  AM_PARAM& param = prim.params.back();
1053 
1054  aText = GetNextLine( aBuff, aBuffSize, aText, gerber_file );
1055 
1056  if( aText == NULL) // End of File
1057  return false;
1058 
1059  param.ReadParam( aText );
1060  }
1061 
1062  if( ii < paramCount )
1063  {
1064  // maybe some day we can throw an exception and track a line number
1065  msg.Printf( "RS274X: read macro descr type %d: read %d parameters, insufficient parameters\n",
1066  prim.primitive_id, ii );
1067  AddMessageToList( msg );
1068  }
1069 
1070  // there are more parameters to read if this is an AMP_OUTLINE
1071  if( prim.primitive_id == AMP_OUTLINE )
1072  {
1073  // so far we have read [0]:exposure, [1]:#points, [2]:X start, [3]: Y start
1074  // Now read all the points, plus trailing rotation in degrees.
1075 
1076  // params[1] is a count of polygon points, so it must be given
1077  // in advance, i.e. be immediate.
1078  wxASSERT( prim.params[1].IsImmediate() );
1079 
1080  paramCount = (int) prim.params[1].GetValue( 0 ) * 2 + 1;
1081 
1082  for( int jj = 0; jj < paramCount && *aText != '*'; ++jj )
1083  {
1084  prim.params.push_back( AM_PARAM() );
1085 
1086  AM_PARAM& param = prim.params.back();
1087 
1088  aText = GetNextLine( aBuff, aBuffSize, aText, gerber_file );
1089 
1090  if( aText == NULL ) // End of File
1091  return false;
1092 
1093  param.ReadParam( aText );
1094  }
1095  }
1096 
1097  // AMP_CIRCLE can have a optional parameter (rotation)
1098  if( prim.primitive_id == AMP_CIRCLE && aText && *aText != '*' )
1099  {
1100  prim.params.push_back( AM_PARAM() );
1101  AM_PARAM& param = prim.params.back();
1102  param.ReadParam( aText );
1103  }
1104 
1105  am.primitives.push_back( prim );
1106  }
1107 
1108  m_aperture_macros.insert( am );
1109 
1110  return true;
1111 }
APERTURE_MACRO_SET m_aperture_macros
a collection of APERTURE_MACROS, sorted by name
void AddMessageToList(const wxString &aMessage)
Function AddMessageToList Add a message to the message list.
wxString name
The name of the aperture macro.
Definition: am_primitive.h:165
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:62
int ReadInt(char *&text, bool aSkipSeparator=true)
Function ReadInt reads an int from an ASCII character buffer.
bool ReadParam(char *&aText)
Function ReadParam Read one aperture macro parameter a parameter can be: a number a reference to an a...
Definition: am_param.cpp:171
AM_PARAMS m_localparamStack
Definition: am_primitive.h:174
char * GetNextLine(char *aBuff, unsigned int aBuffSize, char *aText, FILE *aFile)
test for an end of line if a end of line is found: read a new line
Definition: rs274x.cpp:892
#define NULL
AM_PARAM holds a parameter value for an "aperture macro" as defined within standard RS274X.
Definition: am_param.h:286
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:101
AM_PRIMITIVES primitives
A sequence of AM_PRIMITIVEs.
Definition: am_primitive.h:166
Struct AM_PRIMITIVE holds an aperture macro primitive as given in Table 3 of http://gerbv....
Definition: am_primitive.h:92
AM_PRIMITIVE_ID
Enum AM_PRIMITIVE_ID is the set of all "aperture macro primitives" (primitive numbers).
Definition: am_primitive.h:71
Struct APERTURE_MACRO helps support the "aperture macro" defined within standard RS274X.
Definition: am_primitive.h:163

References AddMessageToList(), AMP_CIRCLE, AMP_COMMENT, AMP_EOF, AMP_LINE2, AMP_LINE20, AMP_LINE_CENTER, AMP_LINE_LOWER_LEFT, AMP_MOIRE, AMP_OUTLINE, AMP_POLYGON, AMP_THERMAL, AMP_UNKNOWN, FROM_UTF8(), GetChars(), GetNextLine(), m_aperture_macros, m_GerbMetric, m_LineNum, APERTURE_MACRO::m_localparamStack, APERTURE_MACRO::name, NULL, AM_PRIMITIVE::params, AM_PRIMITIVE::primitive_id, APERTURE_MACRO::primitives, ReadInt(), and AM_PARAM::ReadParam().

Referenced by ExecuteRS274XCommand().

◆ ReadIJCoord()

wxPoint GERBER_FILE_IMAGE::ReadIJCoord ( char *&  Text)

Returns the current coordinate type pointed to by InnJnn Text (InnnnJmmmm) These coordinates are relative, so if coordinate is absent, it's value defaults to 0.

Definition at line 191 of file rs274_read_XY_and_IJ_coordinates.cpp.

192 {
193  wxPoint pos( 0, 0 );
194 
195  int type_coord = 0, current_coord, nbdigits;
196  bool is_float = false;
197  char* text;
198  char line[256];
199 
200  if( Text == NULL )
201  return pos;
202 
203  text = line;
204  while( *Text )
205  {
206  if( (*Text == 'I') || (*Text == 'J') )
207  {
208  type_coord = *Text;
209  Text++;
210  text = line;
211  nbdigits = 0;
212  while( IsNumber( *Text ) )
213  {
214  if( *Text == '.' )
215  is_float = true;
216 
217  // count digits only (sign and decimal point are not counted)
218  if( (*Text >= '0') && (*Text <='9') )
219  nbdigits++;
220 
221  *(text++) = *(Text++);
222  }
223 
224  *text = 0;
225  if( is_float )
226  {
227  // When X or Y values are float numbers, they are given in mm or inches
228  if( m_GerbMetric ) // units are mm
229  current_coord = KiROUND( atof( line ) * IU_PER_MILS / 0.0254 );
230  else // units are inches
231  current_coord = KiROUND( atof( line ) * IU_PER_MILS * 1000 );
232  }
233  else
234  {
235  int fmt_scale =
236  (type_coord == 'I') ? m_FmtScale.x : m_FmtScale.y;
237 
238  if( m_NoTrailingZeros )
239  {
240  int min_digit =
241  (type_coord == 'I') ? m_FmtLen.x : m_FmtLen.y;
242  while( nbdigits < min_digit )
243  {
244  *(text++) = '0';
245  nbdigits++;
246  }
247 
248  *text = 0;
249  }
250 
251  current_coord = atoi( line );
252 
253  double real_scale = scale_list[fmt_scale];
254 
255  if( m_GerbMetric )
256  real_scale = real_scale / 25.4;
257 
258  current_coord = KiROUND( current_coord * real_scale );
259  }
260  if( type_coord == 'I' )
261  pos.x = current_coord;
262  else if( type_coord == 'J' )
263  pos.y = current_coord;
264 
265  continue;
266  }
267  else
268  break;
269  }
270 
271  m_IJPos = pos;
273  m_LastCoordIsIJPos = true;
274 
275  return pos;
276 }
#define NULL
static double scale_list[SCALE_LIST_SIZE]
LAST_EXTRA_ARC_DATA_TYPE m_LastArcDataType
#define IU_PER_MILS
Definition: plotter.cpp:137
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:61
#define IsNumber(x)

References ARC_INFO_TYPE_CENTER, IsNumber, IU_PER_MILS, KiROUND(), m_FmtLen, m_FmtScale, m_GerbMetric, m_IJPos, m_LastArcDataType, m_LastCoordIsIJPos, m_NoTrailingZeros, NULL, scale_list, wxPoint::x, and wxPoint::y.

Referenced by EXCELLON_IMAGE::Execute_Drill_Command(), EXCELLON_IMAGE::Execute_EXCELLON_G_Command(), EXCELLON_IMAGE::LoadFile(), and LoadGerberFile().

◆ ReadRS274XCommand()

bool GERBER_FILE_IMAGE::ReadRS274XCommand ( char *  aBuff,
unsigned int  aBuffSize,
char *&  aText 
)
private

reads a single RS274X command terminated with a %

Definition at line 144 of file rs274x.cpp.

145 {
146  bool ok = true;
147  int code_command;
148 
149  aText++;
150 
151  for( ; ; )
152  {
153  while( *aText )
154  {
155  switch( *aText )
156  {
157  case '%': // end of command
158  aText++;
160  goto exit; // success completion
161 
162  case ' ':
163  case '\r':
164  case '\n':
165  aText++;
166  break;
167 
168  case '*':
169  aText++;
170  break;
171 
172  default:
173  code_command = ReadXCommandID( aText );
174  ok = ExecuteRS274XCommand( code_command, aBuff, aBuffSize, aText );
175 
176  if( !ok )
177  goto exit;
178 
179  break;
180  }
181  }
182 
183  // end of current line, read another one.
184  if( fgets( aBuff, aBuffSize, m_Current_File ) == NULL )
185  {
186  // end of file
187  ok = false;
188  break;
189  }
190  m_LineNum++;
191  aText = aBuff;
192  }
193 
194 exit:
195  return ok;
196 }
int ReadXCommandID(char *&text)
reads two bytes of data and assembles them into an int with the first byte in the sequence put into t...
Definition: rs274x.cpp:116
bool ExecuteRS274XCommand(int aCommand, char *aBuff, unsigned int aBuffSize, char *&aText)
executes a RS274X command
Definition: rs274x.cpp:199
#define NULL

References CMD_IDLE, ExecuteRS274XCommand(), m_CommandState, m_Current_File, m_LineNum, NULL, and ReadXCommandID().

Referenced by LoadGerberFile().

◆ ReadXCommandID()

int GERBER_FILE_IMAGE::ReadXCommandID ( char *&  text)
private

reads two bytes of data and assembles them into an int with the first byte in the sequence put into the most significant part of a 16 bit value to build a RS274X command identifier.

Parameters
textA reference to a pointer to read bytes from and to advance as they are read.
Returns
a RS274X command identifier.

Definition at line 116 of file rs274x.cpp.

117 {
118  /* reads two bytes of data and assembles them into an int with the first
119  * byte in the sequence put into the most significant part of a 16 bit value
120  */
121  int result;
122  int currbyte;
123 
124  if( text && *text )
125  {
126  currbyte = *text++;
127  result = ( currbyte & 0xFF ) << 8;
128  }
129  else
130  return -1;
131 
132  if( text && *text )
133  {
134  currbyte = *text++;
135  result += currbyte & 0xFF;
136  }
137  else
138  return -1;
139 
140  return result;
141 }

Referenced by Execute_G_Command(), ExecuteRS274XCommand(), and ReadRS274XCommand().

◆ ReadXYCoord()

wxPoint GERBER_FILE_IMAGE::ReadXYCoord ( char *&  aText,
bool  aExcellonMode = false 
)

Function ReadXYCoord Returns the current coordinate type pointed to by XnnYnn Text (XnnnnYmmmm)

Parameters
aTextis a pointer to the text to parse.
aExcellonMode= true to parse a Excellon drill file. it force truncation of a digit string to a max len because the exact coordinate format is not always known

Definition at line 73 of file rs274_read_XY_and_IJ_coordinates.cpp.

74 {
75  wxPoint pos;
76  int type_coord = 0, current_coord, nbdigits;
77  bool is_float = false;
78  char* text;
79  char line[256];
80 
81 
82  if( m_Relative )
83  pos.x = pos.y = 0;
84  else
85  pos = m_CurrentPos;
86 
87  if( Text == NULL )
88  return pos;
89 
90  text = line;
91  while( *Text )
92  {
93  if( (*Text == 'X') || (*Text == 'Y') || (*Text == 'A') )
94  {
95  type_coord = *Text;
96  Text++;
97  text = line;
98  nbdigits = 0;
99 
100  while( IsNumber( *Text ) )
101  {
102  if( *Text == '.' ) // Force decimat format if reading a floating point number
103  is_float = true;
104 
105  // count digits only (sign and decimal point are not counted)
106  if( (*Text >= '0') && (*Text <='9') )
107  nbdigits++;
108  *(text++) = *(Text++);
109  }
110 
111  *text = 0;
112 
113  if( is_float )
114  {
115  // When X or Y (or A) values are float numbers, they are given in mm or inches
116  if( m_GerbMetric ) // units are mm
117  current_coord = KiROUND( atof( line ) * IU_PER_MILS / 0.0254 );
118  else // units are inches
119  current_coord = KiROUND( atof( line ) * IU_PER_MILS * 1000 );
120  }
121  else
122  {
123  int fmt_scale = (type_coord == 'X') ? m_FmtScale.x : m_FmtScale.y;
124 
125  if( m_NoTrailingZeros )
126  {
127  // no trailing zero format, we need to add missing zeros.
128  int digit_count = (type_coord == 'X') ? m_FmtLen.x : m_FmtLen.y;
129 
130  while( nbdigits < digit_count )
131  {
132  *(text++) = '0';
133  nbdigits++;
134  }
135 
136  if( aExcellonMode )
137  {
138  // Truncate the extra digits if the len is more than expected
139  // because the conversion to internal units expect exactly
140  // digit_count digits
141  while( nbdigits > digit_count )
142  {
143  *(text--) = 0;
144  nbdigits--;
145  }
146  }
147 
148  *text = 0;
149  }
150 
151  current_coord = atoi( line );
152  double real_scale = scale_list[fmt_scale];
153 
154  if( m_GerbMetric )
155  real_scale = real_scale / 25.4;
156 
157  current_coord = KiROUND( current_coord * real_scale );
158  }
159 
160  if( type_coord == 'X' )
161  pos.x = current_coord;
162  else if( type_coord == 'Y' )
163  pos.y = current_coord;
164  else if( type_coord == 'A' )
165  {
166  m_ArcRadius = current_coord;
168  }
169 
170  continue;
171  }
172  else
173  break;
174  }
175 
176  if( m_Relative )
177  {
178  pos.x += m_CurrentPos.x;
179  pos.y += m_CurrentPos.y;
180  }
181 
182  m_CurrentPos = pos;
183  return pos;
184 }
#define NULL
static double scale_list[SCALE_LIST_SIZE]
LAST_EXTRA_ARC_DATA_TYPE m_LastArcDataType
#define IU_PER_MILS
Definition: plotter.cpp:137
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:61
#define IsNumber(x)

References ARC_INFO_TYPE_RADIUS, IsNumber, IU_PER_MILS, KiROUND(), m_ArcRadius, m_CurrentPos, m_FmtLen, m_FmtScale, m_GerbMetric, m_LastArcDataType, m_NoTrailingZeros, m_Relative, NULL, scale_list, wxPoint::x, and wxPoint::y.

Referenced by EXCELLON_IMAGE::Execute_Drill_Command(), EXCELLON_IMAGE::Execute_EXCELLON_G_Command(), and LoadGerberFile().

◆ RemoveAttribute()

void GERBER_FILE_IMAGE::RemoveAttribute ( X2_ATTRIBUTE aAttribute)

Function RemoveAttribute.

Called when a TD command is found the Gerber file

Parameters
aAttributeis the X2_ATTRIBUTE which stores the full command Remove the attribute specified by the TD command. is no attribute, all current attributes specified by the TO and the TA commands are cleared. if a attribute name is specified (for instance TD.CN*%) is specified, only this attribute is cleared

Definition at line 373 of file gerber_file_image.cpp.

374 {
375  /* Called when a %TD command is found
376  * Remove the attribute specified by the %TD command.
377  * is no attribute, all current attributes specified by the %TO and the %TA
378  * commands are cleared.
379  * if a attribute name is specified (for instance %TD.CN*%) is specified,
380  * only this attribute is cleared
381  */
382  wxString cmd = aAttribute.GetPrm( 0 );
384 
385  if( cmd.IsEmpty() || cmd == ".AperFunction" )
386  m_AperFunction.Clear();
387 }
const wxString & GetPrm(int aIdx)
GBR_NETLIST_METADATA m_NetAttributeDict
void ClearAttribute(const wxString *aName)
remove the net attribute specified by aName If aName == NULL or empty, remove all attributes

References GBR_NETLIST_METADATA::ClearAttribute(), X2_ATTRIBUTE::GetPrm(), m_AperFunction, and m_NetAttributeDict.

Referenced by ExecuteRS274XCommand().

◆ Replace() [1/2]

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

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 179 of file base_struct.cpp.

180 {
181  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
182 
183  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
184  aSearchData.GetFindString() :
185  aSearchData.GetFindString().Upper() );
186 
187  if( result == wxNOT_FOUND )
188  return false;
189 
190  wxString prefix = aText.Left( result );
191  wxString suffix;
192 
193  if( aSearchData.GetFindString().length() + result < aText.length() )
194  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
195 
196  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
197  GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
198  GetChars( suffix ) );
199 
200  aText = prefix + aSearchData.GetReplaceString() + suffix;
201 
202  return true;
203 }
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:101

References GetChars(), and traceFindReplace.

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

◆ Replace() [2/2]

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_TEXT, SCH_SHEET_PIN, and SCH_FIELD.

Definition at line 505 of file base_struct.h.

505 { return false; }

◆ ResetDefaultValues()

void GERBER_FILE_IMAGE::ResetDefaultValues ( )
virtual

Reimplemented in EXCELLON_IMAGE.

Definition at line 170 of file gerber_file_image.cpp.

171 {
172  m_InUse = false;
174  m_FileName.Empty();
175  m_ImageName = wxT( "no name" ); // Image name from the IN command
176  m_ImageNegative = false; // true = Negative image
177  m_IsX2_file = false; // true only if a %TF, %TA or %TD command
178  delete m_FileFunction; // file function parameters
180  m_MD5_value.Empty(); // MD5 value found in a %TF.MD5 command
181  m_PartString.Empty(); // string found in a %TF.Part command
182  m_hasNegativeItems = -1; // set to uninitialized
183  m_ImageJustifyOffset = wxPoint(0,0); // Image justify Offset
184  m_ImageJustifyXCenter = false; // Image Justify Center on X axis (default = false)
185  m_ImageJustifyYCenter = false; // Image Justify Center on Y axis (default = false)
186  m_GerbMetric = false; // false = Inches (default), true = metric
187  m_Relative = false; // false = absolute Coord,
188  // true = relative Coord
189  m_NoTrailingZeros = false; // true: trailing zeros deleted
190  m_ImageOffset.x = m_ImageOffset.y = 0; // Coord Offset, from IO command
191  m_ImageRotation = 0; // Allowed 0, 90, 180, 270 (in degree)
192  m_LocalRotation = 0.0; // Layer totation from RO command (in 0.1 degree)
193  m_Offset.x = 0;
194  m_Offset.y = 0; // Coord Offset, from OF command
195  m_Scale.x = m_Scale.y = 1.0; // scale (A and B) this layer
196  m_MirrorA = false; // true: miror / axe A (default = X)
197  m_MirrorB = false; // true: miror / axe B (default = Y)
198  m_SwapAxis = false; // false if A = X, B = Y; true if A =Y, B = Y
199  m_Has_DCode = false; // true = DCodes in file
200  // false = no DCode-> perhaps deprecated RS274D file
201  m_Has_MissingDCode = false; // true = some D_Codes are used, but not defined
202  // perhaps deprecated RS274D file
203  m_FmtScale.x = m_FmtScale.y = 4; // Initialize default format to 3.4 => 4
204  m_FmtLen.x = m_FmtLen.y = 3 + 4; // Initialize default format len = 3+4
205 
206  m_Iterpolation = GERB_INTERPOL_LINEAR_1X; // Linear, 90 arc, Circ.
207  m_360Arc_enbl = false; // 360 deg circular
208  // interpolation disable
209  m_Current_Tool = 0; // Current Dcode selected
210  m_CommandState = 0; // State of the current command
211  m_CurrentPos.x = m_CurrentPos.y = 0; // current specified coord
212  m_PreviousPos.x = m_PreviousPos.y = 0; // last specified coord
213  m_IJPos.x = m_IJPos.y = 0; // current centre coord for
214  // plot arcs & circles
215  m_LastCoordIsIJPos = false; // True only after a IJ coordinate is read
216  m_ArcRadius = 0; // radius of arcs in circular interpol (given by A## command).
217  // in command like X##Y##A##
218  m_LastArcDataType = ARC_INFO_TYPE_NONE; // Extra coordinate info type for arcs
219  // (radius or IJ center coord)
220  m_LineNum = 0; // line number in file being read
221  m_Current_File = NULL; // Gerber file to read
222  m_PolygonFillMode = false;
224  m_Selected_Tool = 0;
225  m_Last_Pen_Command = 0;
226  m_Exposure = false;
227 }
X2_ATTRIBUTE_FILEFUNCTION * m_FileFunction
GERBER_LAYER m_GBRLayerParams
#define NULL
bool m_Exposure
whether an aperture macro tool is flashed on or off
LAST_EXTRA_ARC_DATA_TYPE m_LastArcDataType

References ARC_INFO_TYPE_NONE, GERB_INTERPOL_LINEAR_1X, m_360Arc_enbl, m_ArcRadius, m_CommandState, m_Current_File, m_Current_Tool, m_CurrentPos, m_Exposure, m_FileFunction, m_FileName, m_FmtLen, m_FmtScale, m_GBRLayerParams, m_GerbMetric, m_Has_DCode, m_Has_MissingDCode, m_hasNegativeItems, m_IJPos, m_ImageJustifyOffset, m_ImageJustifyXCenter, m_ImageJustifyYCenter, m_ImageName, m_ImageNegative, m_ImageOffset, m_ImageRotation, m_InUse, m_IsX2_file, m_Iterpolation, m_Last_Pen_Command, m_LastArcDataType, m_LastCoordIsIJPos, m_LineNum, m_LocalRotation, m_MD5_value, m_MirrorA, m_MirrorB, m_NoTrailingZeros, m_Offset, m_PartString, m_PolygonFillMode, m_PolygonFillModeState, m_PreviousPos, m_Relative, m_Scale, m_Selected_Tool, m_SwapAxis, NULL, GERBER_LAYER::ResetDefaultValues(), wxPoint::x, and wxPoint::y.

Referenced by GERBER_FILE_IMAGE(), LoadGerberFile(), and EXCELLON_IMAGE::ResetDefaultValues().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )
inlineinherited

◆ SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 257 of file base_struct.h.

257 { m_Flags |= aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189

References EDA_ITEM::m_Flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddModuleToBoard(), PCBNEW_CONTROL::AppendBoard(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::ConvertTextType(), SCH_EDIT_FRAME::CreateNewText(), LIB_PIN_TOOL::CreatePin(), SCH_EDIT_FRAME::CreateSheetPin(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), KIGFX::SCH_PAINTER::draw(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), LIB_DRAWING_TOOLS::DrawShape(), SCH_EDIT_TOOL::Duplicate(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_MOVE_TOOL::getConnectedDragItems(), KIGFX::SCH_VIEW::HighlightItem(), EDIT_POINTS_FACTORY::Make(), TRACKS_CLEANER::mergeCollinearSegments(), SCH_MOVE_TOOL::moveItem(), LIB_MOVE_TOOL::moveItem(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), LIB_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), PCB_EDITOR_CONTROL::PlaceModule(), DRAWING_TOOL::PlaceText(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), LIB_EDIT_FRAME::SaveCopyInUndoList(), EE_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::SelectPoint(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetBrightened(), LIB_PIN::SetConversion(), EDA_ITEM::SetHighlighted(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), WS_DATA_ITEM::SyncDrawItems(), WS_DATA_ITEM_TEXT::SyncDrawItems(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), LIB_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetForceVisible()

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 308 of file base_struct.h.

308 { m_forceVisible = aEnable; }
bool m_forceVisible
Set to true to override the visibility setting of the item.
Definition: base_struct.h:186

References EDA_ITEM::m_forceVisible.

◆ SetHighlighted()

void EDA_ITEM::SetHighlighted ( )
inlineinherited

Definition at line 232 of file base_struct.h.

232 { SetFlags( HIGHLIGHTED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:257
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:142

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

◆ SetModified()

◆ SetParent()

◆ SetSelected()

void EDA_ITEM::SetSelected ( )
inlineinherited

◆ SetState()

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

Definition at line 246 of file base_struct.h.

247  {
248  if( state )
249  m_Status |= type; // state = ON or OFF
250  else
251  m_Status &= ~type;
252  }
STATUS_FLAGS m_Status
Definition: base_struct.h:179

References EDA_ITEM::m_Status.

Referenced by LEGACY_PLUGIN::loadTrackList(), TRACKS_CLEANER::mergeCollinearSegments(), SELECTION_TOOL::selectConnectedTracks(), and TRACK::SetLocked().

◆ SetStatus()

void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited

Definition at line 255 of file base_struct.h.

255 { m_Status = aStatus; }
STATUS_FLAGS m_Status
Definition: base_struct.h:179

References EDA_ITEM::m_Status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 230 of file base_struct.h.

230 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:257
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:124

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

◆ Sort()

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 536 of file base_struct.h.

536 { return *aLeft < *aRight; }

◆ StepAndRepeatItem()

void GERBER_FILE_IMAGE::StepAndRepeatItem ( const GERBER_DRAW_ITEM aItem)

Function StepAndRepeatItem Gerber format has a command Step an Repeat This function must be called when reading a gerber file and after creating a new gerber item that must be repeated (i.e when m_XRepeatCount or m_YRepeatCount are > 1)

Parameters
aItem= the item to repeat

Definition at line 296 of file gerber_file_image.cpp.

297 {
298  if( GetLayerParams().m_XRepeatCount < 2 &&
299  GetLayerParams().m_YRepeatCount < 2 )
300  return; // Nothing to repeat
301 
302  // Duplicate item:
303  for( int ii = 0; ii < GetLayerParams().m_XRepeatCount; ii++ )
304  {
305  for( int jj = 0; jj < GetLayerParams().m_YRepeatCount; jj++ )
306  {
307  // the first gerber item already exists (this is the template)
308  // create duplicate only if ii or jj > 0
309  if( jj == 0 && ii == 0 )
310  continue;
311 
312  GERBER_DRAW_ITEM* dupItem = new GERBER_DRAW_ITEM( aItem );
313  wxPoint move_vector;
314  move_vector.x = scaletoIU( ii * GetLayerParams().m_StepForRepeat.x,
315  GetLayerParams().m_StepForRepeatMetric );
316  move_vector.y = scaletoIU( jj * GetLayerParams().m_StepForRepeat.y,
317  GetLayerParams().m_StepForRepeatMetric );
318  dupItem->MoveXY( move_vector );
319  AddItemToList( dupItem );
320  }
321  }
322 }
int scaletoIU(double aCoord, bool isMetric)
Function scaletoIU converts a distance given in floating point to our internal units.
void AddItemToList(GERBER_DRAW_ITEM *aItem)
Add a new GERBER_DRAW_ITEM item to the drawings list.
void MoveXY(const wxPoint &aMoveVector)
Function MoveXY move this object.
GERBER_LAYER & GetLayerParams()
Function GetLayerParams.

References AddItemToList(), GetLayerParams(), GERBER_LAYER::m_XRepeatCount, GERBER_LAYER::m_YRepeatCount, GERBER_DRAW_ITEM::MoveXY(), scaletoIU(), wxPoint::x, and wxPoint::y.

Referenced by Execute_DCODE_Command(), EXCELLON_IMAGE::Execute_Drill_Command(), Execute_G_Command(), and EXCELLON_IMAGE::FinishRouteCommand().

◆ Type()

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 212 of file base_struct.h.

213  {
214  return m_StructType;
215  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it.
Definition: base_struct.h:178

References EDA_ITEM::m_StructType.

Referenced by MODULE::Add(), CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), CN_CLUSTER::Add(), POINT_EDITOR::addCorner(), CONNECTION_SUBGRAPH::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), ZONE_FILLER::addKnockout(), SCH_SHEET::AddPin(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), CN_ITEM::AnchorCount(), SCH_SCREEN::Append(), CONNECTION_GRAPH::buildConnectionGraph(), SCH_SCREENS::buildScreenList(), calcArea(), calcMaxArea(), PCB_INSPECTION_TOOL::calculateSelectionRatsnest(), POINT_EDITOR::canAddCorner(), SCH_JUNCTION::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_LABEL::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SHEET::CanConnect(), SCH_COMPONENT::CanConnect(), ROUTER_TOOL::CanInlineDrag(), SCH_MARKER::ClassOf(), SCH_JUNCTION::ClassOf(), TEXTE_PCB::ClassOf(), SCH_NO_CONNECT::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), SCH_PIN::ClassOf(), EDGE_MODULE::ClassOf(), PCB_TARGET::ClassOf(), SCH_LINE::ClassOf(), SCH_FIELD::ClassOf(), TEXTE_MODULE::ClassOf(), DRAWSEGMENT::ClassOf(), ZONE_CONTAINER::ClassOf(), SCH_BITMAP::ClassOf(), TRACK::ClassOf(), DIMENSION::ClassOf(), NETINFO_ITEM::ClassOf(), MARKER_PCB::ClassOf(), SCH_SHEET_PIN::ClassOf(), MODULE::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), SCH_SCREEN::ClassOf(), D_PAD::ClassOf(), SCH_COMPONENT::ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), BOARD::ClassOf(), SCH_TEXT::ClassOf(), SCH_SHEET::ClassOf(), ARC::ClassOf(), SCH_LABEL::ClassOf(), VIA::ClassOf(), SCH_GLOBALLABEL::ClassOf(), SCH_HIERLABEL::ClassOf(), TRACKS_CLEANER::cleanupSegments(), LIB_RECTANGLE::compare(), LIB_BEZIER::compare(), LIB_CIRCLE::compare(), LIB_TEXT::compare(), LIB_POLYLINE::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_ITEM::compare(), LIB_PIN::compare(), GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), EE_RTREE::contains(), SCH_EDIT_FRAME::ConvertTextType(), MODULE::CoverageRatio(), CINFO3D_VISU::createLayers(), SCH_EDIT_FRAME::CreateNewText(), CINFO3D_VISU::createNewTrack(), NETLIST_EXPORTER::CreatePinList(), D_PAD::D_PAD(), SCH_SCREEN::DeleteItem(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), SCH_EDITOR_CONTROL::doCopy(), SCH_EDIT_TOOL::DoDelete(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), DRC::doTrackDrc(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), CN_ITEM::Dump(), EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), MODULE::DuplicateItem(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::editFieldText(), LIB_EDIT_TOOL::editTextProperties(), EditToolSelectionFilter(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckLabels(), NETLIST_EXPORTER::findNextComponent(), PCB_BASE_FRAME::FocusOnItem(), SCH_BASE_FRAME::FocusOnItem(), EDIT_TOOL::FootprintFilter(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), SCH_FIELD::GetBoundingBox(), TRACK::GetBoundingBox(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), NETLIST_OBJECT::GetComponentParent(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_TEXT::GetConnectionPoints(), CONNECTION_GRAPH::getDefaultConnection(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_TEXT::GetEndPoints(), SCH_FIELD::GetFullyQualifiedText(), SCH_FIELD::GetMenuImage(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetName(), CONNECTION_SUBGRAPH::GetNameForDriver(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), DRAWSEGMENT::GetParentModule(), SCH_FIELD::GetParentPosition(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), SCH_FIELD::GetPosition(), getRect(), KIGFX::SCH_PAINTER::getRenderColor(), PCBNEW_SELECTION::GetTopLeftItem(), SELECTION_TOOL::GuessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), hash_eda(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlight(), KIGFX::SCH_VIEW::HighlightItem(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EE_RTREE::insert(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), TRACK::IsNull(), SCH_LINE::IsParallel(), SCH_FIELD::IsReplaceable(), SCH_SCREEN::IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), CLIPBOARD_IO::Load(), PNS_PCBNEW_RULE_RESOLVER::localPadClearance(), SCH_MOVE_TOOL::Main(), EE_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), SCH_SCREEN::MarkConnections(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), SCH_FIELD::Matches(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_CONNECTION::Name(), SCH_EDITOR_CONTROL::nextMatch(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), POINT_EDITOR::OnSelectionChange(), SCH_BUS_ENTRY_BASE::operator<(), SCH_FIELD::operator<(), SCH_LINE::operator<(), LIB_ITEM::operator<(), SCH_TEXT::operator<(), SCH_ITEM::operator<(), SCH_SHEET::operator<(), SCH_COMPONENT::operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_COMPONENT::operator=(), EDIT_TOOL::PadFilter(), BOARD_COMMIT::parentObject(), PCBNEW_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_FIELD::Plot(), SCH_SCREEN::Plot(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), SCH_FIELD::Print(), SCH_SCREEN::Print(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshItem(), SCH_BASE_FRAME::RefreshSelection(), EE_RTREE::remove(), MODULE::Remove(), CN_CONNECTIVITY_ALGO::Remove(), BOARD::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), SCH_SHEET::RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_FIELD::Replace(), WS_PROXY_UNDO_ITEM::Restore(), SCH_EDIT_TOOL::Rotate(), SCH_TEXT::Rotate(), SCH_SEXPR_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_SEXPR_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_SEXPR_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_SEXPR_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SELECTION_TOOL::select(), SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::Selectable(), SELECTION_TOOL::selectConnectedTracks(), ITEM_PICKER::SetItem(), SCH_FIELD::SetPosition(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), ShowClearance(), BOARD_COMMIT::Stage(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), SCH_BITMAP::SwapData(), PCB_TARGET::SwapData(), TEXTE_PCB::SwapData(), SCH_SHEET_PIN::SwapData(), SCH_FIELD::SwapData(), TRACK::SwapData(), DIMENSION::SwapData(), ARC::SwapData(), SCH_SHEET::SwapData(), VIA::SwapData(), SCH_COMPONENT::SwapData(), MODULE::SwapData(), ZONE_CONTAINER::SwapData(), D_PAD::SwapData(), SwapItemData(), TEXTE_MODULE::TEXTE_MODULE(), AR_MATRIX::TraceSegmentPcb(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FIELDS_EDITOR_GLOBAL::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), TRACK::TransformShapeWithClearanceToPolygon(), LIB_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlight(), SCH_TEXT::UpdateDanglingState(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), EE_POINT_EDITOR::updateItem(), POINT_EDITOR::updateItem(), CONNECTION_GRAPH::updateItemConnectivity(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updatePoints(), POINT_EDITOR::updatePoints(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateView(), PCB_BRIGHT_BOX::ViewDraw(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), SCH_SHEET::Visit(), SCH_COMPONENT::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const
overridevirtualinherited

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

Returns
BOX2I - the current bounding box

Implements KIGFX::VIEW_ITEM.

Reimplemented in D_PAD, MODULE, EDIT_POINTS, GERBER_DRAW_ITEM, DRAWSEGMENT, DIMENSION, TEXTE_MODULE, TRACK, MARKER_PCB, KIGFX::WS_PROXY_VIEW_ITEM, ROUTER_PREVIEW_ITEM, MY_DRAWING, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::PREVIEW::POLYGON_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::RULER_ITEM, KIGFX::RATSNEST_VIEWITEM, BRIGHT_BOX, and KIGFX::PREVIEW::ARC_ASSISTANT.

Definition at line 227 of file base_struct.cpp.

228 {
229  // Basic fallback
230  return BOX2I( VECTOR2I( GetBoundingBox().GetOrigin() ),
231  VECTOR2I( GetBoundingBox().GetSize() ) );
232 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:521
VECTOR2< int > VECTOR2I
Definition: vector2d.h:594
virtual const EDA_RECT GetBoundingBox() const
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.

References EDA_ITEM::GetBoundingBox().

Referenced by GERBVIEW_FRAME::GetDocumentExtents(), BRIGHT_BOX::ViewBBox(), DIMENSION::ViewBBox(), DRAWSEGMENT::ViewBBox(), and BRIGHT_BOX::ViewDraw().

◆ ViewDraw()

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::WS_PROXY_VIEW_ITEM, ROUTER_PREVIEW_ITEM, KIGFX::VIEW_GROUP, KIGFX::PREVIEW::SELECTION_AREA, MY_DRAWING, 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.

117  {}

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

◆ ViewGetLayers()

void EDA_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[]

Implements KIGFX::VIEW_ITEM.

Reimplemented in D_PAD, MODULE, SCH_SHEET, EDIT_POINTS, VIA, BOARD_ITEM, GERBER_DRAW_ITEM, SCH_ITEM, TEXTE_MODULE, TRACK, LIB_PART, LIB_ITEM, SCH_COMPONENT, MY_DRAWING, ZONE_CONTAINER, LIB_FIELD, MARKER_PCB, SCH_LINE, KIGFX::WS_PROXY_VIEW_ITEM, ROUTER_PREVIEW_ITEM, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_NO_CONNECT, KIGFX::ORIGIN_VIEWITEM, WS_DRAW_ITEM_BASE, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, LIB_TEXT, SCH_JUNCTION, BRIGHT_BOX, KIGFX::RATSNEST_VIEWITEM, SCH_MARKER, and KIGFX::PREVIEW::RULER_ITEM.

Definition at line 235 of file base_struct.cpp.

236 {
237  // Basic fallback
238  aCount = 1;
239  aLayers[0] = 0;
240 }

◆ ViewGetLOD()

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 MODULE_ZONE_CONTAINER, D_PAD, MODULE, VIA, GERBER_DRAW_ITEM, TEXTE_MODULE, TRACK, and EDGE_MODULE.

Definition at line 140 of file view_item.h.

141  {
142  // By default always show the item
143  return 0;
144  }

Referenced by KIGFX::VIEW::drawItem::operator()(), GRID_HELPER::queryVisible(), and SELECTION_TOOL::Selectable().

◆ viewPrivData()

◆ Visit()

SEARCH_RESULT GERBER_FILE_IMAGE::Visit ( INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 390 of file gerber_file_image.cpp.

391 {
392  KICAD_T stype;
394  const KICAD_T* p = scanTypes;
395  bool done = false;
396 
397  while( !done )
398  {
399  stype = *p;
400 
401  switch( stype )
402  {
403  case GERBER_IMAGE_T:
404  case GERBER_LAYOUT_T:
405  ++p;
406  break;
407 
408  case GERBER_DRAW_ITEM_T:
409  result = IterateForward( GetItems(), inspector, testData, p );
410  ++p;
411  break;
412 
413  case EOT:
414  default: // catch EOT or ANY OTHER type here and return.
415  done = true;
416  break;
417  }
418 
419  if( result == SEARCH_RESULT::QUIT )
420  break;
421  }
422 
423  return result;
424 }
GERBER_DRAW_ITEMS & GetItems()
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
static SEARCH_RESULT IterateForward(std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )
Definition: base_struct.h:399
SEARCH_RESULT
Definition: base_struct.h:54

References CONTINUE, EOT, GERBER_DRAW_ITEM_T, GERBER_IMAGE_T, GERBER_LAYOUT_T, GetItems(), EDA_ITEM::IterateForward(), and QUIT.

Referenced by GBR_LAYOUT::Visit().

Member Data Documentation

◆ m_360Arc_enbl

bool GERBER_FILE_IMAGE::m_360Arc_enbl

◆ m_AperFunction

wxString GERBER_FILE_IMAGE::m_AperFunction

◆ m_Aperture_List

D_CODE* GERBER_FILE_IMAGE::m_Aperture_List[TOOLS_MAX_COUNT]
private

Dcode (Aperture) List for this layer (max TOOLS_MAX_COUNT: see dcode.h)

Definition at line 111 of file gerber_file_image.h.

Referenced by GERBER_FILE_IMAGE(), GetDCODE(), GetDCODEOrCreate(), GetDcodesCount(), InitToolTable(), and ~GERBER_FILE_IMAGE().

◆ m_aperture_macros

APERTURE_MACRO_SET GERBER_FILE_IMAGE::m_aperture_macros

a collection of APERTURE_MACROS, sorted by name

Definition at line 173 of file gerber_file_image.h.

Referenced by FindApertureMacro(), InitToolTable(), and ReadApertureMacro().

◆ m_ArcRadius

int GERBER_FILE_IMAGE::m_ArcRadius

◆ m_CommandState

int GERBER_FILE_IMAGE::m_CommandState

Definition at line 154 of file gerber_file_image.h.

Referenced by LoadGerberFile(), ReadRS274XCommand(), and ResetDefaultValues().

◆ m_ComponentsList

std::map<wxString, int> GERBER_FILE_IMAGE::m_ComponentsList

◆ m_Current_File

FILE* GERBER_FILE_IMAGE::m_Current_File

◆ m_Current_Tool

◆ m_CurrentPos

◆ m_drawings

GERBER_DRAW_ITEMS GERBER_FILE_IMAGE::m_drawings
private

◆ m_Exposure

bool GERBER_FILE_IMAGE::m_Exposure
private

whether an aperture macro tool is flashed on or off

Definition at line 113 of file gerber_file_image.h.

Referenced by Execute_DCODE_Command(), Execute_G_Command(), and ResetDefaultValues().

◆ m_FileFunction

◆ m_FileName

◆ m_Flags

◆ m_FmtLen

◆ m_FmtScale

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible
protectedinherited

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

Definition at line 186 of file base_struct.h.

Referenced by ZONE_CONTAINER::initDataFromSrcInCopyCtor(), EDA_ITEM::initVars(), EDA_ITEM::operator=(), SCH_FIELD::Print(), and EDA_ITEM::SetForceVisible().

◆ m_GBRLayerParams

GERBER_LAYER GERBER_FILE_IMAGE::m_GBRLayerParams
private

Definition at line 115 of file gerber_file_image.h.

Referenced by GetLayerParams(), and ResetDefaultValues().

◆ m_GerbMetric

◆ m_GraphicLayer

◆ m_Has_DCode

bool GERBER_FILE_IMAGE::m_Has_DCode

◆ m_Has_MissingDCode

bool GERBER_FILE_IMAGE::m_Has_MissingDCode

◆ m_hasNegativeItems

int GERBER_FILE_IMAGE::m_hasNegativeItems
private

Definition at line 185 of file gerber_file_image.h.

Referenced by HasNegativeItems(), and ResetDefaultValues().

◆ m_IJPos

◆ m_ImageJustifyOffset

◆ m_ImageJustifyXCenter

bool GERBER_FILE_IMAGE::m_ImageJustifyXCenter

Definition at line 133 of file gerber_file_image.h.

Referenced by DisplayImageInfo(), ExecuteRS274XCommand(), and ResetDefaultValues().

◆ m_ImageJustifyYCenter

bool GERBER_FILE_IMAGE::m_ImageJustifyYCenter

Definition at line 134 of file gerber_file_image.h.

Referenced by DisplayImageInfo(), ExecuteRS274XCommand(), and ResetDefaultValues().

◆ m_ImageName

wxString GERBER_FILE_IMAGE::m_ImageName

◆ m_ImageNegative

◆ m_ImageOffset

◆ m_ImageRotation

◆ m_InUse

bool GERBER_FILE_IMAGE::m_InUse

◆ m_IsVisible

bool GERBER_FILE_IMAGE::m_IsVisible

Definition at line 121 of file gerber_file_image.h.

Referenced by GERBER_FILE_IMAGE().

◆ m_IsX2_file

bool GERBER_FILE_IMAGE::m_IsX2_file

◆ m_Iterpolation

◆ m_Last_Pen_Command

int GERBER_FILE_IMAGE::m_Last_Pen_Command

Definition at line 153 of file gerber_file_image.h.

Referenced by Execute_DCODE_Command(), LoadGerberFile(), and ResetDefaultValues().

◆ m_LastArcDataType

◆ m_LastCoordIsIJPos

bool GERBER_FILE_IMAGE::m_LastCoordIsIJPos

Definition at line 159 of file gerber_file_image.h.

Referenced by Execute_DCODE_Command(), ReadIJCoord(), and ResetDefaultValues().

◆ m_LineNum

◆ m_LocalRotation

double GERBER_FILE_IMAGE::m_LocalRotation

◆ m_MD5_value

wxString GERBER_FILE_IMAGE::m_MD5_value

Definition at line 129 of file gerber_file_image.h.

Referenced by ExecuteRS274XCommand(), and ResetDefaultValues().

◆ m_messagesList

wxArrayString GERBER_FILE_IMAGE::m_messagesList
private

Definition at line 184 of file gerber_file_image.h.

Referenced by AddMessageToList(), ClearMessageList(), and GetMessages().

◆ m_MirrorA

bool GERBER_FILE_IMAGE::m_MirrorA

◆ m_MirrorB

bool GERBER_FILE_IMAGE::m_MirrorB

◆ m_NetAttributeDict

◆ m_NetnamesList

std::map<wxString, int> GERBER_FILE_IMAGE::m_NetnamesList

◆ m_NoTrailingZeros

◆ m_Offset

◆ m_Parent

◆ m_PartString

wxString GERBER_FILE_IMAGE::m_PartString

Definition at line 130 of file gerber_file_image.h.

Referenced by ExecuteRS274XCommand(), and ResetDefaultValues().

◆ m_PolygonFillMode

bool GERBER_FILE_IMAGE::m_PolygonFillMode

◆ m_PolygonFillModeState

int GERBER_FILE_IMAGE::m_PolygonFillModeState

◆ m_PositiveDrawColor

COLOR4D GERBER_FILE_IMAGE::m_PositiveDrawColor

Definition at line 123 of file gerber_file_image.h.

Referenced by GERBER_FILE_IMAGE(), and GetPositiveDrawColor().

◆ m_PreviousPos

wxPoint GERBER_FILE_IMAGE::m_PreviousPos

◆ m_Relative

◆ m_Scale

wxRealPoint GERBER_FILE_IMAGE::m_Scale

◆ m_Selected_Tool

◆ m_SwapAxis

bool GERBER_FILE_IMAGE::m_SwapAxis

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid
inherited

Definition at line 169 of file base_struct.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), SCH_EDIT_FRAME::AnnotateComponents(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_SHEET_PATH::Cmp(), Diagnose(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), CONNECTION_GRAPH::ercCheckNoConnects(), PCB_EDIT_FRAME::Exchange_Module(), PCB_BASE_FRAME::FocusOnItem(), SCH_BASE_FRAME::FocusOnItem(), PCB_IO::format(), FormatProbeItem(), SCH_PIN::GetDefaultNetName(), SCH_SHEET::GetMsgPanelInfo(), SCH_REFERENCE::GetPath(), SCH_MARKER::GetUUID(), MARKER_PCB::GetUUID(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_LEGACY_PLUGIN::loadComponent(), LEGACY_PLUGIN::loadMODULE(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), LEGACY_PLUGIN::loadTrackList(), NETLIST_EXPORTER_GENERIC::makeComponents(), mapExistingAnnotation(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), PCB_PARSER::parseDIMENSION(), SCH_EDITOR_CONTROL::Paste(), SCH_SHEET_PATH::PathAsString(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_LEGACY_PLUGIN::saveComponent(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_EDIT_FRAME::SaveProject(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_COMPONENT::SCH_COMPONENT(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SHEET::SCH_SHEET(), RC_ITEM::SetData(), SwapItemData(), TestMultiunitFootprints(), DIALOG_SCH_SHEET_PROPS::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataToWindow(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().


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