KiCad PCB EDA Suite
BASE_SCREEN Class Referenceabstract

Class BASE_SCREEN handles how to draw a screen (a board, a schematic ...) More...

#include <base_screen.h>

Inheritance diagram for BASE_SCREEN:
EDA_ITEM KIGFX::VIEW_ITEM GBR_SCREEN PCB_SCREEN PL_EDITOR_SCREEN SCH_SCREEN

Public Member Functions

 BASE_SCREEN (KICAD_T aType=SCREEN_T)
 
 ~BASE_SCREEN ()
 
void SetCurItem (EDA_ITEM *aItem)
 Function SetCurItem sets the currently selected object, m_CurrentItem. More...
 
EDA_ITEMGetCurItem () const
 
void InitDataPoints (const wxSize &aPageSizeInternalUnits)
 
virtual int MilsToIuScalar ()
 Function MilsToIuScalar returns the scalar required to convert mils to internal units. More...
 
virtual void ClearUndoORRedoList (UNDO_REDO_CONTAINER &aList, int aItemCount=-1)=0
 Function ClearUndoORRedoList (virtual). More...
 
virtual void ClearUndoRedoList ()
 Function ClearUndoRedoList clear undo and redo list, using ClearUndoORRedoList() picked items are deleted by ClearUndoORRedoList() according to their status. More...
 
virtual void PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
 Function PushCommandToUndoList add a command to undo in undo list delete the very old commands when the max count of undo commands is reached ( using ClearUndoORRedoList) More...
 
virtual void PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
 Function PushCommandToRedoList add a command to redo in redo list delete the very old commands when the max count of redo commands is reached ( using ClearUndoORRedoList) More...
 
virtual PICKED_ITEMS_LISTPopCommandFromUndoList ()
 PopCommandFromUndoList return the last command to undo and remove it from list nothing is deleted. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromRedoList ()
 PopCommandFromRedoList return the last command to undo and remove it from list nothing is deleted. More...
 
int GetUndoCommandCount () const
 
int GetRedoCommandCount () const
 
int GetMaxUndoItems () const
 
void SetMaxUndoItems (int aMax)
 
void SetModify ()
 
void ClrModify ()
 
void SetSave ()
 
void ClrSave ()
 
bool IsModify () const
 
bool IsSave () const
 
double GetZoom () const
 Function GetZoom returns the current "zoom factor", which is a measure of "internal units per device unit", or "world units per device unit". More...
 
virtual bool SetZoom (double iu_per_du)
 Function SetZoom adjusts the current zoom factor. More...
 
bool SetNextZoom ()
 
bool SetPreviousZoom ()
 
bool SetFirstZoom ()
 
bool SetLastZoom ()
 
double GetMaxAllowedZoom () const
 Function GetMaxAllowedZoom returns the maximum allowed zoom factor, which was established as the last entry in m_ZoomList. More...
 
double GetMinAllowedZoom () const
 Function GetMinAllowedZoom returns the minimum allowed zoom factor, which was established as the first entry in m_ZoomList. More...
 
void SetScalingFactor (double iu_per_du)
 Function SetScalingFactor sets the scaling factor of "internal unit per device unit". More...
 
double GetScalingFactor () const
 Function GetScalingFactor returns the inverse of the current scale used to draw items on screen. More...
 
int GetGridCmdId () const
 Return the command ID of the currently selected grid. More...
 
const wxRealPoint & GetGridSize () const
 Return the grid size of the currently selected grid. More...
 
const GRID_TYPEGetGrid () const
 Return the grid object of the currently selected grid. More...
 
int SetGrid (const wxRealPoint &size)
 set the current grid size m_Grid. More...
 
int SetGrid (int aCommandId)
 Function SetGrid sets the grid size from command ID (not an index in grid list, but a wxID). More...
 
void SetGridList (GRIDS &sizelist)
 
void AddGrid (const GRID_TYPE &grid)
 
void AddGrid (const wxRealPoint &size, int id)
 
void AddGrid (const wxRealPoint &size, EDA_UNITS_T aUnit, int id)
 
bool GridExists (int aCommandId)
 Function GridExists tests for grid command ID (not an index in grid list, but a wxID) exists in grid list. More...
 
size_t GetGridCount () const
 Function GetGridCount(). More...
 
GRID_TYPEGetGrid (size_t aIndex)
 Function GetGrid() Returns the grid object at aIndex. More...
 
const GRIDSGetGrids () const
 Function GetGrids(). More...
 
int BuildGridsChoiceList (wxArrayString &aGridsList, bool aMmFirst) const
 Function BuildGridsChoiceList(). More...
 
virtual wxString GetClass () const override
 Function GetClass returns the class name. More...
 
bool IsBlockActive () const
 
void ClearBlockCommand ()
 
KICAD_T Type () const
 Function Type() More...
 
void SetTimeStamp (timestamp_t aNewTimeStamp)
 
timestamp_t GetTimeStamp () const
 
EDA_ITEMNext () const
 
EDA_ITEMBack () const
 
EDA_ITEMGetParent () const
 
DHEADGetList () const
 
void SetNext (EDA_ITEM *aNext)
 
void SetBack (EDA_ITEM *aBack)
 
void SetParent (EDA_ITEM *aParent)
 
void SetList (DHEAD *aList)
 
bool IsNew () const
 
bool IsModified () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsResized () const
 
bool IsHighlighted () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetHighlighted ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearHighlighted ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (int type) const
 
void SetState (int type, int state)
 
STATUS_FLAGS GetStatus () const
 
void SetStatus (STATUS_FLAGS aStatus)
 
void SetFlags (STATUS_FLAGS aMask)
 
void ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
STATUS_FLAGS GetFlags () const
 
bool IsType (const KICAD_T aScanTypes[])
 Function IsType Checks whether the item is one of the listed types. More...
 
void SetForceVisible (bool aEnable)
 Function SetForceVisible is used to set and cleag force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
 
virtual void GetMsgPanelInfo (EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM > &aList)
 Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
 
virtual bool HitTest (const wxPoint &aPosition) const
 Function HitTest tests if aPosition is contained within or on the bounding area of an item. More...
 
virtual const EDA_RECT GetBoundingBox () const
 Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes. More...
 
virtual EDA_ITEMClone () const
 Function Clone creates a duplicate of this item with linked list members set to NULL. More...
 
virtual SEARCH_RESULT Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 Function Visit may be re-implemented for each derived class in order to handle all the types given by its member data. More...
 
virtual wxString GetSelectMenuText (EDA_UNITS_T aUnits) const
 Function GetSelectMenuText returns the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
 
virtual BITMAP_DEF GetMenuImage () const
 Function GetMenuImage returns a pointer to an image to be used in menus. More...
 
virtual bool Matches (wxFindReplaceData &aSearchData, void *aAuxData, wxPoint *aFindLocation)
 Function Matches compares the item against the search criteria in aSearchData. More...
 
bool Replace (wxFindReplaceData &aSearchData, wxString &aText)
 Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool Replace (wxFindReplaceData &aSearchData, void *aAuxData=NULL)
 Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool IsReplaceable () const
 Function IsReplaceable. More...
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
virtual const BOX2I ViewBBox () const override
 Function ViewBBox() returns the bounding box of the item covering all its layers. More...
 
virtual void ViewGetLayers (int aLayers[], int &aCount) const override
 Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Function ViewDraw() Draws the parts of the object belonging to layer aLayer. More...
 
virtual unsigned int ViewGetLOD (int aLayer, VIEW *aView) const
 Function ViewGetLOD() Returns the level of detail (LOD) of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 

Static Public Member Functions

