GERBER_FILE_IMAGE Class Reference

Hold the image data and parameters for one gerber file and layer parameters. More...

#include <gerber_file_image.h>

Inheritance diagram for GERBER_FILE_IMAGE:

Public Member Functions
	GERBER_FILE_IMAGE (int layer)
virtual	~GERBER_FILE_IMAGE ()
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 ()
virtual void	ResetDefaultValues ()
	Set all parameters to a default value, before reading a file. More...
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...
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 std::vector< KICAD_T > &aScanTypes) 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
bool	IsRollover () const
void	SetWireImage ()
void	SetSelected ()
void	SetBrightened ()
void	ClearSelected ()
void	ClearBrightened ()
void	SetModified ()
int	GetState (EDA_ITEM_FLAGS type) const
void	SetState (EDA_ITEM_FLAGS type, bool state)
EDA_ITEM_FLAGS	GetStatus () const
void	SetStatus (EDA_ITEM_FLAGS aStatus)
void	SetFlags (EDA_ITEM_FLAGS aMask)
void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
EDA_ITEM_FLAGS	GetFlags () const
bool	HasFlag (EDA_ITEM_FLAGS aFlag) const
EDA_ITEM_FLAGS	GetEditFlags () const
void	ClearTempFlags ()
void	ClearEditFlags ()
virtual bool	RenderAsBitmap (double aWorldScale) const
void	SetIsShownAsBitmap (bool aBitmap)
bool	IsShownAsBitmap () const
virtual bool	IsType (const std::vector< KICAD_T > &aScanTypes) const
	Check whether the item is one of the listed types. More...
void	SetForceVisible (bool aEnable)
	Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
bool	IsForceVisible () const
virtual 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 BOX2I &aRect, bool aContained, int aAccuracy=0) const
	Test if aRect intersects this item. More...
virtual const BOX2I	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...
wxString	GetTypeDesc ()
	Return a translated description of the type for this EDA_ITEM for display in user facing messages. More...
virtual wxString	GetSelectMenuText (UNITS_PROVIDER *aUnitsProvider) 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 EDA_SEARCH_DATA &aSearchData, void *aAuxData) const
	Compare the item against the search criteria in aSearchData. More...
virtual bool	Replace (const EDA_SEARCH_DATA &aSearchData, void *aAuxData=nullptr)
	Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
virtual bool	IsReplaceable () const
	Override this method in any derived object that supports test find and replace. More...
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) const
template<typename T >
T	Get (PROPERTY_BASE *aProperty) const
template<typename T >
std::optional< T >	Get (const wxString &aProperty) const

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

Public Attributes
bool	m_InUse
	true if this image is currently in use (a file is loaded in it) false if it must be not drawn More...
COLOR4D	m_PositiveDrawColor
	The color used to draw positive items. More...
wxString	m_FileName
	Full File Name for this layer. More...
wxString	m_ImageName
	Image name, from IN <name>* command. More...
bool	m_IsX2_file
	True if a X2 gerber attribute was found in file. More...
X2_ATTRIBUTE_FILEFUNCTION *	m_FileFunction
	file function parameters, found in a TF command or a G04 More...
wxString	m_MD5_value
	MD5 value found in a TF.MD5 command. More...
wxString	m_PartString
	string found in a TF.Part command More...
int	m_GraphicLayer
	Graphic layer Number. More...
bool	m_ImageNegative
	true = Negative image More...
bool	m_ImageJustifyXCenter
	Image Justify Center on X axis (default = false) More...
bool	m_ImageJustifyYCenter
	Image Justify Center on Y axis (default = false) More...
VECTOR2I	m_ImageJustifyOffset
	Image Justify Offset on XY axis (default = 0,0) More...
bool	m_GerbMetric
	false = Inches, true = metric More...
bool	m_Relative
	false = absolute Coord, true = relative Coord. More...
bool	m_NoTrailingZeros
	true: remove tailing zeros. More...
VECTOR2I	m_ImageOffset
	Coord Offset, from IO command. More...
wxSize	m_FmtScale
	Fmt 2.3: m_FmtScale = 3, fmt 3.4: m_FmtScale = 4. More...
wxSize	m_FmtLen
	Nb chars per coord. ex fmt 2.3, m_FmtLen = 5. More...
int	m_ImageRotation
	Image rotation (0, 90, 180, 270 only) in degrees. More...
double	m_LocalRotation
	Local rotation added to m_ImageRotation. More...
VECTOR2I	m_Offset
	Coord Offset, from OF command. More...
VECTOR2I	m_Scale
	scale (X and Y) of layer. More...
bool	m_SwapAxis
	false if A = X and B = Y (default); true if A = Y, B = X More...
bool	m_MirrorA
	true: mirror / axis A (X) More...
bool	m_MirrorB
	true: mirror / axis B (Y) More...
int	m_Iterpolation
	Linear, 90 arc, Circ. More...
int	m_Current_Tool
	Current Tool (Dcode) number selected. More...
int	m_Last_Pen_Command
	Current or last pen state (0..9, set by Dn option with n < 10. More...
int	m_CommandState
	state of gerber analysis command More...
int	m_LineNum
	Line number of the gerber file while reading. More...
VECTOR2I	m_CurrentPos
	current specified coord for plot More...
VECTOR2I	m_PreviousPos
	old current specified coord for plot More...
VECTOR2I	m_IJPos
	IJ coord (for arcs & circles ) More...
bool	m_LastCoordIsIJPos
	A value ( = radius in circular routing in Excellon files ). 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 EDA_SEARCH_DATA &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 Member Functions
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
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

Hold the image data and parameters for one gerber file and layer parameters.

Todo:

: Move them in GERBER_LAYER class.

Definition at line 110 of file gerber_file_image.h.

Constructor & Destructor Documentation

GERBER_FILE_IMAGE()

GERBER_FILE_IMAGE::GERBER_FILE_IMAGE

(

int

layer

)

Definition at line 82 of file gerber_file_image.cpp.

 :
 EDA_ITEM( nullptr, GERBER_IMAGE_T )
{
 m_GraphicLayer = aLayer; // Graphic layer Number
 m_PositiveDrawColor = WHITE; // The color used to draw positive items for this image
 
 m_Selected_Tool = 0;
 m_FileFunction = nullptr; // file function parameters
 
 ResetDefaultValues();
 
 for( unsigned ii = 0; ii < arrayDim( m_Aperture_List ); ii++ )
 m_Aperture_List[ii] = nullptr;
}

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

~GERBER_FILE_IMAGE()

GERBER_FILE_IMAGE::~GERBER_FILE_IMAGE ( )

virtual

Definition at line 98 of file gerber_file_image.cpp.

{
 for( GERBER_DRAW_ITEM* item : GetItems() )
 delete item;
 
 m_drawings.clear();
 
 for( unsigned ii = 0; ii < arrayDim( m_Aperture_List ); ii++ )
 delete m_Aperture_List[ii];
 
 delete m_FileFunction;
}

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

Member Function Documentation

AddItemToList()

void GERBER_FILE_IMAGE::AddItemToList ( GERBER_DRAW_ITEM *  aItem )

inline

Add a new GERBER_DRAW_ITEM item to the drawings list.

Parameters

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 m_drawings.

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

AddMessageToList()

void GERBER_FILE_IMAGE::AddMessageToList ( const wxString &  aMessage )

inline

Add a message to the message list.

Definition at line 210 of file gerber_file_image.h.

 {
 m_messagesList.Add( aMessage );
 }

References m_messagesList.

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

ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 122 of file eda_item.h.

{ ClearFlags( BRIGHTENED ); }

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

{ m_flags &= ~aMask; }

References EDA_ITEM::m_flags.

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

ClearMessageList()

void GERBER_FILE_IMAGE::ClearMessageList ( )

inline

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 m_messagesList.

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

ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 121 of file eda_item.h.

{ ClearFlags( SELECTED ); }

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 155 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 82 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 SCH_EDIT_FRAME::AddCopyForRepeatItem(), 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(), 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

)

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 Execute_G_Command(), LoadGerberFile(), and EXCELLON_IMAGE::Select_Tool().

DisplayImageInfo()

void GERBER_FILE_IMAGE::DisplayImageInfo

(

GERBVIEW_FRAME *

aMainFrame

)

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 314 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 );
 
 msg.Printf( wxT( "X=%s Y=%s" ),
 aMainFrame->MessageTextFromValue( m_ImageJustifyOffset.x ),
 aMainFrame->MessageTextFromValue( m_ImageJustifyOffset.y ) );
 
 aMainFrame->AppendMsgPanel( _( "Image Justify Offset" ), msg );
}

References _, EDA_DRAW_FRAME::AppendMsgPanel(), EDA_DRAW_FRAME::ClearMsgPanel(), m_GraphicLayer, m_ImageJustifyOffset, m_ImageJustifyXCenter, m_ImageJustifyYCenter, m_ImageName, m_ImageNegative, m_ImageRotation, m_IsX2_file, UNITS_PROVIDER::MessageTextFromValue(), 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  )

private

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;
}

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

Referenced by LoadGerberFile().

Execute_G_Command()

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

private

Definition at line 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;
}

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

Referenced by LoadGerberFile().

ExecuteRS274XCommand()

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

private

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 = gerbIUScale.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 ? gerbIUScale.IU_PER_MILS / 25.4 : gerbIUScale.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;
}

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

Referenced by Execute_G_Command(), and ReadRS274XCommand().

FindApertureMacro()

