KiCAD pcbnew scripting
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
pcbnew.ZONE_CONTAINER Class Reference
Inheritance diagram for pcbnew.ZONE_CONTAINER:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, args)
 
def GetPosition (self)
 
def SetPosition (self, aPos)
 
def SetPriority (self, aPriority)
 
def GetPriority (self)
 
def GetMsgPanelInfo (self, aList)
 
def Draw (self, args)
 
def DrawFilledArea (self, args)
 
def DrawWhileCreateOutline (self, args)
 
def GetBoundingBox (self)
 
def GetClearance
 
def TestForCopperIslandAndRemoveInsulatedIslands (self, aPcb)
 
def IsOnCopperLayer (self)
 
def SetFillMode (self, aFillMode)
 
def GetFillMode (self)
 
def SetThermalReliefGap (self, aThermalReliefGap)
 
def GetThermalReliefGap
 
def SetThermalReliefCopperBridge (self, aThermalReliefCopperBridge)
 
def GetThermalReliefCopperBridge
 
def SetArcSegmentCount (self, aArcSegCount)
 
def GetArcSegmentCount (self)
 
def IsFilled (self)
 
def SetIsFilled (self, isFilled)
 
def GetZoneClearance (self)
 
def SetZoneClearance (self, aZoneClearance)
 
def GetPadConnection
 
def SetPadConnection (self, aPadConnection)
 
def GetMinThickness (self)
 
def SetMinThickness (self, aMinThickness)
 
def GetSelectedCorner (self)
 
def SetSelectedCorner (self, args)
 
def GetLocalFlags (self)
 
def SetLocalFlags (self, aFlags)
 
def FillSegments (self, args)
 
def Outline (self, args)
 
def SetOutline (self, aOutline)
 
def HitTestInsideZone (self, aPosition)
 
def HitTestFilledArea (self, aRefPos)
 
def TransformSolidAreasShapesToPolygonSet (self, aCornerBuffer, aCircleToSegmentsCount, aCorrectionFactor)
 
def BuildFilledSolidAreasPolygons
 
def AddClearanceAreasPolygonsToPolysList (self, aPcb)
 
def AddClearanceAreasPolygonsToPolysList_NG (self, aPcb)
 
def TransformOutlinesShapeWithClearanceToPolygon (self, aCornerBuffer, aMinClearanceValue, aUseNetClearance)
 
def HitTestForCorner (self, args)
 
def HitTestForEdge (self, args)
 
def HitTest (self, args)
 
def FillZoneAreasWithSegments (self)
 
def UnFill (self)
 
def Move (self, offset)
 
def MoveEdge (self, offset, aEdge)
 
def Rotate (self, centre, angle)
 
def Flip (self, aCentre)
 
def Mirror (self, mirror_ref)
 
def GetClass (self)
 
def GetNumCorners (self)
 
def Iterate (self)
 
def IterateWithHoles (self)
 
def CIterateWithHoles (self)
 
def RemoveAllContours (self)
 
def GetCornerPosition (self, aCornerIndex)
 
def SetCornerPosition (self, aCornerIndex, new_pos)
 
def NewHole (self)
 
def AppendCorner
 
def GetHatchStyle (self)
 
def SetHatchStyle (self, aStyle)
 
def IsSame (self, aZoneToCompare)
 
def ClearFilledPolysList (self)
 
def GetFilledPolysList (self)
 
def AddFilledPolysList (self, aPolysList)
 
def GetSmoothedPoly (self)
 
def SetCornerSmoothingType (self, aType)
 
def GetCornerSmoothingType (self)
 
def SetCornerRadius (self, aRadius)
 
def GetCornerRadius (self)
 
def AddPolygon (self, aPolygon)
 
def AddFilledPolygon (self, aPolygon)
 
def AddFillSegments (self, aSegments)
 
def RawPolysList (self)
 
def GetSelectMenuText (self)
 
def GetMenuImage (self)
 
def Clone (self)
 
def GetIsKeepout (self)
 
def GetDoNotAllowCopperPour (self)
 
def GetDoNotAllowVias (self)
 
def GetDoNotAllowTracks (self)
 
def SetIsKeepout (self, aEnable)
 
def SetDoNotAllowCopperPour (self, aEnable)
 
def SetDoNotAllowVias (self, aEnable)
 
def SetDoNotAllowTracks (self, aEnable)
 
def GetHatchPitch (self)
 
def GetDefaultHatchPitch ()
 
def SetHatch (self, aHatchStyle, aHatchPitch, aRebuildHatch)
 
def SetHatchPitch (self, aPitch)
 
def UnHatch (self)
 
def Hatch (self)
 
def GetHatchLines (self)
 
- Public Member Functions inherited from pcbnew.BOARD_CONNECTED_ITEM
def __init__ (self, args, kwargs)
 
def ClassOf (aItem)
 
def IsConnected (self)
 
def GetNet (self)
 
def SetNet (self, aNetInfo)
 
def GetNetCode (self)
 
def SetNetCode
 
def GetNetname (self)
 
def GetShortNetname (self)
 
def GetClearance
 
def GetNetClass (self)
 
def GetNetClassName (self)
 
def SetLocalRatsnestVisible (self, aVisible)
 
def GetLocalRatsnestVisible (self)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
def __init__ (self, args, kwargs)
 
def GetPosition (self)
 
def GetCenter (self)
 
def SetPosition (self, aPos)
 
def IsConnected (self)
 
def Next (self)
 
def Back (self)
 
def GetParent (self)
 
def GetLayer (self)
 
def GetLayerSet (self)
 
def SetLayer (self, aLayer)
 
def Draw (self, args)
 
def SwapData (self, aImage)
 
def IsOnLayer (self, aLayer)
 
def IsTrack (self)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
def UnLink (self)
 
def DeleteStructure (self)
 
def ShowShape (aShape)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre)
 
def GetBoard (self)
 
def GetLayerName (self)
 
def HitTest (self, args)
 
def FormatAngle (aAngle)
 
def FormatInternalUnits (args)
 
def ViewGetLayers (self, aLayers, aCount)
 
def Cast (self)
 
def Duplicate (self)
 