static SEARCH_RESULT IterateForward (EDA_ITEM *listStart, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 Function IterateForward walks through the object tree calling the inspector() on each object type requested in scanTypes. More...
 
static bool Sort (const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
 Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...
 

Public Attributes

wxPoint m_DrawOrg
 offsets for drawing the circuit on the screen More...
 
wxPoint m_O_Curseur
 Relative Screen cursor coordinate (on grid) in user units. More...
 
int m_ScrollPixelsPerUnitX
 Pixels per scroll unit in the horizontal direction. More...
 
int m_ScrollPixelsPerUnitY
 Pixels per scroll unit in the vertical direction. More...
 
wxSize m_ScrollbarNumber
 Current virtual draw area size in scroll units. More...
 
wxPoint m_ScrollbarPos
 Current scroll bar position in scroll units. More...
 
wxPoint m_StartVisu
 Coordinates in drawing units of the current view position (upper left corner of device) More...
 
bool m_Center
 Center on screen. More...
 
bool m_Initialized
 
UNDO_REDO_CONTAINER m_UndoList
 Objects list for the undo command (old data) More...
 
UNDO_REDO_CONTAINER m_RedoList
 Objects list for the redo command (old data) More...
 
BLOCK_SELECTOR m_BlockLocate
 Block description for block commands. More...
 
int m_ScreenNumber
 
int m_NumberOfScreens
 
std::vector< double > m_ZoomList
 standard zoom (i.e. scale) coefficients. More...
 
bool m_IsPrinting
 

Static Public Attributes

static wxString m_PageLayoutDescrFileName
 the name of the page layout descr file, or emty to used the default pagelayout More...
 

Protected Member Functions

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

Protected Attributes

EDA_ITEMPnext
 next in linked list More...
 
EDA_ITEMPback
 previous in linked list More...
 
DHEADm_List
 which DLIST I am on. More...
 
EDA_ITEMm_Parent
 Linked list: Link (parent struct) More...
 
timestamp_t m_TimeStamp
 Time stamp used for logical links. More...
 
bool m_forceVisible
 Set to true to override the visibility setting of the item. More...
 
STATUS_FLAGS m_Flags
 Flag bits for editing and other uses. More...
 

Private Member Functions

wxPoint getCrossHairPosition (bool aInvertY) const
 Function getCrossHairPosition return the current cross hair position in logical (drawing) coordinates. More...
 
void setCrossHairPosition (const wxPoint &aPosition, const wxPoint &aGridOrigin, bool aSnapToGrid)
 Function setCrossHairPosition sets the screen cross hair position to aPosition in logical (drawing) units. More...
 
wxPoint getCrossHairScreenPosition () const
 Function getCursorScreenPosition returns the cross hair position in device (display) units.b. More...
 
wxPoint getNearestGridPosition (const wxPoint &aPosition, const wxPoint &aGridOrigin, wxRealPoint *aGridSize) const
 Function getNearestGridPosition returns the nearest aGridSize location to aPosition. More...
 
wxPoint getCursorPosition (bool aOnGrid, const wxPoint &aGridOrigin, wxRealPoint *aGridSize) const
 Function getCursorPosition returns the current cursor position in logical (drawing) units. More...
 
void setMousePosition (const wxPoint &aPosition)
 
wxPoint refPos (bool useMouse) const
 Function RefPos Return the reference position, coming from either the mouse position or the cursor position. More...
 
const wxPointgetScrollCenterPosition () const
 
void setScrollCenterPosition (const wxPoint &aPoint)
 

Private Attributes

GRIDS m_grids
 List of valid grid sizes. More...
 
bool m_FlagModified
 Indicates current drawing has been modified. More...
 
bool m_FlagSave
 Indicates automatic file save. More...
 
EDA_ITEMm_CurrentItem
 Currently selected object. More...
 
GRID_TYPE m_Grid
 Current grid selection. More...
 
wxPoint m_scrollCenter
 Current scroll center point in logical units. More...
 
wxPoint m_MousePosition
 Mouse cursor coordinate in logical units. More...
 
int m_UndoRedoCountMax
 undo/Redo command Max depth More...
 
wxPoint m_crossHairPosition
 The cross hair position in logical (drawing) units. More...
 
double m_Zoom
 Current zoom coefficient. More...
 

Friends

class EDA_DRAW_FRAME
 

Detailed Description

Class BASE_SCREEN handles how to draw a screen (a board, a schematic ...)

Definition at line 76 of file base_screen.h.

Constructor & Destructor Documentation

BASE_SCREEN::BASE_SCREEN ( KICAD_T  aType = SCREEN_T)

Definition at line 42 of file base_screen.cpp.

References DEFAULT_MAX_UNDO_ITEMS, ID_POPUP_GRID_LEVEL_50, m_Center, GRID_TYPE::m_CmdId, m_FlagModified, m_FlagSave, m_Grid, m_Initialized, m_IsPrinting, m_NumberOfScreens, m_ScreenNumber, m_ScrollPixelsPerUnitX, m_ScrollPixelsPerUnitY, GRID_TYPE::m_Size, m_UndoRedoCountMax, m_Zoom, and SetCurItem().

42  :
43  EDA_ITEM( aType )
44 {
46  m_Initialized = false;
47  m_ScreenNumber = 1;
48  m_NumberOfScreens = 1; // Hierarchy: Root: ScreenNumber = 1
49  m_Zoom = 32.0;
50  m_Grid.m_Size = wxRealPoint( 50, 50 ); // Default grid size
52  m_Center = true;
53  m_IsPrinting = false;
56 
57  m_FlagModified = false; // Set when any change is made on board.
58  m_FlagSave = false; // Used in auto save set when an auto save is required.
59 
60  SetCurItem( NULL );
61 }
void SetCurItem(EDA_ITEM *aItem)
Function SetCurItem sets the currently selected object, m_CurrentItem.
Definition: base_screen.h:231
int m_UndoRedoCountMax
undo/Redo command Max depth
Definition: base_screen.h:86
int m_ScreenNumber
Definition: base_screen.h:216
bool m_FlagModified
Indicates current drawing has been modified.
Definition: base_screen.h:80
int m_ScrollPixelsPerUnitY
Pixels per scroll unit in the vertical direction.
Definition: base_screen.h:190
#define DEFAULT_MAX_UNDO_ITEMS
Definition: draw_frame.h:47
GRID_TYPE m_Grid
Current grid selection.
Definition: base_screen.h:83
bool m_Center
Center on screen.
Definition: base_screen.h:202
bool m_Initialized
Definition: base_screen.h:207
int m_ScrollPixelsPerUnitX
Pixels per scroll unit in the horizontal direction.
Definition: base_screen.h:189
wxRealPoint m_Size
Definition: base_screen.h:49
bool m_IsPrinting
Definition: base_screen.h:220
EDA_ITEM(EDA_ITEM *parent, KICAD_T idType)
Definition: base_struct.cpp:64
bool m_FlagSave
Indicates automatic file save.
Definition: base_screen.h:81
int m_NumberOfScreens
Definition: base_screen.h:217
double m_Zoom
Current zoom coefficient.
Definition: base_screen.h:95
int m_CmdId
Definition: base_screen.h:48
BASE_SCREEN::~BASE_SCREEN ( )

Definition at line 64 of file base_screen.cpp.

65 {
66 }

Member Function Documentation

void BASE_SCREEN::AddGrid ( const GRID_TYPE grid)

Definition at line 286 of file base_screen.cpp.

References i, ID_POPUP_GRID_USER, GRID_TYPE::m_CmdId, m_grids, and GRID_TYPE::m_Size.

Referenced by AddGrid(), GBR_SCREEN::GBR_SCREEN(), PCB_SCREEN::PCB_SCREEN(), PL_EDITOR_SCREEN::PL_EDITOR_SCREEN(), SCH_SCREEN::SCH_SCREEN(), and DIALOG_SET_GRID::TransferDataFromWindow().

287 {
288  for( unsigned i = 0; i < m_grids.size(); i++ )
289  {
290  if( m_grids[i].m_Size == grid.m_Size && grid.m_CmdId != ID_POPUP_GRID_USER )
291  {
292  wxLogDebug( wxT( "Discarding duplicate grid size( %g, %g )." ),
293  grid.m_Size.x, grid.m_Size.y );
294  return;
295  }
296 
297  if( m_grids[i].m_CmdId == grid.m_CmdId )
298  {
299  wxLogDebug( wxT( "Changing grid ID %d from size( %g, %g ) to " ) \
300  wxT( "size( %g, %g )." ),
301  grid.m_CmdId, m_grids[i].m_Size.x,
302  m_grids[i].m_Size.y, grid.m_Size.x, grid.m_Size.y );
303  m_grids[i].m_Size = grid.m_Size;
304  return;
305  }
306  }
307 
308  m_grids.push_back( grid );
309 }
wxRealPoint m_Size
Definition: base_screen.h:49
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:79
size_t i
Definition: json11.cpp:597
int m_CmdId
Definition: base_screen.h:48
void BASE_SCREEN::AddGrid ( const wxRealPoint &  size,
int  id 
)

Definition at line 312 of file base_screen.cpp.

References AddGrid(), GRID_TYPE::m_CmdId, and GRID_TYPE::m_Size.

313 {
314  GRID_TYPE grid;
315 
316  grid.m_Size = size;
317  grid.m_CmdId = id;
318  AddGrid( grid );
319 }
wxRealPoint m_Size
Definition: base_screen.h:49
void AddGrid(const GRID_TYPE &grid)
Class GRID_TYPE is for grid arrays.
Definition: base_screen.h:45
int m_CmdId
Definition: base_screen.h:48
void BASE_SCREEN::AddGrid ( const wxRealPoint &  size,
EDA_UNITS_T  aUnit,
int  id 
)

Definition at line 322 of file base_screen.cpp.

References AddGrid(), From_User_Unit(), GRID_TYPE::m_CmdId, and GRID_TYPE::m_Size.

323 {
324  wxRealPoint new_size;
325  GRID_TYPE new_grid;
326 
327  new_size.x = From_User_Unit( aUnit, size.x );
328  new_size.y = From_User_Unit( aUnit, size.y );
329  new_grid.m_CmdId = id;
330  new_grid.m_Size = new_size;
331 
332  AddGrid( new_grid );
333 }
double From_User_Unit(EDA_UNITS_T aUnits, double aValue, bool aUseMils)
Return in internal units the value "val" given in a real unit such as "in", "mm" or "deg"...
Definition: base_units.cpp:278
wxRealPoint m_Size
Definition: base_screen.h:49
void AddGrid(const GRID_TYPE &grid)
Class GRID_TYPE is for grid arrays.
Definition: base_screen.h:45
int m_CmdId
Definition: base_screen.h:48
EDA_ITEM* EDA_ITEM::Back ( ) const
inlineinherited

Definition at line 207 of file base_struct.h.

References EDA_ITEM::Pback.

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

207 { return Pback; }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:165
int BASE_SCREEN::BuildGridsChoiceList ( wxArrayString &  aGridsList,
bool  aMmFirst 
) const

Function BuildGridsChoiceList().

Build the human readable list of grid list, for menus or combo boxes the list shows the grid size both in mils or mm.

Parameters
aGridsList= a wxArrayString to populate
aMmFirst= true to have mm first and mils after false to have mils first and mm after
Returns
the index of the curr grid in list, if found or -1

Definition at line 179 of file base_screen.cpp.

References GetGridCount(), GetGridSize(), i, ID_POPUP_GRID_USER, INCHES, GRID_TYPE::m_CmdId, m_grids, GRID_TYPE::m_Size, MILLIMETRES, and To_User_Unit().

Referenced by EDA_DRAW_FRAME::AddMenuZoomAndGrid(), GRID_MENU::GRID_MENU(), GRID_MENU::update(), PCB_BASE_FRAME::updateGridSelectBox(), and GERBVIEW_FRAME::updateGridSelectBox().

180 {
181  wxString msg;
182  wxRealPoint curr_grid_size = GetGridSize();
183  int idx = -1;
184  int idx_usergrid = -1;
185 
186  for( size_t i = 0; i < GetGridCount(); i++ )
187  {
188  const GRID_TYPE& grid = m_grids[i];
189  double gridValueMils = To_User_Unit( INCHES, grid.m_Size.x ) * 1000;
190  double gridValue_mm = To_User_Unit( MILLIMETRES, grid.m_Size.x );
191 
192  if( grid.m_CmdId == ID_POPUP_GRID_USER )
193  {
194  msg = _( "Custom User Grid" );
195  idx_usergrid = i;
196  }
197  else
198  {
199  if( aMmFirst )
200  msg.Printf( _( "Grid: %.4f mm (%.2f mils)" ),
201  gridValue_mm, gridValueMils );
202  else
203  msg.Printf( _( "Grid: %.2f mils (%.4f mm)" ),
204  gridValueMils, gridValue_mm );
205  }
206 
207  aGridsList.Add( msg );
208 
209  if( curr_grid_size == grid.m_Size )
210  idx = i;
211  }
212 
213  if( idx < 0 )
214  idx = idx_usergrid;
215 
216  return idx;
217 }
size_t GetGridCount() const
Function GetGridCount().
Definition: base_screen.h:457
double To_User_Unit(EDA_UNITS_T aUnit, double aValue, bool aUseMils)
Function To_User_Unit convert aValue in internal units to the appropriate user units defined by aUnit...
Definition: base_units.cpp:93
Definition: common.h:160
wxRealPoint m_Size
Definition: base_screen.h:49
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:79
Class GRID_TYPE is for grid arrays.
Definition: base_screen.h:45
size_t i
Definition: json11.cpp:597
const wxRealPoint & GetGridSize() const
Return the grid size of the currently selected grid.
Definition: base_screen.h:410
int m_CmdId
Definition: base_screen.h:48
void BASE_SCREEN::ClearBlockCommand ( )
inline
void EDA_ITEM::ClearBrightened ( )
inlineinherited

Definition at line 233 of file base_struct.h.

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

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

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

Definition at line 254 of file base_struct.h.

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

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

Definition at line 232 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

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

Definition at line 231 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and SELECTED.

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

231 { ClearFlags( SELECTED ); }
#define SELECTED
Definition: base_struct.h:118
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:254
virtual void BASE_SCREEN::ClearUndoORRedoList ( UNDO_REDO_CONTAINER aList,
int  aItemCount = -1 
)
pure virtual

Function ClearUndoORRedoList (virtual).

this function must remove the aItemCount old commands from aList and delete commands, pickers and picked items if needed Because picked items must be deleted only if they are not in use, this is a virtual pure function that must be created for SCH_SCREEN and PCB_SCREEN

Parameters
aList= the UNDO_REDO_CONTAINER of commands
aItemCount= number of old commands to delete. -1 to remove all old commands this will empty the list of commands. Commands are deleted from the older to the last.

Implemented in SCH_SCREEN, PCB_SCREEN, GBR_SCREEN, and PL_EDITOR_SCREEN.

Referenced by ClearUndoRedoList(), PushCommandToRedoList(), and PushCommandToUndoList().

void BASE_SCREEN::ClearUndoRedoList ( )
virtual

Function ClearUndoRedoList clear undo and redo list, using ClearUndoORRedoList() picked items are deleted by ClearUndoORRedoList() according to their status.

Definition at line 413 of file base_screen.cpp.

References ClearUndoORRedoList(), m_RedoList, and m_UndoList.

Referenced by FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), LIB_EDIT_FRAME::emptyScreen(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), PL_EDITOR_FRAME::OnNewPageLayout(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), GBR_SCREEN::~GBR_SCREEN(), PCB_SCREEN::~PCB_SCREEN(), PL_EDITOR_SCREEN::~PL_EDITOR_SCREEN(), and SCH_SCREEN::~SCH_SCREEN().

414 {
417 }
virtual void ClearUndoORRedoList(UNDO_REDO_CONTAINER &aList, int aItemCount=-1)=0
Function ClearUndoORRedoList (virtual).
UNDO_REDO_CONTAINER m_UndoList
Objects list for the undo command (old data)
Definition: base_screen.h:210
UNDO_REDO_CONTAINER m_RedoList
Objects list for the redo command (old data)
Definition: base_screen.h:211
EDA_ITEM * EDA_ITEM::Clone ( ) const
virtualinherited

Function Clone creates a duplicate of this item with linked list members set to NULL.

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

Returns
A clone of the item.

Reimplemented in D_PAD, SCH_COMPONENT, MODULE, ZONE_CONTAINER, SCH_SHEET, LIB_PIN, VIA, SEGZONE, SCH_HIERLABEL, TRACK, SCH_GLOBALLABEL, DRAWSEGMENT, SCH_LABEL, DIMENSION, LIB_FIELD, TEXTE_MODULE, SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, SCH_LINE, SCH_BUS_BUS_ENTRY, SCH_BITMAP, LIB_ARC, SCH_BUS_WIRE_ENTRY, EDGE_MODULE, LIB_TEXT, TEXTE_PCB, LIB_POLYLINE, LIB_RECTANGLE, SCH_NO_CONNECT, SCH_JUNCTION, LIB_BEZIER, SCH_MARKER, PCB_TARGET, LIB_CIRCLE, and KIGFX::ORIGIN_VIEWITEM.

Definition at line 123 of file base_struct.cpp.

References EDA_ITEM::GetClass().

Referenced by PCB_EDIT_FRAME::Block_Duplicate(), LIB_EDIT_FRAME::BlockCopySelectedItems(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), CopyMarkedItems(), LIB_EDIT_FRAME::copySelectedItems(), DrawMovingBlockOutlines(), BOARD::Duplicate(), DuplicateStruct(), EDA_ITEM::HitTest(), LIB_PART::LIB_PART(), LIB_EDIT_FRAME::LoadOneSymbol(), new_clone(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), LIB_EDIT_FRAME::pasteClipboard(), RedrawWhileMovingCursor(), SCH_EDIT_FRAME::RepeatDrawItem(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveWireImage(), LIB_PART::SetConversion(), SCH_EDIT_FRAME::SetRepeatItem(), SCH_EDIT_FRAME::SetUndoItem(), LIB_PART::SetUnitCount(), and COMMIT::Stage().

124 {
125  wxCHECK_MSG( false, NULL, wxT( "Clone not implemented in derived class " ) + GetClass() +
126  wxT( ". Bad programmer!" ) );
127 }
virtual wxString GetClass() const =0
Function GetClass returns the class name.
void BASE_SCREEN::ClrSave ( )
inline

Definition at line 327 of file base_screen.h.

Referenced by SCH_EDIT_FRAME::SaveEEFile(), and PCB_EDIT_FRAME::SavePcbFile().

327 { m_FlagSave = false; }
bool m_FlagSave
Indicates automatic file save.
Definition: base_screen.h:81
const EDA_RECT EDA_ITEM::GetBoundingBox ( ) const
virtualinherited

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

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

Reimplemented in BOARD, D_PAD, SCH_SHEET, LIB_PART, SCH_COMPONENT, SCH_HIERLABEL, SCH_GLOBALLABEL, LIB_ITEM, DIMENSION, GERBER_DRAW_ITEM, SCH_LABEL, DRAWSEGMENT, LIB_FIELD, MODULE, TEXTE_MODULE, ZONE_CONTAINER, SCH_TEXT, LIB_PIN, TRACK, TEXTE_PCB, MARKER_PCB, SCH_LINE, SCH_BITMAP, GBR_LAYOUT, PCB_TARGET, LIB_ARC, SCH_FIELD, LIB_TEXT, SCH_BUS_ENTRY_BASE, LIB_BEZIER, LIB_POLYLINE, LIB_RECTANGLE, LIB_CIRCLE, SCH_NO_CONNECT, SCH_MARKER, and SCH_JUNCTION.

Definition at line 110 of file base_struct.cpp.

Referenced by PCB_EDIT_FRAME::AppendBoardFile(), CN_ITEM::BBox(), MODULE::CoverageRatio(), LIB_ITEM::GetBoundingBox(), GetBoundingBoxes(), getRect(), getSheetBbox(), EDA_ITEM::HitTest(), and EDA_ITEM::ViewBBox().

111 {
112 #if defined(DEBUG)
113  printf( "Missing GetBoundingBox()\n" );
114  Show( 0, std::cout ); // tell me which classes still need GetBoundingBox support
115 #endif
116 
117  // return a zero-sized box per default. derived classes should override
118  // this
119  return EDA_RECT( wxPoint( 0, 0 ), wxSize( 0, 0 ) );
120 }
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
virtual wxString BASE_SCREEN::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Implements EDA_ITEM.

Reimplemented in SCH_SCREEN.

Definition at line 494 of file base_screen.h.

Referenced by PopCommandFromRedoList().

495  {
496  return wxT( "BASE_SCREEN" );
497  }
wxPoint BASE_SCREEN::getCrossHairPosition ( bool  aInvertY) const
inlineprivate

Function getCrossHairPosition return the current cross hair position in logical (drawing) coordinates.

Parameters
aInvertYInverts the Y axis position.
Returns
The cross hair position in drawing coordinates.

Definition at line 107 of file base_screen.h.

References wxPoint::x, and wxPoint::y.

Referenced by EDA_DRAW_FRAME::SetCrossHairPosition().

108  {
109  if( aInvertY )
111 
113  }
wxPoint m_crossHairPosition
The cross hair position in logical (drawing) units.
Definition: base_screen.h:93
wxPoint BASE_SCREEN::getCrossHairScreenPosition ( ) const
private

Function getCursorScreenPosition returns the cross hair position in device (display) units.b.

Returns
The current cross hair position.

Definition at line 392 of file base_screen.cpp.

References GetScalingFactor(), KiROUND(), m_crossHairPosition, m_DrawOrg, wxPoint::x, and wxPoint::y.

Referenced by EDA_DRAW_FRAME::GetCrossHairScreenPosition().

393 {
395  double scalar = GetScalingFactor();
396 
397  pos.x = KiROUND( (double) pos.x * scalar );
398  pos.y = KiROUND( (double) pos.y * scalar );
399 
400  return pos;
401 }
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:120
double GetScalingFactor() const
Function GetScalingFactor returns the inverse of the current scale used to draw items on screen...
Definition: base_screen.cpp:92
wxPoint m_crossHairPosition
The cross hair position in logical (drawing) units.
Definition: base_screen.h:93
wxPoint m_DrawOrg
offsets for drawing the circuit on the screen
Definition: base_screen.h:183
wxPoint BASE_SCREEN::getCursorPosition ( bool  aOnGrid,
const wxPoint aGridOrigin,
wxRealPoint *  aGridSize 
) const
private

Function getCursorPosition returns the current cursor position in logical (drawing) units.

Parameters
aOnGridReturns the nearest grid position at the current cursor position.
aGridOriginOrigin point of the snap grid.
aGridSizeCustom grid size instead of the current grid size. Only valid if aOnGrid is true.
Returns
The current cursor position.

Definition at line 383 of file base_screen.cpp.

References getNearestGridPosition(), and m_crossHairPosition.

Referenced by EDA_DRAW_FRAME::GetCursorPosition().

384 {
385  if( aOnGrid )
386  return getNearestGridPosition( m_crossHairPosition, aGridOrigin, aGridSize );
387 
388  return m_crossHairPosition;
389 }
wxPoint m_crossHairPosition
The cross hair position in logical (drawing) units.
Definition: base_screen.h:93
wxPoint getNearestGridPosition(const wxPoint &aPosition, const wxPoint &aGridOrigin, wxRealPoint *aGridSize) const
Function getNearestGridPosition returns the nearest aGridSize location to aPosition.
STATUS_FLAGS EDA_ITEM::GetFlags ( ) const
inlineinherited

Definition at line 255 of file base_struct.h.

References EDA_ITEM::m_Flags.

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

255 { return m_Flags; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
const GRID_TYPE& BASE_SCREEN::GetGrid ( ) const
inline

Return the grid object of the currently selected grid.

Returns
GRID_TYPE - The currently selected grid.

Definition at line 417 of file base_screen.h.

Referenced by EDA_DRAW_FRAME::AddMenuZoomAndGrid(), GRID_MENU::GRID_MENU(), GERBVIEW_FRAME::OnUpdateSelectGrid(), PCB_BASE_FRAME::OnUpdateSelectGrid(), PCB_BASE_FRAME::updateGridSelectBox(), and GERBVIEW_FRAME::updateGridSelectBox().

417 { return m_Grid; }
GRID_TYPE m_Grid
Current grid selection.
Definition: base_screen.h:83
GRID_TYPE & BASE_SCREEN::GetGrid ( size_t  aIndex)

Function GetGrid() Returns the grid object at aIndex.

Parameters
aIndex- The grid list index.
Returns
- The grid object at aIndex or the current grid if the grid list is empty.

Definition at line 336 of file base_screen.cpp.

References m_Grid, and m_grids.

337 {
338  wxCHECK_MSG( !m_grids.empty() && aIndex < m_grids.size(), m_Grid,
339  wxT( "Cannot get grid object outside the bounds of the grid list." ) );
340 
341  return m_grids[ aIndex ];
342 }
GRID_TYPE m_Grid
Current grid selection.
Definition: base_screen.h:83
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:79
int BASE_SCREEN::GetGridCmdId ( ) const
inline

Return the command ID of the currently selected grid.

Returns
int - Currently selected grid command ID.

Definition at line 403 of file base_screen.h.

References GRID_TYPE::m_CmdId.

Referenced by DIALOG_SET_GRID::DIALOG_SET_GRID(), GERBVIEW_FRAME::OnUpdateSelectGrid(), PCB_BASE_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::SetNextGrid(), EDA_DRAW_FRAME::SetPrevGrid(), DIALOG_SET_GRID::TransferDataFromWindow(), and GRID_MENU::update().

403 { return m_Grid.m_CmdId; }
GRID_TYPE m_Grid
Current grid selection.
Definition: base_screen.h:83
int m_CmdId
Definition: base_screen.h:48
size_t BASE_SCREEN::GetGridCount ( ) const
inline

Function GetGridCount().

Return the size of the grid list.

Returns
- The size of the grid list.

Definition at line 457 of file base_screen.h.

Referenced by EDA_DRAW_FRAME::AddMenuZoomAndGrid(), BuildGridsChoiceList(), GERBVIEW_FRAME::OnUpdateSelectGrid(), PCB_BASE_FRAME::OnUpdateSelectGrid(), PCB_BASE_FRAME::updateGridSelectBox(), and GERBVIEW_FRAME::updateGridSelectBox().

457 { return m_grids.size(); }
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:79
const GRIDS& BASE_SCREEN::GetGrids ( ) const
inline

Function GetGrids().

Returns the current list of grids.

Definition at line 472 of file base_screen.h.

Referenced by DIALOG_SET_GRID::DIALOG_SET_GRID(), PCB_BASE_FRAME::SetFastGrid1(), PCB_BASE_FRAME::SetFastGrid2(), and EDA_DRAW_FRAME::SetPresetGrid().

473  {
474  return m_grids;
475  }
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:79
DHEAD* EDA_ITEM::GetList ( ) const
inlineinherited
double BASE_SCREEN::GetMaxAllowedZoom ( ) const
inline

Function GetMaxAllowedZoom returns the maximum allowed zoom factor, which was established as the last entry in m_ZoomList.

Definition at line 361 of file base_screen.h.

Referenced by SetLastZoom(), SetScalingFactor(), and SetZoom().

361 { return m_ZoomList.size() ? *m_ZoomList.rbegin() : 1.0; }
std::vector< double > m_ZoomList
standard zoom (i.e. scale) coefficients.
Definition: base_screen.h:219
int BASE_SCREEN::GetMaxUndoItems ( ) const
inline

Definition at line 311 of file base_screen.h.

References EDA_DRAW_FRAME::m_UndoRedoCountMax.

311 { return m_UndoRedoCountMax; }
int m_UndoRedoCountMax
undo/Redo command Max depth
Definition: base_screen.h:86
BITMAP_DEF EDA_ITEM::GetMenuImage ( ) const
virtualinherited

Function GetMenuImage returns a pointer to an image to be used in menus.

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

Returns
The menu image associated with the item.

Reimplemented in D_PAD, SCH_COMPONENT, MODULE, ZONE_CONTAINER, SCH_SHEET, LIB_PIN, VIA, SEGZONE, SCH_HIERLABEL, GERBER_DRAW_ITEM, TRACK, SCH_GLOBALLABEL, DRAWSEGMENT, DIMENSION, SCH_LABEL, LIB_FIELD, TEXTE_MODULE, SCH_SHEET_PIN, SCH_BUS_BUS_ENTRY, SCH_TEXT, SCH_FIELD, SCH_LINE, LIB_ARC, SCH_BUS_WIRE_ENTRY, SCH_BITMAP, EDGE_MODULE, LIB_TEXT, TEXTE_PCB, LIB_POLYLINE, MARKER_PCB, LIB_RECTANGLE, PCB_TARGET, LIB_CIRCLE, SCH_MARKER, SCH_NO_CONNECT, and SCH_JUNCTION.

Definition at line 280 of file base_struct.cpp.

References dummy_xpm, EDA_ITEM::GetClass(), i, KIGFX::operator<<(), wxPoint::x, and wxPoint::y.

Referenced by SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SELECTION_TOOL::doSelectionMenu(), EDA_ITEM::HitTest(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), and PCB_BASE_FRAME::PcbGeneralLocateAndDisplay().

281 {
282  return dummy_xpm;
283 }
static const BITMAP_OPAQUE dummy_xpm[1]
Definition: base_struct.cpp:56
double BASE_SCREEN::GetMinAllowedZoom ( ) const
inline

Function GetMinAllowedZoom returns the minimum allowed zoom factor, which was established as the first entry in m_ZoomList.

Definition at line 368 of file base_screen.h.

Referenced by SetFirstZoom(), SetScalingFactor(), and SetZoom().

368 { return m_ZoomList.size() ? *m_ZoomList.begin() : 1.0; }
std::vector< double > m_ZoomList
standard zoom (i.e. scale) coefficients.
Definition: base_screen.h:219
virtual void EDA_ITEM::GetMsgPanelInfo ( EDA_UNITS_T  aUnits,
std::vector< MSG_PANEL_ITEM > &  aList 
)
inlinevirtualinherited

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

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

Reimplemented in BOARD, D_PAD, MODULE, SCH_SHEET, SCH_COMPONENT, GERBER_DRAW_ITEM, LIB_ITEM, NETINFO_ITEM, DIMENSION, TRACK, DRAWSEGMENT, SCH_TEXT, TEXTE_MODULE, LIB_FIELD, LIB_PIN, EDGE_MODULE, MARKER_PCB, ZONE_CONTAINER, LIB_BEZIER, LIB_ARC, LIB_TEXT, SCH_MARKER, LIB_POLYLINE, TEXTE_PCB, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 294 of file base_struct.h.

Referenced by SCH_EDIT_FRAME::LocateItem(), EDA_DRAW_FRAME::SetMsgPanel(), FOOTPRINT_VIEWER_FRAME::UpdateMsgPanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), PCB_BASE_FRAME::UpdateMsgPanel(), and FOOTPRINT_EDIT_FRAME::UpdateMsgPanel().

295  {
296  }
wxPoint BASE_SCREEN::getNearestGridPosition ( const wxPoint aPosition,
const wxPoint aGridOrigin,
wxRealPoint *  aGridSize 
) const
private

Function getNearestGridPosition returns the nearest aGridSize location to aPosition.

Parameters
aPositionThe position to check.
aGridOriginThe origin point of the snap grid.
aGridSizeThe grid size to locate to if provided. If NULL then the current grid size is used.
Returns
The nearst grid position.

Definition at line 358 of file base_screen.cpp.

References GetGridSize(), KiROUND(), point_s::x, wxPoint::x, point_s::y, and wxPoint::y.

Referenced by getCursorPosition(), EDA_DRAW_FRAME::GetNearestGridPosition(), and setCrossHairPosition().

360 {
361  wxPoint pt;
362  wxRealPoint gridSize;
363 
364  if( aGridSize )
365  gridSize = *aGridSize;
366  else
367  gridSize = GetGridSize();
368 
369  double offset = fmod( aGridOrigin.x, gridSize.x );
370  int x = KiROUND( (aPosition.x - offset) / gridSize.x );
371 
372  pt.x = KiROUND( x * gridSize.x + offset );
373 
374  offset = fmod( aGridOrigin.y, gridSize.y );
375 
376  int y = KiROUND( (aPosition.y - offset) / gridSize.y );
377  pt.y = KiROUND ( y * gridSize.y + offset );
378 
379  return pt;
380 }
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:120
const wxRealPoint & GetGridSize() const
Return the grid size of the currently selected grid.
Definition: base_screen.h:410
int BASE_SCREEN::GetRedoCommandCount ( ) const
inline

Definition at line 306 of file base_screen.h.

References UNDO_REDO_CONTAINER::m_CommandsList.

Referenced by PushCommandToRedoList().

307  {
308  return m_RedoList.m_CommandsList.size();
309  }
std::vector< PICKED_ITEMS_LIST * > m_CommandsList
UNDO_REDO_CONTAINER m_RedoList
Objects list for the redo command (old data)
Definition: base_screen.h:211
double BASE_SCREEN::GetScalingFactor ( ) const

Function GetScalingFactor returns the inverse of the current scale used to draw items on screen.

This function somehow got designed to be the inverse of SetScalingFactor().

device coordinates = user coordinates * GetScalingFactor()

Definition at line 92 of file base_screen.cpp.

References GetZoom(), and scale.

Referenced by EDA_DRAW_PANEL::DoPrepareDC(), getCrossHairScreenPosition(), EDA_DRAW_PANEL::OnMouseEvent(), EDA_DRAW_PANEL::OnMouseWheel(), EDA_DRAW_PANEL::OnPan(), and EDA_DRAW_PANEL::OnScroll().

93 {
94  double scale = 1.0 / GetZoom();
95  return scale;
96 }
double GetZoom() const
Function GetZoom returns the current "zoom factor", which is a measure of "internal units per device ...
Definition: base_screen.h:340
const int scale
const wxPoint& BASE_SCREEN::getScrollCenterPosition ( ) const
inlineprivate

Definition at line 173 of file base_screen.h.

Referenced by EDA_DRAW_FRAME::GetScrollCenterPosition().

173 { return m_scrollCenter; }
wxPoint m_scrollCenter
Current scroll center point in logical units.
Definition: base_screen.h:84
wxString EDA_ITEM::GetSelectMenuText ( EDA_UNITS_T  aUnits) const
virtualinherited

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

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

Returns
The menu text string.

Reimplemented in D_PAD, SCH_COMPONENT, MODULE, ZONE_CONTAINER, SCH_SHEET, LIB_PIN, VIA, SEGZONE, DELETED_SCH_ITEM, SCH_HIERLABEL, GERBER_DRAW_ITEM, TRACK, SCH_GLOBALLABEL, DRAWSEGMENT, DIMENSION, SCH_LABEL, LIB_FIELD, TEXTE_MODULE, SCH_SHEET_PIN, SCH_BUS_BUS_ENTRY, SCH_TEXT, SCH_FIELD, SCH_LINE, LIB_ARC, SCH_BUS_WIRE_ENTRY, SCH_BITMAP, EDGE_MODULE, LIB_TEXT, TEXTE_PCB, LIB_POLYLINE, MARKER_PCB, LIB_RECTANGLE, PCB_TARGET, LIB_CIRCLE, SCH_MARKER, SCH_NO_CONNECT, SCH_JUNCTION, and DELETED_BOARD_ITEM.

Definition at line 173 of file base_struct.cpp.

References EDA_ITEM::GetClass().

Referenced by SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SELECTION_TOOL::doSelectionMenu(), SCH_FIND_COLLECTOR::GetText(), EDA_ITEM::HitTest(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), DRC_ITEM::SetData(), and DIALOG_POSITION_RELATIVE::UpdateAnchor().

174 {
175  wxFAIL_MSG( wxT( "GetSelectMenuText() was not overridden for schematic item type " ) +
176  GetClass() );
177 
178  return wxString( wxT( "Undefined menu text for " ) + GetClass() );
179 }
virtual wxString GetClass() const =0
Function GetClass returns the class name.
STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 250 of file base_struct.h.

References EDA_ITEM::m_Status.

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

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

Definition at line 204 of file base_struct.h.

References EDA_ITEM::m_TimeStamp.

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

204 { return m_TimeStamp; }
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:169
int BASE_SCREEN::GetUndoCommandCount ( ) const
inline

Definition at line 301 of file base_screen.h.

References UNDO_REDO_CONTAINER::m_CommandsList.

Referenced by PushCommandToUndoList().

302  {
303  return m_UndoList.m_CommandsList.size();
304  }
std::vector< PICKED_ITEMS_LIST * > m_CommandsList
UNDO_REDO_CONTAINER m_UndoList
Objects list for the undo command (old data)
Definition: base_screen.h:210
double BASE_SCREEN::GetZoom ( ) const
inline

Function GetZoom returns the current "zoom factor", which is a measure of "internal units per device unit", or "world units per device unit".

A device unit is typically a pixel.

Definition at line 340 of file base_screen.h.

References EDA_DRAW_FRAME::SetNextZoom().

Referenced by EDA_DRAW_FRAME::AddMenuZoomAndGrid(), PLEDITOR_PRINTOUT::DrawPage(), SCH_PRINTOUT::DrawPage(), DrawPageOnClipboard(), GetScalingFactor(), EDA_DRAW_PANEL::GetScreen(), EDA_DRAW_FRAME::GetZoom(), DIALOG_ERC::OnLeftClickMarkersList(), GERBVIEW_FRAME::OnUpdateSelectZoom(), PCB_BASE_FRAME::OnUpdateSelectZoom(), SCH_BASE_FRAME::RedrawScreen(), SCH_BASE_FRAME::RedrawScreen2(), and ZOOM_MENU::update().

340 { return m_Zoom; }
double m_Zoom
Current zoom coefficient.
Definition: base_screen.h:95
bool BASE_SCREEN::GridExists ( int  aCommandId)

Function GridExists tests for grid command ID (not an index in grid list, but a wxID) exists in grid list.

Parameters
aCommandId= the wxWidgets command ID
Returns
true if the grid exists in grid list.

Definition at line 345 of file base_screen.cpp.

References i, and m_grids.

Referenced by EDA_DRAW_FRAME::SetNextGrid(), EDA_DRAW_FRAME::SetPresetGrid(), and EDA_DRAW_FRAME::SetPrevGrid().

346 {
347  // tests for grid command ID (not an index in grid list, but a wxID) exists in grid list.
348  for( unsigned i = 0; i < m_grids.size(); i++ )
349  {
350  if( m_grids[i].m_CmdId == aCommandId )
351  return true;
352  }
353 
354  return false;
355 }
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:79
size_t i
Definition: json11.cpp:597
virtual bool EDA_ITEM::HitTest ( const wxPoint aPosition) const
inlinevirtualinherited

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

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

Reimplemented in D_PAD, MODULE, VIA, SCH_ITEM, BOARD_ITEM, GERBER_DRAW_ITEM, ZONE_CONTAINER, DIMENSION, LIB_ITEM, TRACK, DRAWSEGMENT, TEXTE_MODULE, LIB_FIELD, LIB_PIN, MARKER_PCB, LIB_ARC, PCB_TARGET, LIB_TEXT, TEXTE_PCB, LIB_BEZIER, LIB_POLYLINE, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 305 of file base_struct.h.

References EDA_ITEM::Clone(), EDA_ITEM::GetBoundingBox(), EDA_ITEM::GetClass(), EDA_ITEM::GetMenuImage(), EDA_ITEM::GetSelectMenuText(), EDA_ITEM::IterateForward(), and EDA_ITEM::Visit().

Referenced by LIB_ITEM::HitTest(), BOARD_ITEM::HitTest(), GERBER_COLLECTOR::Inspect(), and SCH_COLLECTOR::Inspect().

306  {
307  return false; // derived classes should override this function
308  }
void BASE_SCREEN::InitDataPoints ( const wxSize &  aPageSizeInternalUnits)

Definition at line 69 of file base_screen.cpp.

References m_Center, m_crossHairPosition, m_DrawOrg, m_O_Curseur, wxPoint::x, and wxPoint::y.

Referenced by FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), GBR_SCREEN::GBR_SCREEN(), PCB_SCREEN::PCB_SCREEN(), PL_EDITOR_SCREEN::PL_EDITOR_SCREEN(), SCH_SCREEN::SCH_SCREEN(), GERBVIEW_FRAME::SetPageSettings(), PL_EDITOR_FRAME::SetPageSettings(), and PCB_BASE_FRAME::SetPageSettings().

70 {
71  if( m_Center )
72  {
75 
76  m_DrawOrg.x = -aPageSizeIU.x / 2;
77  m_DrawOrg.y = -aPageSizeIU.y / 2;
78  }
79  else
80  {
81  m_crossHairPosition.x = aPageSizeIU.x / 2;
82  m_crossHairPosition.y = aPageSizeIU.y / 2;
83 
84  m_DrawOrg.x = 0;
85  m_DrawOrg.y = 0;
86  }
87 
88  m_O_Curseur.x = m_O_Curseur.y = 0;
89 }
wxPoint m_crossHairPosition
The cross hair position in logical (drawing) units.
Definition: base_screen.h:93
wxPoint m_O_Curseur
Relative Screen cursor coordinate (on grid) in user units.
Definition: base_screen.h:185
bool m_Center
Center on screen.
Definition: base_screen.h:202
wxPoint m_DrawOrg
offsets for drawing the circuit on the screen
Definition: base_screen.h:183
bool BASE_SCREEN::IsBlockActive ( ) const
inline

Definition at line 499 of file base_screen.h.

References BLOCK_SELECTOR::IsIdle().

Referenced by DrawPageOnClipboard(), SCH_EDIT_FRAME::OnCancelCurrentCommand(), SCH_DRAW_PANEL::OnMouseEvent(), EDA_DRAW_PANEL::OnMouseEvent(), PL_EDITOR_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), and LIB_EDIT_FRAME::OnRightClick().

