KiCad PCB EDA Suite
footprint.h File Reference
#include <deque>
#include <board_item_container.h>
#include <board_item.h>
#include <collectors.h>
#include <layer_ids.h>
#include <lib_id.h>
#include <list>
#include <zones.h>
#include <convert_shape_list_to_polygon.h>
#include <pcb_item_containers.h>
#include <fp_text.h>
#include <functional>

Go to the source code of this file.

Classes

class  FP_3DMODEL
 
struct  FP_3DMODEL::VECTOR3D
 
class  FOOTPRINT
 
struct  FOOTPRINT::cmp_drawings
 
struct  FOOTPRINT::cmp_pads
 
struct  FOOTPRINT::cmp_zones
 

Namespaces

namespace  KIGFX
 The Cairo implementation of the graphics abstraction layer.
 

Macros

#define FP_is_LOCKED   0x01
 footprint LOCKED: no autoplace allowed More...
 
#define FP_is_PLACED   0x02
 In autoplace: footprint automatically placed. More...
 
#define FP_to_PLACE   0x04
 In autoplace: footprint waiting for autoplace. More...
 
#define FP_PADS_are_LOCKED   0x08
 

Enumerations

enum  INCLUDE_NPTH_T { DO_NOT_INCLUDE_NPTH = false , INCLUDE_NPTH = true }
 
enum  FOOTPRINT_ATTR_T {
  FP_THROUGH_HOLE = 0x0001 , FP_SMD = 0x0002 , FP_EXCLUDE_FROM_POS_FILES = 0x0004 , FP_EXCLUDE_FROM_BOM = 0x0008 ,
  FP_BOARD_ONLY = 0x0010 , FP_JUST_ADDED = 0x0020 , FP_ALLOW_SOLDERMASK_BRIDGES = 0x0040 , FP_ALLOW_MISSING_COURTYARD = 0x0080
}
 The set of attributes allowed within a FOOTPRINT, using FOOTPRINT::SetAttributes() and FOOTPRINT::GetAttributes(). More...
 

Macro Definition Documentation

◆ FP_is_LOCKED

#define FP_is_LOCKED   0x01

footprint LOCKED: no autoplace allowed

Definition at line 329 of file footprint.h.

◆ FP_is_PLACED

#define FP_is_PLACED   0x02

In autoplace: footprint automatically placed.

Definition at line 330 of file footprint.h.

◆ FP_PADS_are_LOCKED

#define FP_PADS_are_LOCKED   0x08

Definition at line 332 of file footprint.h.

◆ FP_to_PLACE

#define FP_to_PLACE   0x04

In autoplace: footprint waiting for autoplace.

Definition at line 331 of file footprint.h.

Enumeration Type Documentation

◆ FOOTPRINT_ATTR_T

The set of attributes allowed within a FOOTPRINT, using FOOTPRINT::SetAttributes() and FOOTPRINT::GetAttributes().

These are to be ORed together when calling FOOTPRINT::SetAttributes()

Enumerator
FP_THROUGH_HOLE 
FP_SMD 
FP_EXCLUDE_FROM_POS_FILES 
FP_EXCLUDE_FROM_BOM 
FP_BOARD_ONLY 
FP_JUST_ADDED 
FP_ALLOW_SOLDERMASK_BRIDGES 
FP_ALLOW_MISSING_COURTYARD 

Definition at line 65 of file footprint.h.

66{
67 FP_THROUGH_HOLE = 0x0001,
68 FP_SMD = 0x0002,
70 FP_EXCLUDE_FROM_BOM = 0x0008,
71 FP_BOARD_ONLY = 0x0010, // Footprint has no corresponding symbol
72 FP_JUST_ADDED = 0x0020, // Footprint just added by netlist update
75};
@ FP_SMD
Definition: footprint.h:68
@ FP_ALLOW_MISSING_COURTYARD
Definition: footprint.h:74
@ FP_EXCLUDE_FROM_POS_FILES
Definition: footprint.h:69
@ FP_BOARD_ONLY
Definition: footprint.h:71
@ FP_EXCLUDE_FROM_BOM
Definition: footprint.h:70
@ FP_JUST_ADDED
Definition: footprint.h:72
@ FP_THROUGH_HOLE
Definition: footprint.h:67
@ FP_ALLOW_SOLDERMASK_BRIDGES
Definition: footprint.h:73

◆ INCLUDE_NPTH_T

Enumerator
DO_NOT_INCLUDE_NPTH 
INCLUDE_NPTH 

Definition at line 54 of file footprint.h.

55{
56 DO_NOT_INCLUDE_NPTH = false,
57 INCLUDE_NPTH = true
58};
@ INCLUDE_NPTH
Definition: footprint.h:57
@ DO_NOT_INCLUDE_NPTH
Definition: footprint.h:56