def SetPos (self, p)
 
def SetStartEnd (self, start, end)
 
- Public Member Functions inherited from pcbnew.EDA_ITEM
def __init__ (self, args, kwargs)
 
def Type (self)
 
def SetTimeStamp (self, aNewTimeStamp)
 
def GetTimeStamp (self)
 
def Next (self)
 
def Back (self)
 
def GetParent (self)
 
def GetList (self)
 
def SetParent (self, aParent)
 
def SetList (self, aList)
 
def IsNew (self)
 
def IsModified (self)
 
def IsMoving (self)
 
def IsDragging (self)
 
def IsWireImage (self)
 
def IsSelected (self)
 
def IsResized (self)
 
def IsHighlighted (self)
 
def IsBrightened (self)
 
def SetWireImage (self)
 
def SetSelected (self)
 
def SetHighlighted (self)
 
def SetBrightened (self)
 
def ClearSelected (self)
 
def ClearHighlighted (self)
 
def ClearBrightened (self)
 
def SetModified (self)
 
def GetState (self, type)
 
def SetState (self, type, state)
 
def GetStatus (self)
 
def SetStatus (self, aStatus)
 
def SetFlags (self, aMask)
 
def ClearFlags
 
def GetFlags (self)
 
def SetForceVisible (self, aEnable)
 
def GetMsgPanelInfo (self, aList)
 
def HitTest (self, aPosition)
 
def GetBoundingBox (self)
 
def Clone (self)
 
def IterateForward (listStart, inspector, testData, scanTypes)
 
def Visit (self, inspector, testData, scanTypes)
 
def GetClass (self)
 
def GetSelectMenuText (self)
 
def GetMenuImage (self)
 
def Matches (self, aSearchData, aAuxData, aFindLocation)
 
def Replace (self, args)
 
def IsReplaceable (self)
 
def __lt__ (self, aItem)
 
def Sort (aLeft, aRight)
 
def ViewBBox (self)
 
def ViewGetLayers (self, aLayers, aCount)
 

Public Attributes

 this
 

Static Public Attributes

 NO_HATCH = _pcbnew.ZONE_CONTAINER_NO_HATCH
 
 DIAGONAL_FULL = _pcbnew.ZONE_CONTAINER_DIAGONAL_FULL
 
 DIAGONAL_EDGE = _pcbnew.ZONE_CONTAINER_DIAGONAL_EDGE
 
tuple GetDefaultHatchPitch = staticmethod(GetDefaultHatchPitch)
 
- Static Public Attributes inherited from pcbnew.BOARD_CONNECTED_ITEM
tuple ClassOf = staticmethod(ClassOf)
 
- Static Public Attributes inherited from pcbnew.BOARD_ITEM
tuple ShowShape = staticmethod(ShowShape)
 
tuple FormatAngle = staticmethod(FormatAngle)
 
tuple FormatInternalUnits = staticmethod(FormatInternalUnits)
 
- Static Public Attributes inherited from pcbnew.EDA_ITEM
tuple IterateForward = staticmethod(IterateForward)
 
tuple Sort = staticmethod(Sort)
 

Detailed Description

Class ZONE_CONTAINER handles a list of polygons defining a copper
zone.

A zone is described by a main polygon, a time stamp, a layer, and a
net name. Other polygons inside the main polygon are holes in the
zone.

C++ includes: class_zone.h 

Definition at line 24700 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.ZONE_CONTAINER.__init__ (   self,
  args 
)
__init__(ZONE_CONTAINER self, BOARD parent) -> ZONE_CONTAINER
__init__(ZONE_CONTAINER self, ZONE_CONTAINER aZone) -> ZONE_CONTAINER

ZONE_CONTAINER::ZONE_CONTAINER(const ZONE_CONTAINER &aZone) 

Definition at line 24726 of file pcbnew.py.

Member Function Documentation

def pcbnew.ZONE_CONTAINER.AddClearanceAreasPolygonsToPolysList (   self,
  aPcb 
)
AddClearanceAreasPolygonsToPolysList(ZONE_CONTAINER self, BOARD aPcb)

void
ZONE_CONTAINER::AddClearanceAreasPolygonsToPolysList(BOARD *aPcb)