499 { return !m_BlockLocate.IsIdle(); }
BLOCK_SELECTOR m_BlockLocate
Block description for block commands.
Definition: base_screen.h:214
bool IsIdle() const
Function IsIdle returns true if there is currently no block operation in progress.
bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

Definition at line 224 of file base_struct.h.

References BRIGHTENED.

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

224 { return m_Flags & BRIGHTENED; }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:135
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
bool EDA_ITEM::IsDragging ( ) const
inlineinherited
bool EDA_ITEM::IsHighlighted ( ) const
inlineinherited

Definition at line 223 of file base_struct.h.

References HIGHLIGHTED.

223 { return m_Flags & HIGHLIGHTED; }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:134
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 217 of file base_struct.h.

References IS_CHANGED.

Referenced by LIB_EDIT_FRAME::OnEditPin().

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

Definition at line 216 of file base_struct.h.

References IS_NEW.

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

216 { return m_Flags & IS_NEW; }
#define IS_NEW
New item, just created.
Definition: base_struct.h:111
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
virtual bool EDA_ITEM::IsReplaceable ( ) const
inlinevirtualinherited

Function IsReplaceable.

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

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

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

Definition at line 461 of file base_struct.h.

References EDA_ITEM::operator<().

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

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

Definition at line 222 of file base_struct.h.