APERTURE_MACRO * GERBER_FILE_IMAGE::FindApertureMacro

(

const APERTURE_MACRO &

aLookup

)

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 143 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 m_aperture_macros.

Referenced by ExecuteRS274XCommand().

Get() [1/3]

template<typename T >

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

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 );
 std::optional<T> ret;
 
 if( prop )
 {
 const 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 ) const

inlineinherited

Definition at line 84 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 const void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), 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(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), PCB_EXPR_VAR_REF::GetValue(), and PAD_DESC::PAD_DESC().

Get() [3/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE *  aProperty ) const

inlineinherited

Definition at line 92 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 const void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 
 if( !object )
 throw std::runtime_error( "Could not cast INSPECTABLE to the requested type" );
 
 return aProperty->get<T>( object );
 }

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

GetBoundingBox()

const BOX2I 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 74 of file eda_item.cpp.

{
 // return a zero-sized box per default. derived classes should override
 // this
 return BOX2I( 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::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), SCH_DRAWING_TOOLS::DrawSheet(), enclosedByAreaFunc(), PCB_SELECTION_TOOL::FindItem(), SCH_EDITOR_CONTROL::FindNext(), LIB_ITEM::GetBoundingBox(), GetBoundingBoxes(), BOARD_ITEM::GetCenter(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), EE_SELECTION_TOOL::GuessSelectionCandidates(), EE_RTREE::insert(), intersectsAreaFunc(), 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(), GERBVIEW_SELECTION::ViewBBox(), and EDA_ITEM::ViewBBox().

GetClass()

wxString GERBER_FILE_IMAGE::GetClass ( ) const

inlineoverridevirtual

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

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 132 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 m_Aperture_List.

Referenced by Execute_DCODE_Command(), EXCELLON_IMAGE::Execute_Drill_Command(), Execute_G_Command(), EXCELLON_IMAGE::FinishRouteCommand(), GERBER_DRAW_ITEM::GetDcodeDescr(), EXCELLON_IMAGE::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
	)

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 112 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 m_Aperture_List.

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

GetDcodesCount()

int GERBER_FILE_IMAGE::GetDcodesCount

(

)

Returns

the count of Dcode tools in use in the image

Definition at line 251 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(), m_Aperture_List, and 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 147 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.

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

GetEndOfBlock()

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

private

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 m_LineNum.

Referenced by ExecuteRS274XCommand().

GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 144 of file eda_item.h.

{ return m_flags; }

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), collidesWithArea(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), KIGFX::PCB_PAINTER::draw(), 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(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), PAD_TOOL::RecombinePad(), 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 256 of file eda_item.h.

{ return GetPosition(); }

References EDA_ITEM::GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem().

GetItems()

GERBER_DRAW_ITEMS & GERBER_FILE_IMAGE::GetItems ( )

inline

Returns

a reference to the GERBER_DRAW_ITEMS deque list

Definition at line 158 of file gerber_file_image.h.

{ return m_drawings; }

References m_drawings.

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

GetItemsCount()

int GERBER_FILE_IMAGE::GetItemsCount ( )

inline

Returns

the count of GERBER_DRAW_ITEMS in the image

Definition at line 163 of file gerber_file_image.h.

{ return m_drawings.size(); }

References m_drawings.

Referenced by GERBVIEW_FRAME::Read_GERBER_File().

GetLastItemInList()

GERBER_DRAW_ITEM * GERBER_FILE_IMAGE::GetLastItemInList ( ) const

inline

Returns

the last GERBER_DRAW_ITEM* item of the items list

Definition at line 178 of file gerber_file_image.h.

 {
 return m_drawings.back();
 }

References m_drawings.

Referenced by Execute_DCODE_Command(), and Execute_G_Command().

GetLayerParams()

GERBER_LAYER & GERBER_FILE_IMAGE::GetLayerParams ( )

inline

Returns

the current layers params.

Definition at line 186 of file gerber_file_image.h.

 {
 return m_GBRLayerParams;
 }

References m_GBRLayerParams.

Referenced by Execute_DCODE_Command(), ExecuteRS274XCommand(), GERBER_DRAW_ITEM::SetLayerParameters(), 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 269 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

inline

Definition at line 141 of file gerber_file_image.h.

{ return m_messagesList; }

References m_messagesList.

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

GetMsgPanelInfo()

virtual void EDA_ITEM::GetMsgPanelInfo ( EDA_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 211 of file eda_item.h.

 {
 }

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  )

private

Test for an end of line.

If a end of line is found, read a new line.

Parameters

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

Returns

a pointer to the beginning of the next line or NULL if end of file

Definition at line 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 m_LineNum.

Referenced by ReadApertureMacro().

GetParent()

EDA_ITEM * EDA_ITEM::GetParent ( void  ) const

inlineinherited

Definition at line 99 of file eda_item.h.

{ return m_parent; }

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_FIELD::GetFieldColor(), getInferredSymbols(), SCH_PIN::GetParentSymbol(), EE_SELECTION_TOOL::highlight(), highlightNet(), SCH_FIELD::HitTest(), SCH_PIN::IsStacked(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), 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 249 of file eda_item.h.

{ 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::ercCheckNetclassConflicts(), CONNECTION_GRAPH::ercCheckNoConnects(), PCB_SELECTION_TOOL::FindItem(), GERBVIEW_SELECTION::GetCenter(), EDA_ITEM::GetFocusPosition(), getMinDist(), SCH_FIELD::GetParentPosition(), 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(), POSITION_RELATIVE_TOOL::PositionRelative(), BACK_ANNOTATE::processNetNameChange(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), RC_ITEM::ShowReport(), SCH_EDIT_TOOL::Swap(), EDIT_TOOL::Swap(), 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

inline

Definition at line 153 of file gerber_file_image.h.

{ return m_PositiveDrawColor; }

References m_PositiveDrawColor.

Referenced by GERBER_DRAW_ITEM::Print().

GetSelectMenuText()

wxString EDA_ITEM::GetSelectMenuText ( UNITS_PROVIDER *  aUnitsProvider ) 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 108 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 265 of file eda_item.h.

{ return GetPosition(); }

References EDA_ITEM::GetPosition().

GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS  type ) const

inlineinherited

Definition at line 126 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 139 of file eda_item.h.

{ return m_status; }

References EDA_ITEM::m_status.

GetTypeDesc()

wxString EDA_ITEM::GetTypeDesc ( )

inherited

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

Definition at line 301 of file eda_item.cpp.

{
 //@see EDA_ITEM_DESC for definition of ENUM_MAP<KICAD_T>
 wxString typeDescr = ENUM_MAP<KICAD_T>::Instance().ToString( Type() );
 
 return wxGetTranslation( typeDescr );
}

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

Referenced by PROPERTIES_PANEL::update().

HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS  aFlag ) const

inlineinherited

Definition at line 145 of file eda_item.h.

