tmk::model::Zone Struct Reference

#include <model/board.hpp>

Public Attributes
NetId	net = 0
LayerMask	copper = 0
std::vector< std::string >	layers
std::string	name
std::string	uuid
	breaks priority ties between zones of different nets (ZONE::HigherPriority)
int	priority = 0
Coord	clearance = -1
	(connect_pads (clearance x)): the zone's local clearance override, -1 = none
ZoneConnect	connect = ZoneConnect::Thermal
	Fill settings (doc 05 §36); defaults are KiCad's.
Coord	min_thickness = 250'000
Coord	thermal_gap = 500'000
Coord	thermal_bridge_width = 500'000
int	island_removal = 0
	0 always remove islands, 1 never, 2 below island_area_min
double	island_area_min = 0
	nm²
bool	hatched = false
	(fill (mode hatch))
bool	rule_area = false
bool	keepout_tracks = false
bool	keepout_vias = false
bool	keepout_pads = false
bool	keepout_pour = false
bool	keepout_footprints = false
bool	teardrop = false
	(attr (teardrop ...)): copper KiCad adds where a track meets a pad or via, not a plane
std::vector< std::vector< Point > >	outline
	main outline + holes (arcs flattened)
std::vector< std::pair< int, std::vector< Point > > >	fills
	(copper index, filled polygon)
int	footprint = -1
sexpr::NodeId	node = sexpr::kNoNode

Detailed Description

Definition at line 161 of file board.hpp.

Member Data Documentation

clearance

Coord tmk::model::Zone::clearance = -1

(connect_pads (clearance x)): the zone's local clearance override, -1 = none

Definition at line 168 of file board.hpp.

connect

ZoneConnect tmk::model::Zone::connect = ZoneConnect::Thermal

Fill settings (doc 05 §36); defaults are KiCad's.

(connect_pads [yes|no|thru_hole_only])

Definition at line 170 of file board.hpp.

copper

LayerMask tmk::model::Zone::copper = 0

Definition at line 163 of file board.hpp.

fills

std::vector<std::pair<int, std::vector<Point> > > tmk::model::Zone::fills

(copper index, filled polygon)

Definition at line 181 of file board.hpp.

footprint

int tmk::model::Zone::footprint = -1

Definition at line 182 of file board.hpp.

hatched

bool tmk::model::Zone::hatched = false

(fill (mode hatch))

Definition at line 175 of file board.hpp.

island_area_min

double tmk::model::Zone::island_area_min = 0

nm²

Definition at line 174 of file board.hpp.

island_removal

int tmk::model::Zone::island_removal = 0

0 always remove islands, 1 never, 2 below island_area_min

Definition at line 173 of file board.hpp.

keepout_footprints

bool tmk::model::Zone::keepout_footprints = false

Definition at line 178 of file board.hpp.

keepout_pads

bool tmk::model::Zone::keepout_pads = false

Definition at line 177 of file board.hpp.

keepout_pour

bool tmk::model::Zone::keepout_pour = false

Definition at line 177 of file board.hpp.

keepout_tracks

bool tmk::model::Zone::keepout_tracks = false

Definition at line 177 of file board.hpp.

keepout_vias

bool tmk::model::Zone::keepout_vias = false

Definition at line 177 of file board.hpp.

layers

std::vector<std::string> tmk::model::Zone::layers

Definition at line 164 of file board.hpp.

min_thickness

Coord tmk::model::Zone::min_thickness = 250'000

Definition at line 171 of file board.hpp.

name

std::string tmk::model::Zone::name

Definition at line 165 of file board.hpp.

net

NetId tmk::model::Zone::net = 0

Definition at line 162 of file board.hpp.

node

sexpr::NodeId tmk::model::Zone::node = sexpr::kNoNode

Definition at line 183 of file board.hpp.

outline

std::vector<std::vector<Point> > tmk::model::Zone::outline

main outline + holes (arcs flattened)

Definition at line 180 of file board.hpp.

priority

int tmk::model::Zone::priority = 0

Definition at line 167 of file board.hpp.

rule_area

bool tmk::model::Zone::rule_area = false

Definition at line 176 of file board.hpp.

teardrop

bool tmk::model::Zone::teardrop = false

(attr (teardrop ...)): copper KiCad adds where a track meets a pad or via, not a plane

Definition at line 179 of file board.hpp.

thermal_bridge_width

Coord tmk::model::Zone::thermal_bridge_width = 500'000

Definition at line 172 of file board.hpp.

thermal_gap

Coord tmk::model::Zone::thermal_gap = 500'000

Definition at line 172 of file board.hpp.

uuid

std::string tmk::model::Zone::uuid

breaks priority ties between zones of different nets (ZONE::HigherPriority)

Definition at line 166 of file board.hpp.

---

The documentation for this struct was generated from the following file:

• model/board.hpp