References IS_RESIZED.

Referenced by ExitSheet().

222 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:112
bool BASE_SCREEN::IsSave ( ) const
inline

Definition at line 329 of file base_screen.h.

329 { return m_FlagSave; }
bool m_FlagSave
Indicates automatic file save.
Definition: base_screen.h:81
bool EDA_ITEM::IsSelected ( ) const
inlineinherited

Definition at line 221 of file base_struct.h.

References SELECTED.

Referenced by SCH_SCREEN::addConnectedItemsToBlock(), AddMenusForPin(), LIB_EDIT_FRAME::BlockCopySelectedItems(), KIGFX::PCB_PAINTER::draw(), LIB_CIRCLE::drawGraphic(), LIB_POLYLINE::drawGraphic(), LIB_RECTANGLE::drawGraphic(), LIB_BEZIER::drawGraphic(), LIB_TEXT::drawGraphic(), LIB_ARC::drawGraphic(), LIB_FIELD::drawGraphic(), DrawMovingBlockOutlines(), LIB_PIN::DrawPinElectricalTypeName(), LIB_PIN::DrawPinSymbol(), LIB_PIN::DrawPinTexts(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), LIB_EDIT_FRAME::GlobalSetPins(), SCH_JUNCTION::IsSelectStateChanged(), SCH_NO_CONNECT::IsSelectStateChanged(), SCH_MARKER::IsSelectStateChanged(), SCH_BUS_ENTRY_BASE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), SCH_COMPONENT::IsSelectStateChanged(), MirrorMarkedItems(), MoveMarkedItems(), MoveMarkedItemsExactly(), LIB_TEXT::Plot(), GRID_HELPER::queryVisible(), RotateMarkedItems(), GERBVIEW_SELECTION_TOOL::select(), SELECTION_TOOL::select(), SCH_SCREEN::SelectBlockItems(), GERBVIEW_SELECTION_TOOL::toggleSelection(), SELECTION_TOOL::toggleSelection(), and GERBVIEW_SELECTION_TOOL::unselect().