{ 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

(

)

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 222 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 GetItems(), m_GraphicLayer, m_hasNegativeItems, and m_ImageNegative.

HitTest() [1/2]

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

inlinevirtualinherited

Test if aRect intersects this item.

Parameters

aRect	A reference to a BOX2I 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 235 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 222 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().

IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 110 of file eda_item.h.

{ 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(), SCH_EDIT_FRAME::FocusOnItem(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::setDeviceColors(), SCH_EDITOR_CONTROL::UpdateFind(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 105 of file eda_item.h.

{ return m_flags & IS_DRAGGING; }

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 108 of file eda_item.h.

{ return m_flags & ENTERED; }

References ENTERED, and EDA_ITEM::m_flags.

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

IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 203 of file eda_item.h.

{ return m_forceVisible; }

References EDA_ITEM::m_forceVisible.

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

IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 102 of file eda_item.h.

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

{ 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(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), and SCH_EDIT_TOOL::Swap().

IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 103 of file eda_item.h.

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

{ return false; }

Referenced by EDA_ITEM::Matches().

IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 109 of file eda_item.h.

{ return m_flags & IS_RESIZING; }

References IS_RESIZING, and EDA_ITEM::m_flags.

IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 112 of file eda_item.h.

 {
 return ( m_flags & ( IS_ROLLOVER | IS_MOVING ) ) == IS_ROLLOVER;
 }

References IS_MOVING, IS_ROLLOVER, and EDA_ITEM::m_flags.

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

IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 107 of file eda_item.h.

{ return m_flags & SELECTED; }

References EDA_ITEM::m_flags, and SELECTED.

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

IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 175 of file eda_item.h.

{ return m_flags & IS_SHOWN_AS_BITMAP; }

References IS_SHOWN_AS_BITMAP, and EDA_ITEM::m_flags.

IsType()

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

inlinevirtualinherited

Check whether the item is one of the listed types.

Parameters

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

 {
 for( KICAD_T scanType : aScanTypes )
 {
 if( scanType == SCH_LOCATE_ANY_T || scanType == m_structType )
 return true;
 }
 
 return false;
 }

References EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

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

IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 106 of file eda_item.h.

{ return m_flags & IS_WIRE_IMAGE; }

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

IterateForward() [1/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 302 of file eda_item.h.

 {
 for( const 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 Visit().

IterateForward() [2/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 322 of file eda_item.h.

 {
 for( const 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().

LoadGerberFile()

bool GERBER_FILE_IMAGE::LoadGerberFile

(

const wxString &

aFullFileName

)

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 232 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;
}

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

Matches() [1/2]

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

inlinevirtualinherited

Compare the item against the search criteria in aSearchData.

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

Parameters

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

 {
 return false;
 }

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

Matches() [2/2]

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

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

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

{
 wxString text = aText;
 wxString searchText = aSearchData.findString;
 
 // Don't match if searching for replaceable item and the item doesn't support text replace.
 if( aSearchData.searchAndReplace && !IsReplaceable() )
 return false;
 
 if( !aSearchData.matchCase )
 {
 text.MakeUpper();
 searchText.MakeUpper();
 }
 
 if( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::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( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::WILDCARD )
 {
 return text.Matches( searchText );
 }
 else
 {
 return text.Find( searchText ) != wxNOT_FOUND;
 }
}

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

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

private

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 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, GetNextLine(), m_aperture_macros, m_GerbMetric, 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 ExecuteRS274XCommand().

ReadIJCoord()

VECTOR2I GERBER_FILE_IMAGE::ReadIJCoord

(

char *&

Text

)

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(), m_FmtLen, m_FmtScale, m_GerbMetric, m_IJPos, m_LastArcDataType, m_LastCoordIsIJPos, m_NoTrailingZeros, scale_list, scaletoIU(), VECTOR2< T >::x, and VECTOR2< T >::y.

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

ReadRS274XCommand()

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

private

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, ExecuteRS274XCommand(), exit, m_CommandState, m_Current_File, m_LineNum, and ReadXCommandID().

Referenced by LoadGerberFile().

ReadXCommandID()

int GERBER_FILE_IMAGE::ReadXCommandID ( char *&  text )

private

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 Execute_G_Command(), ExecuteRS274XCommand(), and ReadRS274XCommand().

ReadXYCoord()

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

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(), m_ArcRadius, m_CurrentPos, m_FmtLen, m_FmtScale, m_GerbMetric, m_LastArcDataType, m_NoTrailingZeros, m_Relative, scale_list, scaletoIU(), VECTOR2< T >::x, and VECTOR2< T >::y.

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

RemoveAttribute()

void GERBER_FILE_IMAGE::RemoveAttribute

(

X2_ATTRIBUTE &

aAttribute

)

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 aScanTypes, 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.
aScanTypes	Which KICAD_T types are of interest and the order in which they should be processed.

Returns

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

Definition at line 356 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(), m_AperFunction, and m_NetAttributeDict.

Referenced by ExecuteRS274XCommand().

RenderAsBitmap()

virtual bool EDA_ITEM::RenderAsBitmap ( double  aWorldScale ) const

inlinevirtualinherited

Reimplemented in SCH_ITEM.

Definition at line 165 of file eda_item.h.

{ return false; }

Replace() [1/2]

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

inlinevirtualinherited

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

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

Parameters

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

 {
 return false;
 }

Replace() [2/2]

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

staticinherited

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

Parameters

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

{
 wxString text = aText;
 wxString searchText = aSearchData.findString;
 wxString result;
 bool replaced = false;
 
 if( !aSearchData.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( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::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.replaceString;
 replaced = true;
 ii = next;
 }
 else
 {
 result += aText.GetChar( ii );
 ii++;
 }
 }
 
 aText = result;
 return replaced;
}

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

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

ResetDefaultValues()

void GERBER_FILE_IMAGE::ResetDefaultValues ( )

virtual

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

Reimplemented in EXCELLON_IMAGE.

Definition at line 157 of file gerber_file_image.cpp.

{
 m_InUse = false;
 m_GBRLayerParams.ResetDefaultValues();
 m_FileName.Empty();
 m_ImageName = wxEmptyString; // Image name from the IN command (deprecated)
 m_ImageNegative = false; // true = Negative image
 m_IsX2_file = false; // true only if a %TF, %TA or %TD command
 delete m_FileFunction; // file function parameters
 m_FileFunction = nullptr;
 m_MD5_value.Empty(); // MD5 value found in a %TF.MD5 command
 m_PartString.Empty(); // string found in a %TF.Part command
 m_hasNegativeItems = -1; // set to uninitialized
 m_ImageJustifyOffset = VECTOR2I( 0, 0 ); // Image justify Offset
 m_ImageJustifyXCenter = false; // Image Justify Center on X axis (default = false)
 m_ImageJustifyYCenter = false; // Image Justify Center on Y axis (default = false)
 m_GerbMetric = false; // false = Inches (default), true = metric
 m_Relative = false; // false = absolute Coord,
 // true = relative Coord
 m_NoTrailingZeros = false; // true: trailing zeros deleted
 m_ImageOffset.x = m_ImageOffset.y = 0; // Coord Offset, from IO command
 m_ImageRotation = 0; // Allowed 0, 90, 180, 270 (in degree)
 m_LocalRotation = 0.0; // Layer rotation from RO command (in 0.1 degree)
 m_Offset.x = 0;
 m_Offset.y = 0; // Coord Offset, from OF command
 m_Scale.x = m_Scale.y = 1.0; // scale (A and B) this layer
 m_MirrorA = false; // true: mirror / axe A (default = X)
 m_MirrorB = false; // true: mirror / axe B (default = Y)
 m_SwapAxis = false; // false if A = X, B = Y; true if A =Y, B = Y
 m_Has_DCode = false; // true = DCodes in file
 // false = no DCode-> perhaps deprecated RS274D file
 m_Has_MissingDCode = false; // true = some D_Codes are used, but not defined
 // perhaps deprecated RS274D file
 m_FmtScale.x = m_FmtScale.y = 4; // Initialize default format to 3.4 => 4
 m_FmtLen.x = m_FmtLen.y = 3 + 4; // Initialize default format len = 3+4
 
 m_Iterpolation = GERB_INTERPOL_LINEAR_1X; // Linear, 90 arc, Circ.
 m_360Arc_enbl = true; // 360 deg circular mode (G75) selected as default
 // interpolation disable
 m_AsArcG74G75Cmd = false; // false until a G74 or G75 command is found
 m_Current_Tool = 0; // Current Dcode selected
 m_CommandState = 0; // State of the current command
 m_CurrentPos.x = m_CurrentPos.y = 0; // current specified coord
 m_PreviousPos.x = m_PreviousPos.y = 0; // last specified coord
 m_IJPos.x = m_IJPos.y = 0; // current centre coord for
 // plot arcs & circles
 m_LastCoordIsIJPos = false; // True only after a IJ coordinate is read
 m_ArcRadius = 0; // radius of arcs in circular interpol (given by A## command).
 // in command like X##Y##A##
 m_LastArcDataType = ARC_INFO_TYPE_NONE; // Extra coordinate info type for arcs
 // (radius or IJ center coord)
 m_LineNum = 0; // line number in file being read
 m_Current_File = nullptr; // Gerber file to read
 m_PolygonFillMode = false;
 m_PolygonFillModeState = 0;
 m_Selected_Tool = 0;
 m_Last_Pen_Command = 0;
 m_Exposure = false;
}

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

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

Set() [1/3]

template<typename T >

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

inlineinherited

Definition at line 66 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 54 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), 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();
 void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), 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().

Referenced by PCB_PROPERTIES_PANEL::valueChanged().

SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 119 of file eda_item.h.

{ SetFlags( BRIGHTENED ); }

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

{ m_flags |= aMask; }

References EDA_ITEM::m_flags.

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

SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool  aEnable )

inlineinherited

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

Parameters

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

{ 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 167 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 64 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 100 of file eda_item.h.

{ m_parent = aParent; }

References EDA_ITEM::m_parent.

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

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

{};

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(), SCH_EDIT_TOOL::Swap(), EDIT_TOOL::Swap(), and SCH_DRAWING_TOOLS::TwoClickPlace().

SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 118 of file eda_item.h.

{ 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 131 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 140 of file eda_item.h.

{ m_status = aStatus; }

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

SetWireImage()

void EDA_ITEM::SetWireImage ( )

inlineinherited

Definition at line 117 of file eda_item.h.

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

{ return *aLeft < *aRight; }

StepAndRepeatItem()

void GERBER_FILE_IMAGE::StepAndRepeatItem

(

const GERBER_DRAW_ITEM &

aItem

)

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 277 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 AddItemToList(), GetLayerParams(), GERBER_LAYER::m_XRepeatCount, GERBER_LAYER::m_YRepeatCount, GERBER_DRAW_ITEM::MoveXY(), scaletoIU(), VECTOR2< T >::x, and VECTOR2< T >::y.

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

TestFileIsRS274()

bool GERBER_FILE_IMAGE::TestFileIsRS274 ( const wxString &  aFullFileName )

static

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 139 of file readgerb.cpp.

{
 char* letter = nullptr;
 bool foundADD = false;
 bool foundD0 = false;
 bool foundD2 = false;
 bool foundM0 = false;
 bool foundM2 = false;
 bool foundStar = false;
 bool foundX = false;
 bool foundY = false;
 
 try
 {
 FILE_LINE_READER gerberReader( aFullFileName );
 
 while( gerberReader.ReadLine() )
 {
 // 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& )
 {
 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 97 of file eda_item.h.

{ return m_structType; }

References EDA_ITEM::m_structType.

Referenced by CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), FOOTPRINT::Add(), CN_CLUSTER::Add(), KIGFX::PCB_VIEW::Add(), PCB_POINT_EDITOR::addCorner(), CONNECTION_SUBGRAPH::AddItem(), DRC_TEST_PROVIDER_SOLDER_MASK::addItemToRTrees(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), ZONE_FILLER::addKnockout(), SCH_SHEET::AddPin(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), SCH_MOVE_TOOL::AlignElements(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), CN_ITEM::AnchorCount(), SCH_SCREEN::Append(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), PNS::TOPOLOGY::AssembleTuningPath(), SCH_LABEL_BASE::AutoplaceFields(), EE_SELECTION_TOOL::autostartEvent(), DIALOG_NET_INSPECTOR::buildNewItem(), SCH_SCREENS::buildScreenList(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), PCB_POINT_EDITOR::canAddCorner(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_JUNCTION::CanConnect(), SCH_LABEL_BASE::CanConnect(), SCH_LINE::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_SHEET::CanConnect(), SCH_SYMBOL::CanConnect(), SCH_EDIT_TOOL::ChangeTextType(), KI_TEST::CheckFootprint(), KI_TEST::CheckFpPad(), KI_TEST::CheckFpShape(), KI_TEST::CheckFpText(), KI_TEST::CheckFpZone(), CN_VISITOR::checkZoneItemConnection(), LIB_TEXTBOX::ClassOf(), SCH_BITMAP::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), SCH_FIELD::ClassOf(), SCH_JUNCTION::ClassOf(), SCH_LABEL::ClassOf(), SCH_DIRECTIVE_LABEL::ClassOf(), SCH_GLOBALLABEL::ClassOf(), SCH_HIERLABEL::ClassOf(), SCH_LINE::ClassOf(), SCH_MARKER::ClassOf(), SCH_NO_CONNECT::ClassOf(), SCH_PIN::ClassOf(), SCH_SCREEN::ClassOf(), SCH_SHEET::ClassOf(), SCH_SHEET_PIN::ClassOf(), SCH_SYMBOL::ClassOf(), SCH_TEXT::ClassOf(), SCH_TEXTBOX::ClassOf(), PCB_GROUP::ClassOf(), BOARD::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), FOOTPRINT::ClassOf(), FP_SHAPE::ClassOf(), FP_TEXT::ClassOf(), FP_TEXTBOX::ClassOf(), NETINFO_ITEM::ClassOf(), PAD::ClassOf(), PCB_BITMAP::ClassOf(), PCB_DIM_ALIGNED::ClassOf(), PCB_DIM_ORTHOGONAL::ClassOf(), PCB_DIM_RADIAL::ClassOf(), PCB_DIM_LEADER::ClassOf(), PCB_DIM_CENTER::ClassOf(), PCB_MARKER::ClassOf(), PCB_SHAPE::ClassOf(), PCB_TARGET::ClassOf(), PCB_TEXT::ClassOf(), PCB_TEXTBOX::ClassOf(), PCB_TRACK::ClassOf(), PCB_ARC::ClassOf(), PCB_VIA::ClassOf(), ZONE::ClassOf(), CONNECTION_GRAPH::collectAllDriverValues(), collidesWithArea(), LIB_ITEM::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), LIB_TEXT::compare(), LIB_TEXTBOX::compare(), LIB_SYMBOL::Compare(), PCB_GRID_HELPER::computeAnchors(), EE_GRID_HELPER::computeAnchors(), TEARDROP_MANAGER::ComputePointsOnPadVia(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), SCH_LINE::ConnectionPropagatesTo(), EE_RTREE::contains(), BOARD::ConvertKIIDsToCrossReferences(), SCHEMATIC::ConvertKIIDsToRefs(), PAD_TOOL::copyPadSettings(), FOOTPRINT::CoverageRatio(), BOARD_ADAPTER::createLayers(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), ZONE_CREATE_HELPER::createNewZone(), BOARD_ADAPTER::createTrack(), DRC_TOOL::CrossProbe(), SCH_SCREEN::DeleteItem(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_LABEL_PROPERTIES::DIALOG_LABEL_PROPERTIES(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES(), BOARD_COMMIT::dirtyIntersectingZones(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), SCH_EDITOR_CONTROL::doCopy(), SCH_EDIT_TOOL::DoDelete(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), APPEARANCE_CONTROLS::doesBoardItemNeedRebuild(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), DRAWING_TOOL::DrawDimension(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawVia(), CONNECTION_SUBGRAPH::driverName(), CN_ITEM::Dump(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), EDIT_TOOL::Duplicate(), FOOTPRINT::DuplicateItem(), EDA_ITEM_DESC::EDA_ITEM_DESC(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::editFieldText(), SYMBOL_EDITOR_EDIT_TOOL::editTextBoxProperties(), SYMBOL_EDITOR_EDIT_TOOL::editTextProperties(), enclosedByAreaFunc(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckFloatingWires(), CONNECTION_GRAPH::ercCheckLabels(), CONNECTION_GRAPH::ercCheckMultipleDrivers(), CONNECTION_GRAPH::ercCheckNoConnects(), DRC_ENGINE::EvalRules(), DRC_ENGINE::EvalZoneConnection(), EDIT_TOOL::FilletTracks(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_SELECTION_TOOL::FilterCollectorForMarkers(), PCB_SELECTION_TOOL::FindItem(), NETLIST_EXPORTER_BASE::findNextSymbol(), CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), PCB_BASE_FRAME::FocusOnItems(), EDIT_TOOL::FootprintFilter(), PCB_PLUGIN::Format(), PCB_PLUGIN::format(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), FormatProbeItem(), FP_TEXT::FP_TEXT(), PCB_POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), SCH_FIELD::GetBoundingBox(), SCH_LABEL_BASE::GetBoundingBox(), PCB_TRACK::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), FOOTPRINT::GetCoverageArea(), CONNECTION_GRAPH::getDefaultConnection(), SCH_FIELD::GetDrawRotation(), getDrilledHoleShape(), CONNECTION_SUBGRAPH::GetDriverPriority(), getFieldFunc(), getInferredSymbols(), SELECTION::GetItemsSortedByTypeAndXY(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_FIELD::GetMenuImage(), getMinDist(), SCH_LABEL_BASE::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), SCH_FIELD::GetName(), CONNECTION_SUBGRAPH::GetNetclassForDriver(), CONNECTIVITY_DATA::GetNetItems(), LIB_SYMBOL::GetNextDrawItem(), BOARD_ITEM::GetParentFootprint(), LIB_SYMBOL::GetPin(), SCH_SYMBOL::GetPinPhysicalPosition(), SCH_FIELD::GetPosition(), KIGFX::SCH_PAINTER::getRenderColor(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), PCB_TRACK::GetSelectMenuText(), SCH_FIELD::GetShownText(), PCB_TEXT::GetShownText(), PCB_TEXTBOX::GetShownText(), CONVERT_TOOL::getStartEndPoints(), KIGFX::SCH_PAINTER::getTextThickness(), getTopLevelGroup(), EDA_ITEM::GetTypeDesc(), PCB_EXPR_TYPE_REF::GetValue(), GROUP_TOOL::Group(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), hasDrilledHole(), hash_fp_item(), EE_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), BOARD_INSPECTION_TOOL::HighlightItem(), BOARD_INSPECTION_TOOL::highlightNet(), highlightNet(), SCH_FIELD::HitTest(), SCH_LABEL_BASE::HitTest(), PCB_SELECTION_TOOL::hitTestDistance(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), DRC_RTREE::Insert(), EE_RTREE::insert(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), intersectsAreaFunc(), ARRAY_CREATOR::Invoke(), CONNECTIVITY_DATA::IsConnectedOnLayer(), isCopper(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), PNS_KICAD_IFACE_BASE::IsFlashedOnLayer(), CADSTAR_PCB_ARCHIVE_LOADER::isFootprint(), SCH_FIELD::IsHypertext(), isKeepoutZone(), isMaskAperture(), isNPTHPad(), PCB_TRACK::IsNull(), isNullAperture(), SCH_LINE::IsParallel(), isPlatedFunc(), SCH_FIELD::IsReplaceable(), PNS::ROUTER::isStartingPointRoutable(), SCH_ITEM::IsType(), itemIsIncludedByFilter(), PCB_SELECTION_TOOL::itemPassesFilter(), CLIPBOARD_IO::Load(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), EE_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), NETLIST_EXPORTER_XML::makeListOfNets(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromChainedSegs(), SCH_SCREEN::MarkConnections(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), SCH_FIELD::Matches(), memberOfFunc(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), SCH_EDITOR_CONTROL::nextMatch(), DIALOG_DRC::OnDRCItemSelected(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), EDA_3D_CANVAS::OnMouseMove(), CN_VISITOR::operator()(), BOARD_ITEM::ptr_cmp::operator()(), BOARD::cmp_items::operator()(), BOARD::cmp_drawings::operator()(), PCB_SHAPE::cmp_drawings::operator()(), FOOTPRINT::cmp_drawings::operator()(), KI_TEST::kitest_cmp_drawings::operator()(), PCB_TRACK::cmp_tracks::operator()(), LIB_ITEM::operator<(), SCH_ITEM::operator<(), SCH_BUS_ENTRY_BASE::operator<(), SCH_FIELD::operator<(), SCH_JUNCTION::operator<(), SCH_LINE::operator<(), SCH_SHEET::operator<(), SCH_SYMBOL::operator<(), SCH_TEXT::operator<(), SCH_TEXTBOX::operator<(), PCB_BITMAP::operator=(), SCH_BITMAP::operator=(), SCH_SYMBOL::operator=(), SCH_SHEET::operator=(), LIB_ITEM::operator==(), PAD::PAD(), EDIT_TOOL::PadFilter(), BOARD_EDITOR_CONTROL::PageSettings(), BOARD_COMMIT::parentObject(), SCH_EDITOR_CONTROL::Paste(), PCB_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), BRDITEMS_PLOTTER::PlotPcbGraphicItem(), SCH_FIELD::Print(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), BACK_ANNOTATE::processNetNameChange(), CONNECTION_GRAPH::processSubGraphs(), SCH_EDIT_TOOL::Properties(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_GRID_HELPER::queryVisible(), BOARD_REANNOTATE_TOOL::ReannotateDuplicates(), SCH_CONNECTION::recacheName(), SCH_BASE_FRAME::RefreshZoomDependentItems(), BOARD::Remove(), CN_CONNECTIVITY_ALGO::Remove(), FOOTPRINT::Remove(), EE_RTREE::remove(), SCH_SCREEN::Remove(), KIGFX::PCB_VIEW::Remove(), PCB_POINT_EDITOR::removeCorner(), PCB_POINT_EDITOR::removeCornerCondition(), LIB_SYMBOL::RemoveDrawItem(), SCH_SHEET::RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_FIELD::Replace(), SCH_EDITOR_CONTROL::ReplaceAll(), PCB_SELECTION_TOOL::RequestSelection(), CONNECTION_GRAPH::resolveAllDrivers(), SCHEMATIC::ResolveCrossReference(), PCB_PARSER::resolveGroups(), SCH_LABEL_BASE::ResolveTextVar(), DS_PROXY_UNDO_ITEM::Restore(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_TOOL::Rotate(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), EE_TOOL_BASE< T >::saveCopyInUndoList(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN_CACHE::savePin(), CLIPBOARD_IO::SaveSelection(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveTextBox(), SCH_ITEM::Schematic(), SCH_SCREEN::Schematic(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::selectSameSheet(), PCB_SELECTION_TOOL::selectUnconnected(), PCB_POINT_EDITOR::setAltConstraint(), SCH_FIELD::SetId(), ITEM_PICKER::SetItem(), SCH_FIELD::SetPosition(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), PCB_EDIT_FRAME::ShowFindDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), BOARD_COMMIT::Stage(), PNS::LINE_PLACER::Start(), SCH_EDIT_TOOL::Swap(), EDIT_TOOL::Swap(), PCB_GROUP::SwapData(), FOOTPRINT::SwapData(), PAD::SwapData(), PCB_DIM_ALIGNED::SwapData(), PCB_DIM_ORTHOGONAL::SwapData(), PCB_DIM_RADIAL::SwapData(), PCB_DIM_LEADER::SwapData(), PCB_DIM_CENTER::SwapData(), PCB_TARGET::SwapData(), PCB_TEXT::SwapData(), PCB_TEXTBOX::SwapData(), PCB_TRACK::SwapData(), PCB_ARC::SwapData(), PCB_VIA::SwapData(), ZONE::SwapData(), PCB_BITMAP::SwapData(), SCH_BITMAP::SwapData(), SCH_FIELD::SwapData(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), SCH_SHEET::SwapData(), SCH_SHEET_PIN::SwapData(), SCH_SYMBOL::SwapData(), SwapItemData(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones(), ERC_TESTER::TestMultUnitPinConflicts(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), ERC_TESTER::TestPinToPin(), ERC_TESTER::TestSimilarLabels(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), PCB_TRACK::TransformShapeWithClearanceToPolygon(), SCH_LINE_WIRE_BUS_TOOL::TrimOverLappingWires(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), KIGFX::PCB_VIEW::Update(), SCH_SHEET_PATH::UpdateAllScreenReferences(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), PL_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updateItem(), EE_TOOL_BASE< T >::updateItem(), SCH_BASE_FRAME::UpdateItem(), PCB_CONTROL::UpdateMessagePanel(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updateParentItem(), SCH_EDITOR_CONTROL::updatePastedSheet(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), PCB_POINT_EDITOR::updatePoints(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), PCB_GROUP::Visit(), SCH_SHEET::Visit(), GERBER_DRAW_ITEM::Visit(), PCB_TRACK::Visit(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and NETLIST_EXPORTER_CADSTAR::writeListOfNets().

ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const

overridevirtualinherited

Return the bounding box of the item covering all its layers.

Returns

the current bounding box.

Implements KIGFX::VIEW_ITEM.

Reimplemented in LIB_PIN, SCH_PIN, GERBER_DRAW_ITEM, DS_PROXY_VIEW_ITEM, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::PREVIEW::POLYGON_ITEM, KIGFX::PREVIEW::RULER_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, EDIT_POINTS, FOOTPRINT, FP_TEXT, PAD, PCB_DIMENSION_BASE, PCB_DIM_CENTER, PCB_MARKER, PCB_SHAPE, PCB_TRACK, RATSNEST_VIEW_ITEM, ROUTER_PREVIEW_ITEM, and MY_DRAWING.

Definition at line 254 of file eda_item.cpp.

{
 // Basic fallback
 return GetBoundingBox();
}

References EDA_ITEM::GetBoundingBox().

Referenced by GERBVIEW_FRAME::GetDocumentExtents(), EDIT_TOOL::Rotate(), PCB_DIMENSION_BASE::ViewBBox(), and PCB_SHAPE::ViewBBox().

ViewDraw()

virtual void KIGFX::VIEW_ITEM::ViewDraw ( int  aLayer, VIEW *  aView  ) const

inlinevirtualinherited

Draw the parts of the object belonging to layer aLayer.

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

Parameters

aLayer	is the current drawing layer.
aView	is a pointer to the VIEW device we are drawing on.

Reimplemented in DS_PROXY_VIEW_ITEM, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, EDIT_POINTS, RATSNEST_VIEW_ITEM, ROUTER_PREVIEW_ITEM, MY_DRAWING, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::RULER_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::ORIGIN_VIEWITEM, KIGFX::VIEW_GROUP, and KIGFX::VIEW_OVERLAY.

Definition at line 106 of file view_item.h.

 {}

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

ViewGetLayers()

void EDA_ITEM::ViewGetLayers ( int  aLayers[], int &  aCount  ) const

overridevirtualinherited

Return the all the layers within the VIEW the object is painted on.

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

Parameters

aLayers[]	is the output layer index array.
aCount	is the number of layer indices in aLayers[].

Implements KIGFX::VIEW_ITEM.

Reimplemented in LIB_FIELD, LIB_ITEM, LIB_PIN, LIB_SHAPE, LIB_SYMBOL, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_ITEM, SCH_JUNCTION, SCH_LABEL_BASE, SCH_GLOBALLABEL, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SYMBOL, SCH_TEXT, GERBER_DRAW_ITEM, BOARD_ITEM, DS_DRAW_ITEM_BASE, DS_PROXY_VIEW_ITEM, KIGFX::ORIGIN_VIEWITEM, PCB_GROUP, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::RULER_ITEM, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, EDIT_POINTS, FOOTPRINT, FP_TEXT, FP_TEXTBOX, PAD, PCB_BITMAP, PCB_MARKER, PCB_TRACK, PCB_VIA, RATSNEST_VIEW_ITEM, ROUTER_PREVIEW_ITEM, ZONE, and MY_DRAWING.

Definition at line 261 of file eda_item.cpp.

{
 // Basic fallback
 aCount = 1;
 aLayers[0] = 0;
}

ViewGetLOD()

virtual double KIGFX::VIEW_ITEM::ViewGetLOD ( int  aLayer, VIEW *  aView  ) const

inlinevirtualinherited

Return the level of detail (LOD) of the item.

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

Parameters

aLayer	is the current drawing layer.
aView	is a pointer to the VIEW device we are drawing on.

Returns

the level of detail. 0 always show the item, because the actual zoom level (or VIEW scale) is always > 0

Reimplemented in GERBER_DRAW_ITEM, PCB_GROUP, FOOTPRINT, FP_SHAPE, FP_TEXT, FP_TEXTBOX, PAD, PCB_BITMAP, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, ZONE, and FP_ZONE.

Definition at line 132 of file view_item.h.

 {
 // By default always show the item
 return 0.0;
 }

Referenced by PNS_KICAD_IFACE::IsItemVisible(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), EE_GRID_HELPER::queryVisible(), and PCB_GRID_HELPER::queryVisible().

viewPrivData()

VIEW_ITEM_DATA * KIGFX::VIEW_ITEM::viewPrivData ( ) const

inlineinherited

Definition at line 138 of file view_item.h.

 {
 return m_viewPrivData;
 }

References KIGFX::VIEW_ITEM::m_viewPrivData.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::draw(), KIGFX::VIEW::HasItem(), KIGFX::VIEW::Hide(), KIGFX::VIEW::invalidateItem(), KIGFX::VIEW::IsVisible(), KIGFX::VIEW::OnDestroy(), KIGFX::QUERY_VISITOR< CONTAINER >::operator()(), KIGFX::VIEW::UPDATE_COLOR_VISITOR::operator()(), KIGFX::VIEW::UPDATE_DEPTH_VISITOR::operator()(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), KIGFX::VIEW::RECACHE_ITEM_VISITOR::operator()(), KIGFX::VIEW::CLEAR_LAYER_CACHE_VISITOR::operator()(), KIGFX::VIEW::Remove(), KIGFX::VIEW::SetVisible(), KIGFX::VIEW::Update(), KIGFX::VIEW::updateItemColor(), KIGFX::VIEW::updateItemGeometry(), and KIGFX::VIEW::updateLayers().

Visit()

INSPECT_RESULT GERBER_FILE_IMAGE::Visit ( INSPECTOR  inspector, void *  testData, const std::vector< KICAD_T > &  aScanTypes  )

overridevirtual

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 aScanTypes, 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.
aScanTypes	Which KICAD_T types are of interest and the order in which they should be processed.

Returns

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

Reimplemented from EDA_ITEM.

Definition at line 373 of file gerber_file_image.cpp.

{
 for( KICAD_T scanType : aScanTypes )
 {
 if( scanType == GERBER_DRAW_ITEM_T )
 {
 if( IterateForward( GetItems(), inspector, testData, { scanType } ) == INSPECT_RESULT::QUIT )
 return INSPECT_RESULT::QUIT;
 }
 }
 
 return INSPECT_RESULT::CONTINUE;
}

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

Referenced by GBR_LAYOUT::Visit().

Member Data Documentation

m_360Arc_enbl

bool GERBER_FILE_IMAGE::m_360Arc_enbl

Definition at line 428 of file gerber_file_image.h.

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

m_AperFunction

wxString GERBER_FILE_IMAGE::m_AperFunction

Definition at line 447 of file gerber_file_image.h.

Referenced by Execute_DCODE_Command(), ExecuteRS274XCommand(), and RemoveAttribute().

m_Aperture_List

D_CODE* GERBER_FILE_IMAGE::m_Aperture_List[TOOLS_MAX_COUNT]

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

Whether an aperture macro tool is flashed on or off.

Definition at line 453 of file gerber_file_image.h.

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

m_aperture_macros

APERTURE_MACRO_SET GERBER_FILE_IMAGE::m_aperture_macros

Definition at line 441 of file gerber_file_image.h.

Referenced by FindApertureMacro(), and ReadApertureMacro().

m_ArcRadius

int GERBER_FILE_IMAGE::m_ArcRadius

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

Definition at line 415 of file gerber_file_image.h.

Referenced by EXCELLON_IMAGE::Execute_Drill_Command(), EXCELLON_IMAGE::Execute_EXCELLON_G_Command(), ReadXYCoord(), and ResetDefaultValues().

m_AsArcG74G75Cmd

bool GERBER_FILE_IMAGE::m_AsArcG74G75Cmd

Definition at line 432 of file gerber_file_image.h.

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

m_CommandState

int GERBER_FILE_IMAGE::m_CommandState

state of gerber analysis command

Definition at line 405 of file gerber_file_image.h.

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

m_ComponentsList

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

Definition at line 449 of file gerber_file_image.h.

Referenced by GERBER_DRAW_ITEM::SetNetAttributes(), and GERBVIEW_FRAME::updateComponentListSelectBox().

m_Current_File

FILE* GERBER_FILE_IMAGE::m_Current_File

Definition at line 419 of file gerber_file_image.h.

Referenced by ExecuteRS274XCommand(), EXCELLON_IMAGE::LoadFile(), LoadGerberFile(), ReadRS274XCommand(), and ResetDefaultValues().

m_Current_Tool

int GERBER_FILE_IMAGE::m_Current_Tool

Current Tool (Dcode) number selected.

Definition at line 402 of file gerber_file_image.h.

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

m_CurrentPos

VECTOR2I GERBER_FILE_IMAGE::m_CurrentPos

current specified coord for plot

Definition at line 407 of file gerber_file_image.h.

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

m_drawings

GERBER_DRAW_ITEMS GERBER_FILE_IMAGE::m_drawings

Definition at line 459 of file gerber_file_image.h.

Referenced by AddItemToList(), GetItems(), GetItemsCount(), GetLastItemInList(), and ~GERBER_FILE_IMAGE().

m_Exposure

bool GERBER_FILE_IMAGE::m_Exposure

Definition at line 456 of file gerber_file_image.h.

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

m_FileFunction

X2_ATTRIBUTE_FILEFUNCTION* GERBER_FILE_IMAGE::m_FileFunction

file function parameters, found in a TF command or a G04

Definition at line 373 of file gerber_file_image.h.

Referenced by ExecuteRS274XCommand(), LAYERS_MAP_DIALOG::findNumX2GerbersLoaded(), GERBER_FILE_IMAGE(), GERBER_FILE_IMAGE_LIST::GetDisplayName(), EXCELLON_IMAGE::LoadFile(), ResetDefaultValues(), sortZorder(), and ~GERBER_FILE_IMAGE().

m_FileName

wxString GERBER_FILE_IMAGE::m_FileName

Full File Name for this layer.

Definition at line 369 of file gerber_file_image.h.

Referenced by ExecuteRS274XCommand(), LAYERS_MAP_DIALOG::findNumAltiumGerbersLoaded(), LAYERS_MAP_DIALOG::findNumKiCadGerbersLoaded(), GERBER_FILE_IMAGE_LIST::GetDisplayName(), LAYERS_MAP_DIALOG::initDialog(), EXCELLON_IMAGE::LoadFile(), LoadGerberFile(), GERBVIEW_PRINTOUT::OnPrintPage(), LAYERS_MAP_DIALOG::OnSelectLayer(), GERBVIEW_CONTROL::ReloadAllLayers(), ResetDefaultValues(), GERBVIEW_INSPECTION_TOOL::ShowSource(), sortFileExtension(), DIALOG_PRINT_GERBVIEW::TransferDataToWindow(), GERBVIEW_FRAME::unarchiveFiles(), and GERBVIEW_FRAME::UpdateTitleAndInfo().

m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 498 of file eda_item.h.

Referenced by EDA_ITEM::ClearFlags(), LIB_TEXT::Clone(), DS_DRAW_ITEM_BASE::DS_DRAW_ITEM_BASE(), EDA_ITEM::GetEditFlags(), EDA_ITEM::GetFlags(), PCB_TRACK::GetMsgPanelInfoBase_Common(), SCH_LINE::GetSelectedPoints(), EDA_ITEM::HasFlag(), LIB_ITEM::HitTest(), LIB_SHAPE::HitTest(), LIB_TEXT::HitTest(), SCH_JUNCTION::HitTest(), SCH_LINE::HitTest(), SCH_SYMBOL::HitTest(), LIB_PIN::HitTest(), SCH_PIN::HitTest(), ZONE::InitDataFromSrcInCopyCtor(), EDA_ITEM::IsBrightened(), SCH_ITEM::IsConnected(), EDA_ITEM::IsDragging(), EDA_ITEM::IsEntered(), EDA_ITEM::IsModified(), EDA_ITEM::IsMoving(), EDA_ITEM::IsNew(), EDA_ITEM::IsResized(), EDA_ITEM::IsRollover(), EDA_ITEM::IsSelected(), EDA_ITEM::IsShownAsBitmap(), EDA_ITEM::IsWireImage(), SCH_LINE::MirrorHorizontally(), SCH_LINE::MirrorVertically(), EDA_ITEM::operator=(), SCH_LINE::Rotate(), EDA_ITEM::SetFlags(), and PCB_SHAPE::SwapData().

m_FmtLen

wxSize GERBER_FILE_IMAGE::m_FmtLen

Nb chars per coord. ex fmt 2.3, m_FmtLen = 5.

Definition at line 389 of file gerber_file_image.h.

Referenced by ExecuteRS274XCommand(), EXCELLON_IMAGE::readFileFormat(), ReadIJCoord(), ReadXYCoord(), ResetDefaultValues(), EXCELLON_IMAGE::SelectUnits(), and GERBVIEW_FRAME::UpdateTitleAndInfo().

m_FmtScale

wxSize GERBER_FILE_IMAGE::m_FmtScale

Fmt 2.3: m_FmtScale = 3, fmt 3.4: m_FmtScale = 4.

Definition at line 388 of file gerber_file_image.h.

Referenced by ExecuteRS274XCommand(), EXCELLON_IMAGE::readFileFormat(), ReadIJCoord(), ReadXYCoord(), ResetDefaultValues(), EXCELLON_IMAGE::SelectUnits(), and GERBVIEW_FRAME::UpdateTitleAndInfo().

m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 497 of file eda_item.h.

Referenced by ZONE::InitDataFromSrcInCopyCtor(), EDA_ITEM::IsForceVisible(), EDA_ITEM::operator=(), EDA_ITEM::SetForceVisible(), and PCB_SHAPE::SwapData().

m_GBRLayerParams

GERBER_LAYER GERBER_FILE_IMAGE::m_GBRLayerParams

Definition at line 458 of file gerber_file_image.h.

Referenced by GetLayerParams(), and ResetDefaultValues().

m_GerbMetric

bool GERBER_FILE_IMAGE::m_GerbMetric

false = Inches, true = metric

Definition at line 384 of file gerber_file_image.h.

Referenced by Execute_G_Command(), ExecuteRS274XCommand(), EXCELLON_IMAGE::LoadFile(), ReadApertureMacro(), ReadIJCoord(), EXCELLON_IMAGE::readToolInformation(), ReadXYCoord(), ResetDefaultValues(), EXCELLON_IMAGE::SelectUnits(), GERBER_DRAW_ITEM::SetLayerParameters(), and GERBVIEW_FRAME::UpdateTitleAndInfo().

m_GraphicLayer

int GERBER_FILE_IMAGE::m_GraphicLayer

Graphic layer Number.

Definition at line 377 of file gerber_file_image.h.

Referenced by DisplayImageInfo(), GERBER_FILE_IMAGE(), GERBER_DRAW_ITEM::GetLayer(), GERBER_FILE_IMAGE_LIST::GetLayerRemap(), and HasNegativeItems().

m_Has_DCode

bool GERBER_FILE_IMAGE::m_Has_DCode

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

Definition at line 424 of file gerber_file_image.h.

Referenced by ExecuteRS274XCommand(), GERBVIEW_FRAME::Read_GERBER_File(), EXCELLON_IMAGE::readToolInformation(), and ResetDefaultValues().

m_Has_MissingDCode

bool GERBER_FILE_IMAGE::m_Has_MissingDCode

Definition at line 427 of file gerber_file_image.h.

Referenced by Execute_DCODE_Command(), GERBVIEW_FRAME::Read_GERBER_File(), and ResetDefaultValues().

m_hasNegativeItems

int GERBER_FILE_IMAGE::m_hasNegativeItems

private

True if the image is negative or has some negative items.

Used to optimize drawing because when there are no negative items screen refresh does not need to build an intermediate bitmap specific to this image.

• -1 negative items are.
• 0 no negative items found.
• 1 have negative items found.

Definition at line 474 of file gerber_file_image.h.

Referenced by HasNegativeItems(), and ResetDefaultValues().

m_IJPos

VECTOR2I GERBER_FILE_IMAGE::m_IJPos

IJ coord (for arcs & circles )

True if a IJ coord was read (for arcs & circles ).

Definition at line 409 of file gerber_file_image.h.

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

m_ImageJustifyOffset

VECTOR2I GERBER_FILE_IMAGE::m_ImageJustifyOffset

Image Justify Offset on XY axis (default = 0,0)

Definition at line 382 of file gerber_file_image.h.

Referenced by DisplayImageInfo(), ExecuteRS274XCommand(), GERBER_DRAW_ITEM::GetABPosition(), GERBER_DRAW_ITEM::GetXYPosition(), and ResetDefaultValues().

m_ImageJustifyXCenter

bool GERBER_FILE_IMAGE::m_ImageJustifyXCenter

Image Justify Center on X axis (default = false)

Definition at line 380 of file gerber_file_image.h.

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

m_ImageJustifyYCenter

bool GERBER_FILE_IMAGE::m_ImageJustifyYCenter

Image Justify Center on Y axis (default = false)

Definition at line 381 of file gerber_file_image.h.

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

m_ImageName

wxString GERBER_FILE_IMAGE::m_ImageName

Image name, from IN <name>* command.

Definition at line 370 of file gerber_file_image.h.

Referenced by DisplayImageInfo(), ExecuteRS274XCommand(), ResetDefaultValues(), and GERBVIEW_FRAME::UpdateTitleAndInfo().

m_ImageNegative

bool GERBER_FILE_IMAGE::m_ImageNegative

true = Negative image

Definition at line 378 of file gerber_file_image.h.

Referenced by DisplayImageInfo(), KIGFX::GERBVIEW_PAINTER::draw(), ExecuteRS274XCommand(), GERBER_DRAW_ITEM::HasNegativeItems(), HasNegativeItems(), GERBER_DRAW_ITEM::Print(), GERBVIEW_FRAME::Read_GERBER_File(), and ResetDefaultValues().

m_ImageOffset

VECTOR2I GERBER_FILE_IMAGE::m_ImageOffset

Coord Offset, from IO command.

Definition at line 387 of file gerber_file_image.h.

Referenced by ExecuteRS274XCommand(), GERBER_DRAW_ITEM::GetABPosition(), GERBER_DRAW_ITEM::GetXYPosition(), and ResetDefaultValues().

m_ImageRotation

int GERBER_FILE_IMAGE::m_ImageRotation

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

Definition at line 391 of file gerber_file_image.h.

Referenced by DisplayImageInfo(), ExecuteRS274XCommand(), GERBER_DRAW_ITEM::GetABPosition(), GERBER_DRAW_ITEM::GetXYPosition(), and ResetDefaultValues().

m_InUse

bool GERBER_FILE_IMAGE::m_InUse

true if this image is currently in use (a file is loaded in it) false if it must be not drawn

Definition at line 365 of file gerber_file_image.h.

Referenced by GetDcodesCount(), EXCELLON_IMAGE::LoadFile(), LoadGerberFile(), GERBVIEW_CONTROL::ReloadAllLayers(), ResetDefaultValues(), sortFileExtension(), and sortZorder().

m_IsX2_file

bool GERBER_FILE_IMAGE::m_IsX2_file

True if a X2 gerber attribute was found in file.

Definition at line 372 of file gerber_file_image.h.

Referenced by DisplayImageInfo(), ExecuteRS274XCommand(), LAYERS_MAP_DIALOG::findNumX2GerbersLoaded(), ResetDefaultValues(), GERBVIEW_FRAME::unarchiveFiles(), and GERBVIEW_FRAME::UpdateTitleAndInfo().

m_Iterpolation

int GERBER_FILE_IMAGE::m_Iterpolation

Linear, 90 arc, Circ.

Definition at line 401 of file gerber_file_image.h.

Referenced by Execute_DCODE_Command(), EXCELLON_IMAGE::Execute_Drill_Command(), EXCELLON_IMAGE::Execute_EXCELLON_G_Command(), Execute_G_Command(), ExecuteRS274XCommand(), and ResetDefaultValues().

m_Last_Pen_Command

int GERBER_FILE_IMAGE::m_Last_Pen_Command

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

Definition at line 403 of file gerber_file_image.h.

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

m_LastArcDataType

LAST_EXTRA_ARC_DATA_TYPE GERBER_FILE_IMAGE::m_LastArcDataType

Definition at line 418 of file gerber_file_image.h.

Referenced by EXCELLON_IMAGE::Execute_Drill_Command(), EXCELLON_IMAGE::Execute_EXCELLON_G_Command(), ReadIJCoord(), ReadXYCoord(), and ResetDefaultValues().

m_LastCoordIsIJPos

bool GERBER_FILE_IMAGE::m_LastCoordIsIJPos

A value ( = radius in circular routing in Excellon files ).

Definition at line 412 of file gerber_file_image.h.

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

m_LineNum

int GERBER_FILE_IMAGE::m_LineNum

Line number of the gerber file while reading.

Definition at line 406 of file gerber_file_image.h.

Referenced by ExecuteRS274XCommand(), GetEndOfBlock(), GetNextLine(), LoadGerberFile(), ReadApertureMacro(), ReadRS274XCommand(), and ResetDefaultValues().

m_LocalRotation

double GERBER_FILE_IMAGE::m_LocalRotation

Local rotation added to m_ImageRotation.

Note

This value is stored in 0.1 degrees

Definition at line 392 of file gerber_file_image.h.

Referenced by ExecuteRS274XCommand(), ResetDefaultValues(), and GERBER_DRAW_ITEM::SetLayerParameters().

m_MD5_value

wxString GERBER_FILE_IMAGE::m_MD5_value

MD5 value found in a TF.MD5 command.

Definition at line 375 of file gerber_file_image.h.

Referenced by ExecuteRS274XCommand(), and ResetDefaultValues().

m_messagesList

wxArrayString GERBER_FILE_IMAGE::m_messagesList

private

Definition at line 462 of file gerber_file_image.h.

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

m_MirrorA

bool GERBER_FILE_IMAGE::m_MirrorA

true: mirror / axis A (X)

Definition at line 399 of file gerber_file_image.h.

Referenced by ExecuteRS274XCommand(), ResetDefaultValues(), and GERBER_DRAW_ITEM::SetLayerParameters().

m_MirrorB

bool GERBER_FILE_IMAGE::m_MirrorB

true: mirror / axis B (Y)

Definition at line 400 of file gerber_file_image.h.

Referenced by ExecuteRS274XCommand(), ResetDefaultValues(), and GERBER_DRAW_ITEM::SetLayerParameters().

m_NetAttributeDict

GBR_NETLIST_METADATA GERBER_FILE_IMAGE::m_NetAttributeDict

Definition at line 444 of file gerber_file_image.h.

Referenced by Execute_DCODE_Command(), ExecuteRS274XCommand(), fillArcGBRITEM(), fillArcPOLY(), fillFlashedGBRITEM(), fillLineGBRITEM(), and RemoveAttribute().

m_NetnamesList

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

Definition at line 450 of file gerber_file_image.h.

Referenced by GERBER_DRAW_ITEM::SetNetAttributes(), and GERBVIEW_FRAME::updateNetnameListSelectBox().

m_NoTrailingZeros

bool GERBER_FILE_IMAGE::m_NoTrailingZeros

true: remove tailing zeros.

Definition at line 386 of file gerber_file_image.h.

Referenced by EXCELLON_IMAGE::Execute_HEADER_And_M_Command(), ExecuteRS274XCommand(), EXCELLON_IMAGE::LoadFile(), ReadIJCoord(), ReadXYCoord(), ResetDefaultValues(), EXCELLON_IMAGE::ResetDefaultValues(), and GERBVIEW_FRAME::UpdateTitleAndInfo().

m_Offset

VECTOR2I GERBER_FILE_IMAGE::m_Offset

Coord Offset, from OF command.

Definition at line 395 of file gerber_file_image.h.

Referenced by EXCELLON_IMAGE::Execute_EXCELLON_G_Command(), ExecuteRS274XCommand(), ResetDefaultValues(), and GERBER_DRAW_ITEM::SetLayerParameters().

m_parent

EDA_ITEM* EDA_ITEM::m_parent

protectedinherited

Linked list: Link (parent struct)

Definition at line 496 of file eda_item.h.

Referenced by LIB_TEXT::Clone(), LIB_FIELD::Copy(), SCH_FIELD::DoHypertextAction(), FP_TEXT::FP_TEXT(), SCH_FIELD::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), SCH_FIELD::GetDrawRotation(), FP_TEXT::GetDrawRotation(), FP_TEXTBOX::GetDrawRotation(), SCH_FIELD::GetMenuImage(), FP_SHAPE::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_FIELD::GetName(), LIB_ITEM::GetParent(), SCH_SHEET_PIN::GetParent(), BOARD_ITEM::GetParent(), EDA_ITEM::GetParent(), PAD::GetParent(), FP_SHAPE::GetParentAsString(), FP_TEXT::GetParentAsString(), FP_TEXTBOX::GetParentAsString(), PAD::GetParentAsString(), SCH_FIELD::GetParentPosition(), SCH_FIELD::GetPosition(), SCH_FIELD::GetShownText(), LIB_FIELD::HitTest(), SCH_FIELD::IsHypertext(), SCH_FIELD::IsReplaceable(), SCH_PIN::IsStacked(), SCH_FIELD::Matches(), EDA_ITEM::operator=(), LIB_FIELD::operator=(), PAD::PAD(), SCH_FIELD::Plot(), SCH_FIELD::Print(), SCH_FIELD::Replace(), SCH_LABEL_BASE::ResolveTextVar(), SCH_SYMBOL::SCH_SYMBOL(), FP_SHAPE::SetDrawCoord(), FP_TEXT::SetDrawCoord(), PAD::SetDrawCoord(), SCH_FIELD::SetId(), FP_SHAPE::SetLocalCoord(), FP_TEXT::SetLocalCoord(), PAD::SetLocalCoord(), EDA_ITEM::SetModified(), EDA_ITEM::SetParent(), SCH_FIELD::SetPosition(), and PCB_SHAPE::SwapData().

m_PartString

wxString GERBER_FILE_IMAGE::m_PartString

string found in a TF.Part command

Definition at line 376 of file gerber_file_image.h.

Referenced by ExecuteRS274XCommand(), and ResetDefaultValues().

m_PolygonFillMode

bool GERBER_FILE_IMAGE::m_PolygonFillMode

Definition at line 435 of file gerber_file_image.h.

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

m_PolygonFillModeState

int GERBER_FILE_IMAGE::m_PolygonFillModeState

a collection of APERTURE_MACROS, sorted by name

Definition at line 438 of file gerber_file_image.h.

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

m_PositiveDrawColor

COLOR4D GERBER_FILE_IMAGE::m_PositiveDrawColor

The color used to draw positive items.

Definition at line 368 of file gerber_file_image.h.

Referenced by GERBER_FILE_IMAGE(), and GetPositiveDrawColor().

m_PreviousPos

VECTOR2I GERBER_FILE_IMAGE::m_PreviousPos

old current specified coord for plot

Definition at line 408 of file gerber_file_image.h.

Referenced by Execute_DCODE_Command(), EXCELLON_IMAGE::Execute_Drill_Command(), and ResetDefaultValues().

m_Relative

bool GERBER_FILE_IMAGE::m_Relative

false = absolute Coord, true = relative Coord.

Definition at line 385 of file gerber_file_image.h.

Referenced by EXCELLON_IMAGE::Execute_EXCELLON_G_Command(), Execute_G_Command(), EXCELLON_IMAGE::Execute_HEADER_And_M_Command(), ExecuteRS274XCommand(), ReadXYCoord(), and ResetDefaultValues().

m_Scale

VECTOR2I GERBER_FILE_IMAGE::m_Scale

scale (X and Y) of layer.

Definition at line 396 of file gerber_file_image.h.

Referenced by ExecuteRS274XCommand(), ResetDefaultValues(), and GERBER_DRAW_ITEM::SetLayerParameters().

m_Selected_Tool

int GERBER_FILE_IMAGE::m_Selected_Tool

Definition at line 421 of file gerber_file_image.h.

Referenced by GERBER_FILE_IMAGE(), GERBVIEW_CONTROL::HighlightControl(), GERBVIEW_FRAME::OnSelectActiveDCode(), GERBVIEW_FRAME::OnUpdateSelectDCode(), ResetDefaultValues(), and GERBVIEW_FRAME::syncLayerBox().

m_status

EDA_ITEM_FLAGS EDA_ITEM::m_status

protectedinherited

Definition at line 495 of file eda_item.h.

Referenced by EDA_ITEM::GetState(), EDA_ITEM::GetStatus(), EDA_ITEM::operator=(), EDA_ITEM::SetState(), EDA_ITEM::SetStatus(), and PCB_SHAPE::SwapData().

m_structType

KICAD_T EDA_ITEM::m_structType

privateinherited

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

See comment near SetType() regarding virtual functions.

Definition at line 505 of file eda_item.h.

Referenced by EDA_ITEM::IsType(), EDA_ITEM::operator=(), and EDA_ITEM::Type().

m_SwapAxis

bool GERBER_FILE_IMAGE::m_SwapAxis

false if A = X and B = Y (default); true if A = Y, B = X

Definition at line 397 of file gerber_file_image.h.

Referenced by ExecuteRS274XCommand(), ResetDefaultValues(), and GERBER_DRAW_ITEM::SetLayerParameters().

m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 492 of file eda_item.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), SCH_SYMBOL::AddHierarchicalReference(), RC_ITEM::AddItem(), SCH_EDIT_FRAME::AnnotateSymbols(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), KI_TEST::CheckFpPad(), KI_TEST::CheckFpShape(), KI_TEST::CheckFpText(), KI_TEST::CheckFpZone(), SCH_SHEET_PATH::Cmp(), SCHEMATIC::ConvertRefsToKIIDs(), MICROWAVE_TOOL::createMicrowaveInductor(), ZONE_FILLER_TOOL::DirtyZone(), DRAWING_TOOL::DrawVia(), LIB_SYMBOL::Duplicate(), BOARD_ITEM::Duplicate(), FOOTPRINT::Duplicate(), SCH_ITEM::Duplicate(), FOOTPRINT::DuplicateItem(), PCB_EDIT_FRAME::ExchangeFootprint(), PAD_TOOL::explodePad(), SCH_SHEET_LIST::FillItemMap(), BOARD::FillItemMap(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), SCH_EDIT_FRAME::FocusOnItem(), PCB_PLUGIN::format(), SCH_SEXPR_PLUGIN::Format(), SCH_PIN::GetDefaultNetName(), BOARD::GetItem(), SCH_SHEET_LIST::GetItem(), PAD::GetMsgPanelInfo(), DIALOG_BOARD_REANNOTATE::GetNewRefDes(), FP_SHAPE::GetParentAsString(), FP_TEXT::GetParentAsString(), FP_TEXTBOX::GetParentAsString(), PAD::GetParentAsString(), SCH_REFERENCE::GetPath(), SCH_MARKER::GetUUID(), PCB_MARKER::GetUUID(), FIELDS_EDITOR_GRID_DATA_MODEL::GetValue(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), ZONE::HigherPriority(), SCH_SHEET_PATH::IsContainedWithin(), LEGACY_PLUGIN::loadFOOTPRINT(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), PCB_EDIT_FRAME::LoadFootprints(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_LEGACY_PLUGIN::loadSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), LEGACY_PLUGIN::loadTrackList(), PNS::LOGGER::Log(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_EDIT_FRAME::mapExistingAnnotation(), BOARD_ITEM::ptr_cmp::operator()(), BOARD::cmp_items::operator()(), BOARD::cmp_drawings::operator()(), PCB_SHAPE::cmp_drawings::operator()(), FOOTPRINT::cmp_drawings::operator()(), FOOTPRINT::cmp_zones::operator()(), FOOTPRINT::cmp_pads::operator()(), PCB_TRACK::cmp_tracks::operator()(), SCH_ITEM::operator<(), SCH_SYMBOL::operator<(), PAD::PAD(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_EDITOR_CONTROL::Paste(), SCH_SHEET_PATH::PathAsString(), SCH_SHEET_PATH::PathWithoutRootUuid(), FIELDS_EDITOR_GRID_DATA_MODEL::RemoveColumn(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_SYMBOL::ReplaceInstanceSheetPath(), PCB_PARSER::resolveGroups(), SCH_SEXPR_PLUGIN::saveBitmap(), SCH_SEXPR_PLUGIN::saveBusEntry(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN::saveJunction(), SCH_SEXPR_PLUGIN::saveLine(), SCH_SEXPR_PLUGIN::saveNoConnect(), SCH_EDIT_FRAME::SaveProject(), SCH_SEXPR_PLUGIN::saveShape(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_LEGACY_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN::saveTextBox(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SHEET::SCH_SHEET(), SCH_SYMBOL::SCH_SYMBOL(), RC_ITEM::SetItems(), FIELDS_EDITOR_GRID_DATA_MODEL::SetValue(), SwapItemData(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), testGroupEqual(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), SCH_EDITOR_CONTROL::updatePastedSheet(), SCH_EDITOR_CONTROL::updatePastedSymbol(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 151 of file view_item.h.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW_ITEM::ClearViewPrivData(), KIGFX::VIEW_ITEM::viewPrivData(), and KIGFX::VIEW_ITEM::~VIEW_ITEM().

---

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

• gerber_file_image.h
• gerber_file_image.cpp
• readgerb.cpp
• rs274_read_XY_and_IJ_coordinates.cpp
• rs274d.cpp
• rs274x.cpp