KiCad PCB EDA Suite
Loading...
Searching...
No Matches
eda_item_flags.h File Reference
#include <cstdint>
#include <string>
#include <vector>
#include <sstream>

Go to the source code of this file.

Macros

#define IS_CHANGED   (1UL << 0)
 Item was edited, and modified.
 
#define IS_LINKED   (1UL << 1)
 Used in calculation to mark linked items (temporary use)
 
#define IN_EDIT   (1UL << 2)
 Item currently edited.
 
#define IS_MOVING   (1UL << 3)
 Item being moved.
 
#define IS_NEW   (1UL << 4)
 New item, just created.
 
#define IS_BROKEN   (1UL << 5)
 Is a segment just broken by BreakSegment.
 
#define IS_DELETED   (1UL << 7)
 
#define STARTPOINT   (1UL << 9)
 When a line is selected, these flags indicate which.
 
#define ENDPOINT   (1UL << 10)
 ends. (Used to support dragging.)
 
#define SELECTED   (1UL << 11)
 Item was manually selected by the user.
 
#define SELECTED_BY_DRAG   (1UL << 12)
 Item was algorithmically selected as a dragged item.
 
#define STRUCT_DELETED   (1UL << 13)
 flag indication structures to be erased
 
#define CANDIDATE   (1UL << 14)
 flag indicating that the structure is connected
 
#define SKIP_STRUCT   (1UL << 15)
 flag indicating that the structure should be ignored
 
#define IS_PASTED   (1UL << 17)
 Modifier on IS_NEW which indicates it came from clipboard.
 
#define IS_SHOWN_AS_BITMAP   (1UL << 18)
 
#define COURTYARD_CONFLICT   (1UL << 19)
 temporary set when moving footprints having courtyard overlapping
 
#define MALFORMED_F_COURTYARD   (1UL << 20)
 
#define MALFORMED_B_COURTYARD   (1UL << 21)
 
#define MALFORMED_COURTYARDS   ( MALFORMED_F_COURTYARD | MALFORMED_B_COURTYARD )
 
#define ROUTER_TRANSIENT   (1UL << 22)
 transient items that should NOT be cached
 
#define CONNECTIVITY_CANDIDATE   (1UL << 23)
 flag indicating that the structure is connected for connectivity
 
#define HOLE_PROXY   (1UL << 24)
 Indicates the BOARD_ITEM is a proxy for its hole.
 
#define SHOW_ELEC_TYPE   (1UL << 25)
 Show pin electrical type.
 
#define BRIGHTENED   (1UL << 26)
 item is drawn with a bright contour
 
#define MCT_SKIP_STRUCT   (1 << 27)
 flag used by the multichannel tool to mark items that should be skipped
 
#define UR_TRANSIENT   (1UL << 28)
 indicates the item is owned by the undo/redo stack
 
#define IS_DANGLING   (1UL << 29)
 indicates a pin is dangling
 
#define ENTERED   (1UL << 30)
 indicates a group has been entered
 
#define SELECTION_CANDIDATE   (1UL << 31)
 indicates an item is a candidate for selection
 
#define EDA_ITEM_ALL_FLAGS   UINT32_MAX
 

Typedefs

typedef std::uint32_t EDA_ITEM_FLAGS
 

Functions

std::string EDAItemFlagsToString (EDA_ITEM_FLAGS flags)
 

Macro Definition Documentation

◆ BRIGHTENED

◆ CANDIDATE

◆ CONNECTIVITY_CANDIDATE

#define CONNECTIVITY_CANDIDATE   (1UL << 23)

flag indicating that the structure is connected for connectivity

Definition at line 63 of file eda_item_flags.h.

Referenced by CONNECTION_GRAPH::buildItemSubGraphs(), EDAItemFlagsToString(), and EDA_ITEM::GetTempFlags().

◆ COURTYARD_CONFLICT

#define COURTYARD_CONFLICT   (1UL << 19)

◆ EDA_ITEM_ALL_FLAGS

#define EDA_ITEM_ALL_FLAGS   UINT32_MAX

Definition at line 80 of file eda_item_flags.h.

Referenced by EDA_ITEM::ClearFlags(), and SCH_COMMIT::pushSchEdit().

◆ ENDPOINT

◆ ENTERED

◆ HOLE_PROXY

#define HOLE_PROXY   (1UL << 24)

Indicates the BOARD_ITEM is a proxy for its hole.

Definition at line 65 of file eda_item_flags.h.

Referenced by collidesWithArea(), EDAItemFlagsToString(), DRC_ENGINE::EvalRules(), and DRC_TEST_PROVIDER_DISALLOW::Run().

◆ IN_EDIT

◆ IS_BROKEN

#define IS_BROKEN   (1UL << 5)

Is a segment just broken by BreakSegment.

Definition at line 41 of file eda_item_flags.h.