221 { return m_Flags & SELECTED; }
#define SELECTED
Definition: base_struct.h:118
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
bool EDA_ITEM::IsType ( const KICAD_T  aScanTypes[])
inlineinherited

Function IsType Checks whether the item is one of the listed types.

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

Definition at line 263 of file base_struct.h.

References EOT.

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

Definition at line 220 of file base_struct.h.

References IS_WIRE_IMAGE.

Referenced by SCH_FIELD::Draw().

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

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

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

Definition at line 130 of file base_struct.cpp.

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

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

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

Function Matches compares the item against the search criteria in aSearchData.

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

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search criteria.
aAuxDataA pointer to optional data required for the search or NULL if not used.
aFindLocationA pointer to a wxPoint object to store the location of matched item. The pointer can be NULL if it is not used.
Returns
True if the item's text matches the search criteria in aSearchData.

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

Definition at line 417 of file base_struct.h.

References EDA_ITEM::Replace().

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

418  {
419  return false;
420  }
bool EDA_ITEM::Matches ( const wxString &  aText,
wxFindReplaceData &  aSearchData 
)
protectedinherited

Function Matches compares aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

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

Definition at line 182 of file base_struct.cpp.

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

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

Function MilsToIuScalar returns the scalar required to convert mils to internal units.

Note
This is a temporary hack until the derived objects SCH_SCREEN and PCB_SCREEN no longer need to be derived from BASE_SCREEN. I does allow removal of the obsolete GetInternalUnits function.

Reimplemented in PCB_SCREEN, GBR_SCREEN, and PL_EDITOR_SCREEN.

Definition at line 245 of file base_screen.h.

Referenced by DrawPageOnClipboard(), and DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample().

245 { return 1; }
bool EDA_ITEM::operator< ( const EDA_ITEM aItem) const
inherited

Test if another item is less than this object.

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

Definition at line 239 of file base_struct.cpp.

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

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

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

PopCommandFromRedoList return the last command to undo and remove it from list nothing is deleted.

Definition at line 454 of file base_screen.cpp.

References GetClass(), m_RedoList, and UNDO_REDO_CONTAINER::PopCommand().

Referenced by LIB_EDIT_FRAME::GetComponentFromRedoList(), and SCH_EDIT_FRAME::GetSchematicFromRedoList().

