Handle a drill image. More...

#include <excellon_image.h>

Inheritance diagram for EXCELLON_IMAGE:

Public Member Functions
	EXCELLON_IMAGE (int layer)

	~EXCELLON_IMAGE ()

virtual void	ResetDefaultValues () override
	Set all parameters to a default value, before reading a file. More...

bool	LoadFile (const wxString &aFullFileName, EXCELLON_DEFAULTS *aDefaults)
	Read and load a drill (EXCELLON format) file. More...

wxString	GetClass () const override
	Return the class name. More...

bool	LoadGerberFile (const wxString &aFullFileName)
	Read and load a gerber file. More...

const wxArrayString &	GetMessages () const

int	GetDcodesCount ()

COLOR4D	GetPositiveDrawColor () const

GERBER_DRAW_ITEMS &	GetItems ()

int	GetItemsCount ()

void	AddItemToList (GERBER_DRAW_ITEM *aItem)
	Add a new GERBER_DRAW_ITEM item to the drawings list. More...

GERBER_DRAW_ITEM *	GetLastItemInList () const

GERBER_LAYER &	GetLayerParams ()

bool	HasNegativeItems ()

void	ClearMessageList ()
	Clear the message list. More...

void	AddMessageToList (const wxString &aMessage)
	Add a message to the message list. More...

void	InitToolTable ()

VECTOR2I	ReadXYCoord (char *&aText, bool aExcellonMode=false)
	Return the current coordinate type pointed to by XnnYnn Text (XnnnnYmmmm). More...

VECTOR2I	ReadIJCoord (char *&Text)
	Return the current coordinate type pointed to by InnJnn Text (InnnnJmmmm) More...

int	CodeNumber (char *&aText)
	Reads the next number and returns the value. More...

D_CODE *	GetDCODEOrCreate (int aDCODE, bool aCreateIfNoExist=true)
	Return a pointer to the D_CODE within this GERBER for the given aDCODE. More...

D_CODE *	GetDCODE (int aDCODE) const
	Return a pointer to the D_CODE within this GERBER for the given aDCODE. More...

APERTURE_MACRO *	FindApertureMacro (const APERTURE_MACRO &aLookup)
	Look up a previously read in aperture macro. More...

void	StepAndRepeatItem (const GERBER_DRAW_ITEM &aItem)
	Gerber format has a command Step an Repeat. More...

void	DisplayImageInfo (GERBVIEW_FRAME *aMainFrame)
	Display information about image parameters in the status bar. More...

void	RemoveAttribute (X2_ATTRIBUTE &aAttribute)
	Called when a TD command is found the Gerber file. More...

INSPECT_RESULT	Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[]) override
	May be re-implemented for each derived class in order to handle all the types given by its member data. More...

KICAD_T	Type () const
	Returns the type of object. More...

EDA_ITEM *	GetParent () const

virtual void	SetParent (EDA_ITEM *aParent)

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsDragging () const

bool	IsWireImage () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsResized () const

bool	IsBrightened () const

void	SetWireImage ()

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

int	GetState (EDA_ITEM_FLAGS type) const

void	SetState (EDA_ITEM_FLAGS type, bool state)

EDA_ITEM_FLAGS	GetStatus () const

void	SetStatus (EDA_ITEM_FLAGS aStatus)

void	SetFlags (EDA_ITEM_FLAGS aMask)

void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

EDA_ITEM_FLAGS	GetFlags () const

bool	HasFlag (EDA_ITEM_FLAGS aFlag) const

EDA_ITEM_FLAGS	GetEditFlags () const

void	ClearTempFlags ()

void	ClearEditFlags ()

virtual bool	RenderAsBitmap (double aWorldScale) const

void	SetIsShownAsBitmap (bool aBitmap)

bool	IsShownAsBitmap () const

virtual bool	IsType (const KICAD_T aScanTypes[]) const
	Check whether the item is one of the listed types. More...

void	SetForceVisible (bool aEnable)
	Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...

bool	IsForceVisible () const

virtual void	GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList)
	Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...

virtual bool	HitTest (const VECTOR2I &aPosition, int aAccuracy=0) const
	Test if aPosition is inside or on the boundary of this item. More...

virtual bool	HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const
	Test if aRect intersects this item. More...

virtual const EDA_RECT	GetBoundingBox () const
	Return the orthogonal bounding box of this object for display purposes. More...

virtual VECTOR2I	GetPosition () const

virtual void	SetPosition (const VECTOR2I &aPos)

virtual const VECTOR2I	GetFocusPosition () const
	Similar to GetPosition, but allows items to return their visual center rather than their anchor. More...

virtual VECTOR2I	GetSortPosition () const
	Return the coordinates that should be used for sorting this element visually compared to other elements. More...

virtual EDA_ITEM *	Clone () const
	Create a duplicate of this item with linked list members set to NULL. More...

virtual wxString	GetSelectMenuText (EDA_UNITS aUnits) const
	Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...

virtual BITMAPS	GetMenuImage () const
	Return a pointer to an image to be used in menus. More...

virtual bool	Matches (const wxFindReplaceData &aSearchData, void *aAuxData) const
	Compare the item against the search criteria in aSearchData. More...

virtual bool	Replace (const wxFindReplaceData &aSearchData, void *aAuxData=nullptr)
	Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...

virtual bool	IsReplaceable () const
	Override this method in any derived object that supports test find and replace. More...

bool	operator< (const EDA_ITEM &aItem) const
	Test if another item is less than this object. More...

virtual const BOX2I	ViewBBox () const override
	Return the bounding box of the item covering all its layers. More...

virtual void	ViewGetLayers (int aLayers[], int &aCount) const override
	Return the all the layers within the VIEW the object is painted on. More...

virtual void	ViewDraw (int aLayer, VIEW *aView) const
	Draw the parts of the object belonging to layer aLayer. More...

virtual double	ViewGetLOD (int aLayer, VIEW *aView) const
	Return the level of detail (LOD) of the item. More...

VIEW_ITEM_DATA *	viewPrivData () const

void	ClearViewPrivData ()

bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue)

template<typename T >
bool	Set (PROPERTY_BASE *aProperty, T aValue)

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

wxAny	Get (PROPERTY_BASE *aProperty)

template<typename T >
T	Get (PROPERTY_BASE *aProperty)

template<typename T >
boost::optional< T >	Get (const wxString &aProperty)

Static Public Member Functions
static bool	TestFileIsExcellon (const wxString &aFullFileName)
	Performs a heuristics-based check of whether the file is an Excellon drill file. More...

static bool	TestFileIsRS274 (const wxString &aFullFileName)
	Performs a heuristics-based check of whether the file is an RS274 gerber file. More...

template<class T >
static INSPECT_RESULT	IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	This changes first parameter to avoid the DList and use the main queue instead. More...

template<class T >
static INSPECT_RESULT	IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	Change first parameter to avoid the DList and use std::vector instead. More...

static bool	Replace (const wxFindReplaceData &aSearchData, wxString &aText)
	Perform a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...

static bool	Sort (const EDA_ITEM aLeft, const EDA_ITEM aRight)
	Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...

Public Attributes
bool	m_InUse

bool	m_IsVisible
	< True if the draw layer is visible and must be drawn. More...

COLOR4D	m_PositiveDrawColor

wxString	m_FileName

wxString	m_ImageName

bool	m_IsX2_file
	< True if a X2 gerber attribute was found in file. More...

X2_ATTRIBUTE_FILEFUNCTION *	m_FileFunction

wxString	m_MD5_value

wxString	m_PartString

int	m_GraphicLayer

bool	m_ImageNegative

bool	m_ImageJustifyXCenter
	< Image Justify Center on X axis (default = false). More...

bool	m_ImageJustifyYCenter
	Image Justify Offset on XY axis (default = 0,0). More...

VECTOR2I	m_ImageJustifyOffset

bool	m_GerbMetric

bool	m_Relative
	< false = absolute Coord, true = relative Coord. More...

bool	m_NoTrailingZeros

VECTOR2I	m_ImageOffset

wxSize	m_FmtScale
	< Fmt 2.3: m_FmtScale = 3, fmt 3.4: m_FmtScale = 4. More...

wxSize	m_FmtLen
	Image rotation (0, 90, 180, 270 only) in degrees. More...

int	m_ImageRotation
	Local rotation in degrees added to m_ImageRotation. More...

double	m_LocalRotation

VECTOR2I	m_Offset

VECTOR2I	m_Scale

bool	m_SwapAxis

bool	m_MirrorA

bool	m_MirrorB

int	m_Iterpolation

int	m_Current_Tool