Referenced by SCH_LINE_WIRE_BUS_TOOL::BreakSegment(), EDAItemFlagsToString(), EDA_ITEM::GetEditFlags(), and SCH_MOVE_TOOL::trimDanglingLines().

◆ IS_CHANGED

◆ IS_DANGLING

#define IS_DANGLING   (1UL << 29)

indicates a pin is dangling

Definition at line 73 of file eda_item_flags.h.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), EDAItemFlagsToString(), and SCH_SYMBOL::Plot().

◆ IS_DELETED

◆ IS_LINKED

#define IS_LINKED   (1UL << 1)

Used in calculation to mark linked items (temporary use)

Definition at line 37 of file eda_item_flags.h.

Referenced by SYMBOL_EDITOR_PIN_TOOL::CreatePin(), EDAItemFlagsToString(), EDA_ITEM::GetTempFlags(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), and SYMBOL_EDITOR_PIN_TOOL::RepeatPin().

◆ IS_MOVING

◆ IS_NEW

#define IS_NEW   (1UL << 4)

New item, just created.

Definition at line 40 of file eda_item_flags.h.

Referenced by SCH_IO_EAGLE::addBusEntries(), PCB_BASE_FRAME::AddFootprintToBoard(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SCH_IO_ALTIUM::AddTextBox(), SCH_DRAWING_TOOLS::AutoPlaceAllSheetPins(), BOOST_AUTO_TEST_CASE(), SCH_LINE_WIRE_BUS_TOOL::BreakSegment(), SCH_IO_ALTIUM::CreateAliases(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), PCB_TUNING_PATTERN::CreateNew(), SCH_DRAWING_TOOLS::createNewLabel(), SCH_DRAWING_TOOLS::createNewSheetPin(), SCH_DRAWING_TOOLS::createNewText(), SYMBOL_EDITOR_PIN_TOOL::CreatePin(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), PL_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCBNEW_JOBS_HANDLER::doFpExportSvg(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::drawOneBezier(), DRAWING_TOOL::DrawRectangle(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawTable(), SCH_DRAWING_TOOLS::DrawTable(), EDAItemFlagsToString(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SCH_MOVE_TOOL::getConnectedDragItems(), EDA_ITEM::GetEditFlags(), SELECTION_CONDITIONS::Idle(), EDA_ITEM::IsNew(), LIB_SYMBOL::LIB_SYMBOL(), PCB_SELECTION_TOOL::Main(), SCH_SELECTION_TOOL::Main(), LIB_SYMBOL::operator=(), SCH_MOVE_TOOL::orthoLineDrag(), SCH_IO_ALTIUM::ParseBezier(), SCH_IO_ALTIUM::ParseBus(), SCH_IO_ALTIUM::ParseBusEntry(), SCH_IO_ALTIUM::ParseHarnessEntry(), SCH_IO_ALTIUM::ParseImage(), SCH_IO_ALTIUM::ParseJunction(), SCH_IO_ALTIUM::ParseLabel(), SCH_IO_ALTIUM::ParseLine(), SCH_IO_ALTIUM::ParseNetLabel(), SCH_IO_ALTIUM::ParseNoERC(), SCH_IO_ALTIUM::ParsePieChart(), SCH_IO_ALTIUM::ParsePolygon(), SCH_IO_ALTIUM::ParsePolyline(), SCH_IO_ALTIUM::ParsePortHelper(), SCH_IO_ALTIUM::ParseRectangle(), SCH_IO_ALTIUM::ParseRoundRectangle(), SCH_IO_ALTIUM::ParseSheetSymbol(), SCH_IO_ALTIUM::ParseSignalHarness(), SCH_IO_ALTIUM::ParseWire(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), BACK_ANNOTATE::processNetNameChange(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDITOR_PIN_TOOL::RepeatPin(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ IS_PASTED

◆ IS_SHOWN_AS_BITMAP

◆ MALFORMED_B_COURTYARD

◆ MALFORMED_COURTYARDS

◆ MALFORMED_F_COURTYARD

◆ MCT_SKIP_STRUCT

#define MCT_SKIP_STRUCT   (1 << 27)

flag used by the multichannel tool to mark items that should be skipped

Definition at line 69 of file eda_item_flags.h.

Referenced by PCB_CONTROL::ApplyDesignBlockLayout().

◆ ROUTER_TRANSIENT

#define ROUTER_TRANSIENT   (1UL << 22)

◆ SELECTED

◆ SELECTED_BY_DRAG

#define SELECTED_BY_DRAG   (1UL << 12)

◆ SELECTION_CANDIDATE

◆ SHOW_ELEC_TYPE

◆ SKIP_STRUCT

◆ STARTPOINT

◆ STRUCT_DELETED

◆ UR_TRANSIENT

Typedef Documentation

◆ EDA_ITEM_FLAGS

typedef std::uint32_t EDA_ITEM_FLAGS

Definition at line 82 of file eda_item_flags.h.

Function Documentation

◆ EDAItemFlagsToString()