455 {
456  return m_RedoList.PopCommand( );
457 }
PICKED_ITEMS_LIST * PopCommand()
UNDO_REDO_CONTAINER m_RedoList
Objects list for the redo command (old data)
Definition: base_screen.h:211
PICKED_ITEMS_LIST * BASE_SCREEN::PopCommandFromUndoList ( )
virtual

PopCommandFromUndoList return the last command to undo and remove it from list nothing is deleted.

Definition at line 448 of file base_screen.cpp.

References m_UndoList, and UNDO_REDO_CONTAINER::PopCommand().

Referenced by LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_EDIT_FRAME::GetSchematicFromUndoList(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

449 {
450  return m_UndoList.PopCommand( );
451 }
PICKED_ITEMS_LIST * PopCommand()
UNDO_REDO_CONTAINER m_UndoList
Objects list for the undo command (old data)
Definition: base_screen.h:210
void BASE_SCREEN::PushCommandToRedoList ( PICKED_ITEMS_LIST aItem)
virtual

Function PushCommandToRedoList add a command to redo in redo list delete the very old commands when the max count of redo commands is reached ( using ClearUndoORRedoList)

Definition at line 434 of file base_screen.cpp.

References ClearUndoORRedoList(), GetRedoCommandCount(), m_RedoList, m_UndoRedoCountMax, and UNDO_REDO_CONTAINER::PushCommand().

Referenced by LIB_EDIT_FRAME::GetComponentFromUndoList(), and SCH_EDIT_FRAME::GetSchematicFromUndoList().

435 {
436  m_RedoList.PushCommand( aNewitem );
437 
438  // Delete the extra items, if count max reached
439  if( m_UndoRedoCountMax > 0 )
440  {
441  int extraitems = GetRedoCommandCount() - m_UndoRedoCountMax;
442  if( extraitems > 0 )
443  ClearUndoORRedoList( m_RedoList, extraitems );
444  }
445 }
int m_UndoRedoCountMax
undo/Redo command Max depth
Definition: base_screen.h:86
virtual void ClearUndoORRedoList(UNDO_REDO_CONTAINER &aList, int aItemCount=-1)=0
Function ClearUndoORRedoList (virtual).
void PushCommand(PICKED_ITEMS_LIST *aCommand)
UNDO_REDO_CONTAINER m_RedoList
Objects list for the redo command (old data)
Definition: base_screen.h:211
int GetRedoCommandCount() const
Definition: base_screen.h:306
void BASE_SCREEN::PushCommandToUndoList ( PICKED_ITEMS_LIST aItem)
virtual

Function PushCommandToUndoList add a command to undo in undo list delete the very old commands when the max count of undo commands is reached ( using ClearUndoORRedoList)

Definition at line 420 of file base_screen.cpp.

References ClearUndoORRedoList(), GetUndoCommandCount(), m_UndoList, m_UndoRedoCountMax, and UNDO_REDO_CONTAINER::PushCommand().

Referenced by LIB_EDIT_FRAME::GetComponentFromRedoList(), SCH_EDIT_FRAME::GetSchematicFromRedoList(), LIB_EDIT_FRAME::SaveCopyInUndoList(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

421 {
422  m_UndoList.PushCommand( aNewitem );
423 
424  // Delete the extra items, if count max reached
425  if( m_UndoRedoCountMax > 0 )
426  {
427  int extraitems = GetUndoCommandCount() - m_UndoRedoCountMax;
428  if( extraitems > 0 )
429  ClearUndoORRedoList( m_UndoList, extraitems );
430  }
431 }
int m_UndoRedoCountMax
undo/Redo command Max depth
Definition: base_screen.h:86
virtual void ClearUndoORRedoList(UNDO_REDO_CONTAINER &aList, int aItemCount=-1)=0
Function ClearUndoORRedoList (virtual).
void PushCommand(PICKED_ITEMS_LIST *aCommand)
int GetUndoCommandCount() const
Definition: base_screen.h:301
UNDO_REDO_CONTAINER m_UndoList
Objects list for the undo command (old data)
Definition: base_screen.h:210
wxPoint BASE_SCREEN::refPos ( bool  useMouse) const
inlineprivate

Function RefPos Return the reference position, coming from either the mouse position or the cursor position.

Parameters
useMouseIf true, return mouse position, else cursor's.
Returns
wxPoint - The reference point, either the mouse position or the cursor position.

Definition at line 168 of file base_screen.h.

Referenced by EDA_DRAW_FRAME::RefPos().

169  {
170  return useMouse ? m_MousePosition : m_crossHairPosition;
171  }
wxPoint m_crossHairPosition
The cross hair position in logical (drawing) units.
Definition: base_screen.h:93
wxPoint m_MousePosition
Mouse cursor coordinate in logical units.
Definition: base_screen.h:85
bool EDA_ITEM::Replace ( wxFindReplaceData &  aSearchData,
wxString &  aText 
)
inherited

Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace.

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search and replace criteria.
aTextA reference to a wxString object containing the text to be replaced.
Returns
True if aText was modified, otherwise false.

Definition at line 209 of file base_struct.cpp.

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

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

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

Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace.

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

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search and replace criteria.
aAuxDataA pointer to optional data required for the search or NULL if not used.
Returns
True if the item text was modified, otherwise false.

Reimplemented in SCH_SHEET, SCH_SHEET_PIN, SCH_FIELD, and SCH_TEXT.

Definition at line 449 of file base_struct.h.

449 { return false; }
void EDA_ITEM::SetBack ( EDA_ITEM aBack)
inlineinherited

Definition at line 212 of file base_struct.h.

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

212 { Pback = aBack; }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:165
void EDA_ITEM::SetBrightened ( )
inlineinherited

Definition at line 229 of file base_struct.h.

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

229 { SetFlags( BRIGHTENED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:253
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:135
void BASE_SCREEN::setCrossHairPosition ( const wxPoint aPosition,
const wxPoint aGridOrigin,
bool  aSnapToGrid 
)
private

Function setCrossHairPosition sets the screen cross hair position to aPosition in logical (drawing) units.

Parameters
aPositionThe new cross hair position.
aGridOriginOrigin point of the snap grid.
aSnapToGridSets the cross hair position to the nearest grid position to aPosition.

Definition at line 404 of file base_screen.cpp.

References getNearestGridPosition(), and m_crossHairPosition.

Referenced by EDA_DRAW_FRAME::SetCrossHairPosition().

405 {
406  if( aSnapToGrid )
407  m_crossHairPosition = getNearestGridPosition( aPosition, aGridOrigin, NULL );
408  else
409  m_crossHairPosition = aPosition;
410 }
wxPoint m_crossHairPosition
The cross hair position in logical (drawing) units.
Definition: base_screen.h:93
wxPoint getNearestGridPosition(const wxPoint &aPosition, const wxPoint &aGridOrigin, wxRealPoint *aGridSize) const
Function getNearestGridPosition returns the nearest aGridSize location to aPosition.
void BASE_SCREEN::SetCurItem ( EDA_ITEM aItem)
inline

Function SetCurItem sets the currently selected object, m_CurrentItem.

Parameters
aItemAny object derived from EDA_ITEM

Definition at line 231 of file base_screen.h.

Referenced by Abort_Move_ModuleOutline(), AbortBlockCurrentCommand(), AbortMoveTextModule(), BASE_SCREEN(), GERBVIEW_FRAME::OnLeftClick(), GERBVIEW_FRAME::OnRightClick(), PL_EDITOR_SCREEN::SetCurItem(), PCB_SCREEN::SetCurItem(), GERBVIEW_FRAME::SetCurItem(), SCH_SCREEN::SetCurItem(), and SCH_SCREEN::SetCurLibItem().

231 { m_CurrentItem = aItem; }
EDA_ITEM * m_CurrentItem
Currently selected object.
Definition: base_screen.h:82
bool BASE_SCREEN::SetFirstZoom ( )

Definition at line 108 of file base_screen.cpp.

References GetMinAllowedZoom(), and SetZoom().

109 {
110  return SetZoom( GetMinAllowedZoom() );
111 }
double GetMinAllowedZoom() const
Function GetMinAllowedZoom returns the minimum allowed zoom factor, which was established as the firs...
Definition: base_screen.h:368
virtual bool SetZoom(double iu_per_du)
Function SetZoom adjusts the current zoom factor.
void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 253 of file base_struct.h.

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

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

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

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

Definition at line 282 of file base_struct.h.

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

282 { m_forceVisible = aEnable; }
bool m_forceVisible
Set to true to override the visibility setting of the item.
Definition: base_struct.h:172
int BASE_SCREEN::SetGrid ( const wxRealPoint &  size)

set the current grid size m_Grid.

The size must be existing in grid list (in m_grids) If not, the near existing grid size is used

Parameters
size= the size of the new grid
Returns
the grid id offset (id from ID_POPUP_GRID_LEVEL_1000 ) of the currently selected grid.

Definition at line 229 of file base_screen.cpp.

References i, ID_POPUP_GRID_LEVEL_1000, m_Grid, m_grids, and GRID_TYPE::m_Size.

Referenced by SCH_EDIT_FRAME::AppendSchematic(), DIALOG_SET_GRID::DIALOG_SET_GRID(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GBR_SCREEN::GBR_SCREEN(), GERBVIEW_FRAME::GERBVIEW_FRAME(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_SCREEN::PCB_SCREEN(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), PL_EDITOR_SCREEN::PL_EDITOR_SCREEN(), SCH_SCREEN::SCH_SCREEN(), EDA_DRAW_FRAME::SetPresetGrid(), and DIALOG_SET_GRID::TransferDataFromWindow().

230 {
231  wxASSERT( !m_grids.empty() );
232 
233  GRID_TYPE nearest_grid = m_grids[0];
234  int gridIdx = 0;
235 
236  for( unsigned i = 0; i < m_grids.size(); i++ )
237  {
238  if( m_grids[i].m_Size == size )
239  {
240  m_Grid = m_grids[i];
241  return m_grids[i].m_CmdId - ID_POPUP_GRID_LEVEL_1000;
242  }
243 
244  // keep track of the nearest larger grid size, if the exact size is not found
245  if ( size.x < m_grids[i].m_Size.x )
246  {
247  gridIdx = m_grids[i].m_CmdId - ID_POPUP_GRID_LEVEL_1000;
248  nearest_grid = m_grids[i];
249  }
250  }
251 
252  m_Grid = nearest_grid;
253 
254  wxLogWarning( _( "Grid size( %f, %f ) not in grid list, falling back "
255  "to grid size( %f, %f )." ),
256  size.x, size.y, m_Grid.m_Size.x, m_Grid.m_Size.y );
257 
258  return gridIdx;
259 }
GRID_TYPE m_Grid
Current grid selection.
Definition: base_screen.h:83
wxRealPoint m_Size
Definition: base_screen.h:49
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:79
Class GRID_TYPE is for grid arrays.
Definition: base_screen.h:45
size_t i
Definition: json11.cpp:597
int BASE_SCREEN::SetGrid ( int  aCommandId)

Function SetGrid sets the grid size from command ID (not an index in grid list, but a wxID).

Parameters
aCommandId= the wxWidgets command ID
Returns
the grid id offset (id from ID_POPUP_GRID_LEVEL_1000 ) of the currently selected grid.

Definition at line 262 of file base_screen.cpp.

References i, ID_POPUP_GRID_LEVEL_1000, m_Grid, m_grids, and GRID_TYPE::m_Size.

263 {
264  wxASSERT( !m_grids.empty() );
265 
266  for( unsigned i = 0; i < m_grids.size(); i++ )
267  {
268  if( m_grids[i].m_CmdId == aCommandId )
269  {
270  m_Grid = m_grids[i];
271  return m_grids[i].m_CmdId - ID_POPUP_GRID_LEVEL_1000;
272  }
273  }
274 
275  m_Grid = m_grids[0];
276 
277  wxLogWarning( _( "Grid ID %d not in grid list, falling back to "
278  "grid size( %g, %g )." ), aCommandId,
279  m_Grid.m_Size.x, m_Grid.m_Size.y );
280 
281  return m_grids[0].m_CmdId - ID_POPUP_GRID_LEVEL_1000;
282 }
GRID_TYPE m_Grid
Current grid selection.
Definition: base_screen.h:83
wxRealPoint m_Size
Definition: base_screen.h:49
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:79
size_t i
Definition: json11.cpp:597
void BASE_SCREEN::SetGridList ( GRIDS sizelist)

Definition at line 220 of file base_screen.cpp.

References m_grids.

221 {
222  if( !m_grids.empty() )
223  m_grids.clear();
224 
225  m_grids = gridlist;
226 }
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:79
void EDA_ITEM::SetHighlighted ( )
inlineinherited

Definition at line 228 of file base_struct.h.

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

228 { SetFlags( HIGHLIGHTED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:253
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:134
bool BASE_SCREEN::SetLastZoom ( )

Definition at line 114 of file base_screen.cpp.

References GetMaxAllowedZoom(), and SetZoom().

115 {
116  return SetZoom( GetMaxAllowedZoom() );
117 }
virtual bool SetZoom(double iu_per_du)
Function SetZoom adjusts the current zoom factor.
double GetMaxAllowedZoom() const
Function GetMaxAllowedZoom returns the maximum allowed zoom factor, which was established as the last...
Definition: base_screen.h:361
void EDA_ITEM::SetList ( DHEAD aList)
inlineinherited

Definition at line 214 of file base_struct.h.

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

214 { m_List = aList; }
DHEAD * m_List
which DLIST I am on.
Definition: base_struct.h:166
void BASE_SCREEN::SetMaxUndoItems ( int  aMax)
inline

Definition at line 313 of file base_screen.h.

References ABS_MAX_UNDO_ITEMS, and DEFAULT_MAX_UNDO_ITEMS.

Referenced by SCH_EDIT_FRAME::CreateScreens(), and SCH_EDIT_FRAME::EditSheet().

314  {
315  if( aMax >= 0 && aMax < ABS_MAX_UNDO_ITEMS )
316  m_UndoRedoCountMax = aMax;
317  else
318  {
319  wxFAIL_MSG( "Maximum undo items not within limits" );
321  }
322  }
int m_UndoRedoCountMax
undo/Redo command Max depth
Definition: base_screen.h:86
#define DEFAULT_MAX_UNDO_ITEMS
Definition: draw_frame.h:47
#define ABS_MAX_UNDO_ITEMS
Definition: draw_frame.h:48
void EDA_ITEM::SetModified ( )
inherited
void BASE_SCREEN::setMousePosition ( const wxPoint aPosition)
inlineprivate

Definition at line 156 of file base_screen.h.

Referenced by EDA_DRAW_FRAME::SetMousePosition().

156 { m_MousePosition = aPosition; }
wxPoint m_MousePosition
Mouse cursor coordinate in logical units.
Definition: base_screen.h:85
void EDA_ITEM::SetNext ( EDA_ITEM aNext)
inlineinherited

Definition at line 211 of file base_struct.h.

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

211 { Pnext = aNext; }
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:164
bool BASE_SCREEN::SetNextZoom ( )

Definition at line 139 of file base_screen.cpp.

References i, m_Zoom, m_ZoomList, and SetZoom().

Referenced by EDA_DRAW_FRAME::SetNextZoom().

140 {
141  // Step must be AT LEAST 1.2
142  double target = m_Zoom * 1.2;
143 
144  for( unsigned i=0; i < m_ZoomList.size(); ++i )
145  {
146  if( target < m_ZoomList[i] )
147  {
148  SetZoom( m_ZoomList[i] );
149  return true;
150  }
151  }
152 
153  return false;
154 }
virtual bool SetZoom(double iu_per_du)
Function SetZoom adjusts the current zoom factor.
size_t i
Definition: json11.cpp:597
double m_Zoom
Current zoom coefficient.
Definition: base_screen.h:95
std::vector< double > m_ZoomList
standard zoom (i.e. scale) coefficients.
Definition: base_screen.h:219
bool BASE_SCREEN::SetPreviousZoom ( )

Definition at line 157 of file base_screen.cpp.

References i, m_Zoom, m_ZoomList, and SetZoom().

Referenced by EDA_DRAW_FRAME::SetPrevZoom().

158 {
159  // Step must be AT LEAST 1.2
160  double target = m_Zoom / 1.2;
161 
162  for( unsigned i = m_ZoomList.size(); i != 0; --i )
163  {
164  if( target > m_ZoomList[i - 1] )
165  {
166  SetZoom( m_ZoomList[i - 1] );
167  return true;
168  }
169  }
170 
171  return false;
172 }
virtual bool SetZoom(double iu_per_du)
Function SetZoom adjusts the current zoom factor.
size_t i
Definition: json11.cpp:597
double m_Zoom
Current zoom coefficient.
Definition: base_screen.h:95
std::vector< double > m_ZoomList
standard zoom (i.e. scale) coefficients.
Definition: base_screen.h:219
void BASE_SCREEN::SetSave ( )
inline

Definition at line 326 of file base_screen.h.

Referenced by PCB_BASE_FRAME::OnModify().

326 { m_FlagSave = true; }
bool m_FlagSave
Indicates automatic file save.
Definition: base_screen.h:81
void BASE_SCREEN::SetScalingFactor ( double  iu_per_du)

Function SetScalingFactor sets the scaling factor of "internal unit per device unit".

If the output device is a screen, then "device units" are pixels. The "logical unit" is wx terminology, and corresponds to KiCad's "Internal Unit (IU)".

This scaling factor is "internal units per device unit". This function is the same thing currently as SetZoom(), but clamps the argument within a legal range.

Parameters
iu_per_duis the current scale used to draw items onto the device context wxDC.

Definition at line 99 of file base_screen.cpp.

References Clamp(), GetMaxAllowedZoom(), GetMinAllowedZoom(), and SetZoom().

Referenced by SCH_BASE_FRAME::Window_Zoom(), and SCH_BASE_FRAME::Zoom_Automatique().

100 {
101  // Limit zoom to max and min allowed values:
102  double zoom = Clamp( GetMinAllowedZoom(), aScale, GetMaxAllowedZoom() );
103 
104  SetZoom( zoom );
105 }
const T & Clamp(const T &lower, const T &value, const T &upper)
Function Clamp limits value within the range lower <= value <= upper.
Definition: macros.h:127
double GetMinAllowedZoom() const
Function GetMinAllowedZoom returns the minimum allowed zoom factor, which was established as the firs...
Definition: base_screen.h:368
virtual bool SetZoom(double iu_per_du)
Function SetZoom adjusts the current zoom factor.
double GetMaxAllowedZoom() const
Function GetMaxAllowedZoom returns the maximum allowed zoom factor, which was established as the last...
Definition: base_screen.h:361
void BASE_SCREEN::setScrollCenterPosition ( const wxPoint aPoint)
inlineprivate

Definition at line 174 of file base_screen.h.

Referenced by EDA_DRAW_FRAME::SetScrollCenterPosition().

174 { m_scrollCenter = aPoint; }
wxPoint m_scrollCenter
Current scroll center point in logical units.
Definition: base_screen.h:84
void EDA_ITEM::SetSelected ( )
inlineinherited

Definition at line 227 of file base_struct.h.

References SELECTED, and EDA_ITEM::SetFlags().

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

227 { SetFlags( SELECTED ); }
#define SELECTED
Definition: base_struct.h:118
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:253
void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited
void EDA_ITEM::SetTimeStamp ( timestamp_t  aNewTimeStamp)
inlineinherited

Definition at line 203 of file base_struct.h.

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

203 { m_TimeStamp = aNewTimeStamp; }
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:169
void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 226 of file base_struct.h.

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

Referenced by moveItemWithMouseCursor().

226 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:253
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:115
bool BASE_SCREEN::SetZoom ( double  iu_per_du)
virtual

Function SetZoom adjusts the current zoom factor.

Parameters
iu_per_duis the number of internal units (world units) per device units (pixels typically).

Definition at line 120 of file base_screen.cpp.

References GetMaxAllowedZoom(), GetMinAllowedZoom(), and m_Zoom.

Referenced by PLEDITOR_PRINTOUT::DrawPage(), SCH_PRINTOUT::DrawPage(), DrawPageOnClipboard(), SCH_EDIT_FRAME::FindComponentAndItem(), GBR_SCREEN::GBR_SCREEN(), EDA_DRAW_PANEL::GetScreen(), SCH_EDIT_FRAME::OnFindDrcMarker(), EDA_DRAW_PANEL_GAL::onPaint(), EDA_DRAW_FRAME::OnSelectZoom(), PCB_SCREEN::PCB_SCREEN(), PL_EDITOR_SCREEN::PL_EDITOR_SCREEN(), SCH_SCREEN::SCH_SCREEN(), SetFirstZoom(), SetLastZoom(), SetNextZoom(), EDA_DRAW_FRAME::SetPresetZoom(), SetPreviousZoom(), and SetScalingFactor().

121 {
122  if( iu_per_du == m_Zoom )
123  return false;
124 
125  //wxLogDebug( "Zoom:%.16g 1/Zoom:%.16g", iu_per_du, 1/iu_per_du );
126 
127  if( iu_per_du < GetMinAllowedZoom() )
128  return false;
129 
130  if( iu_per_du > GetMaxAllowedZoom() )
131  return false;
132 
133  m_Zoom = iu_per_du;
134 
135  return true;
136 }
double GetMinAllowedZoom() const
Function GetMinAllowedZoom returns the minimum allowed zoom factor, which was established as the firs...
Definition: base_screen.h:368
double GetMaxAllowedZoom() const
Function GetMaxAllowedZoom returns the maximum allowed zoom factor, which was established as the last...
Definition: base_screen.h:361
double m_Zoom
Current zoom coefficient.
Definition: base_screen.h:95
static bool EDA_ITEM::Sort ( const EDA_ITEM aLeft,
const EDA_ITEM aRight 
)
inlinestaticinherited

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

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

Definition at line 480 of file base_struct.h.

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

Referenced by PART_LIB::GetEntryTypePowerNames().

480 { return *aLeft < *aRight; }
KICAD_T EDA_ITEM::Type ( ) const
inlineinherited

Function Type()

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

Returns
KICAD_T - the type of object.

Definition at line 198 of file base_struct.h.

References EDA_ITEM::m_StructType.

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

199  {
200  return m_StructType;
201  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it...
Definition: base_struct.h:160
const BOX2I EDA_ITEM::ViewBBox ( ) const
overridevirtualinherited

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

Returns
BOX2I - the current bounding box

Implements KIGFX::VIEW_ITEM.

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

Definition at line 265 of file base_struct.cpp.

References EDA_ITEM::GetBoundingBox().

Referenced by EDA_ITEM::Sort(), BRIGHT_BOX::ViewBBox(), DIMENSION::ViewBBox(), DRAWSEGMENT::ViewBBox(), BRIGHT_BOX::ViewDraw(), and COMMON_TOOLS::ZoomFitScreen().

266 {
267  // Basic fallback
268  return BOX2I( VECTOR2I( GetBoundingBox().GetOrigin() ),
269  VECTOR2I( GetBoundingBox().GetSize() ) );
270 }
virtual const EDA_RECT GetBoundingBox() const
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes...
BOX2< VECTOR2I > BOX2I
Definition: box2.h:520
VECTOR2< int > VECTOR2I
Definition: vector2d.h:587
virtual void KIGFX::VIEW_ITEM::ViewDraw ( int  aLayer,
VIEW aView 
) const
inlinevirtualinherited

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

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

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

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

Definition at line 116 of file view_item.h.

References KIGFX::VIEW_ITEM::ViewGetLayers().

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

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

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

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

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

Implements KIGFX::VIEW_ITEM.

Reimplemented in D_PAD, MODULE, EDIT_POINTS, VIA, BOARD_ITEM, GERBER_DRAW_ITEM, TRACK, TEXTE_MODULE, ZONE_CONTAINER, MARKER_PCB, KIGFX::WORKSHEET_VIEWITEM, SCH_BITMAP, ROUTER_PREVIEW_ITEM, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, BRIGHT_BOX, KIGFX::RATSNEST_VIEWITEM, and KIGFX::PREVIEW::RULER_ITEM.

Definition at line 273 of file base_struct.cpp.

Referenced by EDA_ITEM::Sort().

274 {
275  // Basic fallback
276  aCount = 1;
277  aLayers[0] = 0;
278 }
virtual unsigned int KIGFX::VIEW_ITEM::ViewGetLOD ( int  aLayer,
VIEW aView 
) const
inlinevirtualinherited

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

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

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

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

Definition at line 140 of file view_item.h.

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

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

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

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

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

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

Definition at line 149 of file base_struct.cpp.

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

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

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

Friends And Related Function Documentation

friend class EDA_DRAW_FRAME
friend

Definition at line 99 of file base_screen.h.

Member Data Documentation

BLOCK_SELECTOR BASE_SCREEN::m_BlockLocate

Block description for block commands.

Definition at line 214 of file base_screen.h.

Referenced by AbortBlockCurrentCommand(), SCH_SCREEN::addConnectedItemsToBlock(), AddMenusForBlock(), PCB_EDIT_FRAME::AppendBoardFile(), PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Block_Duplicate(), PCB_EDIT_FRAME::Block_Flip(), PL_EDITOR_FRAME::Block_Move(), GERBVIEW_FRAME::Block_Move(), PCB_EDIT_FRAME::Block_Move(), PCB_EDIT_FRAME::Block_Rotate(), PCB_EDIT_FRAME::Block_SelectItems(), DrawAndSizingBlockOutlines(), drawMovingBlock(), DrawMovingBlockOutlines(), DrawPageOnClipboard(), drawPickedItems(), PCB_BASE_EDIT_FRAME::duplicateItem(), SCH_EDIT_FRAME::EditImage(), SCH_BASE_FRAME::HandleBlockBegin(), EDA_DRAW_FRAME::HandleBlockBegin(), PL_EDITOR_FRAME::HandleBlockEnd(), FOOTPRINT_EDIT_FRAME::HandleBlockEnd(), GERBVIEW_FRAME::HandleBlockEnd(), LIB_EDIT_FRAME::HandleBlockEnd(), PCB_EDIT_FRAME::HandleBlockEnd(), SCH_EDIT_FRAME::HandleBlockEnd(), PL_EDITOR_FRAME::HandleBlockPlace(), FOOTPRINT_EDIT_FRAME::HandleBlockPlace(), GERBVIEW_FRAME::HandleBlockPlace(), LIB_EDIT_FRAME::HandleBlockPlace(), PCB_EDIT_FRAME::HandleBlockPlace(), SCH_EDIT_FRAME::HandleBlockPlace(), EDA_DRAW_FRAME::InitBlockPasteInfos(), LIB_EDIT_FRAME::InitBlockPasteInfos(), SCH_EDIT_FRAME::InitBlockPasteInfos(), EDA_DRAW_FRAME::isBusy(), SCH_EDIT_FRAME::OnDragItem(), FOOTPRINT_EDIT_FRAME::OnHotKey(), SCH_EDIT_FRAME::OnHotKey(), LIB_EDIT_FRAME::OnHotKey(), SCH_DRAW_PANEL::OnMouseEvent(), EDA_DRAW_PANEL::OnMouseEvent(), SCH_EDIT_FRAME::OnMoveItem(), LIB_EDIT_FRAME::OnOrient(), SCH_EDIT_FRAME::OnOrient(), FOOTPRINT_EDIT_FRAME::OnRightClick(), GERBVIEW_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), LIB_EDIT_FRAME::OnRotate(), SCH_EDIT_FRAME::OnRotate(), FOOTPRINT_EDIT_FRAME::PrepareItemForHotkey(), LIB_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_FRAME::Process_Special_Functions(), PCB_EDIT_FRAME::Process_Special_Functions(), SCH_SCREEN::SelectBlockItems(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), and SCH_SCREEN::UpdatePickList().

bool BASE_SCREEN::m_Center

Center on screen.

If true (0.0) is centered on screen coordinates can be < 0 and

0 except for schematics.

false: when coordinates can only be >= 0 Schematic

Definition at line 202 of file base_screen.h.

Referenced by BASE_SCREEN(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), InitDataPoints(), PL_EDITOR_SCREEN::PL_EDITOR_SCREEN(), and SCH_SCREEN::SCH_SCREEN().

wxPoint BASE_SCREEN::m_crossHairPosition
private

The cross hair position in logical (drawing) units.

The cross hair is not the cursor position. It is an addition indicator typically drawn on grid to indicate to the user where the current action will be performed.

Definition at line 93 of file base_screen.h.

Referenced by getCrossHairScreenPosition(), getCursorPosition(), InitDataPoints(), and setCrossHairPosition().

EDA_ITEM* BASE_SCREEN::m_CurrentItem
private

Currently selected object.

Definition at line 82 of file base_screen.h.

wxPoint BASE_SCREEN::m_DrawOrg
bool BASE_SCREEN::m_FlagModified
private

Indicates current drawing has been modified.

Definition at line 80 of file base_screen.h.

Referenced by BASE_SCREEN().

STATUS_FLAGS EDA_ITEM::m_Flags
protectedinherited

Flag bits for editing and other uses.

Definition at line 175 of file base_struct.h.

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

bool BASE_SCREEN::m_FlagSave
private

Indicates automatic file save.

Definition at line 81 of file base_screen.h.

Referenced by BASE_SCREEN().

bool EDA_ITEM::m_forceVisible
protectedinherited

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

Definition at line 172 of file base_struct.h.

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

GRID_TYPE BASE_SCREEN::m_Grid
private

Current grid selection.

Definition at line 83 of file base_screen.h.

Referenced by BASE_SCREEN(), GetGrid(), and SetGrid().

GRIDS BASE_SCREEN::m_grids
private

List of valid grid sizes.

Definition at line 79 of file base_screen.h.

Referenced by AddGrid(), BuildGridsChoiceList(), GetGrid(), GridExists(), SetGrid(), and SetGridList().

bool BASE_SCREEN::m_Initialized
DHEAD* EDA_ITEM::m_List
protectedinherited

which DLIST I am on.

Definition at line 166 of file base_struct.h.

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

wxPoint BASE_SCREEN::m_MousePosition
private

Mouse cursor coordinate in logical units.

Definition at line 85 of file base_screen.h.

UNDO_REDO_CONTAINER BASE_SCREEN::m_RedoList

Objects list for the redo command (old data)

Definition at line 211 of file base_screen.h.

Referenced by ClearUndoRedoList(), PopCommandFromRedoList(), and PushCommandToRedoList().

wxSize BASE_SCREEN::m_ScrollbarNumber

Current virtual draw area size in scroll units.

m_ScrollbarNumber * m_ScrollPixelsPerUnit = virtual draw area size in pixels

Definition at line 192 of file base_screen.h.

wxPoint BASE_SCREEN::m_ScrollbarPos

Current scroll bar position in scroll units.

Definition at line 196 of file base_screen.h.

Referenced by EDA_DRAW_PANEL::OnScroll().

wxPoint BASE_SCREEN::m_scrollCenter
private

Current scroll center point in logical units.

Definition at line 84 of file base_screen.h.

int BASE_SCREEN::m_ScrollPixelsPerUnitX

Pixels per scroll unit in the horizontal direction.

Definition at line 189 of file base_screen.h.

Referenced by BASE_SCREEN().

int BASE_SCREEN::m_ScrollPixelsPerUnitY

Pixels per scroll unit in the vertical direction.

Definition at line 190 of file base_screen.h.

Referenced by BASE_SCREEN().

wxPoint BASE_SCREEN::m_StartVisu

Coordinates in drawing units of the current view position (upper left corner of device)

Definition at line 198 of file base_screen.h.

Referenced by PLEDITOR_PRINTOUT::DrawPage(), SCH_PRINTOUT::DrawPage(), DrawPageOnClipboard(), DIALOG_FIND::onButtonFindItemClick(), DIALOG_FIND::onButtonFindMarkerClick(), EDA_DRAW_PANEL::OnPaint(), and EDA_DRAW_PANEL::OnScroll().

timestamp_t EDA_ITEM::m_TimeStamp
protectedinherited
UNDO_REDO_CONTAINER BASE_SCREEN::m_UndoList

Objects list for the undo command (old data)

Definition at line 210 of file base_screen.h.

Referenced by ClearUndoRedoList(), SCH_EDIT_FRAME::DisplayCurrentSheet(), PopCommandFromUndoList(), and PushCommandToUndoList().

int BASE_SCREEN::m_UndoRedoCountMax
private

undo/Redo command Max depth

Definition at line 86 of file base_screen.h.

Referenced by BASE_SCREEN(), PushCommandToRedoList(), and PushCommandToUndoList().

double BASE_SCREEN::m_Zoom
private

Current zoom coefficient.

Definition at line 95 of file base_screen.h.

Referenced by BASE_SCREEN(), SetNextZoom(), SetPreviousZoom(), and SetZoom().

EDA_ITEM* EDA_ITEM::Pback
protectedinherited

previous in linked list

Definition at line 165 of file base_struct.h.

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


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