int	m_Last_Pen_Command
	< Current or last pen state (0..9, set by Dn option with n < 10. More...

int	m_CommandState

int	m_LineNum
	< Line number of the gerber file while reading. More...

VECTOR2I	m_CurrentPos

VECTOR2I	m_PreviousPos

VECTOR2I	m_IJPos

bool	m_LastCoordIsIJPos
	< True if a IJ coord was read (for arcs & circles ). More...

int	m_ArcRadius
	Identifier for arc data type (IJ (center) or A## (radius)). More...

LAST_EXTRA_ARC_DATA_TYPE	m_LastArcDataType

FILE *	m_Current_File

int	m_Selected_Tool

bool	m_Has_DCode
	< True if has DCodes in file or false if no DCodes found. Perhaps deprecated RS274D file. More...

bool	m_Has_MissingDCode

bool	m_360Arc_enbl

bool	m_AsArcG74G75Cmd

bool	m_PolygonFillMode

int	m_PolygonFillModeState
	a collection of APERTURE_MACROS, sorted by name More...

APERTURE_MACRO_SET	m_aperture_macros

GBR_NETLIST_METADATA	m_NetAttributeDict

wxString	m_AperFunction

std::map< wxString, int >	m_ComponentsList

std::map< wxString, int >	m_NetnamesList

D_CODE *	m_Aperture_List [TOOLS_MAX_COUNT]
	< Dcode (Aperture) List for this layer (max TOOLS_MAX_COUNT: see dcode.h) More...

bool	m_Exposure

GERBER_LAYER	m_GBRLayerParams

GERBER_DRAW_ITEMS	m_drawings

const KIID	m_Uuid

Protected Member Functions
bool	Matches (const wxString &aText, const wxFindReplaceData &aSearchData) const
	Compare aText against search criteria in aSearchData. More...

Protected Attributes
EDA_ITEM_FLAGS	m_status

EDA_ITEM *	m_parent
	Linked list: Link (parent struct) More...

bool	m_forceVisible

EDA_ITEM_FLAGS	m_flags

Private Types
enum	EXCELLON_STATE { READ_HEADER_STATE , READ_PROGRAM_STATE }

Private Member Functions
bool	Execute_HEADER_And_M_Command (char *&text)

bool	Select_Tool (char *&text)

bool	Execute_EXCELLON_G_Command (char *&text)

bool	Execute_Drill_Command (char *&text)

void	readFileFormat (char *&aText)
	Read an Altium-specific FILE_FORMAT=X:X attribute that specifies the length and mantissa of the numbers in the gerber file. More...

bool	readToolInformation (char *&aText)
	Read a tool definition like T1C0.02 or T1F00S00C0.02 or T1C0.02F00S00 and enter params in TCODE list. More...

void	FinishRouteCommand ()
	End a route command started by M15 ot G01, G02 or G03 command. More...

void	SelectUnits (bool aMetric, EXCELLON_DEFAULTS *aDefaults)
	Switch unit selection, and the coordinate format (nn:mm) if not yet set. More...

char *	GetNextLine (char aBuff, unsigned int aBuffSize, char aText, FILE *aFile)
	Test for an end of line. More...

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

bool	ReadRS274XCommand (char aBuff, unsigned int aBuffSize, char &aText)
	Read a single RS274X command terminated with a %. More...

bool	ExecuteRS274XCommand (int aCommand, char aBuff, unsigned int aBuffSize, char &aText)
	Execute a RS274X command. More...

int	ReadXCommandID (char *&text)
	Read 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)
	Read 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
EXCELLON_STATE	m_State

bool	m_SlotOn

bool	m_RouteModeOn

std::vector< EXCELLON_ROUTE_COORD >	m_RoutePositions

bool	m_hasFormat
	Excellon file do not have a format statement to specify the coordinate format like nn:mm. More...

wxArrayString	m_messagesList

int	m_hasNegativeItems
	True if the image is negative or has some negative items. More...

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

VIEW_ITEM_DATA *	m_viewPrivData

Detailed Description

Handle a drill image.

It is derived from GERBER_FILE_IMAGE because there is a lot of likeness between EXCELLON files and GERBER files. DCode apertures are also similar to T Codes.

Definition at line 137 of file excellon_image.h.

Member Enumeration Documentation

◆ EXCELLON_STATE

enum EXCELLON_IMAGE::EXCELLON_STATE

private

Enumerator
READ_HEADER_STATE
READ_PROGRAM_STATE

Definition at line 209 of file excellon_image.h.

 {
 READ_HEADER_STATE, // When we are in this state, we are reading header
 READ_PROGRAM_STATE // When we are in this state, we are reading drill data
 };

Constructor & Destructor Documentation

◆ EXCELLON_IMAGE()

EXCELLON_IMAGE::EXCELLON_IMAGE ( int layer )

inline

Definition at line 139 of file excellon_image.h.

 : EXCELLON_IMAGE( int layer ) :
 GERBER_FILE_IMAGE( layer )
 {
 m_State = READ_HEADER_STATE;
 m_SlotOn = false;
 m_RouteModeOn = false;
 m_hasFormat = false;
 }

References m_hasFormat, m_RouteModeOn, m_SlotOn, m_State, and READ_HEADER_STATE.

◆ ~EXCELLON_IMAGE()

EXCELLON_IMAGE::~EXCELLON_IMAGE ( )

inline

Definition at line 149 of file excellon_image.h.

149{};

Member Function Documentation

◆ AddItemToList()

void GERBER_FILE_IMAGE::AddItemToList ( GERBER_DRAW_ITEM * aItem )

inlineinherited

Add a new GERBER_DRAW_ITEM item to the drawings list.

Parameters

aItem is the GERBER_DRAW_ITEM to add to list

Definition at line 170 of file gerber_file_image.h.

 {
 m_drawings.push_back( aItem );
 }

References GERBER_FILE_IMAGE::m_drawings.

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

◆ AddMessageToList()

void GERBER_FILE_IMAGE::AddMessageToList ( const wxString & aMessage )

inlineinherited

Add a message to the message list.

Definition at line 210 of file gerber_file_image.h.

 {
 m_messagesList.Add( aMessage );
 }

References GERBER_FILE_IMAGE::m_messagesList.

Referenced by GERBER_FILE_IMAGE::Execute_DCODE_Command(), Execute_Drill_Command(), Execute_EXCELLON_G_Command(), GERBER_FILE_IMAGE::Execute_G_Command(), Execute_HEADER_And_M_Command(), GERBER_FILE_IMAGE::ExecuteRS274XCommand(), FinishRouteCommand(), LoadFile(), GERBER_FILE_IMAGE::LoadGerberFile(), GERBER_FILE_IMAGE::ReadApertureMacro(), and readToolInformation().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 132 of file eda_item.h.

132{ ClearFlags( BRIGHTENED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:153

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:66

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 170 of file eda_item.h.

 {
 ClearFlags( GetEditFlags() );
 }

References EDA_ITEM::ClearFlags(), and EDA_ITEM::GetEditFlags().

Referenced by BOARD::Add(), FOOTPRINT::Add(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 153 of file eda_item.h.

153{ m_flags &= ~aMask; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:500

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), FOOTPRINT::BuildCourtyardCaches(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SCH_ITEM::Duplicate(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_SELECTION_TOOL::ExitGroup(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE_ON_MOVE::Init(), EE_COLLECTOR::Inspect(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), EE_SELECTION_TOOL::Main(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), DRC_TEST_PROVIDER_DISALLOW::Run(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetIsShownAsBitmap(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and EE_SELECTION_TOOL::unhighlight().

◆ ClearMessageList()

void GERBER_FILE_IMAGE::ClearMessageList ( )

inlineinherited

Clear the message list.

Call it before reading a Gerber file

Definition at line 202 of file gerber_file_image.h.

 {
 m_messagesList.Clear();
 }

References GERBER_FILE_IMAGE::m_messagesList.

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

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 131 of file eda_item.h.

131{ ClearFlags( SELECTED ); }

SELECTED

#define SELECTED

Item was manually selected by the user.

Definition: eda_item_flags.h:48

References EDA_ITEM::ClearFlags(), and SELECTED.

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

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 165 of file eda_item.h.

 {
 ClearFlags( CANDIDATE | SELECTED_BY_DRAG | IS_LINKED | SKIP_STRUCT | DO_NOT_DRAW );
 }

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

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

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 143 of file view_item.h.

 {
 m_viewPrivData = nullptr;
 }

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * EDA_ITEM::Clone ( ) const

virtualinherited

Create a duplicate of this item with linked list members set to NULL.

The default version will return NULL in release builds and likely crash the program. In debug builds, a warning message indicating the derived class has not implemented cloning. This really should be a pure virtual function. Due to the fact that there are so many objects derived from EDA_ITEM, the decision was made to return NULL until all the objects derived from EDA_ITEM implement cloning. Once that happens, this function should be made pure.

Returns: A clone of the item.

Reimplemented in LIB_FIELD, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_WIRE_ENTRY, SCH_BUS_BUS_ENTRY, SCH_FIELD, SCH_JUNCTION, SCH_LABEL, SCH_DIRECTIVE_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, KIGFX::ORIGIN_VIEWITEM, PCB_GROUP, FOOTPRINT, FP_SHAPE, FP_TEXT, FP_TEXTBOX, NETINFO_ITEM, PAD, PCB_BITMAP, PCB_DIM_ALIGNED, PCB_DIM_ORTHOGONAL, PCB_DIM_RADIAL, PCB_DIM_LEADER, PCB_DIM_CENTER, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_ARC, PCB_VIA, ZONE, and FP_ZONE.

Definition at line 83 of file eda_item.cpp.

{
 wxCHECK_MSG( false, nullptr, wxT( "Clone not implemented in derived class " ) + GetClass() +
 wxT( ". Bad programmer!" ) );
}

References EDA_ITEM::GetClass().

Referenced by DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_DIMENSION_BASE::GetEffectiveShape(), LIB_SYMBOL::LIB_SYMBOL(), new_clone(), LIB_SYMBOL::operator=(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_LIB_PLUGIN_CACHE::removeSymbol(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), CLIPBOARD_IO::SaveSelection(), LIB_SYMBOL::SetConversion(), LIB_SYMBOL::SetUnitCount(), SCH_DRAWING_TOOLS::SingleClickPlace(), COMMIT::Stage(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ CodeNumber()

int GERBER_FILE_IMAGE::CodeNumber ( char *& aText )

inherited

Reads the next number and returns the value.

Parameters

aText Pointer to the input string vector

Returns

Definition at line 401 of file rs274d.cpp.

{
 int retval;
 char* endptr;
 
 errno = 0;
 
 retval = strtol( aText + 1, &endptr, 10 );
 
 if( endptr == aText || errno != 0 )
 return 0;
 
 wxCHECK_MSG( retval < std::numeric_limits<int>::max(), 0, _( "Invalid Code Number" ) );
 
 aText = endptr;
 
 return static_cast<int>( retval );
}

References _.

Referenced by GERBER_FILE_IMAGE::Execute_G_Command(), GERBER_FILE_IMAGE::LoadGerberFile(), and Select_Tool().

◆ DisplayImageInfo()

void GERBER_FILE_IMAGE::DisplayImageInfo ( GERBVIEW_FRAME * aMainFrame )

inherited

Display information about image parameters in the status bar.

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

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) Some are deprecated

Definition at line 332 of file gerber_file_image.cpp.

{
 wxString msg;
 
 aMainFrame->ClearMsgPanel();
 
 // Display the Gerber variant (X1 / X2
 aMainFrame->AppendMsgPanel( _( "Format" ), m_IsX2_file ? wxT( "X2" ) : wxT( "X1" ) );
 
 // Display Image name (Image specific). IM command (Image Name) is deprecated
 // So non empty image name is very rare, probably never found
 if( !m_ImageName.IsEmpty() )
 aMainFrame->AppendMsgPanel( _( "Image name" ), m_ImageName );
 
 // Display graphic layer number used to draw this Image
 // (not a Gerber parameter but is also image specific)
 msg.Printf( wxT( "%d" ), m_GraphicLayer + 1 );
 aMainFrame->AppendMsgPanel( _( "Graphic layer" ), msg );
 
 // Display Image rotation (Image specific)
 msg.Printf( wxT( "%d" ), m_ImageRotation );
 aMainFrame->AppendMsgPanel( _( "Img Rot." ), msg );
 
 // Display Image polarity (Image specific)
 msg = m_ImageNegative ? _("Negative") : _("Normal");
 aMainFrame->AppendMsgPanel( _( "Polarity" ), msg );
 
 // Display Image justification and offset for justification (Image specific)
 msg = m_ImageJustifyXCenter ? _("Center") : _("Normal");
 aMainFrame->AppendMsgPanel( _( "X Justify" ), msg );
 
 msg = m_ImageJustifyYCenter ? _("Center") : _("Normal");
 aMainFrame->AppendMsgPanel( _( "Y Justify" ), msg );
 
 switch( aMainFrame->GetUserUnits() )
 {
 case EDA_UNITS::MILS:
 msg.Printf( wxT( "X=%f Y=%f" ), Iu2Mils( m_ImageJustifyOffset.x ),
 Iu2Mils( m_ImageJustifyOffset.y ) );
 break;
 
 case EDA_UNITS::INCHES:
 msg.Printf( wxT( "X=%f Y=%f" ), Iu2Mils( m_ImageJustifyOffset.x ) / 1000.0,
 Iu2Mils( m_ImageJustifyOffset.y ) / 1000.0 );
 break;
 
 case EDA_UNITS::MILLIMETRES:
 msg.Printf( wxT( "X=%f Y=%f" ), Iu2Millimeter( m_ImageJustifyOffset.x ),
 Iu2Millimeter( m_ImageJustifyOffset.y ) );
 break;
 
 default:
 wxASSERT_MSG( false, wxT( "Invalid unit" ) );
 }
 
 aMainFrame->AppendMsgPanel( _( "Image Justify Offset" ), msg );
}

References _, EDA_DRAW_FRAME::AppendMsgPanel(), EDA_DRAW_FRAME::ClearMsgPanel(), EDA_BASE_FRAME::GetUserUnits(), INCHES, GERBER_FILE_IMAGE::m_GraphicLayer, GERBER_FILE_IMAGE::m_ImageJustifyOffset, GERBER_FILE_IMAGE::m_ImageJustifyXCenter, GERBER_FILE_IMAGE::m_ImageJustifyYCenter, GERBER_FILE_IMAGE::m_ImageName, GERBER_FILE_IMAGE::m_ImageNegative, GERBER_FILE_IMAGE::m_ImageRotation, GERBER_FILE_IMAGE::m_IsX2_file, MILLIMETRES, MILS, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by GERBVIEW_FRAME::UpdateTitleAndInfo().

◆ Execute_DCODE_Command()

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

privateinherited

Definition at line 557 of file rs274d.cpp.

{
 wxSize size( 15, 15 );
 
 APERTURE_T aperture = APT_CIRCLE;
 GERBER_DRAW_ITEM* gbritem;
 
 int dcode = 0;
 D_CODE* tool = nullptr;
 wxString msg;
 
 if( D_commande >= FIRST_DCODE ) // This is a "Set tool" command
 {
 if( D_commande > (TOOLS_MAX_COUNT - 1) )
 D_commande = TOOLS_MAX_COUNT - 1;
 
 // remember which tool is selected, nothing is done with it in this
 // call
 m_Current_Tool = D_commande;
 
 D_CODE* pt_Dcode = GetDCODE( D_commande );
 
 if( pt_Dcode )
 pt_Dcode->m_InUse = true;
 else
 m_Has_MissingDCode = true;
 
 return true;
 }
 else // D_commande = 0..9: this is a pen command (usually D1, D2 or D3)
 {
 m_Last_Pen_Command = D_commande;
 }
 
 if( m_PolygonFillMode ) // Enter a polygon description:
 {
 switch( D_commande )
 {
 case 1: // code D01 Draw line, exposure ON
 if( !m_Exposure ) // Start a new polygon outline:
 {
 m_Exposure = true;
 gbritem = new GERBER_DRAW_ITEM( this );
 AddItemToList( gbritem );
 gbritem->m_Shape = GBR_POLYGON;
 gbritem->m_Flashed = false;
 gbritem->m_DCode = 0; // No DCode for a Polygon (Region in Gerber dialect)
 
 
 if( gbritem->m_GerberImageFile )
 {
 gbritem->SetNetAttributes( gbritem->m_GerberImageFile->m_NetAttributeDict );
 gbritem->m_AperFunction = gbritem->m_GerberImageFile->m_AperFunction;
 }
 }
 
 switch( m_Iterpolation )
 {
 case GERB_INTERPOL_ARC_NEG:
 case GERB_INTERPOL_ARC_POS:
 // Before any arc command, a G74 or G75 command must be set.
 // Otherwise the Gerber file is invalid
 if( !m_AsArcG74G75Cmd )
 {
 AddMessageToList( _( "Invalid Gerber file: missing G74 or G75 arc command" ) );
 
 // Disable further warning messages:
 m_AsArcG74G75Cmd = true;
 }
 
 gbritem = GetLastItemInList();
 
 fillArcPOLY( gbritem, m_PreviousPos,
 m_CurrentPos, m_IJPos,
 ( m_Iterpolation == GERB_INTERPOL_ARC_NEG ) ? false : true,
 m_360Arc_enbl, GetLayerParams().m_LayerNegative );
 break;
 
 default:
 gbritem = GetLastItemInList();
 
 gbritem->m_Start = m_PreviousPos; // m_Start is used as temporary storage
 
 if( gbritem->m_Polygon.OutlineCount() == 0 )
 {
 gbritem->m_Polygon.NewOutline();
 gbritem->m_Polygon.Append( VECTOR2I( gbritem->m_Start ) );
 }
 
 gbritem->m_End = m_CurrentPos; // m_End is used as temporary storage
 gbritem->m_Polygon.Append( VECTOR2I( gbritem->m_End ) );
 break;
 }
 
 m_PreviousPos = m_CurrentPos;
 m_PolygonFillModeState = 1;
 break;
 
 case 2: // code D2: exposure OFF (i.e. "move to")
 if( m_Exposure && GetLastItemInList() ) // End of polygon
 {
 gbritem = GetLastItemInList();
 gbritem->m_Polygon.Append( gbritem->m_Polygon.CVertex( 0 ) );
 StepAndRepeatItem( *gbritem );
 }
 
 m_Exposure = false;
 m_PreviousPos = m_CurrentPos;
 m_PolygonFillModeState = 0;
 break;
 
 default:
 return false;
 }
 }
 else
 {
 switch( D_commande )
 {
 case 1: // code D01 Draw line, exposure ON
 m_Exposure = true;
 
 tool = GetDCODE( m_Current_Tool );
 
 if( tool )
 {
 size = tool->m_Size;
 dcode = tool->m_Num_Dcode;
 aperture = tool->m_Shape;
 }
 
 switch( m_Iterpolation )
 {
 case GERB_INTERPOL_LINEAR_1X:
 gbritem = new GERBER_DRAW_ITEM( this );
 AddItemToList( gbritem );
 
 fillLineGBRITEM( gbritem, dcode, m_PreviousPos,
 m_CurrentPos, size, GetLayerParams().m_LayerNegative );
 StepAndRepeatItem( *gbritem );
 break;
 
 case GERB_INTERPOL_ARC_NEG:
 case GERB_INTERPOL_ARC_POS:
 gbritem = new GERBER_DRAW_ITEM( this );
 AddItemToList( gbritem );
 
 if( m_LastCoordIsIJPos )
 {
 fillArcGBRITEM( gbritem, dcode, m_PreviousPos,
 m_CurrentPos, m_IJPos, size,
 ( m_Iterpolation == GERB_INTERPOL_ARC_NEG ) ?
 false : true, m_360Arc_enbl, GetLayerParams().m_LayerNegative );
 m_LastCoordIsIJPos = false;
 }
 else
 {
 fillLineGBRITEM( gbritem, dcode, m_PreviousPos,
 m_CurrentPos, size, GetLayerParams().m_LayerNegative );
 }
 
 StepAndRepeatItem( *gbritem );
 
 break;
 
 default:
 msg.Printf( wxT( "RS274D: DCODE Command: interpol error (type %X)" ),
 m_Iterpolation );
 AddMessageToList( msg );
 break;
 }
 
 m_PreviousPos = m_CurrentPos;
 break;
 
 case 2: // code D2: exposure OFF (i.e. "move to")
 m_Exposure = false;
 m_PreviousPos = m_CurrentPos;
 break;
 
 case 3: // code D3: flash aperture
 tool = GetDCODE( m_Current_Tool );
 
 if( tool )
 {
 size = tool->m_Size;
 dcode = tool->m_Num_Dcode;
 aperture = tool->m_Shape;
 }
 
 gbritem = new GERBER_DRAW_ITEM( this );
 AddItemToList( gbritem );
 fillFlashedGBRITEM( gbritem, aperture, dcode, m_CurrentPos,
 size, GetLayerParams().m_LayerNegative );
 StepAndRepeatItem( *gbritem );
 m_PreviousPos = m_CurrentPos;
 break;
 
 default:
 return false;
 }
 }
 
 return true;
}

Referenced by GERBER_FILE_IMAGE::LoadGerberFile().

◆ Execute_Drill_Command()

bool EXCELLON_IMAGE::Execute_Drill_Command ( char *& text )

private

Definition at line 809 of file excellon_read_drill_file.cpp.

{
 D_CODE* tool;
 GERBER_DRAW_ITEM * gbritem;
 
 while( true )
 {
 switch( *text )
 {
 case 'X':
 case 'Y':
 ReadXYCoord( text, true );
 
  if( *text == 'I' || *text == 'J' )
 ReadIJCoord( text );
 
 break;
 
 case 'G': // G85 is found here for oval holes
 m_PreviousPos = m_CurrentPos;
 Execute_EXCELLON_G_Command( text );
 break;
 
 case 0: // E.O.L: execute command
 if( m_RouteModeOn )
 {
 // We are in routing mode, and this is an intermediate point.
 // So just store it
 int rmode = 0; // linear routing.
 
 if( m_Iterpolation == GERB_INTERPOL_ARC_NEG )
 rmode = ROUTE_CW;
 else if( m_Iterpolation == GERB_INTERPOL_ARC_POS )
 rmode = ROUTE_CCW;
 
 if( m_LastArcDataType == ARC_INFO_TYPE_CENTER )
 {
 EXCELLON_ROUTE_COORD point( m_CurrentPos, m_IJPos, rmode );
 m_RoutePositions.push_back( point );
 }
 else
 {
 EXCELLON_ROUTE_COORD point( m_CurrentPos, m_ArcRadius, rmode );
 m_RoutePositions.push_back( point );
 }
 return true;
 }
 
 tool = GetDCODE( m_Current_Tool );
 if( !tool )
 {
 wxString msg;
 msg.Printf( _( "Tool %d not defined" ), m_Current_Tool );
 AddMessageToList( msg );
 return false;
 }
 
 gbritem = new GERBER_DRAW_ITEM( this );
 AddItemToList( gbritem );
 
 if( m_SlotOn ) // Oblong hole
 {
 fillLineGBRITEM( gbritem, tool->m_Num_Dcode,
 m_PreviousPos, m_CurrentPos,
 tool->m_Size, false );
 // the hole is made: reset the slot on command (G85)
 // (it is needed for each oblong hole)
 m_SlotOn = false;
 }
 else
 {
 fillFlashedGBRITEM( gbritem, tool->m_Shape, tool->m_Num_Dcode,
 m_CurrentPos, tool->m_Size, false );
 }
 
 StepAndRepeatItem( *gbritem );
 m_PreviousPos = m_CurrentPos;
 return true;
 break;
 
 default:
 text++;
 break;
 }
 }
 
 return true;
}

Referenced by LoadFile().

◆ Execute_EXCELLON_G_Command()

bool EXCELLON_IMAGE::Execute_EXCELLON_G_Command ( char *& text )

private

Definition at line 942 of file excellon_read_drill_file.cpp.

{
 EXCELLON_CMD* cmd = nullptr;
 bool success = false;
 int id = DRILL_G_UNKNOWN;
 
 // Search command in list
 EXCELLON_CMD* candidate;
 char * gcmd = text; // gcmd points the G command, for error messages.
 
 for( unsigned ii = 0; ; ii++ )
 {
 candidate = &excellon_G_CmdList[ii];
 int len = candidate->m_Name.size();
 if( len == 0 ) // End of list reached
 break;
 if( candidate->m_Name.compare( 0, len, text, len ) == 0 ) // found.
 {
 cmd = candidate;
 text += len;
 success = true;
 id = cmd->m_Code;
 break;
 }
 }
 
 switch( id )
 {
 case DRILL_G_ZERO_SET:
 ReadXYCoord( text, true );
 m_Offset = m_CurrentPos;
 break;
 
 case DRILL_G_ROUT:
 m_SlotOn = false;
 
 if( m_RouteModeOn )
 FinishRouteCommand();
 
 m_RouteModeOn = true;
 m_RoutePositions.clear();
 m_LastArcDataType = ARC_INFO_TYPE_NONE;
 ReadXYCoord( text, true );
 // This is the first point (starting point) of routing
 m_RoutePositions.emplace_back( m_CurrentPos );
 break;
 
 case DRILL_G_DRILL:
 m_SlotOn = false;
 
 if( m_RouteModeOn )
 FinishRouteCommand();
 
 m_RouteModeOn = false;
 m_RoutePositions.clear();
 m_LastArcDataType = ARC_INFO_TYPE_NONE;
 break;
 
 case DRILL_G_SLOT:
 m_SlotOn = true;
 break;
 
 case DRILL_G_LINEARMOVE:
 m_LastArcDataType = ARC_INFO_TYPE_NONE;
 m_Iterpolation = GERB_INTERPOL_LINEAR_1X;
 ReadXYCoord( text, true );
 m_RoutePositions.emplace_back( m_CurrentPos );
 break;
 
 case DRILL_G_CWMOVE:
 m_Iterpolation = GERB_INTERPOL_ARC_NEG;
 ReadXYCoord( text, true );
 
 if( *text == 'I' || *text == 'J' )
 ReadIJCoord( text );
 
 if( m_LastArcDataType == ARC_INFO_TYPE_CENTER )
 m_RoutePositions.emplace_back( m_CurrentPos, m_IJPos, ROUTE_CW );
 else
 m_RoutePositions.emplace_back( m_CurrentPos, m_ArcRadius, ROUTE_CW );
 break;
 
 case DRILL_G_CCWMOVE:
 m_Iterpolation = GERB_INTERPOL_ARC_POS;
 ReadXYCoord( text, true );
 
 if( *text == 'I' || *text == 'J' )
 ReadIJCoord( text );
 
 if( m_LastArcDataType == ARC_INFO_TYPE_CENTER )
 m_RoutePositions.emplace_back( m_CurrentPos, m_IJPos, ROUTE_CCW );
 else
 m_RoutePositions.emplace_back( m_CurrentPos, m_ArcRadius, ROUTE_CCW );
 break;
 
 case DRILL_G_ABSOLUTE:
 m_Relative = false; // false = absolute coord
 break;
 
 case DRILL_G_INCREMENTAL:
 m_Relative = true; // true = relative coord
 break;
 
 case DRILL_G_UNKNOWN:
 default:
 AddMessageToList( wxString::Format( _( "Unknown Excellon G Code: &lt;%s&gt;" ), FROM_UTF8(gcmd) ) );
 while( *text )
 text++;
 return false;
 }
 
 return success;
}

Referenced by Execute_Drill_Command(), and LoadFile().

◆ Execute_G_Command()

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

privateinherited

Definition at line 421 of file rs274d.cpp.

{
 switch( G_command )
 {
 case GC_PHOTO_MODE: // can starts a D03 flash command: redundant, can be safely ignored.
 break;
 
 case GC_LINEAR_INTERPOL_1X:
 m_Iterpolation = GERB_INTERPOL_LINEAR_1X;
 break;
 
 case GC_CIRCLE_NEG_INTERPOL:
 m_Iterpolation = GERB_INTERPOL_ARC_NEG;
 break;
 
 case GC_CIRCLE_POS_INTERPOL:
 m_Iterpolation = GERB_INTERPOL_ARC_POS;
 break;
 
 case GC_COMMENT:
 // Skip comment, but only if the line does not start by "G04 #@! "
 // which is a metadata, i.e. a X2 command inside the comment.
 // this comment is called a "structured comment"
 if( strncmp( text, " #@! ", 5 ) == 0 )
 {
 text += 5;
 
 // The string starting at text is the same as the X2 attribute,
 // but a X2 attribute ends by '%'. So we build the X2 attribute string
 std::string x2buf;
 
 while( *text && (*text != '*') )
 {
 x2buf += *text;
 text++;
 }
 
 // add the end of X2 attribute string
 x2buf += "*%";
 x2buf += '\0';
 
 char* cptr = (char*)x2buf.data();
 int code_command = ReadXCommandID( cptr );
 ExecuteRS274XCommand( code_command, nullptr, 0, cptr );
 }
 
 while( *text && (*text != '*') )
 text++;
 
 break;
 
 case GC_SELECT_TOOL:
 {
 int D_commande = CodeNumber( text );
 
 if( D_commande < FIRST_DCODE )
 return false;
 
 if( D_commande > (TOOLS_MAX_COUNT - 1) )
 D_commande = TOOLS_MAX_COUNT - 1;
 
 m_Current_Tool = D_commande;
 D_CODE* pt_Dcode = GetDCODE( D_commande );
 
 if( pt_Dcode )
 pt_Dcode->m_InUse = true;
 
 break;
 }
 
 case GC_SPECIFY_INCHES:
 m_GerbMetric = false; // false = Inches, true = metric
 break;
 
 case GC_SPECIFY_MILLIMETERS:
 m_GerbMetric = true; // false = Inches, true = metric
 break;
 
 case GC_TURN_OFF_360_INTERPOL: // disable Multi cadran arc and Arc interpol
 m_360Arc_enbl = false;
 m_Iterpolation = GERB_INTERPOL_LINEAR_1X; // not sure it should be done
 m_AsArcG74G75Cmd = true;
 break;
 
 case GC_TURN_ON_360_INTERPOL:
 m_360Arc_enbl = true;
 m_AsArcG74G75Cmd = true;
 break;
 
 case GC_SPECIFY_ABSOLUES_COORD:
 m_Relative = false; // false = absolute Coord, true = relative
 // Coord
 break;
 
 case GC_SPECIFY_RELATIVEES_COORD:
 m_Relative = true; // false = absolute Coord, true = relative
 // Coord
 break;
 
 case GC_TURN_ON_POLY_FILL:
 m_PolygonFillMode = true;
 m_Exposure = false;
 break;
 
 case GC_TURN_OFF_POLY_FILL:
 if( m_Exposure && GetLastItemInList() ) // End of polygon
 {
 GERBER_DRAW_ITEM * gbritem = GetLastItemInList();
 
 if( gbritem->m_Polygon.VertexCount() )
 gbritem->m_Polygon.Append( gbritem->m_Polygon.CVertex( 0 ) );
 
 StepAndRepeatItem( *gbritem );
 }
 
 m_Exposure = false;
 m_PolygonFillMode = false;
 m_PolygonFillModeState = 0;
 m_Iterpolation = GERB_INTERPOL_LINEAR_1X; // not sure it should be done
 break;
 
 case GC_MOVE: // Non existent
 default:
 {
 wxString msg;
 msg.Printf( wxT( "G%0.2d command not handled" ), G_command );
 AddMessageToList( msg );
 return false;
 }
 }
 
 
 return true;
}

Referenced by GERBER_FILE_IMAGE::LoadGerberFile().

◆ Execute_HEADER_And_M_Command()

bool EXCELLON_IMAGE::Execute_HEADER_And_M_Command ( char *& text )

private

Definition at line 553 of file excellon_read_drill_file.cpp.

{
 EXCELLON_CMD* cmd = nullptr;
 wxString msg;
 
 // Search command in list
 for( unsigned ii = 0; ; ii++ )
 {
 EXCELLON_CMD* candidate = &excellonHeaderCmdList[ii];
 int len = candidate->m_Name.size();
 
 if( len == 0 ) // End of list reached
 break;
 
 if( candidate->m_Name.compare( 0, len, text, len ) == 0 ) // found.
 {
 cmd = candidate;
 text += len;
 break;
 }
 }
 
 if( !cmd )
 {
 msg.Printf( _( "Unknown Excellon command &lt;%s&gt;" ), text );
 AddMessageToList( msg );
 while( *text )
 text++;
 
 return false;
 }
 
 // Execute command
 // some do nothing
 switch( cmd->m_Code )
 {
 case DRILL_SKIP:
 case DRILL_M_UNKNOWN:
 break;
 
 case DRILL_M_END:
 case DRILL_M_ENDFILE:
 // if a route command is in progress, finish it
 if( m_RouteModeOn )
 FinishRouteCommand();
 
 break;
 
 case DRILL_M_MESSAGE:
 break;
 
 case DRILL_M_LONGMESSAGE:
 break;
 
 case DRILL_M_HEADER:
 m_State = READ_HEADER_STATE;
 break;
 
 case DRILL_M_ENDHEADER:
 m_State = READ_PROGRAM_STATE;
 break;
 
 case DRILL_REWIND_STOP: // End of header. No action in a viewer
 m_State = READ_PROGRAM_STATE;
 break;
 
 case DRILL_FORMAT_ALTIUM:
 readFileFormat( text );
 break;
 
 case DRILL_HEADER_SKIP:
 break;
 
 case DRILL_M_METRIC:
 SelectUnits( true, nullptr );
 break;
 
 case DRILL_IMPERIAL_HEADER: // command like INCH,TZ or INCH,LZ
 case DRILL_METRIC_HEADER: // command like METRIC,TZ or METRIC,LZ
 SelectUnits( cmd->m_Code == DRILL_METRIC_HEADER ? true : false, nullptr );
 
 if( *text != ',' )
 {
 // No TZ or LZ specified. Should be a decimal format
 // but this is not always the case. Use our default setting
 break;
 }
 
 text++; // skip separator
 if( *text == 'T' )
 m_NoTrailingZeros = false;
 else
 m_NoTrailingZeros = true;
 break;
 
 case DRILL_M_BEGINPATTERN:
 break;
 
 case DRILL_M_ENDPATTERN:
 break;
 
 case DRILL_M_CANNEDTEXT:
 break;
 
 case DRILL_M_TIPCHECK:
 break;
 
 case DRILL_DETECT_BROKEN:
 break;
 
 case DRILL_INCREMENTALHEADER:
 if( *text != ',' )
 {
 AddMessageToList( wxT( "ICI command has no parameter" ) );
 break;
 }
 text++; // skip separator
 // Parameter should be ON or OFF
 if( strncasecmp( text, "OFF", 3 ) == 0 )
 m_Relative = false;
 else if( strncasecmp( text, "ON", 2 ) == 0 )
 m_Relative = true;
 else
 AddMessageToList( wxT( "ICI command has incorrect parameter" ) );
 break;
 
 case DRILL_TOOL_CHANGE_STOP:
 break;
 
 case DRILL_AUTOMATIC_SPEED:
 break;
 
 case DRILL_AXIS_VERSION:
 break;
 
 case DRILL_RESET_CMD:
 break;
 
 case DRILL_AUTOMATIC_TOOL_CHANGE:
 break;
 
 case DRILL_FMT:
 break;
 
 case DRILL_TOOL_INFORMATION:
 readToolInformation( text );
 break;
 
 case DRILL_M_TOOL_DOWN: // tool down (starting a routed hole or polyline)
 // Only the last position is useful:
 if( m_RoutePositions.size() > 1 )
 m_RoutePositions.erase( m_RoutePositions.begin(), m_RoutePositions.begin() + m_RoutePositions.size() - 1 );
 
 break;
 
 case DRILL_M_TOOL_UP: // tool up (ending a routed polyline)
 FinishRouteCommand();
 break;
 }
 
 while( *text )
 text++;
 
 return true;
}

References _, GERBER_FILE_IMAGE::AddMessageToList(), DRILL_AUTOMATIC_SPEED, DRILL_AUTOMATIC_TOOL_CHANGE, DRILL_AXIS_VERSION, DRILL_DETECT_BROKEN, DRILL_FMT, DRILL_FORMAT_ALTIUM, DRILL_HEADER_SKIP, DRILL_IMPERIAL_HEADER, DRILL_INCREMENTALHEADER, DRILL_M_BEGINPATTERN, DRILL_M_CANNEDTEXT, DRILL_M_END, DRILL_M_ENDFILE, DRILL_M_ENDHEADER, DRILL_M_ENDPATTERN, DRILL_M_HEADER, DRILL_M_LONGMESSAGE, DRILL_M_MESSAGE, DRILL_M_METRIC, DRILL_M_TIPCHECK, DRILL_M_TOOL_DOWN, DRILL_M_TOOL_UP, DRILL_M_UNKNOWN, DRILL_METRIC_HEADER, DRILL_RESET_CMD, DRILL_REWIND_STOP, DRILL_SKIP, DRILL_TOOL_CHANGE_STOP, DRILL_TOOL_INFORMATION, excellonHeaderCmdList, FinishRouteCommand(), EXCELLON_CMD::m_Code, EXCELLON_CMD::m_Name, GERBER_FILE_IMAGE::m_NoTrailingZeros, GERBER_FILE_IMAGE::m_Relative, m_RouteModeOn, m_RoutePositions, m_State, READ_HEADER_STATE, READ_PROGRAM_STATE, readFileFormat(), readToolInformation(), SelectUnits(), and text.

Referenced by LoadFile().

◆ ExecuteRS274XCommand()

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

privateinherited

Execute a RS274X command.

Definition at line 198 of file rs274x.cpp.

{
 int code;
 int seq_len; // not used, just provided
 int seq_char;
 bool ok = true;
 wxString msg;
 double fcoord;
 bool x_fmt_known = false;
 bool y_fmt_known = false;
 
 // conv_scale = scaling factor from inch to Internal Unit
 double conv_scale = IU_PER_MILS * 1000;
 
 if( m_GerbMetric )
 conv_scale /= 25.4;
 
 switch( aCommand )
 {
 case FORMAT_STATEMENT:
 seq_len = 2;
 
 while( *aText != '*' )
 {
 switch( *aText )
 {
 case ' ':
 aText++;
 break;
 
 case 'D': // Non-standard option for all zeros (leading + tailing)
 msg.Printf( _( "RS274X: Invalid GERBER format command '%c' at line %d: \"%s\"" ),
 'D', m_LineNum, aBuff );
 AddMessageToList( msg );
 msg.Printf( _("GERBER file \"%s\" may not display as intended." ),
 m_FileName.ToAscii() );
 AddMessageToList( msg );
 KI_FALLTHROUGH;
 
 case 'L': // No Leading 0
 m_NoTrailingZeros = false;
 aText++;
 break;
 
 case 'T': // No trailing 0
 m_NoTrailingZeros = true;
 aText++;
 break;
 
 case 'A': // Absolute coord
 m_Relative = false;
 aText++;
 break;
 
 case 'I': // Relative coord
 m_Relative = true;
 aText++;
 break;
 
 case 'G':
 case 'N': // Sequence code (followed by one digit: the sequence len)
 // (sometimes found before the X,Y sequence)
 // Obscure option
 aText++;
 seq_char = *aText++;
 
 if( (seq_char >= '0') && (seq_char <= '9') )
 seq_len = seq_char - '0';
 
 break;
 
 case 'M': // Sequence code (followed by one digit: the sequence len)
 // (sometimes found after the X,Y sequence)
 // Obscure option
 aText++;
 code = *aText;
 
 if( ( code >= '0' ) && ( code <= '9' ) )
 aText++; // skip the digit
 
 break;
 
 case 'X':
 case 'Y':
 {
 code = *(aText++);
 char ctmp = *(aText++) - '0';
 
 if( code == 'X' )
 {
 x_fmt_known = true;
 // number of digits after the decimal point (0 to 7 allowed)
 m_FmtScale.x = *aText - '0';
 m_FmtLen.x = ctmp + m_FmtScale.x;
 
 // m_FmtScale is 0 to 7
 // (Old Gerber specification was 0 to 6)
 if( m_FmtScale.x < 0 )
 m_FmtScale.x = 0;
 
 if( m_FmtScale.x > 7 )
 m_FmtScale.x = 7;
 }
 else
 {
 y_fmt_known = true;
 m_FmtScale.y = *aText - '0';
 m_FmtLen.y = ctmp + m_FmtScale.y;
 
 if( m_FmtScale.y < 0 )
 m_FmtScale.y = 0;
 
 if( m_FmtScale.y > 7 )
 m_FmtScale.y = 7;
 }
 
 aText++;
 }
 break;
 
 case '*':
 break;
 
 default:
 msg.Printf( wxT( "Unknown id (%c) in FS command" ),
 *aText );
 AddMessageToList( msg );
 GetEndOfBlock( aBuff, aBuffSize, aText, m_Current_File );
 ok = false;
 break;
 }
 }
 
 if( !x_fmt_known || !y_fmt_known )
 AddMessageToList( wxT( "RS274X: Format Statement (FS) without X or Y format" ) );
 
 break;
 
 case AXIS_SELECT: // command ASAXBY*% or %ASAYBX*%
 m_SwapAxis = false;
 
 if( strncasecmp( aText, "AYBX", 4 ) == 0 )
 m_SwapAxis = true;
 
 break;
 
 case MIRROR_IMAGE: // command %MIA0B0*%, %MIA0B1*%, %MIA1B0*%, %MIA1B1*%
 m_MirrorA = m_MirrorB = false;
 
 while( *aText && *aText != '*' )
 {
 switch( *aText )
 {
 case 'A': // Mirror A axis ?
 aText++;
 
 if( *aText == '1' )
 m_MirrorA = true;
 
  break;
 
 case 'B': // Mirror B axis ?
 aText++;
 
 if( *aText == '1' )
 m_MirrorB = true;
 
 break;
 
 default:
 aText++;
 break;
 }
 }
 break;
 
 case MODE_OF_UNITS:
 code = ReadXCommandID( aText );
 
 if( code == INCH )
 m_GerbMetric = false;
 else if( code == MILLIMETER )
 m_GerbMetric = true;
 
 conv_scale = m_GerbMetric ? IU_PER_MILS / 25.4 : IU_PER_MILS;
 break;
 
 case FILE_ATTRIBUTE: // Command %TF ...
 {
 X2_ATTRIBUTE dummy;
 dummy.ParseAttribCmd( m_Current_File, aBuff, aBuffSize, aText, m_LineNum );
 
 if( dummy.IsFileFunction() )
 {
 delete m_FileFunction;
 m_FileFunction = new X2_ATTRIBUTE_FILEFUNCTION( dummy );
 
 // Don't set this until we get a file function; other code expects m_IsX2_file == true
 // to mean that we have a valid m_FileFunction
 m_IsX2_file = true;
 }
 else if( dummy.IsFileMD5() )
 {
 m_MD5_value = dummy.GetPrm( 1 );
 }
 else if( dummy.IsFilePart() )
 {
 m_PartString = dummy.GetPrm( 1 );
 }
 }
 break;
 
 case APERTURE_ATTRIBUTE: // Command %TA
 {
 X2_ATTRIBUTE dummy;
 dummy.ParseAttribCmd( m_Current_File, aBuff, aBuffSize, aText, m_LineNum );
 
 if( dummy.GetAttribute() == wxT( ".AperFunction" ) )
 {
 m_AperFunction = dummy.GetPrm( 1 );
 
 // A few function values can have other parameters. Add them
 for( int ii = 2; ii < dummy.GetPrmCount(); ii++ )
 m_AperFunction << wxT( "," ) << dummy.GetPrm( ii );
 }
 }
 break;
 
 case NET_ATTRIBUTE: // Command %TO currently %TO.P %TO.N and %TO.C
 {
 X2_ATTRIBUTE dummy;
 
 dummy.ParseAttribCmd( m_Current_File, aBuff, aBuffSize, aText, m_LineNum );
 
 if( dummy.GetAttribute() == wxT( ".N" ) )
 {
 m_NetAttributeDict.m_NetAttribType |= GBR_NETLIST_METADATA::GBR_NETINFO_NET;
 m_NetAttributeDict.m_Netname = FormatStringFromGerber( dummy.GetPrm( 1 ) );
 }
 else if( dummy.GetAttribute() == wxT( ".C" ) )
 {
 m_NetAttributeDict.m_NetAttribType |= GBR_NETLIST_METADATA::GBR_NETINFO_CMP;
 m_NetAttributeDict.m_Cmpref = FormatStringFromGerber( dummy.GetPrm( 1 ) );
 }
 else if( dummy.GetAttribute() == wxT( ".P" ) )
 {
 m_NetAttributeDict.m_NetAttribType |= GBR_NETLIST_METADATA::GBR_NETINFO_PAD;
 m_NetAttributeDict.m_Cmpref = FormatStringFromGerber( dummy.GetPrm( 1 ) );
 m_NetAttributeDict.m_Padname.SetField( FormatStringFromGerber( dummy.GetPrm( 2 ) ), true, true );
 
 if( dummy.GetPrmCount() > 3 )
 {
 m_NetAttributeDict.m_PadPinFunction.SetField(
 FormatStringFromGerber( dummy.GetPrm( 3 ) ), true, true );
 }
 else
 {
 m_NetAttributeDict.m_PadPinFunction.Clear();
 }
 }
 }
 break;
 
 case REMOVE_APERTURE_ATTRIBUTE: // Command %TD ...
 {
 X2_ATTRIBUTE dummy;
 dummy.ParseAttribCmd( m_Current_File, aBuff, aBuffSize, aText, m_LineNum );
 RemoveAttribute( dummy );
 }
 break;
 
 case OFFSET: // command: OFAnnBnn (nn = float number) = layer Offset
 m_Offset.x = m_Offset.y = 0;
 while( *aText != '*' )
 {
 switch( *aText )
 {
 case 'A': // A axis offset in current unit (inch or mm)
 aText++;
 fcoord = ReadDouble( aText );
 m_Offset.x = KiROUND( fcoord * conv_scale );
 break;
 
 case 'B': // B axis offset in current unit (inch or mm)
 aText++;
 fcoord = ReadDouble( aText );
 m_Offset.y = KiROUND( fcoord * conv_scale );
 break;
 }
 }
 break;
 
 case SCALE_FACTOR:
 m_Scale.x = m_Scale.y = 1.0;
 while( *aText != '*' )
 {
 switch( *aText )
 {
 case 'A': // A axis scale
 aText++;
 m_Scale.x = ReadDouble( aText );
 break;
 
 case 'B': // B axis scale
 aText++;
 m_Scale.y = ReadDouble( aText );
 break;
 }
 }
 break;
 
 case IMAGE_OFFSET: // command: IOAnnBnn (nn = float number) = Image Offset
 m_ImageOffset.x = m_ImageOffset.y = 0;
 while( *aText != '*' )
 {
 switch( *aText )
 {
 case 'A': // A axis offset in current unit (inch or mm)
 aText++;
 fcoord = ReadDouble( aText );
 m_ImageOffset.x = KiROUND( fcoord * conv_scale );
 break;
 
 case 'B': // B axis offset in current unit (inch or mm)
 aText++;
 fcoord = ReadDouble( aText );
 m_ImageOffset.y = KiROUND( fcoord * conv_scale );
 break;
 }
 }
 break;
 
 case IMAGE_ROTATION: // command IR0* or IR90* or IR180* or IR270*
 if( strncasecmp( aText, "0*", 2 ) == 0 )
 m_ImageRotation = 0;
 else if( strncasecmp( aText, "90*", 3 ) == 0 )
 m_ImageRotation = 90;
 else if( strncasecmp( aText, "180*", 4 ) == 0 )
 m_ImageRotation = 180;
 else if( strncasecmp( aText, "270*", 4 ) == 0 )
 m_ImageRotation = 270;
 else
 AddMessageToList( _( "RS274X: Command \"IR\" rotation value not allowed" ) );
 
 break;
 
 case STEP_AND_REPEAT: // command SR, like %SRX3Y2I5.0J2*%
 m_Iterpolation = GERB_INTERPOL_LINEAR_1X; // Start a new Gerber layer
 GetLayerParams().m_StepForRepeat.x = 0.0;
 GetLayerParams().m_StepForRepeat.x = 0.0; // offset for Step and Repeat command
 GetLayerParams().m_XRepeatCount = 1;
 GetLayerParams().m_YRepeatCount = 1; // The repeat count
 GetLayerParams().m_StepForRepeatMetric = m_GerbMetric; // the step units
 
 while( *aText && *aText != '*' )
 {
 switch( *aText )
 {
 case 'I': // X axis offset
 aText++;
 GetLayerParams().m_StepForRepeat.x = ReadDouble( aText );
 break;
 
 case 'J': // Y axis offset
 aText++;
 GetLayerParams().m_StepForRepeat.y = ReadDouble( aText );
 break;
 
 case 'X': // X axis repeat count
 aText++;
 GetLayerParams().m_XRepeatCount = ReadInt( aText );
 break;
 
 case 'Y': // Y axis offset
 aText++;
 GetLayerParams().m_YRepeatCount = ReadInt( aText );
 break;
 
 default:
 aText++;
 break;
 }
 }
 break;
 
 case IMAGE_JUSTIFY: // Command IJAnBn*
 m_ImageJustifyXCenter = false; // Image Justify Center on X axis (default = false)
 m_ImageJustifyYCenter = false; // Image Justify Center on Y axis (default = false)
 m_ImageJustifyOffset = VECTOR2I( 0, 0 ); // Image Justify Offset on XY axis (default = 0,0)
 while( *aText && *aText != '*' )
 {
 // IJ command is (for A or B axis) AC or AL or A<coordinate>
 switch( *aText )
 {
 case 'A': // A axis justify
 aText++;
 
 if( *aText == 'C' )
 {
 m_ImageJustifyXCenter = true;
 aText++;
 }
 else if( *aText == 'L' )
 {
 m_ImageJustifyXCenter = true;
 aText++;
 }
 else
 {
 m_ImageJustifyOffset.x = KiROUND( ReadDouble( aText ) * conv_scale);
 }
 
 break;
 
 case 'B': // B axis justify
 aText++;
 
 if( *aText == 'C' )
 {
 m_ImageJustifyYCenter = true;
 aText++;
 }
 else if( *aText == 'L' )
 {
 m_ImageJustifyYCenter = true;
 aText++;
 }
 else
 {
 m_ImageJustifyOffset.y = KiROUND( ReadDouble( aText ) * conv_scale);
 }
 
 break;
 
 default:
 aText++;
 break;
 }
 }
 
 if( m_ImageJustifyXCenter )
 m_ImageJustifyOffset.x = 0;
 
 if( m_ImageJustifyYCenter )
 m_ImageJustifyOffset.y = 0;
 
 break;
 
 case KNOCKOUT:
 m_Iterpolation = GERB_INTERPOL_LINEAR_1X; // Start a new Gerber layer
 msg = _( "RS274X: Command KNOCKOUT ignored by GerbView" ) ;
 AddMessageToList( msg );
 break;
 
 case ROTATE: // Layer rotation: command like %RO45*%
 m_Iterpolation = GERB_INTERPOL_LINEAR_1X; // Start a new Gerber layer
 m_LocalRotation = ReadDouble( aText ); // Store layer rotation in degrees
 break;
 
 case IMAGE_NAME:
 m_ImageName.Empty();
 
 while( *aText != '*' )
 m_ImageName.Append( *aText++ );
 
 break;
 
 case LOAD_NAME:
 // %LN is a (deprecated) equivalentto G04: a comment
 while( *aText && *aText != '*' )
 aText++; // Skip text
 
 break;
 
 case IMAGE_POLARITY:
 if( strncasecmp( aText, "NEG", 3 ) == 0 )
 m_ImageNegative = true;
 else
 m_ImageNegative = false;
 
 break;
 
 case LOAD_POLARITY:
 if( *aText == 'C' )
 GetLayerParams().m_LayerNegative = true;
 else
 GetLayerParams().m_LayerNegative = false;
 
 break;
 
 case AP_MACRO: // lines like %AMMYMACRO*
 // 5,1,8,0,0,1.08239X$1,22.5*
 // %
 /*ok = */ReadApertureMacro( aBuff, aBuffSize, aText, m_Current_File );
 break;
 
 case AP_DEFINITION:
 /* input example: %ADD30R,0.081800X0.101500*%
 * Aperture definition has 4 options: C, R, O, P
 * (Circle, Rect, Oval, regular Polygon)
 * and shapes can have a hole (round or rectangular).
 * All optional parameters values start by X
 * at this point, text points to 2nd 'D'
 */
 if( *aText++ != 'D' )
 {
 ok = false;
 break;
 }
 
 m_Has_DCode = true;
 
 code = ReadInt( aText );
 
 D_CODE* dcode;
 dcode = GetDCODEOrCreate( code );
 
 if( dcode == nullptr )
 break;
 
 dcode->m_AperFunction = m_AperFunction;
 
 // at this point, text points to character after the ADD<num>,
 // i.e. R in example above. If aText[0] is one of the usual
 // apertures: (C,R,O,P), there is a comma after it.
 if( aText[1] == ',' )
 {
 char stdAperture = *aText;
 
 aText += 2; // skip "C," for example
 
 // First parameter is the size X:
 dcode->m_Size.x = KiROUND( ReadDouble( aText ) * conv_scale );
 dcode->m_Size.y = dcode->m_Size.x;
 
 switch( stdAperture ) // Aperture desceiption has optional parameters. Read them
 {
 case 'C': // Circle
 dcode->m_Shape = APT_CIRCLE;
 while( *aText == ' ' )
 aText++;
 
 if( *aText == 'X' )
 {
 aText++;
 dcode->m_Drill.x = dcode->m_Drill.y =
 KiROUND( ReadDouble( aText ) * conv_scale );
 dcode->m_DrillShape = APT_DEF_ROUND_HOLE;
 }
 
 while( *aText == ' ' )
 aText++;
 
 if( *aText == 'X' )
 {
 aText++;
 dcode->m_Drill.y =
 KiROUND( ReadDouble( aText ) * conv_scale );
 
 dcode->m_DrillShape = APT_DEF_RECT_HOLE;
 }
 dcode->m_Defined = true;
 break;
 
 case 'O': // oval
 case 'R': // rect
 dcode->m_Shape = (stdAperture == 'O') ? APT_OVAL : APT_RECT;
 
 while( *aText == ' ' )
 aText++;
 
 if( *aText == 'X' ) // Second parameter: size Y
 {
 aText++;
 dcode->m_Size.y =
 KiROUND( ReadDouble( aText ) * conv_scale );
 }
 
 while( *aText == ' ' )
 aText++;
 
 if( *aText == 'X' ) // third parameter: drill size (or drill size X)
 {
 aText++;
 dcode->m_Drill.x = KiROUND( ReadDouble( aText ) * conv_scale );
 dcode->m_Drill.y = dcode->m_Drill.x;
 dcode->m_DrillShape = APT_DEF_ROUND_HOLE;
 }
 
 while( *aText == ' ' )
 aText++;
 
 if( *aText == 'X' ) // fourth parameter: drill size Y
 {
 aText++;
 dcode->m_Drill.y =
 KiROUND( ReadDouble( aText ) * conv_scale );
 dcode->m_DrillShape = APT_DEF_RECT_HOLE;
 }
 
 dcode->m_Defined = true;
 break;
 
 case 'P':
 
 /* Regular polygon: a command line like %ADD12P,0.040X10X25X0.025X0.025X0.0150*%
 * params are: <diameter>, X<edge count>, X<Rotation>, X<X hole dim>, X<Y hole dim>
 */
 dcode->m_Shape = APT_POLYGON;
 while( *aText == ' ' )
 aText++;
 
 if( *aText == 'X' )
 {
 aText++;
 dcode->m_EdgesCount = ReadInt( aText );
 }
 
 while( *aText == ' ' )
 aText++;
 
 if( *aText == 'X' )
 {
 aText++;
 dcode->m_Rotation = EDA_ANGLE( ReadDouble( aText ), DEGREES_T );
 }
 
 while( *aText == ' ' )
 aText++;
 
 if( *aText == 'X' )
 {
 aText++;
 dcode->m_Drill.x = KiROUND( ReadDouble( aText ) * conv_scale );
 dcode->m_Drill.y = dcode->m_Drill.x;
 dcode->m_DrillShape = APT_DEF_ROUND_HOLE;
 }
 
 while( *aText == ' ' )
 aText++;
 
 if( *aText == 'X' )
 {
 aText++;
 dcode->m_Drill.y = KiROUND( ReadDouble( aText ) * conv_scale );
 dcode->m_DrillShape = APT_DEF_RECT_HOLE;
 }
 dcode->m_Defined = true;
 break;
 }
 }
 else // aText[0] starts an aperture macro name
 {
 APERTURE_MACRO am_lookup;
 
 while( *aText && *aText != '*' && *aText != ',' )
 am_lookup.name.Append( *aText++ );
 
 // When an aperture definition is like %AMLINE2* 22,1,$1,$2,0,0,-45*
 // the ADDxx<MACRO_NAME> command has parameters, like %ADD14LINE2,0.8X0.5*%
 if( *aText == ',' )
 { // Read aperture macro parameters and store them
 aText++; // aText points the first parameter
 
 while( *aText && *aText != '*' )
 {
 double param = ReadDouble( aText );
 dcode->AppendParam( param );
 
 while( isspace( *aText ) )
 aText++;
 
 // Skip 'X' separator:
 if( *aText == 'X' || *aText == 'x' )
 aText++;
 }
 }
 
 // lookup the aperture macro here.
 APERTURE_MACRO* pam = FindApertureMacro( am_lookup );
 
 if( !pam )
 {
 msg.Printf( wxT( "RS274X: aperture macro %s not found\n" ),
 TO_UTF8( am_lookup.name ) );
 AddMessageToList( msg );
 ok = false;
 break;
 }
 
 dcode->m_Shape = APT_MACRO;
 dcode->SetMacro( pam );
 dcode->m_Defined = true;
 }
 
 break;
 
 default:
 ok = false;
 break;
 }
 
 ignore_unused( seq_len );
 
 ok = GetEndOfBlock( aBuff, aBuffSize, aText, m_Current_File );
 
 return ok;
}

Referenced by GERBER_FILE_IMAGE::Execute_G_Command(), and GERBER_FILE_IMAGE::ReadRS274XCommand().

◆ FindApertureMacro()

APERTURE_MACRO * GERBER_FILE_IMAGE::FindApertureMacro ( const APERTURE_MACRO & aLookup )

inherited

Look up a previously read in aperture macro.

Parameters

aLookup A dummy APERTURE_MACRO with [only] the name field set.

Returns: the aperture macro with a matching name or NULL if not found.

Definition at line 146 of file gerber_file_image.cpp.

{
 APERTURE_MACRO_SET::iterator iter = m_aperture_macros.find( aLookup );
 
 if( iter != m_aperture_macros.end() )
 {
 APERTURE_MACRO* pam = (APERTURE_MACRO*) &(*iter);
 return pam;
 }
 
 return nullptr; // not found
}

References GERBER_FILE_IMAGE::m_aperture_macros.

Referenced by GERBER_FILE_IMAGE::ExecuteRS274XCommand().

◆ FinishRouteCommand()

void EXCELLON_IMAGE::FinishRouteCommand ( )

private

End a route command started by M15 ot G01, G02 or G03 command.

Definition at line 1115 of file excellon_read_drill_file.cpp.

{
 // Ends a route command started by M15 ot G01, G02 or G03 command
 // if a route command is not in progress, do nothing
 
 if( !m_RouteModeOn )
 return;
 
 D_CODE* tool = GetDCODE( m_Current_Tool );
 
 if( !tool )
 {
 AddMessageToList( wxString::Format( wxT( "Unknown tool code %d" ), m_Current_Tool ) );
 return;
 }
 
 for( size_t ii = 1; ii < m_RoutePositions.size(); ii++ )
 {
 GERBER_DRAW_ITEM* gbritem = new GERBER_DRAW_ITEM( this );
 
 if( m_RoutePositions[ii].m_rmode == 0 ) // linear routing
 {
 fillLineGBRITEM( gbritem, tool->m_Num_Dcode,
 m_RoutePositions[ii-1].GetPos(), m_RoutePositions[ii].GetPos(),
 tool->m_Size, false );
 }
 else // circular (cw or ccw) routing
 {
 bool rot_ccw = m_RoutePositions[ii].m_rmode == ROUTE_CW;
 int radius = m_RoutePositions[ii].m_radius; // Can be adjusted by computeCenter.
 VECTOR2I center;
 
 if( m_RoutePositions[ii].m_arc_type_info == ARC_INFO_TYPE_CENTER )
 center = VECTOR2I( m_RoutePositions[ii].m_cx, m_RoutePositions[ii].m_cy );
 else
 center = computeCenter( m_RoutePositions[ii-1].GetPos(),
 m_RoutePositions[ii].GetPos(), radius, rot_ccw );
 
 fillArcGBRITEM( gbritem, tool->m_Num_Dcode,
 m_RoutePositions[ii-1].GetPos(), m_RoutePositions[ii].GetPos(),
 center - m_RoutePositions[ii-1].GetPos(),
 tool->m_Size, not rot_ccw , true,
 false );
 }
 
 AddItemToList( gbritem );
 
 StepAndRepeatItem( *gbritem );
 }
 
 m_RoutePositions.clear();
 m_RouteModeOn = false;
}

References GERBER_FILE_IMAGE::AddItemToList(), GERBER_FILE_IMAGE::AddMessageToList(), ARC_INFO_TYPE_CENTER, computeCenter(), fillArcGBRITEM(), fillLineGBRITEM(), Format(), GERBER_FILE_IMAGE::GetDCODE(), GERBER_FILE_IMAGE::m_Current_Tool, D_CODE::m_Num_Dcode, m_RouteModeOn, m_RoutePositions, D_CODE::m_Size, ROUTE_CW, and GERBER_FILE_IMAGE::StepAndRepeatItem().

Referenced by Execute_EXCELLON_G_Command(), and Execute_HEADER_And_M_Command().

◆ Get() [1/3]

template<typename T >

boost::optional< T > INSPECTABLE::Get ( const wxString & aProperty )

inlineinherited

Definition at line 104 of file inspectable.h.

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

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

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty )

inlineinherited

Definition at line 86 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
 return object ? aProperty->getter( object ) : wxAny();
 }

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

Referenced by BOOST_AUTO_TEST_CASE(), CLASS_D_DESC::CLASS_D_DESC(), PCB_EXPR_VAR_REF::GetValue(), and PAD_DESC::PAD_DESC().

◆ Get() [3/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty )

inlineinherited

Definition at line 95 of file inspectable.h.

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

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

◆ GetBoundingBox()

const EDA_RECT EDA_ITEM::GetBoundingBox ( ) const

virtualinherited

Return the orthogonal bounding box of this object for display purposes.

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

Reimplemented in LIB_FIELD, LIB_ITEM, LIB_PIN, LIB_SHAPE, LIB_SYMBOL, LIB_TEXT, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SYMBOL, SCH_TEXT, GBR_LAYOUT, GERBER_DRAW_ITEM, DS_DRAW_ITEM_LINE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_PAGE, DS_DRAW_ITEM_TEXT, DS_DRAW_ITEM_BITMAP, PCB_GROUP, BOARD, FOOTPRINT, FP_TEXT, NETINFO_ITEM, PAD, PCB_BITMAP, PCB_DIMENSION_BASE, PCB_DIM_CENTER, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TRACK, ZONE, and DS_DRAW_ITEM_BASE.

Definition at line 75 of file eda_item.cpp.

{
 // return a zero-sized box per default. derived classes should override
 // this
 return EDA_RECT( VECTOR2I( 0, 0 ), VECTOR2I( 0, 0 ) );
}

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), CN_ITEM::BBox(), SCH_EDIT_TOOL::ChangeTextType(), TEST_BOARD_ITEM_FIXTURE::CompareItems(), TEST_EE_ITEM_FIXTURE::CompareItems(), EE_RTREE::contains(), BOARD_COMMIT::dirtyIntersectingZones(), KIGFX::PCB_PAINTER::Draw(), SCH_DRAWING_TOOLS::DrawSheet(), PCB_SELECTION_TOOL::FindItem(), SCH_EDITOR_CONTROL::FindNext(), LIB_ITEM::GetBoundingBox(), GetBoundingBoxes(), BOARD_ITEM::GetCenter(), GERBVIEW_SELECTION::GetCenter(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), EE_SELECTION_TOOL::GuessSelectionCandidates(), EE_RTREE::insert(), insideArea(), insideBackCourtyard(), insideCourtyard(), insideFrontCourtyard(), SCH_SCREEN::MarkConnections(), SCH_EDIT_TOOL::Mirror(), DRC_RTREE::QueryColliding(), EE_RTREE::remove(), SCH_EDIT_TOOL::Rotate(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskBridges(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones(), GERBVIEW_SELECTION::ViewBBox(), and EDA_ITEM::ViewBBox().

◆ GetClass()

wxString GERBER_FILE_IMAGE::GetClass ( ) const

inlineoverridevirtualinherited

Return the class name.

Implements EDA_ITEM.

Definition at line 116 of file gerber_file_image.h.

 {
 return wxT( "GERBER_FILE_IMAGE" );
 }

◆ GetDCODE()

D_CODE * GERBER_FILE_IMAGE::GetDCODE ( int aDCODE ) const

inherited

Return a pointer to the D_CODE within this GERBER for the given aDCODE.

Parameters

aDCODE The numeric value of the D_CODE to look up.

Returns: The D code implied by the given aDCODE or NULL if the requested aDCODE is out of range.

Definition at line 135 of file gerber_file_image.cpp.

{
 unsigned ndx = aDCODE - FIRST_DCODE;
 
 if( ndx < (unsigned) arrayDim( m_Aperture_List ) )
 return m_Aperture_List[ndx];
 
 return nullptr;
}

References arrayDim(), FIRST_DCODE, and GERBER_FILE_IMAGE::m_Aperture_List.

Referenced by GERBER_FILE_IMAGE::Execute_DCODE_Command(), Execute_Drill_Command(), GERBER_FILE_IMAGE::Execute_G_Command(), FinishRouteCommand(), GERBER_DRAW_ITEM::GetDcodeDescr(), Select_Tool(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), GERBVIEW_FRAME::updateAperAttributesSelectBox(), and GERBVIEW_FRAME::updateDCodeSelectBox().

◆ GetDCODEOrCreate()

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

inherited

Return a pointer to the D_CODE within this GERBER for the given aDCODE.

Parameters

aDCODE	The numeric value of the D_CODE to look up.
aCreateIfNoExist	If true, then create the D_CODE if it does not exist in list.

Returns: The one implied by the given aDCODE or NULL if the requested aDCODE is out of range.

Definition at line 115 of file gerber_file_image.cpp.

{
 unsigned ndx = aDCODE - FIRST_DCODE;
 
 if( ndx < (unsigned) arrayDim( m_Aperture_List ) )
 {
 // lazily create the D_CODE if it does not exist.
 if( aCreateIfNoExist )
 {
 if( m_Aperture_List[ndx] == nullptr )
 m_Aperture_List[ndx] = new D_CODE( ndx + FIRST_DCODE );
 }
 
 return m_Aperture_List[ndx];
 }
 
 return nullptr;
}

References arrayDim(), FIRST_DCODE, and GERBER_FILE_IMAGE::m_Aperture_List.

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

◆ GetDcodesCount()

int GERBER_FILE_IMAGE::GetDcodesCount ( )

inherited

Returns: the count of Dcode tools in use in the image

Definition at line 254 of file gerber_file_image.cpp.

{
 int count = 0;
 
 for( unsigned ii = 0; ii < arrayDim( m_Aperture_List ); ii++ )
 {
 if( m_Aperture_List[ii] )
 {
 if( m_Aperture_List[ii]->m_InUse || m_Aperture_List[ii]->m_Defined )
 ++count;
 }
 
 }
 
 return count;
}

References arrayDim(), GERBER_FILE_IMAGE::m_Aperture_List, and GERBER_FILE_IMAGE::m_InUse.

Referenced by GERBVIEW_INSPECTION_TOOL::ShowDCodes(), GERBVIEW_FRAME::updateAperAttributesSelectBox(), and GERBVIEW_FRAME::updateDCodeSelectBox().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 157 of file eda_item.h.

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

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

◆ GetEndOfBlock()

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

privateinherited

Definition at line 909 of file rs274x.cpp.

{
 for( ; ; )
 {
 while( (aText < aBuff + aBuffSize) && *aText )
 {
 if( *aText == '*' )
 return true;
 
 if( *aText == '%' )
 return true;
 
 aText++;
 }
 
 if( fgets( aBuff, aBuffSize, gerber_file ) == nullptr )
 break;
 
 m_LineNum++;
 aText = aBuff;
 }
 
 return false;
}

References gerber_file, and GERBER_FILE_IMAGE::m_LineNum.

Referenced by GERBER_FILE_IMAGE::ExecuteRS274XCommand().

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 154 of file eda_item.h.

154{ return m_flags; }

References EDA_ITEM::m_flags.

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

◆ GetFocusPosition()

virtual const VECTOR2I EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

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

Reimplemented in BOARD, PCB_SHAPE, and PCB_TRACK.

Definition at line 269 of file eda_item.h.

269{ return GetPosition(); }

EDA_ITEM::GetPosition

virtual VECTOR2I GetPosition() const

Definition: eda_item.h:262

References EDA_ITEM::GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem().

◆ GetItems()

GERBER_DRAW_ITEMS & GERBER_FILE_IMAGE::GetItems ( )

inlineinherited

Returns: a reference to the GERBER_DRAW_ITEMS deque list

Definition at line 158 of file gerber_file_image.h.

158{ return m_drawings; }

References GERBER_FILE_IMAGE::m_drawings.

Referenced by GBR_LAYOUT::ComputeBoundingBox(), GBR_TO_PCB_EXPORTER::ExportPcb(), GERBER_FILE_IMAGE::HasNegativeItems(), GERBVIEW_FRAME::Read_EXCELLON_File(), GERBVIEW_FRAME::Read_GERBER_File(), GERBVIEW_DRAW_PANEL_GAL::SwitchBackend(), GERBER_FILE_IMAGE::Visit(), and GERBER_FILE_IMAGE::~GERBER_FILE_IMAGE().

◆ GetItemsCount()

int GERBER_FILE_IMAGE::GetItemsCount ( )

inlineinherited

Returns: the count of GERBER_DRAW_ITEMS in the image

Definition at line 163 of file gerber_file_image.h.

163{ return m_drawings.size(); }

References GERBER_FILE_IMAGE::m_drawings.

Referenced by GERBVIEW_FRAME::Read_GERBER_File().

◆ GetLastItemInList()

GERBER_DRAW_ITEM * GERBER_FILE_IMAGE::GetLastItemInList ( ) const

inlineinherited

Returns: the last GERBER_DRAW_ITEM* item of the items list

Definition at line 178 of file gerber_file_image.h.

 {
 return m_drawings.back();
 }

References GERBER_FILE_IMAGE::m_drawings.

Referenced by GERBER_FILE_IMAGE::Execute_DCODE_Command(), and GERBER_FILE_IMAGE::Execute_G_Command().

◆ GetLayerParams()

GERBER_LAYER & GERBER_FILE_IMAGE::GetLayerParams ( )

inlineinherited

Returns: the current layers params.

Definition at line 186 of file gerber_file_image.h.

 {
 return m_GBRLayerParams;
 }

References GERBER_FILE_IMAGE::m_GBRLayerParams.

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

◆ GetMenuImage()

BITMAPS EDA_ITEM::GetMenuImage ( ) const

virtualinherited

Return a pointer to an image to be used in menus.

The default version returns the right arrow image. Override this function to provide object specific menu images.

Returns: The menu image associated with the item.

Reimplemented in LIB_FIELD, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_WIRE_ENTRY, SCH_BUS_BUS_ENTRY, SCH_FIELD, SCH_JUNCTION, SCH_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_SHAPE, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, GERBER_DRAW_ITEM, PCB_GROUP, FOOTPRINT, FP_SHAPE, FP_TEXT, FP_TEXTBOX, PAD, PCB_BITMAP, PCB_DIM_ALIGNED, PCB_DIM_ORTHOGONAL, PCB_DIM_RADIAL, PCB_DIM_LEADER, PCB_DIM_CENTER, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 274 of file eda_item.cpp.

{
 return BITMAPS::dummy_item;
}

References dummy_item.

Referenced by SELECTION_TOOL::doSelectionMenu().

◆ GetMessages()

const wxArrayString & GERBER_FILE_IMAGE::GetMessages ( ) const

inlineinherited

Definition at line 141 of file gerber_file_image.h.

141{ return m_messagesList; }

References GERBER_FILE_IMAGE::m_messagesList.

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

◆ GetMsgPanelInfo()

virtual void EDA_ITEM::GetMsgPanelInfo	(	EDA_DRAW_FRAME *	aFrame,
		std::vector< MSG_PANEL_ITEM > &	aList
	)

inlinevirtualinherited

Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

Parameters

aList is the list to populate.

Reimplemented in LIB_FIELD, LIB_ITEM, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_LABEL_BASE, SCH_LINE, SCH_MARKER, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, GERBER_DRAW_ITEM, DS_DRAW_ITEM_BASE, PCB_GROUP, BOARD, FOOTPRINT, FP_SHAPE, FP_TEXT, FP_TEXTBOX, NETINFO_ITEM, PAD, PCB_BITMAP, PCB_DIMENSION_BASE, PCB_DIM_ALIGNED, PCB_DIM_LEADER, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 224 of file eda_item.h.

225 {

226 }

Referenced by SCH_SHAPE::GetMsgPanelInfo(), EDA_DRAW_FRAME::SetMsgPanel(), EE_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), PCB_CONTROL::UpdateMessagePanel(), and FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel().

◆ GetNextLine()

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

privateinherited

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 935 of file rs274x.cpp.

{
 for( ; ; )
 {
 switch (*aText )
 {
 case ' ': // skip blanks
 case '\n':
 case '\r': // Skip line terminators
 ++aText;
 break;
 
 case 0: // End of text found in aBuff: Read a new string
 if( fgets( aBuff, aBuffSize, aFile ) == nullptr )
 return nullptr;
 
 m_LineNum++;
 aText = aBuff;
 return aText;
 
 default:
 return aText;
 }
 }
 return aText;
}

References GERBER_FILE_IMAGE::m_LineNum.

Referenced by GERBER_FILE_IMAGE::ReadApertureMacro().

◆ GetParent()

EDA_ITEM * EDA_ITEM::GetParent ( void ) const

inlineinherited

Definition at line 114 of file eda_item.h.

114{ return m_parent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:498

References EDA_ITEM::m_parent.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_TOOL::editFieldText(), SCH_PIN::GetParentSymbol(), EE_SELECTION_TOOL::highlight(), highlightNet(), SCH_FIELD::HitTest(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), EE_SELECTION_TOOL::Main(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_EDITOR_CONTROL::nextMatch(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), BOARD_COMMIT::parentObject(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshZoomDependentItems(), SCH_EDITOR_CONTROL::ReplaceAll(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< T >::saveCopyInUndoList(), SCH_ITEM::Schematic(), SCH_SCREEN::Schematic(), SCH_SHEET::SearchHierarchy(), PCB_SELECTION_TOOL::select(), BOARD_COMMIT::Stage(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), EE_SELECTION_TOOL::unhighlight(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), EE_TOOL_BASE< T >::updateItem(), and SCH_BASE_FRAME::UpdateItem().

◆ GetPosition()

virtual VECTOR2I EDA_ITEM::GetPosition ( ) const

inlinevirtualinherited

Reimplemented in LIB_FIELD, LIB_PIN, LIB_SHAPE, LIB_TEXT, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SYMBOL, SCH_TEXT, GERBER_DRAW_ITEM, DELETED_BOARD_ITEM, DS_DRAW_ITEM_LINE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_PAGE, DS_DRAW_ITEM_TEXT, DS_DRAW_ITEM_BITMAP, KIGFX::ORIGIN_VIEWITEM, PCB_GROUP, BOARD, FOOTPRINT, FP_TEXT, NETINFO_ITEM, PAD, PCB_BITMAP, PCB_DIMENSION_BASE, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TRACK, PCB_ARC, PCB_VIA, and ZONE.

Definition at line 262 of file eda_item.h.

262{ return VECTOR2I(); }

Referenced by SCH_MOVE_TOOL::AlignElements(), SCH_EDIT_TOOL::ChangeTextType(), TEST_BOARD_ITEM_FIXTURE::CompareItems(), TEST_EE_ITEM_FIXTURE::CompareItems(), PCB_GRID_HELPER::computeAnchors(), EE_GRID_HELPER::computeAnchors(), SCH_EDIT_FRAME::DeleteJunction(), KIGFX::PCB_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckMultipleDrivers(), CONNECTION_GRAPH::ercCheckNoConnects(), PCB_SELECTION_TOOL::FindItem(), GERBVIEW_SELECTION::GetCenter(), EDA_ITEM::GetFocusPosition(), getMinDist(), SCH_FIELD::GetParentPosition(), SCH_SCREEN::GetSheets(), EDA_ITEM::GetSortPosition(), PCB_SELECTION::GetTopLeftItem(), EE_SELECTION::GetTopLeftItem(), BOARD_ITEM::GetX(), BOARD_ITEM::GetY(), SCH_MOVE_TOOL::Main(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_EDITOR_CONTROL::nextMatch(), DIALOG_MIGRATE_BUSES::onItemSelected(), BOARD::cmp_items::operator()(), SCH_ITEM::operator<(), SCH_EDITOR_CONTROL::Paste(), PL_EDIT_TOOL::Paste(), PCB_CONTROL::placeBoardItems(), BACK_ANNOTATE::processNetNameChange(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), RC_ITEM::ShowReport(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), DRC_TEST_PROVIDER_MISC::testTextVars(), TransformItem(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), EDIT_TOOL::updateModificationPoint(), PL_EDIT_TOOL::updateModificationPoint(), and EE_POINT_EDITOR::updatePoints().

◆ GetPositiveDrawColor()

COLOR4D GERBER_FILE_IMAGE::GetPositiveDrawColor ( ) const

inlineinherited

Definition at line 153 of file gerber_file_image.h.

153{ return m_PositiveDrawColor; }

GERBER_FILE_IMAGE::m_PositiveDrawColor

COLOR4D m_PositiveDrawColor

Definition: gerber_file_image.h:373

References GERBER_FILE_IMAGE::m_PositiveDrawColor.

Referenced by GERBER_DRAW_ITEM::Print().

◆ GetSelectMenuText()

wxString EDA_ITEM::GetSelectMenuText ( EDA_UNITS aUnits ) const

virtualinherited

Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position.

The default version of this function raises an assertion in the debug mode and returns a string to indicate that it was not overridden to provide the object specific text.

Returns: The menu text string.

Reimplemented in LIB_FIELD, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_WIRE_ENTRY, SCH_BUS_BUS_ENTRY, SCH_FIELD, SCH_JUNCTION, SCH_LABEL, SCH_DIRECTIVE_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, DELETED_SHEET_ITEM, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, GERBER_DRAW_ITEM, DELETED_BOARD_ITEM, DS_DRAW_ITEM_LINE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_PAGE, DS_DRAW_ITEM_TEXT, DS_DRAW_ITEM_BITMAP, PCB_GROUP, BOARD, FOOTPRINT, FP_SHAPE, FP_TEXT, FP_TEXTBOX, PAD, PCB_BITMAP, PCB_DIMENSION_BASE, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 109 of file eda_item.cpp.

{
 wxFAIL_MSG( wxT( "GetSelectMenuText() was not overridden for schematic item type " ) +
 GetClass() );
 
 return wxString( wxT( "Undefined menu text for " ) + GetClass() );
}

References EDA_ITEM::GetClass().

Referenced by CONNECTION_GRAPH::collectAllDriverValues(), DIALOG_GROUP_PROPERTIES::DoAddMember(), SELECTION_TOOL::doSelectionMenu(), DRC_ENGINE::EvalRules(), BOARD_INSPECTION_TOOL::getItemDescription(), PCB_MARKER::GetMsgPanelInfo(), RC_TREE_MODEL::GetValue(), RC_ITEM::ShowReport(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), and PCB_CONTROL::UpdateMessagePanel().

◆ GetSortPosition()

virtual VECTOR2I EDA_ITEM::GetSortPosition ( ) const

inlinevirtualinherited

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

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

Returns: X,Y coordinate of the sort point

Reimplemented in SCH_LINE.

Definition at line 278 of file eda_item.h.

278{ return GetPosition(); }

References EDA_ITEM::GetPosition().

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS type ) const

inlineinherited

Definition at line 136 of file eda_item.h.

 {
 return m_status & type;
 }

References EDA_ITEM::m_status.

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 149 of file eda_item.h.

149{ return m_status; }

References EDA_ITEM::m_status.

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 155 of file eda_item.h.

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

References EDA_ITEM::m_flags.

Referenced by GRAPHICS_CLEANER::cleanupShapes(), SCH_EDIT_TOOL::DoDelete(), EDIT_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), FOOTPRINT::IsConflicting(), SCH_MOVE_TOOL::Main(), SCH_SCREEN::MarkConnections(), SCH_MOVE_TOOL::moveItem(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_TOOL::Rotate(), and EE_TOOL_BASE< T >::saveCopyInUndoList().

◆ HasNegativeItems()

bool GERBER_FILE_IMAGE::HasNegativeItems ( )

inherited

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 225 of file gerber_file_image.cpp.

{
 if( m_hasNegativeItems < 0 ) // negative items are not yet searched: find them if any
 {
 if( m_ImageNegative ) // A negative layer is expected having always negative objects.
 {
 m_hasNegativeItems = 1;
 }
 else
 {
 m_hasNegativeItems = 0;
 
 for( GERBER_DRAW_ITEM* item : GetItems() )
 {
 if( item->GetLayer() != m_GraphicLayer )
 continue;
 
 if( item->HasNegativeItems() )
 {
 m_hasNegativeItems = 1;
 break;
 }
 }
 }
 }
 
 return m_hasNegativeItems == 1;
}

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

◆ HitTest() [1/2]

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

inlinevirtualinherited

Test if aRect intersects this item.

Parameters

aRect	A reference to a EDA_RECT object containing the rectangle to test.
aContained	Set to true to test for containment instead of an intersection.
aAccuracy	Increase aRect by this amount.

Returns: True if aRect contains or intersects the item bounding box.

Reimplemented in LIB_ITEM, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, DS_DRAW_ITEM_BASE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_TEXT, DS_DRAW_ITEM_BITMAP, PCB_GROUP, FOOTPRINT, FP_TEXT, FP_TEXTBOX, PAD, PCB_BITMAP, PCB_DIMENSION_BASE, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, PCB_ARC, ZONE, and GERBER_DRAW_ITEM.

Definition at line 248 of file eda_item.h.

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

◆ HitTest() [2/2]

virtual bool EDA_ITEM::HitTest	(	const VECTOR2I &	aPosition,
		int	aAccuracy = `0`
	)		const

inlinevirtualinherited

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

Parameters

aPosition	A reference to a VECTOR2I object containing the coordinates to test.
aAccuracy	Increase the item bounding box by this amount.

Returns: True if aPosition is within the item bounding box.

Reimplemented in RATSNEST_VIEW_ITEM, SCH_SHEET, FP_TEXT, FP_TEXTBOX, PCB_DIMENSION_BASE, PCB_TEXT, PCB_TEXTBOX, LIB_FIELD, LIB_ITEM, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, DS_DRAW_ITEM_BASE, DS_DRAW_ITEM_LINE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_PAGE, DS_DRAW_ITEM_TEXT, DS_DRAW_ITEM_BITMAP, PCB_GROUP, FOOTPRINT, PAD, PCB_BITMAP, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TRACK, PCB_ARC, PCB_VIA, ZONE, and GERBER_DRAW_ITEM.

Definition at line 235 of file eda_item.h.

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

Referenced by PCB_GRID_HELPER::AlignToNearestPad(), PL_SELECTION_TOOL::guessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), LIB_ITEM::HitTest(), DS_DRAW_ITEM_BASE::HitTest(), EE_COLLECTOR::Inspect(), GERBER_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), PCB_SELECTION_TOOL::selectionContains(), and PCB_SELECTION_TOOL::selectMultiple().

◆ InitToolTable()

void GERBER_FILE_IMAGE::InitToolTable ( )

inherited

Definition at line 272 of file gerber_file_image.cpp.

{
 for( int count = 0; count < TOOLS_MAX_COUNT; count++ )
 {
 if( m_Aperture_List[count] == nullptr )
 continue;
 
 m_Aperture_List[count]->m_Num_Dcode = count + FIRST_DCODE;
 m_Aperture_List[count]->Clear_D_CODE_Data();
 }
 
 m_aperture_macros.clear();
}

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

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 125 of file eda_item.h.

125{ return m_flags & BRIGHTENED; }

References BRIGHTENED, and EDA_ITEM::m_flags.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::getRenderColor(), KIGFX::SCH_PAINTER::setDeviceColors(), SCH_EDITOR_CONTROL::UpdateFind(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 120 of file eda_item.h.

120{ return m_flags & IS_DRAGGING; }

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 123 of file eda_item.h.

123{ return m_flags & ENTERED; }

ENTERED

#define ENTERED

indicates a group has been entered

Definition: eda_item_flags.h:73

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 216 of file eda_item.h.

216{ return m_forceVisible; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:499

References EDA_ITEM::m_forceVisible.

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

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 117 of file eda_item.h.

117{ return m_flags & IS_CHANGED; }

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 119 of file eda_item.h.

119{ return m_flags & IS_MOVING; }

References IS_MOVING, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), LIB_PIN::CalcEdit(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), PCB_BASE_FRAME::PlaceFootprint(), SCH_EDIT_TOOL::Rotate(), and SYMBOL_EDITOR_EDIT_TOOL::Rotate().

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 118 of file eda_item.h.

118{ return m_flags & IS_NEW; }

References IS_NEW, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_TOOL::ConvertDeMorgan(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), DIALOG_PIN_PROPERTIES::getSyncPinsMessage(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), EE_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), EDIT_TOOL::MoveExact(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), and DIALOG_SHEET_PROPERTIES::TransferDataFromWindow().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

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

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

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

Definition at line 422 of file eda_item.h.

422{ return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 124 of file eda_item.h.

124{ return m_flags & IS_RESIZING; }

References IS_RESIZING, and EDA_ITEM::m_flags.

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 122 of file eda_item.h.

122{ return m_flags & SELECTED; }

References EDA_ITEM::m_flags, and SELECTED.

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 185 of file eda_item.h.

185{ return m_flags & IS_SHOWN_AS_BITMAP; }

IS_SHOWN_AS_BITMAP

#define IS_SHOWN_AS_BITMAP

Definition: eda_item_flags.h:55

References IS_SHOWN_AS_BITMAP, and EDA_ITEM::m_flags.

◆ IsType()

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

inlinevirtualinherited

Check whether the item is one of the listed types.

Parameters

aScanTypes List of item types

Returns: true if the item type is contained in the list aScanTypes

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

Definition at line 193 of file eda_item.h.

 {
 if( aScanTypes[0] == SCH_LOCATE_ANY_T )
 return true;
 
 for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
 {
 if( m_structType == *p )
 return true;
 }
 
 return false;
 }

References EOT, EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

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

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 121 of file eda_item.h.

121{ return m_flags & IS_WIRE_IMAGE; }

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

◆ IterateForward() [1/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 314 of file eda_item.h.

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

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

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 333 of file eda_item.h.

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

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

◆ LoadFile()

bool EXCELLON_IMAGE::LoadFile	(	const wxString &	aFullFileName,
		EXCELLON_DEFAULTS *	aDefaults
	)

Read and load a drill (EXCELLON format) file.

When the file cannot be loaded, warning and info messages are stored in m_Messages.

Parameters

aFullFileName	is the full filename of the Excellon file.
aDefaults	is the default values when not found in file.

Returns: true if OK, false if the gerber file was not loaded.

Definition at line 455 of file excellon_read_drill_file.cpp.

{
 // Set the default parameter values:
 ResetDefaultValues();
 ClearMessageList();
 
 m_Current_File = wxFopen( aFullFileName, wxT( "rt" ) );
 
 if( m_Current_File == nullptr )
 return false;
 
 // Initial format setting, usualy defined in file, but not always...
 m_NoTrailingZeros = aDefaults->m_LeadingZero;
 m_GerbMetric = aDefaults->m_UnitsMM;
 
 wxString msg;
 m_FileName = aFullFileName;
 
 LOCALE_IO toggleIo;
 
 // FILE_LINE_READER will close the file.
 FILE_LINE_READER excellonReader( m_Current_File, m_FileName );
 
 while( true )
 {
 if( excellonReader.ReadLine() == nullptr )
 break;
 
 char* line = excellonReader.Line();
 char* text = StrPurge( line );
 
 if( *text == 0 ) // Skip empty lines
 continue;
 
 if( m_State == EXCELLON_IMAGE::READ_HEADER_STATE )
 {
 Execute_HEADER_And_M_Command( text );
 
 // Now units (inch/mm) are known, set the coordinate format
 SelectUnits( m_GerbMetric, aDefaults );
 }
 else
 {
 switch( *text )
 {
 case ';':
 case 'M':
 Execute_HEADER_And_M_Command( text );
 break;
 
 case 'G': // Line type Gxx : command
 Execute_EXCELLON_G_Command( text );
 break;
 
 case 'X':
 case 'Y': // command like X12550Y19250
 Execute_Drill_Command(text);
 break;
 
 case 'I':
 case 'J': /* Auxiliary Move command */
 m_IJPos = ReadIJCoord( text );
 if( *text == '*' ) // command like X35142Y15945J504
 {
 Execute_Drill_Command( text);
 }
 break;
 
 case 'T': // Select Tool command (can also create
 // the tool with an embedded definition)
 Select_Tool( text );
 break;
 
 case '%':
 break;
 
 default:
 msg.Printf( wxT( "Unexpected symbol 0x%2.2X &lt;%c&gt;" ), *text, *text );
 AddMessageToList( msg );
 break;
 } // End switch
 }
 }
 
 // Add our file attribute, to identify the drill file
 X2_ATTRIBUTE dummy;
 char* text = (char*)file_attribute;
 int dummyline = 0;
 dummy.ParseAttribCmd( nullptr, nullptr, 0, text, dummyline );
 delete m_FileFunction;
 m_FileFunction = new X2_ATTRIBUTE_FILEFUNCTION( dummy );
 
 m_InUse = true;
 
 return true;
}

◆ LoadGerberFile()

bool GERBER_FILE_IMAGE::LoadGerberFile ( const wxString & aFullFileName )

inherited

Read and load a gerber file.

If the file cannot be loaded, warning and information messages are stored in m_messagesList.

Parameters

aFullFileName The full filename of the Gerber file.

Returns: true if file loaded successfully, false if the gerber file was not loaded.

Definition at line 236 of file readgerb.cpp.

{
 int G_command = 0; // command number for G commands like G04
 int D_commande = 0; // command number for D commands like D02
 char* text;
 
 ClearMessageList( );
 ResetDefaultValues();
 
 // Read the gerber file */
 m_Current_File = wxFopen( aFullFileName, wxT( "rt" ) );
 
 if( m_Current_File == nullptr )
 return false;
 
 m_FileName = aFullFileName;
 
 LOCALE_IO toggleIo;
 
 wxString msg;
 
 while( true )
 {
 if( fgets( lineBuffer, GERBER_BUFZ, m_Current_File ) == nullptr )
 break;
 
 m_LineNum++;
 text = StrPurge( lineBuffer );
 
 while( text && *text )
 {
 switch( *text )
 {
 case ' ':
 case '\r':
 case '\n':
 text++;
 break;
 
 case '*': // End command
 m_CommandState = END_BLOCK;
 text++;
 break;
 
 case 'M': // End file
 m_CommandState = CMD_IDLE;
 while( *text )
 text++;
 break;
 
 case 'G': /* Line type Gxx : command */
 G_command = CodeNumber( text );
 Execute_G_Command( text, G_command );
 break;
 
 case 'D': /* Line type Dxx : Tool selection (xx > 0) or
 * command if xx = 0..9 */
 D_commande = CodeNumber( text );
 Execute_DCODE_Command( text, D_commande );
 break;
 
 case 'X':
 case 'Y': /* Move or draw command */
 m_CurrentPos = ReadXYCoord( text );
 if( *text == '*' ) // command like X12550Y19250*
 {
 Execute_DCODE_Command( text, m_Last_Pen_Command );
 }
 break;
 
 case 'I':
 case 'J': /* Auxiliary Move command */
 m_IJPos = ReadIJCoord( text );
 
 if( *text == '*' ) // command like X35142Y15945J504*
 {
 Execute_DCODE_Command( text, m_Last_Pen_Command );
 }
 break;
 
 case '%':
 if( m_CommandState != ENTER_RS274X_CMD )
 {
 m_CommandState = ENTER_RS274X_CMD;
 ReadRS274XCommand( lineBuffer, GERBER_BUFZ, text );
 }
 else //Error
 {
 AddMessageToList( wxT( "Expected RS274X Command" ) );
 m_CommandState = CMD_IDLE;
 text++;
 }
 break;
 
 default:
 msg.Printf( wxT( "Unexpected char 0x%2.2X" ), *text );
 AddMessageToList( msg );
 text++;
 break;
 }
 }
 }
 
 fclose( m_Current_File );
 
 m_InUse = true;
 
 return true;
}

◆ Matches() [1/2]

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

inlinevirtualinherited

Compare the item against the search criteria in aSearchData.

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

Parameters

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

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

Reimplemented in SCH_MARKER, LIB_TEXTBOX, SCH_FIELD, SCH_PIN, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, FP_TEXT, FP_TEXTBOX, NETINFO_ITEM, PCB_MARKER, PCB_TEXT, PCB_TEXTBOX, and ZONE.

Definition at line 384 of file eda_item.h.

 {
 return false;
 }

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

◆ Matches() [2/2]

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

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

aText	A reference to a wxString object containing the string to test.
aSearchData	The criteria to search against.

Returns: True if aText matches the search criteria in aSearchData.

Definition at line 118 of file eda_item.cpp.

{
 wxString text = aText;
 int flags = aSearchData.GetFlags();
 wxString searchText = aSearchData.GetFindString();
 
 // Don't match if searching for replaceable item and the item doesn't support text replace.
 if( ( flags & FR_SEARCH_REPLACE ) && !IsReplaceable() )
 return false;
 
 if( !( flags & wxFR_MATCHCASE ) )
 {
 text.MakeUpper();
 searchText.MakeUpper();
 }
 
 if( flags & wxFR_WHOLEWORD )
 {
 int ii = 0;
 
 while( ii < (int) text.length() )
 {
 int next = text.find( searchText, ii );
 
 if( next == wxNOT_FOUND )
 return false;
 
 ii = next;
 next += searchText.length();
 
 bool startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
 bool endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
 
 if( startOK && endOK )
 return true;
 else
 ii++;
 }
 
 return false;
 }
 else if( flags & FR_MATCH_WILDCARD )
 {
 return text.Matches( searchText );
 }
 else
 {
 return text.Find( searchText ) != wxNOT_FOUND;
 }
}

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

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

{
 wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
 GetClass() ) );
 
 return false;
}

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

◆ ReadApertureMacro()

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

privateinherited

Read in an aperture macro and saves it in m_aperture_macros.

Parameters

aBuff	a character buffer at least GERBER_BUFZ long that can be used to read successive lines from the gerber file.
text	A reference to a character pointer which gives the initial text to read from.
aBuffSize	is the size of aBuff
gerber_file	Which file to read from for continuation.

Returns: true if a macro was read in successfully, else false.

Definition at line 963 of file rs274x.cpp.

{
 wxString msg;
 APERTURE_MACRO am;
 
 // read macro name
 while( *aText )
 {
 if( *aText == '*' )
 {
 ++aText;
 break;
 }
 
 am.name.Append( *aText++ );
 }
 
 // Read aperture macro parameters
 for( ; ; )
 {
 if( *aText == '*' )
 ++aText;
 
 aText = GetNextLine( aBuff, aBuffSize, aText, gerber_file );
 
 if( aText == nullptr ) // End of File
 return false;
 
 // aText points the beginning of a new line.
 
 // Test for the last line in aperture macro lis:
 // last line is % or *% sometime found.
 if( *aText == '*' )
 ++aText;
 
 if( *aText == '%' )
 break; // exit with aText still pointing at %
 
 int paramCount = 0; // will be set to the minimal parameters count,
 // depending on the actual primitive
 int primitive_type = AMP_UNKNOWN;
 // Test for a valid symbol at the beginning of a description:
 // it can be: a parameter declaration like $1=$2/4
 // or a digit (macro primitive selection)
 // all other symbols are illegal.
 if( *aText == '$' ) // local parameter declaration, inside the aperture macro
 {
 am.m_localparamStack.push_back( AM_PARAM() );
 AM_PARAM& param = am.m_localparamStack.back();
 aText = GetNextLine( aBuff, aBuffSize, aText, gerber_file );
 if( aText == nullptr) // End of File
 return false;
 param.ReadParam( aText );
 continue;
 }
 else if( !isdigit(*aText) ) // Ill. symbol
 {
 msg.Printf( wxT( "RS274X: Aperture Macro \"%s\": ill. symbol, line: \"%s\"" ),
 am.name, FROM_UTF8( aBuff ) );
 AddMessageToList( msg );
 primitive_type = AMP_COMMENT;
 }
 else
 primitive_type = ReadInt( aText );
 
 bool is_comment = false;
 
 switch( primitive_type )
 {
 case AMP_COMMENT: // lines starting by 0 are a comment
 paramCount = 0;
 is_comment = true;
 
 // Skip comment
 while( *aText && ( *aText != '*' ) )
 aText++;
 
 break;
 
 case AMP_CIRCLE:
 paramCount = 4; // minimal count. can have a optional parameter (rotation)
 break;
 
 case AMP_LINE2:
 case AMP_LINE20:
 paramCount = 7;
 break;
 
 case AMP_LINE_CENTER:
 case AMP_LINE_LOWER_LEFT:
 paramCount = 6;
 break;
 
 case AMP_EOF:
 paramCount = 0;
 break;
 
 case AMP_OUTLINE:
 paramCount = 4; // partial count. other parameters are vertices and rotation
 // Second parameter is vertice (coordinate pairs) count.
 break;
 
 case AMP_POLYGON:
 paramCount = 6;
 break;
 
 case AMP_MOIRE:
 paramCount = 9;
 break;
 
 case AMP_THERMAL:
 paramCount = 6;
 break;
 
 default:
 msg.Printf( wxT( "RS274X: Aperture Macro \"%s\": Invalid primitive id code %d, line %d: \"%s\"" ),
 am.name, primitive_type, m_LineNum, FROM_UTF8( aBuff ) );
 AddMessageToList( msg );
 return false;
 }
 
 if( is_comment )
 continue;
 
 AM_PRIMITIVE prim( m_GerbMetric );
 prim.primitive_id = (AM_PRIMITIVE_ID) primitive_type;
 int ii;
 
 for( ii = 0; ii < paramCount && *aText && *aText != '*'; ++ii )
 {
 prim.params.push_back( AM_PARAM() );
 
 AM_PARAM& param = prim.params.back();
 
 aText = GetNextLine( aBuff, aBuffSize, aText, gerber_file );
 
 if( aText == nullptr) // End of File
 return false;
 
 param.ReadParam( aText );
 }
 
 if( ii < paramCount )
 {
 // maybe some day we can throw an exception and track a line number
 msg.Printf( wxT( "RS274X: read macro descr type %d: read %d parameters, insufficient "
 "parameters\n" ),
 prim.primitive_id, ii );
 AddMessageToList( msg );
 }
 
 // there are more parameters to read if this is an AMP_OUTLINE
 if( prim.primitive_id == AMP_OUTLINE )
 {
 // so far we have read [0]:exposure, [1]:#points, [2]:X start, [3]: Y start
 // Now read all the points, plus trailing rotation in degrees.
 
 // params[1] is a count of polygon points, so it must be given
 // in advance, i.e. be immediate.
 wxASSERT( prim.params[1].IsImmediate() );
 
 paramCount = (int) prim.params[1].GetValue( nullptr ) * 2 + 1;
 
 for( int jj = 0; jj < paramCount && *aText != '*'; ++jj )
 {
 prim.params.push_back( AM_PARAM() );
 
 AM_PARAM& param = prim.params.back();
 
 aText = GetNextLine( aBuff, aBuffSize, aText, gerber_file );
 
 if( aText == nullptr ) // End of File
 return false;
 
 param.ReadParam( aText );
 }
 }
 
 // AMP_CIRCLE can have a optional parameter (rotation)
 if( prim.primitive_id == AMP_CIRCLE && aText && *aText != '*' )
 {
 prim.params.push_back( AM_PARAM() );
 AM_PARAM& param = prim.params.back();
 param.ReadParam( aText );
 }
 
 am.primitives.push_back( prim );
 }
 
 m_aperture_macros.insert( am );
 
 return true;
}

References GERBER_FILE_IMAGE::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(), gerber_file, GERBER_FILE_IMAGE::GetNextLine(), GERBER_FILE_IMAGE::m_aperture_macros, GERBER_FILE_IMAGE::m_GerbMetric, GERBER_FILE_IMAGE::m_LineNum, APERTURE_MACRO::m_localparamStack, APERTURE_MACRO::name, AM_PRIMITIVE::params, AM_PRIMITIVE::primitive_id, APERTURE_MACRO::primitives, ReadInt(), and AM_PARAM::ReadParam().

Referenced by GERBER_FILE_IMAGE::ExecuteRS274XCommand().

◆ readFileFormat()

void EXCELLON_IMAGE::readFileFormat ( char *& aText )

private

Read an Altium-specific FILE_FORMAT=X:X attribute that specifies the length and mantissa of the numbers in the gerber file.

Parameters

aText Text containing format and mantissa

Definition at line 720 of file excellon_read_drill_file.cpp.

{
 int mantissaDigits = 0;
 int characteristicDigits = 0;
 
 // Example String: ;FILE_FORMAT=4:4
 // The ;FILE_FORMAT potion will already be stripped off.
 // Parse the rest strictly as single_digit:single_digit like 4:4 or 2:4
 // Don't allow anything clever like spaces or multiple digits
 if( *aText != '=' )
 return;
 
 aText++;
 
 if( !isdigit( *aText ) )
 return;
 
 characteristicDigits = *aText - '0';
 aText++;
 
 if( *aText != ':' )
 return;
 
 aText++;
 
 if( !isdigit( *aText ) )
 return;
 
 mantissaDigits = *aText - '0';
 
 m_hasFormat = true;
 m_FmtLen.x = m_FmtLen.y = characteristicDigits + mantissaDigits;
 m_FmtScale.x = m_FmtScale.y = mantissaDigits;
}

References GERBER_FILE_IMAGE::m_FmtLen, GERBER_FILE_IMAGE::m_FmtScale, and m_hasFormat.

Referenced by Execute_HEADER_And_M_Command().

◆ ReadIJCoord()

VECTOR2I GERBER_FILE_IMAGE::ReadIJCoord ( char *& Text )

inherited

Return the current coordinate type pointed to by InnJnn Text (InnnnJmmmm)

These coordinates are relative, so if coordinate is absent, its value defaults to 0

Definition at line 163 of file rs274_read_XY_and_IJ_coordinates.cpp.

{
 VECTOR2I pos( 0, 0 );
 bool is_float = false;
 
 std::string line;
 
 // Reserve the anticipated length plus an optional sign and decimal
 line.reserve( std::max( m_FmtLen.x, m_FmtLen.y ) + 3 );
 
 if( aText == nullptr )
 return pos;
 
 while( *aText && ( ( *aText == 'I' ) || ( *aText == 'J' ) ) )
 {
 double decimal_scale = 1.0;
 int nbdigits = 0;
 int current_coord = 0;
 char type_coord = *aText++;
 
 line.clear();
 
 while( IsNumber( *aText ) )
 {
 if( *aText == '.' ) // Force decimal format if reading a floating point number
 is_float = true;
 
 // count digits only (sign and decimal point are not counted)
 if( (*aText >= '0') && (*aText <='9') )
 nbdigits++;
 
 line.push_back( *( aText++ ) );
 }
 
 double val = strtod( line.data(), nullptr );
 
 if( is_float )
 {
 current_coord = scaletoIU( val, m_GerbMetric );
 }
 else
 {
 int fmt_scale = ( type_coord == 'I' ) ? m_FmtScale.x : m_FmtScale.y;
 
 if( m_NoTrailingZeros )
 {
 // no trailing zero format, we need to add missing zeros.
 int digit_count = ( type_coord == 'I' ) ? m_FmtLen.x : m_FmtLen.y;
 
 // Truncate the extra digits if the len is more than expected
 // because the conversion to internal units expect exactly
 // digit_count digits. Alternatively, add some additional digits
 // to pad out to the missing zeros
 if( nbdigits < digit_count )
 decimal_scale = std::pow<double>( 10, digit_count - nbdigits );
 }
 
 double real_scale = scale_list[fmt_scale];
 
 if( m_GerbMetric )
 real_scale = real_scale / 25.4;
 
 current_coord = KiROUND( val * real_scale * decimal_scale );
 }
 
 if( type_coord == 'I' )
 {
 pos.x = current_coord;
 }
 else if( type_coord == 'J' )
 {
 pos.y = current_coord;
 }
 }
 
 m_IJPos = pos;
 m_LastArcDataType = ARC_INFO_TYPE_CENTER;
 m_LastCoordIsIJPos = true;
 
 return pos;
}

References ARC_INFO_TYPE_CENTER, IsNumber, KiROUND(), GERBER_FILE_IMAGE::m_FmtLen, GERBER_FILE_IMAGE::m_FmtScale, GERBER_FILE_IMAGE::m_GerbMetric, GERBER_FILE_IMAGE::m_IJPos, GERBER_FILE_IMAGE::m_LastArcDataType, GERBER_FILE_IMAGE::m_LastCoordIsIJPos, GERBER_FILE_IMAGE::m_NoTrailingZeros, scale_list, scaletoIU(), VECTOR2< T >::x, and VECTOR2< T >::y.

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

◆ ReadRS274XCommand()

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

privateinherited

Read a single RS274X command terminated with a %.

Definition at line 143 of file rs274x.cpp.

{
 bool ok = true;
 int code_command;
 
 aText++;
 
 for( ; ; )
 {
 while( *aText )
 {
 switch( *aText )
 {
 case '%': // end of command
 aText++;
 m_CommandState = CMD_IDLE;
 goto exit; // success completion
 
 case ' ':
 case '\r':
 case '\n':
 aText++;
 break;
 
 case '*':
 aText++;
 break;
 
 default:
 code_command = ReadXCommandID( aText );
 ok = ExecuteRS274XCommand( code_command, aBuff, aBuffSize, aText );
 
 if( !ok )
 goto exit;
 
 break;
 }
 }
 
 // end of current line, read another one.
 if( fgets( aBuff, aBuffSize, m_Current_File ) == nullptr )
 {
 // end of file
 ok = false;
 break;
 }
 m_LineNum++;
 aText = aBuff;
 }
 
exit:
 return ok;
}

References CMD_IDLE, GERBER_FILE_IMAGE::ExecuteRS274XCommand(), exit, GERBER_FILE_IMAGE::m_CommandState, GERBER_FILE_IMAGE::m_Current_File, GERBER_FILE_IMAGE::m_LineNum, and GERBER_FILE_IMAGE::ReadXCommandID().

Referenced by GERBER_FILE_IMAGE::LoadGerberFile().

◆ readToolInformation()

bool EXCELLON_IMAGE::readToolInformation ( char *& aText )

private

Read a tool definition like T1C0.02 or T1F00S00C0.02 or T1C0.02F00S00 and enter params in TCODE list.

Definition at line 756 of file excellon_read_drill_file.cpp.

{
 // Read a tool definition like T1C0.02 or T1F00S00C0.02 or T1C0.02F00S00
 // and enter the TCODE param in list (using the D_CODE param management, which
 // is similar to TCODE params.
 if( *aText == 'T' ) // This is the beginning of the definition
 aText++;
 
 // Read tool number:
 int iprm = ReadInt( aText, false );
 
 // Skip Feed rate and Spindle speed, if any here
 while( *aText && ( *aText == 'F' || *aText == 'S' ) )
 {
 aText++;
 ReadInt( aText, false );
 }
 
 // Read tool shape
 if( ! *aText )
 AddMessageToList( wxString:: Format(
 _( "Tool definition shape not found" ) ) );
 else if( *aText != 'C' )
 AddMessageToList( wxString:: Format(
 _( "Tool definition '%c' not supported" ), *aText ) );
 if( *aText )
 aText++;
 
 //read tool diameter:
 double dprm = ReadDouble( aText, false );
 m_Has_DCode = true;
 
 // Initialize Dcode to handle this Tool
 // Remember: dcodes are >= FIRST_DCODE
 D_CODE* dcode = GetDCODEOrCreate( iprm + FIRST_DCODE );
 
 if( dcode == nullptr )
 return false;
 
 // conv_scale = scaling factor from inch to Internal Unit
 double conv_scale = IU_PER_MILS * 1000;
 
 if( m_GerbMetric )
 conv_scale /= 25.4;
 
 dcode->m_Size.x = dcode->m_Size.y = KiROUND( dprm * conv_scale );
 dcode->m_Shape = APT_CIRCLE;
 dcode->m_Defined = true;
 
 return true;
}

References _, GERBER_FILE_IMAGE::AddMessageToList(), APT_CIRCLE, FIRST_DCODE, Format(), GERBER_FILE_IMAGE::GetDCODEOrCreate(), IU_PER_MILS, KiROUND(), D_CODE::m_Defined, GERBER_FILE_IMAGE::m_GerbMetric, GERBER_FILE_IMAGE::m_Has_DCode, D_CODE::m_Shape, D_CODE::m_Size, ReadDouble(), and ReadInt().

Referenced by Execute_HEADER_And_M_Command(), and Select_Tool().

◆ ReadXCommandID()

int GERBER_FILE_IMAGE::ReadXCommandID ( char *& text )

privateinherited

Read 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

text	A reference to a pointer to read bytes from and to advance as they are read.

Returns: a RS274X command identifier.

Definition at line 115 of file rs274x.cpp.

{
 /* 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
 */
 int result;
 int currbyte;
 
 if( text && *text )
 {
 currbyte = *text++;
 result = ( currbyte & 0xFF ) << 8;
 }
 else
 return -1;
 
 if( text && *text )
 {
 currbyte = *text++;
 result += currbyte & 0xFF;
 }
 else
 return -1;
 
 return result;
}

References text.

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

◆ ReadXYCoord()

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

inherited

Return the current coordinate type pointed to by XnnYnn Text (XnnnnYmmmm).

Parameters

aText	is a pointer to the text to parse.
aExcellonMode	= true to parse a Excellon drill file. it forces truncation of a digit string to a maximum length because the exact coordinate format is not always known.

Definition at line 71 of file rs274_read_XY_and_IJ_coordinates.cpp.

{
 VECTOR2I pos( 0, 0 );
 bool is_float = false;
 
 std::string line;
 
 // Reserve the anticipated length plus an optional sign and decimal
 line.reserve( std::max( m_FmtLen.x, m_FmtLen.y ) + 3 );
 
 // Set up return value for case where aText == nullptr
 if( !m_Relative )
 pos = m_CurrentPos;
 
 if( aText == nullptr )
 return pos;
 
 while( *aText && ( ( *aText == 'X' ) || ( *aText == 'Y' ) || ( *aText == 'A' ) ) )
 {
 double decimal_scale = 1.0;
 int nbdigits = 0;
 int current_coord = 0;
 char type_coord = *aText++;
 
 line.clear();
 
 while( IsNumber( *aText ) )
 {
 if( *aText == '.' ) // Force decimal format if reading a floating point number
 is_float = true;
 
 // count digits only (sign and decimal point are not counted)
 if( (*aText >= '0') && (*aText <='9') )
 nbdigits++;
 
 line.push_back( *( aText++ ) );
 }
 
 double val = strtod( line.data(), nullptr );
 
 if( is_float )
 {
 current_coord = scaletoIU( val, m_GerbMetric );
 }
 else
 {
 int fmt_scale = (type_coord == 'X') ? m_FmtScale.x : m_FmtScale.y;
 
 if( m_NoTrailingZeros )
 {
 // no trailing zero format, we need to add missing zeros.
 int digit_count = (type_coord == 'X') ? m_FmtLen.x : m_FmtLen.y;
 
 // Truncate the extra digits if the len is more than expected
 // because the conversion to internal units expect exactly
 // digit_count digits. Alternatively, add some additional digits
 // to pad out to the missing zeros
 if( nbdigits < digit_count || ( aExcellonMode && ( nbdigits > digit_count ) ) )
 decimal_scale = std::pow<double>( 10, digit_count - nbdigits );
 }
 
 double real_scale = scale_list[fmt_scale];
 
 if( m_GerbMetric )
 real_scale = real_scale / 25.4;
 
 current_coord = KiROUND( val * real_scale * decimal_scale );
 }
 
 if( type_coord == 'X' )
 {
 pos.x = current_coord;
 }
 else if( type_coord == 'Y' )
 {
 pos.y = current_coord;
 }
 else if( type_coord == 'A' )
 {
 m_ArcRadius = current_coord;
 m_LastArcDataType = ARC_INFO_TYPE_RADIUS;
 }
 }
 
 if( m_Relative )
 pos += m_CurrentPos;
 
 m_CurrentPos = pos;
 return pos;
}

References ARC_INFO_TYPE_RADIUS, IsNumber, KiROUND(), GERBER_FILE_IMAGE::m_ArcRadius, GERBER_FILE_IMAGE::m_CurrentPos, GERBER_FILE_IMAGE::m_FmtLen, GERBER_FILE_IMAGE::m_FmtScale, GERBER_FILE_IMAGE::m_GerbMetric, GERBER_FILE_IMAGE::m_LastArcDataType, GERBER_FILE_IMAGE::m_NoTrailingZeros, GERBER_FILE_IMAGE::m_Relative, scale_list, scaletoIU(), VECTOR2< T >::x, and VECTOR2< T >::y.

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

◆ RemoveAttribute()

void GERBER_FILE_IMAGE::RemoveAttribute ( X2_ATTRIBUTE & aAttribute )

inherited

Called when a TD command is found the Gerber file.

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

Parameters

aAttribute is the X2_ATTRIBUTE which stores the full command May be re-implemented for each derived class in order to handle all the types given by its member data.

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

Parameters

inspector	An INSPECTOR instance to use in the inspection.
testData	Arbitrary data used by the inspector.
scanTypes	Which# KICAD_T types are of interest and the order is significant too, terminated by EOT.

Returns: #SEARCH_RESULT SEARCH_QUIT if the Iterator is to stop the scan, else #SCAN_CONTINUE, and determined by the inspector.

Definition at line 391 of file gerber_file_image.cpp.

{
 /* Called when a %TD command is found
 * 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
 */
 wxString cmd = aAttribute.GetPrm( 0 );
 m_NetAttributeDict.ClearAttribute( &cmd );
 
 if( cmd.IsEmpty() || cmd == wxT( ".AperFunction" ) )
 m_AperFunction.Clear();
}

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

Referenced by GERBER_FILE_IMAGE::ExecuteRS274XCommand().

◆ RenderAsBitmap()

virtual bool EDA_ITEM::RenderAsBitmap ( double aWorldScale ) const

inlinevirtualinherited

Reimplemented in SCH_ITEM.

Definition at line 175 of file eda_item.h.

175{ return false; }

◆ Replace() [1/2]

virtual bool EDA_ITEM::Replace	(	const wxFindReplaceData &	aSearchData,
		void *	aAuxData = `nullptr`
	)

inlinevirtualinherited

Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace.

This function must be overridden for items that support text replace.

Parameters

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

Returns: True if the item text was modified, otherwise false.

Reimplemented in LIB_TEXTBOX, SCH_PIN, SCH_TEXT, SCH_TEXTBOX, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 411 of file eda_item.h.

 {
 return false;
 }

◆ Replace() [2/2]

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

staticinherited

Perform a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace.

Parameters

aSearchData	A reference to a wxFindReplaceData object containing the search and replace criteria.
aText	A reference to a wxString object containing the text to be replaced.

Returns: True if aText was modified, otherwise false.

Definition at line 170 of file eda_item.cpp.

{
 wxString text = aText;
 int flags = aSearchData.GetFlags();
 wxString searchText = aSearchData.GetFindString();
 wxString result;
 bool replaced = false;
 
 if( flags & wxFR_MATCHCASE )
 {
 text = text.Upper();
 searchText = searchText.Upper();
 }
 
 int ii = 0;
 
 while( ii < (int) text.length() )
 {
 int next = text.find( searchText, ii );
 
 if( next == wxNOT_FOUND )
 {
 result += aText.Mid( ii, wxString::npos );
 break;
 }
 
 if( next > ii )
 result += aText.Mid( ii, next - ii );
 
 ii = next;
 next += searchText.length();
 
 bool startOK;
 bool endOK;
 
 if( flags & wxFR_WHOLEWORD )
 {
 startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
 endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
 }
 else
 {
 startOK = true;
 endOK = true;
 }
 
 if( startOK && endOK )
 {
 result += aSearchData.GetReplaceString();
 replaced = true;
 ii = next;
 }
 else
 {
 result += aText.GetChar( ii );
 ii++;
  }
 }
 
 aText = result;
 return replaced;
}

References next(), and text.

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

◆ ResetDefaultValues()

void EXCELLON_IMAGE::ResetDefaultValues ( )

overridevirtual

Set all parameters to a default value, before reading a file.

Reimplemented from GERBER_FILE_IMAGE.

Definition at line 304 of file excellon_read_drill_file.cpp.

{
 GERBER_FILE_IMAGE::ResetDefaultValues();
 SelectUnits( false, nullptr ); // Default unit = inch
 m_hasFormat = false; // will be true if a Altium file containing
 // the nn:mm file format is read
 
 // Files using non decimal can use No Trailing zeros or No leading Zeros
 // Unfortunately, the identifier (INCH,TZ or INCH,LZ for instance) is not
 // always set in drill files.
 // The option leading zeros looks like more frequent, so use this default
 m_NoTrailingZeros = true;
}

References m_hasFormat, GERBER_FILE_IMAGE::m_NoTrailingZeros, GERBER_FILE_IMAGE::ResetDefaultValues(), and SelectUnits().

Referenced by LoadFile().

◆ Select_Tool()

bool EXCELLON_IMAGE::Select_Tool ( char *& text )

private

Definition at line 899 of file excellon_read_drill_file.cpp.

{
 // Select the tool from the command line Tn, with n = 1 ... TOOLS_MAX_COUNT - 1
 // Because some drill file have an embedded TCODE definition (like T1C.008F0S0)
 // in tool selection command, if the tool is not defined in list,
 // and the definition is embedded, it will be entered in list
 char * startline = text; // the tool id starts here.
 int tool_id = CodeNumber( text );
 
 // T0 is legal, but is not a selection tool. it is a special command
 if( tool_id >= 0 )
 {
 int dcode_id = tool_id + FIRST_DCODE; // Remember: dcodes are >= FIRST_DCODE
 
 if( dcode_id > (TOOLS_MAX_COUNT - 1) )
 dcode_id = TOOLS_MAX_COUNT - 1;
 
 m_Current_Tool = dcode_id;
 D_CODE* currDcode = GetDCODE( dcode_id );
 
 // if the tool does not exist, and the definition is embedded, create this tool
 if( currDcode == nullptr && tool_id > 0 )
 {
 text = startline; // text starts at the beginning of the command
 readToolInformation( text );
 currDcode = GetDCODE( dcode_id );
 }
 
 // If the Tool is still not existing, create a dummy tool
 if( !currDcode )
 currDcode = GetDCODEOrCreate( dcode_id, true );
 
 if( currDcode )
 currDcode->m_InUse = true;
 }
 
 while( *text )
 text++;
 
 return tool_id >= 0;
}

References GERBER_FILE_IMAGE::CodeNumber(), FIRST_DCODE, GERBER_FILE_IMAGE::GetDCODE(), GERBER_FILE_IMAGE::GetDCODEOrCreate(), GERBER_FILE_IMAGE::m_Current_Tool, D_CODE::m_InUse, readToolInformation(), text, and TOOLS_MAX_COUNT.

Referenced by LoadFile().

◆ SelectUnits()

void EXCELLON_IMAGE::SelectUnits	(	bool	aMetric,
		EXCELLON_DEFAULTS *	aDefaults
	)

private

Switch unit selection, and the coordinate format (nn:mm) if not yet set.

Definition at line 1056 of file excellon_read_drill_file.cpp.

{
 /* Coordinates are measured either in inch or metric (millimeters).
 * Inch coordinates are in six digits (00.0000) with increments
 * as small as 0.0001 (1/10,000).
 * Metric coordinates can be measured in microns (thousandths of a millimeter)
 * in one of the following three ways:
 * Five digit 10 micron resolution (000.00)
 * Six digit 10 micron resolution (0000.00)
 * Six digit micron resolution (000.000)
 *
 * Inches: Default fmt = 2.4 for X and Y axis: 6 digits with 0.0001 resolution
 * metric: Default fmt = 3.3 for X and Y axis: 6 digits, 1 micron resolution
 *
 * However some drill files do not use standard values.
 */
 if( aMetric )
 {
 m_GerbMetric = true;
 
 if( !m_hasFormat )
 {
 if( aDefaults )
 {
 // number of digits in mantissa
 m_FmtScale.x = m_FmtScale.y = aDefaults->m_MmMantissaLen;
 // number of digits (mantissa+integer)
 m_FmtLen.x = m_FmtLen.y = aDefaults->m_MmIntegerLen
 + aDefaults->m_MmMantissaLen;
 }
 else
 {
 m_FmtScale.x = m_FmtScale.y = FMT_MANTISSA_MM;
 m_FmtLen.x = m_FmtLen.y = FMT_INTEGER_MM + FMT_MANTISSA_MM;
 }
 }
 }
 else
 {
 m_GerbMetric = false;
 
 if( !m_hasFormat )
 {
 if( aDefaults )
 {
 m_FmtScale.x = m_FmtScale.y = aDefaults->m_InchMantissaLen;
 m_FmtLen.x = m_FmtLen.y = aDefaults->m_InchIntegerLen
 + aDefaults->m_InchMantissaLen;
 }
 else
 {
 m_FmtScale.x = m_FmtScale.y = FMT_MANTISSA_INCH;
 m_FmtLen.x = m_FmtLen.y = FMT_INTEGER_INCH + FMT_MANTISSA_INCH;
 }
 }
 }
}

References FMT_INTEGER_INCH, FMT_INTEGER_MM, FMT_MANTISSA_INCH, FMT_MANTISSA_MM, GERBER_FILE_IMAGE::m_FmtLen, GERBER_FILE_IMAGE::m_FmtScale, GERBER_FILE_IMAGE::m_GerbMetric, m_hasFormat, EXCELLON_DEFAULTS::m_InchIntegerLen, EXCELLON_DEFAULTS::m_InchMantissaLen, EXCELLON_DEFAULTS::m_MmIntegerLen, and EXCELLON_DEFAULTS::m_MmMantissaLen.

Referenced by Execute_HEADER_And_M_Command(), LoadFile(), and ResetDefaultValues().

◆ Set() [1/3]

template<typename T >

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

inlineinherited

Definition at line 68 of file inspectable.h.

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

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

◆ Set() [2/3]

template<typename T >

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

inlineinherited

Definition at line 55 of file inspectable.h.

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

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

◆ Set() [3/3]

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

inlineinherited

Definition at line 42 of file inspectable.h.

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

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

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 129 of file eda_item.h.

129{ SetFlags( BRIGHTENED ); }

EDA_ITEM::SetFlags

void SetFlags(EDA_ITEM_FLAGS aMask)

Definition: eda_item.h:152

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 152 of file eda_item.h.

152{ m_flags |= aMask; }

References EDA_ITEM::m_flags.

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool aEnable )

inlineinherited

Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible.

Parameters

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

Definition at line 214 of file eda_item.h.

214{ m_forceVisible = aEnable; }

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 177 of file eda_item.h.

 {
 if( aBitmap )
 SetFlags( IS_SHOWN_AS_BITMAP );
 else
 ClearFlags( IS_SHOWN_AS_BITMAP );
 }

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

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 65 of file eda_item.cpp.

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

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

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

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL, and PCB_DIMENSION_BASE.

Definition at line 115 of file eda_item.h.

115{ m_parent = aParent; }

References EDA_ITEM::m_parent.

Referenced by BOARD::Add(), FOOTPRINT::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), SCH_SHEET::AddPin(), PAD::AddPrimitive(), PAD::AddPrimitiveArc(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitivePoly(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), LIB_FIELD::Copy(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_SYMBOL::Flatten(), FOOTPRINT::FOOTPRINT(), PCB_PLUGIN::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), LIB_SYMBOL::LIB_SYMBOL(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), LIB_SYMBOL::operator=(), FOOTPRINT::operator=(), PCB_PARSER::parseFOOTPRINT_unchecked(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PCB_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BACK_ANNOTATE::processNetNameChange(), BOARD_COMMIT::Push(), SCH_LIB_PLUGIN_CACHE::removeSymbol(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), SaveCopyOfZones(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_SYMBOL::SetFields(), PCB_DIMENSION_BASE::SetParent(), PIN_TABLE_DATA_MODEL::SetValue(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_LABEL_BASE::SwapData(), SCH_SHEET::SwapData(), SCH_SYMBOL::SwapData(), SwapItemData(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetPosition()

virtual void EDA_ITEM::SetPosition ( const VECTOR2I & aPos )

inlinevirtualinherited

Reimplemented in DELETED_SHEET_ITEM, DELETED_BOARD_ITEM, PCB_GROUP, PCB_VIA, LIB_PIN, SCH_SHAPE, GERBER_DRAW_ITEM, DS_DRAW_ITEM_LINE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_PAGE, DS_DRAW_ITEM_TEXT, DS_DRAW_ITEM_BITMAP, BOARD, FOOTPRINT, FP_TEXT, NETINFO_ITEM, PAD, PCB_DIMENSION_BASE, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TRACK, PCB_ARC, ZONE, LIB_ITEM, LIB_SHAPE, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, KIGFX::ORIGIN_VIEWITEM, and PCB_BITMAP.

Definition at line 263 of file eda_item.h.

263{};

Referenced by BOARD_EDITOR_CONTROL::DoSetDrillOrigin(), PCB_CONTROL::DoSetGridOrigin(), DRAWING_TOOL::DrawVia(), FOOTPRINT::GetFpPadsLocalBbox(), SCH_EAGLE_PLUGIN::moveLabels(), PL_DRAWING_TOOLS::PlaceItem(), PlotStandardLayer(), BOARD_ITEM::SetX(), BOARD_ITEM::SetY(), SCH_DRAWING_TOOLS::SingleClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 128 of file eda_item.h.

128{ SetFlags( SELECTED ); }

References SELECTED, and EDA_ITEM::SetFlags().

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

◆ SetState()

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

inlineinherited

Definition at line 141 of file eda_item.h.

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

References EDA_ITEM::m_status.

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

◆ SetStatus()

void EDA_ITEM::SetStatus ( EDA_ITEM_FLAGS aStatus )

inlineinherited

Definition at line 150 of file eda_item.h.

150{ m_status = aStatus; }

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )

inlineinherited

Definition at line 127 of file eda_item.h.

127{ SetFlags( IS_WIRE_IMAGE ); }

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

◆ Sort()

static bool EDA_ITEM::Sort	(	const EDA_ITEM *	aLeft,
		const EDA_ITEM *	aRight
	)

inlinestaticinherited

Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers.

Parameters

aLeft	The left hand item to compare.
aRight	The right hand item to compare.

Returns: True if aLeft is less than aRight.

Definition at line 440 of file eda_item.h.

440{ return *aLeft < *aRight; }

◆ StepAndRepeatItem()

void GERBER_FILE_IMAGE::StepAndRepeatItem ( const GERBER_DRAW_ITEM & aItem )

inherited

Gerber format has a command Step an Repeat.

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)

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
aItem	= the item to repeat

Definition at line 295 of file gerber_file_image.cpp.

{
 if( GetLayerParams().m_XRepeatCount < 2 && GetLayerParams().m_YRepeatCount < 2 )
 return; // Nothing to repeat
 
 // Duplicate item:
 for( int ii = 0; ii < GetLayerParams().m_XRepeatCount; ii++ )
 {
 for( int jj = 0; jj < GetLayerParams().m_YRepeatCount; jj++ )
 {
 // the first gerber item already exists (this is the template)
 // create duplicate only if ii or jj > 0
 if( jj == 0 && ii == 0 )
 continue;
 
 GERBER_DRAW_ITEM* dupItem = new GERBER_DRAW_ITEM( aItem );
 VECTOR2I move_vector;
 move_vector.x = scaletoIU( ii * GetLayerParams().m_StepForRepeat.x,
 GetLayerParams().m_StepForRepeatMetric );
 move_vector.y = scaletoIU( jj * GetLayerParams().m_StepForRepeat.y,
 GetLayerParams().m_StepForRepeatMetric );
 dupItem->MoveXY( move_vector );
 AddItemToList( dupItem );
 }
 }
}

References GERBER_FILE_IMAGE::AddItemToList(), GERBER_FILE_IMAGE::GetLayerParams(), GERBER_LAYER::m_XRepeatCount, GERBER_LAYER::m_YRepeatCount, GERBER_DRAW_ITEM::MoveXY(), scaletoIU(), VECTOR2< T >::x, and VECTOR2< T >::y.

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

◆ TestFileIsExcellon()

bool EXCELLON_IMAGE::TestFileIsExcellon ( const wxString & aFullFileName )

static

Performs a heuristics-based check of whether the file is an Excellon drill file.

Does not invoke the full parser.

Parameters

aFullFileName aFullFileName is the full filename of the Excellon file.

Returns: True if drill file, false otherwise

Definition at line 344 of file excellon_read_drill_file.cpp.

{
 char* letter;
 bool foundM48 = false;
 bool foundM30 = false;
 bool foundPercent = false;
 bool foundT = false;
 bool foundX = false;
 bool foundY = false;
 
 FILE* file = wxFopen( aFullFileName, "rb" );
 
 if( file == nullptr )
 return false;
 
 FILE_LINE_READER excellonReader( file, aFullFileName );
 
 try
 {
 while( true )
 {
 if( excellonReader.ReadLine() == nullptr )
 break;
 
 // Remove all whitespace from the beginning and end
 char* line = StrPurge( excellonReader.Line() );
 
 // Skip empty lines
 if( *line == 0 )
 continue;
 
 // Check that file is not binary (non-printing chars)
 for( size_t i = 0; i < strlen( line ); i++ )
 {
 if( !isascii( line[i] ) )
 return false;
 }
 
 // We don't want to look for any commands after a comment so
 // just end the line early if we find a comment
 char* buf = strstr( line, ";" );
 if( buf != nullptr )
 *buf = 0;
 
 // Check for M48 = start of drill header
 if( strstr( line, "M48" ) )
 foundM48 = true;
 
 // Check for M30 = end of drill program
 if( strstr( line, "M30" ) )
 if( foundPercent )
 foundM30 = true; // Found M30 after % = good
 
 // Check for % on its own line at end of header
 if( ( letter = strstr( line, "%" ) ) != nullptr )
 if( ( letter[1] == '\r' ) || ( letter[1] == '\n' ) )
 foundPercent = true;
 
 // Check for T<number>
 if( ( letter = strstr( line, "T" ) ) != nullptr )
 {
 if( !foundT && ( foundX || foundY ) )
 foundT = false; /* Found first T after X or Y */
 else
 {
 // verify next char is digit
 if( isdigit( letter[1] ) )
 foundT = true;
 }
 }
 
 // look for X<number> or Y<number>
 if( ( letter = strstr( line, "X" ) ) != nullptr )
 if( isdigit( letter[1] ) )
 foundX = true;
 
 if( ( letter = strstr( line, "Y" ) ) != nullptr )
 if( isdigit( letter[1] ) )
 foundY = true;
 }
 }
 catch( IO_ERROR& e )
 {
 return false;
 }
 
 
 /* Now form logical expression determining if this is a drill file */
 if( ( ( foundX || foundY ) && foundT ) && ( foundM48 || ( foundPercent && foundM30 ) ) )
 return true;
 else if( foundM48 && foundT && foundPercent && foundM30 )
 /* Pathological case of drill file with valid header
 and EOF but no drill XY locations. */
 return true;
 
 return false;
}

References LINE_READER::Line(), FILE_LINE_READER::ReadLine(), and StrPurge().

Referenced by GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles(), and GERBVIEW_FRAME::unarchiveFiles().

◆ TestFileIsRS274()

bool GERBER_FILE_IMAGE::TestFileIsRS274 ( const wxString & aFullFileName )

staticinherited

Performs a heuristics-based check of whether the file is an RS274 gerber file.

Does not invoke the full parser.

Parameters

aFullFileName aFullFileName is the full filename of the gerber file.

Returns: True if RS274 file, false otherwise

Definition at line 138 of file readgerb.cpp.

{
 char* letter;
 bool foundADD = false;
 bool foundD0 = false;
 bool foundD2 = false;
 bool foundM0 = false;
 bool foundM2 = false;
 bool foundStar = false;
 bool foundX = false;
 bool foundY = false;
 
 
 FILE* file = wxFopen( aFullFileName, "rb" );
 
 if( file == nullptr )
 return false;
 
 FILE_LINE_READER gerberReader( aFullFileName );
 
 try
 {
 while( true )
 {
 if( gerberReader.ReadLine() == nullptr )
 break;
 
 // Remove all whitespace from the beginning and end
 char* line = StrPurge( gerberReader.Line() );
 
 // Skip empty lines
 if( *line == 0 )
 continue;
 
 // Check that file is not binary (non-printing chars)
 for( size_t i = 0; i < strlen( line ); i++ )
 {
 if( !isascii( line[i] ) )
 return false;
 }
 
 if( strstr( line, "%ADD" ) )
 foundADD = true;
 
 if( strstr( line, "D00" ) || strstr( line, "D0" ) )
 foundD0 = true;
 
 if( strstr( line, "D02" ) || strstr( line, "D2" ) )
 foundD2 = true;
 
 if( strstr( line, "M00" ) || strstr( line, "M0" ) )
 foundM0 = true;
 
 if( strstr( line, "M02" ) || strstr( line, "M2" ) )
 foundM2 = true;
 
 if( strstr( line, "*" ) )
 foundStar = true;
 
 /* look for X<number> or Y<number> */
 if( ( letter = strstr( line, "X" ) ) != nullptr )
 {
 if( isdigit( letter[1] ) )
 foundX = true;
 }
 
 if( ( letter = strstr( line, "Y" ) ) != nullptr )
 {
 if( isdigit( letter[1] ) )
 foundY = true;
 }
 }
 }
 catch( IO_ERROR& e )
 {
 return false;
 }
 
 // RS-274X
 if( ( foundD0 || foundD2 || foundM0 || foundM2 ) && foundADD && foundStar
 && ( foundX || foundY ) )
 return true;
 // RS-274D. Could be folded into the expression above, but someday
 // we might want to test for them separately.
 else if( ( foundD0 || foundD2 || foundM0 || foundM2 ) && !foundADD && foundStar
 && ( foundX || foundY ) )
 return true;
 
 
 return false;
}

References LINE_READER::Line(), FILE_LINE_READER::ReadLine(), and StrPurge().

Referenced by GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles(), and GERBVIEW_FRAME::unarchiveFiles().

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const

inlineinherited

Returns the type of object.

This attribute should never be changed after a ctor sets it, so there is no public "setter" method.

Returns: the type of object.

Definition at line 112 of file eda_item.h.

112{ return m_structType; }

References EDA_ITEM::m_structType.

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EXCELLON_STATE

Constructor & Destructor Documentation

◆ EXCELLON_IMAGE()

◆ ~EXCELLON_IMAGE()

Member Function Documentation

◆ AddItemToList()

◆ AddMessageToList()

◆ ClearBrightened()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearMessageList()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearViewPrivData()

◆ Clone()

◆ CodeNumber()

◆ DisplayImageInfo()

◆ Execute_DCODE_Command()

◆ Execute_Drill_Command()

◆ Execute_EXCELLON_G_Command()

◆ Execute_G_Command()

◆ Execute_HEADER_And_M_Command()

◆ ExecuteRS274XCommand()

◆ FindApertureMacro()

◆ FinishRouteCommand()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetBoundingBox()

◆ GetClass()

◆ GetDCODE()

◆ GetDCODEOrCreate()

◆ GetDcodesCount()

◆ GetEditFlags()

◆ GetEndOfBlock()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetItems()

◆ GetItemsCount()

◆ GetLastItemInList()

◆ GetLayerParams()

◆ GetMenuImage()

◆ GetMessages()

◆ GetMsgPanelInfo()

◆ GetNextLine()

◆ GetParent()

◆ GetPosition()

◆ GetPositiveDrawColor()

◆ GetSelectMenuText()

◆ GetSortPosition()

◆ GetState()

◆ GetStatus()

◆ HasFlag()

◆ HasNegativeItems()

◆ HitTest() [1/2]

◆ HitTest() [2/2]

◆ InitToolTable()

◆ IsBrightened()

◆ IsDragging()

◆ IsEntered()

◆ IsForceVisible()

◆ IsModified()

◆ IsMoving()

◆ IsNew()

◆ IsReplaceable()

◆ IsResized()

◆ IsSelected()

◆ IsShownAsBitmap()

◆ IsType()

◆ IsWireImage()