Function AddClearanceAreasPolygonsToPolysList Add non copper areas
polygons (pads and tracks with clearance) to a filled copper area used
in BuildFilledSolidAreasPolygons when calculating filled areas in a
zone Non copper areas are pads and track and their clearance area The
filled copper area must be computed before
BuildFilledSolidAreasPolygons() call this function just after creating
the filled copper area polygon (without clearance areas.

Parameters:
-----------

aPcb:  the current board _NG version uses SHAPE_POLY_SET instead of
Boost.Polygon 

Definition at line 25321 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.ZONE_CONTAINER.AddClearanceAreasPolygonsToPolysList_NG (   self,
  aPcb 
)
AddClearanceAreasPolygonsToPolysList_NG(ZONE_CONTAINER self, BOARD aPcb)

void
ZONE_CONTAINER::AddClearanceAreasPolygonsToPolysList_NG(BOARD *aPcb)

Function AddClearanceAreasPolygonsToPolysList Supports a min thickness
area constraint.

Add non copper areas polygons (pads and tracks with clearance) to the
filled copper area found in BuildFilledPolysListData after calculating
filled areas in a zone Non filled copper areas are pads and track and
their clearance areas The filled copper area must be computed just
before. BuildFilledPolysListData() call this function just after
creating the filled copper area polygon (without clearance areas) to
do that this function: 1 - Creates the main outline (zone outline)
using a correction to shrink the resulting area with
m_ZoneMinThickness/2 value. The result is areas with a margin of
m_ZoneMinThickness/2 When drawing outline with segments having a
thickness of m_ZoneMinThickness, the outlines will match exactly the
initial outlines 3 - Add all non filled areas (pads, tracks) in group
B with a clearance of m_Clearance + m_ZoneMinThickness/2 in a buffer
If Thermal shapes are wanted, add non filled area, in order to create
these thermal shapes 4 - calculates the polygon A - B 5 - put
resulting list of polygons (filled areas) in m_FilledPolysList This
zone contains pads with the same net. 6 - Remove insulated copper
islands 7 - If Thermal shapes are wanted, remove unconnected stubs in
thermal shapes: creates a buffer of polygons corresponding to stubs to
remove sub them to the filled areas. Remove new insulated copper
islands 

Definition at line 25345 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.AddFilledPolygon (   self,
  aPolygon 
)
AddFilledPolygon(ZONE_CONTAINER self, SHAPE_POLY_SET aPolygon)

void
ZONE_CONTAINER::AddFilledPolygon(SHAPE_POLY_SET &aPolygon)

add a polygon to the zone filled areas list.

these polygons have no hole, therefore any added polygon is a new
filled area 

Definition at line 25896 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.AddFilledPolysList (   self,
  aPolysList 
)
AddFilledPolysList(ZONE_CONTAINER self, SHAPE_POLY_SET aPolysList)

void
ZONE_CONTAINER::AddFilledPolysList(SHAPE_POLY_SET &aPolysList)

Function AddFilledPolysList sets the list of filled polygons. 

Definition at line 25817 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.AddFillSegments (   self,
  aSegments 
)
AddFillSegments(ZONE_CONTAINER self, std::vector< SEGMENT,std::allocator< SEGMENT > > & aSegments)

void
ZONE_CONTAINER::AddFillSegments(std::vector< SEGMENT > &aSegments) 

Definition at line 25911 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.AddPolygon (   self,
  aPolygon 
)
AddPolygon(ZONE_CONTAINER self, wxPoint_Vector aPolygon)

void
ZONE_CONTAINER::AddPolygon(std::vector< wxPoint > &aPolygon)

add a polygon to the zone outline if the zone outline is empty, this
is the main outline else it is a hole inside the main outline 

Definition at line 25883 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.AppendCorner (   self,
  aPosition,
  aHoleIdx,
  aAllowDuplication = False 
)
AppendCorner(ZONE_CONTAINER self, wxPoint aPosition, int aHoleIdx, bool aAllowDuplication=False) -> bool
AppendCorner(ZONE_CONTAINER self, wxPoint aPosition, int aHoleIdx) -> bool

bool
ZONE_CONTAINER::AppendCorner(wxPoint aPosition, int aHoleIdx, bool
aAllowDuplication=false)

Add a new corner to the zone outline (to the main outline or a hole)

Parameters:
-----------

aPosition:  is the position of the new corner.

aHoleIdx:  is the index of the hole (-1 for the main outline, >= 0 for
hole).

aAllowDuplication:  is a flag to indicate whether it is allowed to add
this corner even if it is duplicated.

true if the corner was added, false if error (aHoleIdx > hole count
-1) 

Definition at line 25719 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.BuildFilledSolidAreasPolygons (   self,
  aPcb,
  aOutlineBuffer = None 
)
BuildFilledSolidAreasPolygons(ZONE_CONTAINER self, BOARD aPcb, SHAPE_POLY_SET aOutlineBuffer=None) -> bool
BuildFilledSolidAreasPolygons(ZONE_CONTAINER self, BOARD aPcb) -> bool

bool ZONE_CONTAINER::BuildFilledSolidAreasPolygons(BOARD *aPcb,
SHAPE_POLY_SET *aOutlineBuffer=NULL)

Build the filled solid areas polygons from zone outlines (stored in
m_Poly) The solid areas can be more than one on copper layers, and do
not have holes ( holes are linked by overlapping segments to the main
outline) in order to have drawable (and plottable) filled polygons.

true if OK, false if the solid polygons cannot be built

Parameters:
-----------

aPcb:  the current board (can be NULL for non copper zones)

aOutlineBuffer:  A reference to a SHAPE_POLY_SET buffer to store
polygons, or NULL. if NULL (default): m_FilledPolysList is used to
store solid areas polygons.

on copper layers, tracks and other items shapes of other nets are
removed from solid areas if not null: Only the zone outline (with
holes, if any) is stored in aOutlineBuffer with holes linked.
Therefore only one polygon is created

When aOutlineBuffer is not null, his function calls
AddClearanceAreasPolygonsToPolysList() to add holes for pads and
tracks and other items not in net. 

Definition at line 25285 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.ZONE_CONTAINER.CIterateWithHoles (   self)
CIterateWithHoles(ZONE_CONTAINER self) -> SHAPE_POLY_SET::CONST_ITERATOR

SHAPE_POLY_SET::CONST_ITERATOR ZONE_CONTAINER::CIterateWithHoles()
const

Function CIterateWithHoles returns an iterator to visit all points of
the zone's main outline with holes.

SHAPE_POLY_SET::ITERATOR - an iterator to visit the zone vertices with
holes. 

Definition at line 25659 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.ClearFilledPolysList (   self)
ClearFilledPolysList(ZONE_CONTAINER self)

void
ZONE_CONTAINER::ClearFilledPolysList()

Function ClearFilledPolysList clears the list of filled polygons. 

Definition at line 25790 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.Clone (   self)
Clone(ZONE_CONTAINER self) -> EDA_ITEM

EDA_ITEM *
ZONE_CONTAINER::Clone() const override

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.

A clone of the item. 

Definition at line 25968 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.Draw (   self,
  args 
)
Draw(ZONE_CONTAINER self, EDA_DRAW_PANEL * panel, wxDC * DC, GR_DRAWMODE aDrawMode, wxPoint offset)
Draw(ZONE_CONTAINER self, EDA_DRAW_PANEL * panel, wxDC * DC, GR_DRAWMODE aDrawMode)

void
ZONE_CONTAINER::Draw(EDA_DRAW_PANEL *panel, wxDC *DC, GR_DRAWMODE
aDrawMode, const wxPoint &offset=ZeroOffset) override

Function Draw Draws the zone outline.

Parameters:
-----------

panel:  = current Draw Panel

DC:  = current Device Context

aDrawMode:  = GR_OR, GR_XOR, GR_COPY ..

offset:  = Draw offset (usually wxPoint(0,0)) 

Definition at line 24826 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.DrawFilledArea (   self,
  args 
)
DrawFilledArea(ZONE_CONTAINER self, EDA_DRAW_PANEL * panel, wxDC * DC, GR_DRAWMODE aDrawMode, wxPoint offset)
DrawFilledArea(ZONE_CONTAINER self, EDA_DRAW_PANEL * panel, wxDC * DC, GR_DRAWMODE aDrawMode)

void
ZONE_CONTAINER::DrawFilledArea(EDA_DRAW_PANEL *panel, wxDC *DC,
GR_DRAWMODE aDrawMode, const wxPoint &offset=ZeroOffset)

Function DrawDrawFilledArea Draws the filled area for this zone
(polygon list .m_FilledPolysList)

Parameters:
-----------

panel:  = current Draw Panel

DC:  = current Device Context

offset:  = Draw offset (usually wxPoint(0,0))

aDrawMode:  = GR_OR, GR_XOR, GR_COPY .. 

Definition at line 24851 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.DrawWhileCreateOutline (   self,
  args 
)
DrawWhileCreateOutline(ZONE_CONTAINER self, EDA_DRAW_PANEL * panel, wxDC * DC, GR_DRAWMODE draw_mode)
DrawWhileCreateOutline(ZONE_CONTAINER self, EDA_DRAW_PANEL * panel, wxDC * DC)

void
ZONE_CONTAINER::DrawWhileCreateOutline(EDA_DRAW_PANEL *panel, wxDC
*DC, GR_DRAWMODE draw_mode=GR_OR)

Function DrawWhileCreateOutline Draws the zone outline when it is
created.

The moving edges are in XOR graphic mode, old segment in draw_mode
graphic mode (usually GR_OR). The closing edge has its own shape.

Parameters:
-----------

panel:  = current Draw Panel

DC:  = current Device Context

draw_mode:  = draw mode: OR, XOR .. 

Definition at line 24877 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.FillSegments (   self,
  args 
)
FillSegments(ZONE_CONTAINER self) -> std::vector< SEGMENT,std::allocator< SEGMENT > >
FillSegments(ZONE_CONTAINER self) -> std::vector< SEGMENT,std::allocator< SEGMENT > > const &

const
std::vector<SEGMENT>& ZONE_CONTAINER::FillSegments() const 

Definition at line 25184 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.FillZoneAreasWithSegments (   self)
FillZoneAreasWithSegments(ZONE_CONTAINER self) -> bool

bool ZONE_CONTAINER::FillZoneAreasWithSegments()

Function FillZoneAreasWithSegments Fill sub areas in a zone with
segments with m_ZoneMinThickness width A scan is made line per line,
on the whole filled areas, with a step of m_ZoneMinThickness.

all intersecting points with the horizontal infinite line and polygons
to fill are calculated a list of SEGZONE items is built, line per line
true if success, false on error 

Definition at line 25478 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.Flip (   self,
  aCentre 
)
Flip(ZONE_CONTAINER self, wxPoint aCentre)

void
ZONE_CONTAINER::Flip(const wxPoint &aCentre) override

Function Flip Flip this object, i.e.

change the board side for this object (like Mirror() but changes
layer)

Parameters:
-----------

aCentre:  - the rotation point. 

Definition at line 25565 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetArcSegmentCount (   self)
GetArcSegmentCount(ZONE_CONTAINER self) -> int

int
ZONE_CONTAINER::GetArcSegmentCount() const 

Definition at line 25052 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetBoundingBox (   self)
GetBoundingBox(ZONE_CONTAINER self) -> EDA_RECT

const EDA_RECT
ZONE_CONTAINER::GetBoundingBox() const override

Function GetBoundingBox (virtual)

an EDA_RECT that is the bounding box of the zone outline 

Definition at line 24904 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetClass (   self)
GetClass(ZONE_CONTAINER self) -> wxString

wxString
ZONE_CONTAINER::GetClass() const override

Function GetClass returns the class name.

wxString 

Definition at line 25603 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetClearance (   self,
  aItem = None 
)
GetClearance(ZONE_CONTAINER self, BOARD_CONNECTED_ITEM aItem=None) -> int
GetClearance(ZONE_CONTAINER self) -> int

int
ZONE_CONTAINER::GetClearance(BOARD_CONNECTED_ITEM *aItem=NULL) const
override

Function GetClearance returns the clearance in internal units.

If aItem is not NULL then the returned clearance is the greater of
this object's NETCLASS clearance and aItem's NETCLASS clearance. If
aItem is NULL, then this objects clearance is returned.

Parameters:
-----------

aItem:  is another BOARD_CONNECTED_ITEM or NULL

int - the clearance in internal units. 

Definition at line 24918 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetCornerPosition (   self,
  aCornerIndex 
)
GetCornerPosition(ZONE_CONTAINER self, int aCornerIndex) -> VECTOR2I const &

const
VECTOR2I& ZONE_CONTAINER::GetCornerPosition(int aCornerIndex) const 

Definition at line 25685 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetCornerRadius (   self)
GetCornerRadius(ZONE_CONTAINER self) -> unsigned int

unsigned int
ZONE_CONTAINER::GetCornerRadius() const 

Definition at line 25873 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetCornerSmoothingType (   self)
GetCornerSmoothingType(ZONE_CONTAINER self) -> int

int
ZONE_CONTAINER::GetCornerSmoothingType() const 

Definition at line 25853 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetDefaultHatchPitch ( )
GetDefaultHatchPitch() -> int

Definition at line 26087 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetDoNotAllowCopperPour (   self)
GetDoNotAllowCopperPour(ZONE_CONTAINER self) -> bool

bool
ZONE_CONTAINER::GetDoNotAllowCopperPour() const 

Definition at line 26003 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetDoNotAllowTracks (   self)
GetDoNotAllowTracks(ZONE_CONTAINER self) -> bool

bool
ZONE_CONTAINER::GetDoNotAllowTracks() const 

Definition at line 26023 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetDoNotAllowVias (   self)
GetDoNotAllowVias(ZONE_CONTAINER self) -> bool

bool
ZONE_CONTAINER::GetDoNotAllowVias() const 

Definition at line 26013 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetFilledPolysList (   self)
GetFilledPolysList(ZONE_CONTAINER self) -> SHAPE_POLY_SET

const
SHAPE_POLY_SET& ZONE_CONTAINER::GetFilledPolysList() const

Function GetFilledPolysList returns a reference to the list of filled
polygons.

Reference to the list of filled polygons. 

Definition at line 25802 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetFillMode (   self)
GetFillMode(ZONE_CONTAINER self) -> int

int
ZONE_CONTAINER::GetFillMode() const 

Definition at line 24990 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetHatchLines (   self)
GetHatchLines(ZONE_CONTAINER self) -> std::vector< SEG,std::allocator< SEG > > const &

const
std::vector<SEG>& ZONE_CONTAINER::GetHatchLines() const 

Definition at line 26161 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetHatchPitch (   self)
GetHatchPitch(ZONE_CONTAINER self) -> int

int
ZONE_CONTAINER::GetHatchPitch() const

Hatch related methods.

Function GetHatchPitch int - the zone hatch pitch in iu. 

Definition at line 26073 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetHatchStyle (   self)
GetHatchStyle(ZONE_CONTAINER self) -> ZONE_CONTAINER::HATCH_STYLE

HATCH_STYLE
ZONE_CONTAINER::GetHatchStyle() const 

Definition at line 25747 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetIsKeepout (   self)
GetIsKeepout(ZONE_CONTAINER self) -> bool

bool
ZONE_CONTAINER::GetIsKeepout() const

Accessors to parameters used in Keepout zones: 

Definition at line 25991 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetLocalFlags (   self)
GetLocalFlags(ZONE_CONTAINER self) -> int

int
ZONE_CONTAINER::GetLocalFlags() const 

Definition at line 25164 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetMenuImage (   self)
GetMenuImage(ZONE_CONTAINER self) -> BITMAP_DEF

BITMAP_DEF
ZONE_CONTAINER::GetMenuImage() const override

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. The menu image
associated with the item. 

Definition at line 25951 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetMinThickness (   self)
GetMinThickness(ZONE_CONTAINER self) -> int

int
ZONE_CONTAINER::GetMinThickness() const 

Definition at line 25123 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetMsgPanelInfo (   self,
  aList 
)
GetMsgPanelInfo(ZONE_CONTAINER self, std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > & aList)

void
ZONE_CONTAINER::GetMsgPanelInfo(std::vector< MSG_PANEL_ITEM > &aList)
override

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

This method replaces DisplayInfo() so that KiCad objects no longer
have any knowledge of wxWidgets UI objects.

Parameters:
-----------

aList:  is the list to populate. 

Definition at line 24804 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetNumCorners (   self)
GetNumCorners(ZONE_CONTAINER self) -> int

int
ZONE_CONTAINER::GetNumCorners(void) const

Access to m_Poly parameters. 

Definition at line 25617 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetPadConnection (   self,
  aPad = None 
)
GetPadConnection(ZONE_CONTAINER self, D_PAD aPad=None) -> ZoneConnection
GetPadConnection(ZONE_CONTAINER self) -> ZoneConnection

ZoneConnection ZONE_CONTAINER::GetPadConnection(D_PAD *aPad=NULL)
const 

Definition at line 25102 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetPosition (   self)
GetPosition(ZONE_CONTAINER self) -> wxPoint

const wxPoint &
ZONE_CONTAINER::GetPosition() const override

Function GetPosition.

Returns a reference to the first corner of the polygon set.

WARNING:  The implementation of this function relies on the fact that
wxPoint and VECTOR2I have the same layout. If you intend to use the
returned reference directly, please note that you are only allowed to
use members x and y. Any use on anything that is not one of these
members will have undefined behaviour.

a wxPoint, position of the first point of the outline 

Definition at line 24741 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetPriority (   self)
GetPriority(ZONE_CONTAINER self) -> unsigned int

unsigned
ZONE_CONTAINER::GetPriority() const

Function GetPriority.

the priority level of this zone 

Definition at line 24790 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetSelectedCorner (   self)
GetSelectedCorner(ZONE_CONTAINER self) -> int

int
ZONE_CONTAINER::GetSelectedCorner() const 

Definition at line 25143 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetSelectMenuText (   self)
GetSelectMenuText(ZONE_CONTAINER self) -> wxString

wxString
ZONE_CONTAINER::GetSelectMenuText() const override

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.

The menu text string. 

Definition at line 25931 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetSmoothedPoly (   self)
GetSmoothedPoly(ZONE_CONTAINER self) -> SHAPE_POLY_SET

SHAPE_POLY_SET* ZONE_CONTAINER::GetSmoothedPoly() const

Function GetSmoothedPoly returns a pointer to the corner-smoothed
version of m_Poly if it exists, otherwise it returns m_Poly.

SHAPE_POLY_SET* - pointer to the polygon. 

Definition at line 25829 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetThermalReliefCopperBridge (   self,
  aPad = None 
)
GetThermalReliefCopperBridge(ZONE_CONTAINER self, D_PAD aPad=None) -> int
GetThermalReliefCopperBridge(ZONE_CONTAINER self) -> int

int ZONE_CONTAINER::GetThermalReliefCopperBridge(D_PAD *aPad=NULL)
const 

Definition at line 25031 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetThermalReliefGap (   self,
  aPad = None 
)
GetThermalReliefGap(ZONE_CONTAINER self, D_PAD aPad=None) -> int
GetThermalReliefGap(ZONE_CONTAINER self) -> int

int
ZONE_CONTAINER::GetThermalReliefGap(D_PAD *aPad=NULL) const 

Definition at line 25010 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetZoneClearance (   self)
GetZoneClearance(ZONE_CONTAINER self) -> int

int
ZONE_CONTAINER::GetZoneClearance() const 

Definition at line 25082 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.Hatch (   self)
Hatch(ZONE_CONTAINER self)

void
ZONE_CONTAINER::Hatch()

Function Hatch computes the hatch lines depending on the hatch
parameters and stores it in the zone's attribute m_HatchLines. 

Definition at line 26148 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.HitTest (   self,
  args 
)
HitTest(ZONE_CONTAINER self, wxPoint aPosition) -> bool
HitTest(ZONE_CONTAINER self, EDA_RECT aRect, bool aContained=True, int aAccuracy=0) -> bool
HitTest(ZONE_CONTAINER self, EDA_RECT aRect, bool aContained=True) -> bool
HitTest(ZONE_CONTAINER self, EDA_RECT aRect) -> bool

bool
ZONE_CONTAINER::HitTest(const EDA_RECT &aRect, bool aContained=true,
int aAccuracy=0) const override

Parameters:
-----------

aRect:  A reference to an EDA_RECT object containg the area to test.

aContained:  Test if aRect contains this object completly.

aAccuracy:  Increase the item bounding box by this amount.

bool - True if aRect contains this object completly or if aRect
intersects the object and aContained is False, otherwise false. 

Definition at line 25452 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.HitTestFilledArea (   self,
  aRefPos 
)
HitTestFilledArea(ZONE_CONTAINER self, wxPoint aRefPos) -> bool

bool
ZONE_CONTAINER::HitTestFilledArea(const wxPoint &aRefPos) const

Function HitTestFilledArea tests if the given wxPoint is within the
bounds of a filled area of this zone.

Parameters:
-----------

aRefPos:  A wxPoint to test

bool - true if a hit, else false 

Definition at line 25237 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.HitTestForCorner (   self,
  args 
)
HitTestForCorner(ZONE_CONTAINER self, wxPoint refPos, SHAPE_POLY_SET::VERTEX_INDEX & aCornerHit) -> bool
HitTestForCorner(ZONE_CONTAINER self, wxPoint refPos) -> bool

bool
ZONE_CONTAINER::HitTestForCorner(const wxPoint &refPos) const

Function HitTestForCorner tests if the given wxPoint is near a corner.

Parameters:
-----------

refPos:  is the wxPoint to test.

bool - true if some corner was found to be closer to refPos than
aClearance; false otherwise. 

Definition at line 25409 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.HitTestForEdge (   self,
  args 
)
HitTestForEdge(ZONE_CONTAINER self, wxPoint refPos, SHAPE_POLY_SET::VERTEX_INDEX & aCornerHit) -> bool
HitTestForEdge(ZONE_CONTAINER self, wxPoint refPos) -> bool

bool
ZONE_CONTAINER::HitTestForEdge(const wxPoint &refPos) const

Function HitTestForEdge tests if the given wxPoint is near a segment
defined by 2 corners.

Parameters:
-----------

refPos:  is the wxPoint to test.

bool - true if some edge was found to be closer to refPos than
aClearance. 

Definition at line 25430 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.HitTestInsideZone (   self,
  aPosition 
)
HitTestInsideZone(ZONE_CONTAINER self, wxPoint aPosition) -> bool

bool
ZONE_CONTAINER::HitTestInsideZone(const wxPoint &aPosition) const

Function HitTest tests if a point is inside the zone area, i.e.

inside the main outline and outside holes.

Parameters:
-----------

aPosition:  : the wxPoint to test

bool - true if a hit, else false 

Definition at line 25216 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.IsFilled (   self)
IsFilled(ZONE_CONTAINER self) -> bool

bool
ZONE_CONTAINER::IsFilled() const 

Definition at line 25062 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.IsOnCopperLayer (   self)
IsOnCopperLayer(ZONE_CONTAINER self) -> bool

bool
ZONE_CONTAINER::IsOnCopperLayer() const

Function IsOnCopperLayer.

true if this zone is on a copper layer, false if on a technical layer

Definition at line 24962 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.IsSame (   self,
  aZoneToCompare 
)
IsSame(ZONE_CONTAINER self, ZONE_CONTAINER aZoneToCompare) -> bool

bool
ZONE_CONTAINER::IsSame(const ZONE_CONTAINER &aZoneToCompare)

Function IsSame tests if 2 zones are equivalent: 2 zones are
equivalent if they have same parameters and same outlines info,
filling is not taken into account.

Function IsSame test is 2 zones are equivalent: 2 zones are equivalent
if they have same parameters and same outlines info relative to
filling is not take in account.

Parameters:
-----------

aZoneToCompare:  = zone to compare with "this" 

Definition at line 25767 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.Iterate (   self)
Iterate(ZONE_CONTAINER self) -> SHAPE_POLY_SET::ITERATOR

SHAPE_POLY_SET::ITERATOR ZONE_CONTAINER::Iterate()

Function Iterate returns an iterator to visit all points of the zone's
main outline without holes.

SHAPE_POLY_SET::ITERATOR - an iterator to visit the zone vertices
without holes. 

Definition at line 25629 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.IterateWithHoles (   self)
IterateWithHoles(ZONE_CONTAINER self) -> SHAPE_POLY_SET::ITERATOR

SHAPE_POLY_SET::ITERATOR ZONE_CONTAINER::IterateWithHoles()

Function IterateWithHoles returns an iterator to visit all points of
the zone's main outline with holes.

SHAPE_POLY_SET::ITERATOR - an iterator to visit the zone vertices with
holes. 

Definition at line 25644 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.Mirror (   self,
  mirror_ref 
)
Mirror(ZONE_CONTAINER self, wxPoint mirror_ref)

void
ZONE_CONTAINER::Mirror(const wxPoint &mirror_ref)

Function Mirror Mirror the outlines , relative to a given horizontal
axis the layer is not changed.

Parameters:
-----------

mirror_ref:  = vertical axis position 

Definition at line 25585 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.ZONE_CONTAINER.Move (   self,
  offset 
)
Move(ZONE_CONTAINER self, wxPoint offset)

void
ZONE_CONTAINER::Move(const wxPoint &offset) override

Function Move Move the outlines.

Parameters:
-----------

offset:  = moving vector 

Definition at line 25510 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.MoveEdge (   self,
  offset,
  aEdge 
)
MoveEdge(ZONE_CONTAINER self, wxPoint offset, int aEdge)

void
ZONE_CONTAINER::MoveEdge(const wxPoint &offset, int aEdge)

Function MoveEdge Move the outline Edge.

Parameters:
-----------

offset:  = moving vector

aEdge:  = start point of the outline edge 

Definition at line 25527 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.NewHole (   self)
NewHole(ZONE_CONTAINER self)

void
ZONE_CONTAINER::NewHole()

Function NewHole creates a new hole on the zone; i.e., a new contour
on the zone's outline. 

Definition at line 25706 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.Outline (   self,
  args 
)
Outline(ZONE_CONTAINER self) -> SHAPE_POLY_SET
Outline(ZONE_CONTAINER self) -> SHAPE_POLY_SET

const SHAPE_POLY_SET*
ZONE_CONTAINER::Outline() const 

Definition at line 25195 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.RawPolysList (   self)
RawPolysList(ZONE_CONTAINER self) -> SHAPE_POLY_SET

SHAPE_POLY_SET&
ZONE_CONTAINER::RawPolysList() 

Definition at line 25921 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.RemoveAllContours (   self)
RemoveAllContours(ZONE_CONTAINER self)

void
ZONE_CONTAINER::RemoveAllContours(void) 

Definition at line 25675 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.Rotate (   self,
  centre,
  angle 
)
Rotate(ZONE_CONTAINER self, wxPoint centre, double angle)

void
ZONE_CONTAINER::Rotate(const wxPoint &centre, double angle) override

Function Rotate Move the outlines.

Parameters:
-----------

centre:  = rot centre

angle:  = in 0.1 degree 

Definition at line 25546 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetArcSegmentCount (   self,
  aArcSegCount 
)
SetArcSegmentCount(ZONE_CONTAINER self, int aArcSegCount)

void
ZONE_CONTAINER::SetArcSegmentCount(int aArcSegCount) 

Definition at line 25042 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetCornerPosition (   self,
  aCornerIndex,
  new_pos 
)
SetCornerPosition(ZONE_CONTAINER self, int aCornerIndex, wxPoint new_pos)

void
ZONE_CONTAINER::SetCornerPosition(int aCornerIndex, wxPoint new_pos)

Definition at line 25695 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetCornerRadius (   self,
  aRadius 
)
SetCornerRadius(ZONE_CONTAINER self, unsigned int aRadius)

void
ZONE_CONTAINER::SetCornerRadius(unsigned int aRadius) 

Definition at line 25863 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetCornerSmoothingType (   self,
  aType 
)
SetCornerSmoothingType(ZONE_CONTAINER self, int aType)

void
ZONE_CONTAINER::SetCornerSmoothingType(int aType) 

Definition at line 25843 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetDoNotAllowCopperPour (   self,
  aEnable 
)
SetDoNotAllowCopperPour(ZONE_CONTAINER self, bool aEnable)

void
ZONE_CONTAINER::SetDoNotAllowCopperPour(bool aEnable) 

Definition at line 26043 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetDoNotAllowTracks (   self,
  aEnable 
)
SetDoNotAllowTracks(ZONE_CONTAINER self, bool aEnable)

void
ZONE_CONTAINER::SetDoNotAllowTracks(bool aEnable) 

Definition at line 26063 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetDoNotAllowVias (   self,
  aEnable 
)
SetDoNotAllowVias(ZONE_CONTAINER self, bool aEnable)

void
ZONE_CONTAINER::SetDoNotAllowVias(bool aEnable) 

Definition at line 26053 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetFillMode (   self,
  aFillMode 
)
SetFillMode(ZONE_CONTAINER self, int aFillMode)

void
ZONE_CONTAINER::SetFillMode(int aFillMode)

How to fill areas: 0 = use filled polygons, 1 => fill with segments.

Definition at line 24977 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetHatch (   self,
  aHatchStyle,
  aHatchPitch,
  aRebuildHatch 
)
SetHatch(ZONE_CONTAINER self, int aHatchStyle, int aHatchPitch, bool aRebuildHatch)

void
ZONE_CONTAINER::SetHatch(int aHatchStyle, int aHatchPitch, bool
aRebuildHatch)

Function SetHatch sets all hatch parameters for the zone.

Parameters:
-----------

aHatchStyle:  is the style of the hatch, specified as one of
HATCH_STYLE possible values.

aHatchPitch:  is the hatch pitch in iu.

aRebuildHatch:  is a flag to indicate whether to re-hatch after having
set the previous parameters. 

Definition at line 26095 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetHatchPitch (   self,
  aPitch 
)
SetHatchPitch(ZONE_CONTAINER self, int aPitch)

void
ZONE_CONTAINER::SetHatchPitch(int aPitch)

Function SetHatchPitch sets the hatch pitch parameter for the zone.

Parameters:
-----------

aPitch:  is the hatch pitch in iu. 

Definition at line 26119 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetHatchStyle (   self,
  aStyle 
)
SetHatchStyle(ZONE_CONTAINER self, ZONE_CONTAINER::HATCH_STYLE aStyle)

void
ZONE_CONTAINER::SetHatchStyle(HATCH_STYLE aStyle) 

Definition at line 25757 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetIsFilled (   self,
  isFilled 
)
SetIsFilled(ZONE_CONTAINER self, bool isFilled)

void
ZONE_CONTAINER::SetIsFilled(bool isFilled) 

Definition at line 25072 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetIsKeepout (   self,
  aEnable 
)
SetIsKeepout(ZONE_CONTAINER self, bool aEnable)

void
ZONE_CONTAINER::SetIsKeepout(bool aEnable) 

Definition at line 26033 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetLocalFlags (   self,
  aFlags 
)
SetLocalFlags(ZONE_CONTAINER self, int aFlags)

void
ZONE_CONTAINER::SetLocalFlags(int aFlags) 

Definition at line 25174 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetMinThickness (   self,
  aMinThickness 
)
SetMinThickness(ZONE_CONTAINER self, int aMinThickness)

void
ZONE_CONTAINER::SetMinThickness(int aMinThickness) 

Definition at line 25133 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetOutline (   self,
  aOutline 
)
SetOutline(ZONE_CONTAINER self, SHAPE_POLY_SET aOutline)

void
ZONE_CONTAINER::SetOutline(SHAPE_POLY_SET *aOutline) 

Definition at line 25206 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetPadConnection (   self,
  aPadConnection 
)
SetPadConnection(ZONE_CONTAINER self, ZoneConnection aPadConnection)

void
ZONE_CONTAINER::SetPadConnection(ZoneConnection aPadConnection) 

Definition at line 25113 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetPosition (   self,
  aPos 
)
SetPosition(ZONE_CONTAINER self, wxPoint aPos)

void
ZONE_CONTAINER::SetPosition(const wxPoint &aPos) override 

Definition at line 24763 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetPriority (   self,
  aPriority 
)
SetPriority(ZONE_CONTAINER self, unsigned int aPriority)

void
ZONE_CONTAINER::SetPriority(unsigned aPriority)

Function SetPriority.

Parameters:
-----------

aPriority:  = the priority level 

Definition at line 24773 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetSelectedCorner (   self,
  args 
)
SetSelectedCorner(ZONE_CONTAINER self, int aCorner)
SetSelectedCorner(ZONE_CONTAINER self, wxPoint aPosition)

void
ZONE_CONTAINER::SetSelectedCorner(const wxPoint &aPosition) 

Definition at line 25153 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetThermalReliefCopperBridge (   self,
  aThermalReliefCopperBridge 
)
SetThermalReliefCopperBridge(ZONE_CONTAINER self, int aThermalReliefCopperBridge)

void ZONE_CONTAINER::SetThermalReliefCopperBridge(int
aThermalReliefCopperBridge) 

Definition at line 25021 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetThermalReliefGap (   self,
  aThermalReliefGap 
)
SetThermalReliefGap(ZONE_CONTAINER self, int aThermalReliefGap)

void
ZONE_CONTAINER::SetThermalReliefGap(int aThermalReliefGap) 

Definition at line 25000 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetZoneClearance (   self,
  aZoneClearance 
)
SetZoneClearance(ZONE_CONTAINER self, int aZoneClearance)

void
ZONE_CONTAINER::SetZoneClearance(int aZoneClearance) 

Definition at line 25092 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.TestForCopperIslandAndRemoveInsulatedIslands (   self,
  aPcb 
)
TestForCopperIslandAndRemoveInsulatedIslands(ZONE_CONTAINER self, BOARD aPcb)

void
ZONE_CONTAINER::TestForCopperIslandAndRemoveInsulatedIslands(BOARD
*aPcb)

Function TestForCopperIslandAndRemoveInsulatedIslands Remove insulated
copper islands found in m_FilledPolysList.

Parameters:
-----------

aPcb:  = the board to analyze 

Definition at line 24943 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.TransformOutlinesShapeWithClearanceToPolygon (   self,
  aCornerBuffer,
  aMinClearanceValue,
  aUseNetClearance 
)
TransformOutlinesShapeWithClearanceToPolygon(ZONE_CONTAINER self, SHAPE_POLY_SET aCornerBuffer, int aMinClearanceValue, bool aUseNetClearance)

void ZO
NE_CONTAINER::TransformOutlinesShapeWithClearanceToPolygon(SHAPE_POLY_
SET &aCornerBuffer, int aMinClearanceValue, bool aUseNetClearance)

Function TransformOutlinesShapeWithClearanceToPolygon Convert the
outlines shape to a polygon with no holes inflated (optional) by max(
aClearanceValue, the zone clearance) (holes are linked to external
outline by overlapping segments) Used in filling zones calculations
Circles (vias) and arcs (ends of tracks) are approximated by segments.

Parameters:
-----------

aCornerBuffer:  = a buffer to store the polygon

aMinClearanceValue:  = the min clearance around outlines

aUseNetClearance:  = true to use a clearance which is the max value
between aMinClearanceValue and the net clearance false to use
aMinClearanceValue only if both aMinClearanceValue = 0 and
aUseNetClearance = false: create the zone outline polygon. 

Definition at line 25380 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.TransformSolidAreasShapesToPolygonSet (   self,
  aCornerBuffer,
  aCircleToSegmentsCount,
  aCorrectionFactor 
)
TransformSolidAreasShapesToPolygonSet(ZONE_CONTAINER self, SHAPE_POLY_SET aCornerBuffer, int aCircleToSegmentsCount, double aCorrectionFactor)

void
ZONE_CONTAINER::TransformSolidAreasShapesToPolygonSet(SHAPE_POLY_SET
&aCornerBuffer, int aCircleToSegmentsCount, double aCorrectionFactor)
const

Function TransformSolidAreasShapesToPolygonSet Convert solid areas
full shapes to polygon set (the full shape is the polygon area with a
thick outline) Used in 3D view Arcs (ends of segments) are
approximated by segments.

Parameters:
-----------

aCornerBuffer:  = a buffer to store the polygons

aCircleToSegmentsCount:  = the number of segments to approximate a
circle

aCorrectionFactor:  = the correction to apply to arcs radius to
roughly keep arc radius when approximated by segments 

Definition at line 25257 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.UnFill (   self)
UnFill(ZONE_CONTAINER self) -> bool

bool
ZONE_CONTAINER::UnFill()

Function UnFill Removes the zone filling.

true if a previous filling is removed, false if no change (when no
filling found) 

Definition at line 25495 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.UnHatch (   self)
UnHatch(ZONE_CONTAINER self)

void
ZONE_CONTAINER::UnHatch()

Function UnHatch clears the zone's hatch. 

Definition at line 26136 of file pcbnew.py.

Member Data Documentation

pcbnew.ZONE_CONTAINER.DIAGONAL_EDGE = _pcbnew.ZONE_CONTAINER_DIAGONAL_EDGE
static

Definition at line 24724 of file pcbnew.py.

pcbnew.ZONE_CONTAINER.DIAGONAL_FULL = _pcbnew.ZONE_CONTAINER_DIAGONAL_FULL
static

Definition at line 24723 of file pcbnew.py.

tuple pcbnew.ZONE_CONTAINER.GetDefaultHatchPitch = staticmethod(GetDefaultHatchPitch)
static

Definition at line 26092 of file pcbnew.py.

pcbnew.ZONE_CONTAINER.NO_HATCH = _pcbnew.ZONE_CONTAINER_NO_HATCH
static

Definition at line 24722 of file pcbnew.py.

pcbnew.ZONE_CONTAINER.this

Definition at line 24737 of file pcbnew.py.


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