footprint.h File Reference

#include <deque>
#include <template_fieldnames.h>
#include <board_item_container.h>
#include <board_item.h>
#include <collectors.h>
#include <component_classes/component_class_manager.h>
#include <embedded_files.h>
#include <layer_ids.h>
#include <lset.h>
#include <lib_id.h>
#include <list>
#include <zones.h>
#include <convert_shape_list_to_polygon.h>
#include <pcb_item_containers.h>
#include <pcb_text.h>
#include <pcb_field.h>
#include <functional>
#include <math/vector3.h>

Go to the source code of this file.

Classes
class	FP_3DMODEL
class	FOOTPRINT
struct	FOOTPRINT::FP_UNIT_INFO
struct	FOOTPRINT::cmp_drawings
struct	FOOTPRINT::cmp_pads
struct	FOOTPRINT::cmp_zones

Namespaces
namespace	KIGFX
	The Cairo implementation of the graphics abstraction layer.
namespace	KIFONT

Macros
#define	FP_is_LOCKED   0x01
	footprint LOCKED: no autoplace allowed
#define	FP_is_PLACED   0x02
	In autoplace: footprint automatically placed.
#define	FP_to_PLACE   0x04
	In autoplace: footprint waiting for autoplace.
#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_DNP = 0x0040 }
	The set of attributes allowed within a FOOTPRINT, using FOOTPRINT::SetAttributes() and FOOTPRINT::GetAttributes(). More...
enum class	FOOTPRINT_STACKUP { EXPAND_INNER_LAYERS , CUSTOM_LAYERS }

Macro Definition Documentation

FP_is_LOCKED

#define FP_is_LOCKED   0x01

footprint LOCKED: no autoplace allowed

Definition at line 448 of file footprint.h.

Referenced by FOOTPRINT::IsLocked(), and FOOTPRINT::SetLocked().

FP_is_PLACED

#define FP_is_PLACED   0x02

In autoplace: footprint automatically placed.

Definition at line 449 of file footprint.h.

Referenced by FOOTPRINT::GetMsgPanelInfo(), FOOTPRINT::IsPlaced(), and FOOTPRINT::SetIsPlaced().

FP_PADS_are_LOCKED

#define FP_PADS_are_LOCKED   0x08

Definition at line 451 of file footprint.h.

Referenced by FOOTPRINT::FOOTPRINT(), and FOOTPRINT::LegacyPadsLocked().

FP_to_PLACE

#define FP_to_PLACE   0x04

In autoplace: footprint waiting for autoplace.

Definition at line 450 of file footprint.h.

Referenced by FOOTPRINT::NeedsPlaced(), and FOOTPRINT::SetNeedsPlaced().

Enumeration Type Documentation

FOOTPRINT_ATTR_T

enum 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_DNP

Definition at line 79 of file footprint.h.

FOOTPRINT_STACKUP

enum class FOOTPRINT_STACKUP

strong

Enumerator
EXPAND_INNER_LAYERS	The 'normal' stackup handling, where there is a single inner layer (In1) and rule areas using it expand to all inner layer on the host PCB.
CUSTOM_LAYERS	Stackup handling where the footprint can have any number of copper layers, and objects on those layers go to the matching inner layer on the host PCB.

Definition at line 90 of file footprint.h.

INCLUDE_NPTH_T

enum INCLUDE_NPTH_T

Enumerator
DO_NOT_INCLUDE_NPTH
INCLUDE_NPTH

Definition at line 68 of file footprint.h.