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 SetLayerSet (self, aLayerSet)
 
def GetLayerSet (self)
 
def Draw (self, args)
 
def DrawFilledArea (self, args)
 
def DrawWhileCreateOutline (self, args)
 
def GetBoundingBox (self)
 
def GetClearance
 
def IsOnCopperLayer (self)
 
def CommonLayerExists (self, aLayerSet)
 
def SetLayer (self, aLayer)
 
def GetLayer (self)
 
def IsOnLayer (self, arg2)
 
def ViewGetLayers (self, aLayers, aCount)
 
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 TransformOutlinesShapeWithClearanceToPolygon (self, aCornerBuffer, aMinClearanceValue, aUseNetClearance)
 
def TransformShapeWithClearanceToPolygon (self, aCornerBuffer, aClearanceValue, aCircleToSegmentsCount, aCorrectionFactor)
 
def HitTestForCorner (self, args)
 
def HitTestForEdge (self, args)
 
def HitTest (self, args)
 
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 CacheTriangulation (self)
 
def SetFilledPolysList (self, aPolysList)
 
def SetRawPolysList (self, aPolysList)
 
def BuildSmoothedPoly (self, aSmoothedPoly)
 
def SetCornerSmoothingType (self, aType)
 
def GetCornerSmoothingType (self)
 
def SetCornerRadius (self, aRadius)
 
def GetCornerRadius (self)
 
def AddPolygon (self, aPolygon)
 
def SetFillSegments (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)
 
def SwapData (self, aImage)
 
- 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, args)
 
def Rotate (self, args)
 
def Flip (self, args)
 
def GetBoard (self)
 
def GetLayerName (self)
 
def HitTest (self, args)
 
def FormatAngle (aAngle)
 
def FormatInternalUnits (args)
 
def ViewGetLayers (self, aLayers, aCount)
 
def TransformShapeWithClearanceToPolygon (self, aCornerBuffer, aClearanceValue, aCircleToSegmentsCount, aCorrectionFactor)
 
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 25841 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 25867 of file pcbnew.py.

Member Function Documentation

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 27016 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 26829 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.BuildSmoothedPoly (   self,
  aSmoothedPoly 
)
BuildSmoothedPoly(ZONE_CONTAINER self, SHAPE_POLY_SET aSmoothedPoly) -> bool

bool
ZONE_CONTAINER::BuildSmoothedPoly(SHAPE_POLY_SET &aSmoothedPoly) 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 26961 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.CacheTriangulation (   self)
CacheTriangulation(ZONE_CONTAINER self)

void
ZONE_CONTAINER::CacheTriangulation() 

Definition at line 26927 of file pcbnew.py.

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 26769 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 26900 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 27086 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.CommonLayerExists (   self,
  aLayerSet 
)
CommonLayerExists(ZONE_CONTAINER self, LSET aLayerSet) -> bool

bool
ZONE_CONTAINER::CommonLayerExists(const LSET aLayerSet) const

Function CommonLayerExist Test if this zone shares a common layer with
the given layer set. 

Definition at line 26124 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 25992 of file pcbnew.py.

Here is the caller graph for this function:

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 26017 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 26043 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.FillSegments (   self,
  args 
)
FillSegments(ZONE_CONTAINER self) -> ZONE_SEGMENT_FILL
FillSegments(ZONE_CONTAINER self) -> ZONE_SEGMENT_FILL const &

const
ZONE_SEGMENT_FILL& ZONE_CONTAINER::FillSegments() const 

Definition at line 26419 of file pcbnew.py.

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

void
BOARD_ITEM::Flip(const VECTOR2I &aCentre) 

Definition at line 26685 of file pcbnew.py.

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

int
ZONE_CONTAINER::GetArcSegmentCount() const 

Definition at line 26287 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 26070 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 26713 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 26084 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 26795 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 27006 of file pcbnew.py.

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

int
ZONE_CONTAINER::GetCornerSmoothingType() const 

Definition at line 26986 of file pcbnew.py.

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

Definition at line 27205 of file pcbnew.py.

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

bool
ZONE_CONTAINER::GetDoNotAllowCopperPour() const 

Definition at line 27121 of file pcbnew.py.

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

bool
ZONE_CONTAINER::GetDoNotAllowTracks() const 

Definition at line 27141 of file pcbnew.py.

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

bool
ZONE_CONTAINER::GetDoNotAllowVias() const 

Definition at line 27131 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 26912 of file pcbnew.py.

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

ZONE_FILL_MODE
ZONE_CONTAINER::GetFillMode() const 

Definition at line 26225 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 27279 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 27191 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 26857 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 27109 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetLayer (   self)
GetLayer(ZONE_CONTAINER self) -> PCB_LAYER_ID

PCB_LAYER_ID
ZONE_CONTAINER::GetLayer() const override

Function GetLayer returns the primary layer this item is on. 

Definition at line 26155 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.GetLayerSet (   self)
GetLayerSet(ZONE_CONTAINER self) -> LSET

LSET
ZONE_CONTAINER::GetLayerSet() const override

Function GetLayerSet returns a "layer mask", which is a bitmap of
all layers on which the TRACK segment or VIA physically resides.

int - a layer mask, see layers_id_colors_visibility.h. 

Definition at line 25977 of file pcbnew.py.

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

int
ZONE_CONTAINER::GetLocalFlags() const 

Definition at line 26399 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 27069 of file pcbnew.py.

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

int
ZONE_CONTAINER::GetMinThickness() const 

Definition at line 26358 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 25945 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 26727 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 26337 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 25882 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 25931 of file pcbnew.py.

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

int
ZONE_CONTAINER::GetSelectedCorner() const 

Definition at line 26378 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 27049 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 26266 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 26245 of file pcbnew.py.

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

int
ZONE_CONTAINER::GetZoneClearance() const 

Definition at line 26317 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 27266 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 26605 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 26472 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 26562 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 26583 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 26451 of file pcbnew.py.

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

bool
ZONE_CONTAINER::IsFilled() const 

Definition at line 26297 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 26109 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.IsOnLayer (   self,
  arg2 
)
IsOnLayer(ZONE_CONTAINER self, PCB_LAYER_ID arg2) -> bool

bool
ZONE_CONTAINER::IsOnLayer(PCB_LAYER_ID) const override

Function IsOnLayer tests to see if this object is on the given layer.

Is virtual so objects like D_PAD, which reside on multiple layers can
do their own form of testing.

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

aLayer:  The layer to test for.

bool - true if on given layer, else false. 

Definition at line 26167 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 26877 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 26739 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 26754 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 26695 of file pcbnew.py.

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

void
BOARD_ITEM::Move(const VECTOR2I &aMoveVector) 

Definition at line 26646 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 26656 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 26816 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 26430 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 27039 of file pcbnew.py.

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

void
ZONE_CONTAINER::RemoveAllContours(void) 

Definition at line 26785 of file pcbnew.py.

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

void
BOARD_ITEM::Rotate(const VECTOR2I &aRotCentre, double aAngle) 

Definition at line 26675 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 26277 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 26805 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 26996 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 26976 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 27161 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 27181 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 27171 of file pcbnew.py.

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

void
ZONE_CONTAINER::SetFilledPolysList(SHAPE_POLY_SET &aPolysList)

Function SetFilledPolysList sets the list of filled polygons. 

Definition at line 26937 of file pcbnew.py.

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

void
ZONE_CONTAINER::SetFillMode(ZONE_FILL_MODE aFillMode) 

Definition at line 26215 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetFillSegments (   self,
  aSegments 
)
SetFillSegments(ZONE_CONTAINER self, ZONE_SEGMENT_FILL const & aSegments)

void
ZONE_CONTAINER::SetFillSegments(const ZONE_SEGMENT_FILL &aSegments) 

Definition at line 27029 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 27213 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 27237 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 26867 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 26307 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 27151 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetLayer (   self,
  aLayer 
)
SetLayer(ZONE_CONTAINER self, PCB_LAYER_ID aLayer)

void
ZONE_CONTAINER::SetLayer(PCB_LAYER_ID aLayer) override

Function SetLayer sets the layer this item is on.

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

aLayer:  The layer number. is virtual because some items (in fact:
class DIMENSION) have a slightly different initialization 

Definition at line 26137 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SetLayerSet (   self,
  aLayerSet 
)
SetLayerSet(ZONE_CONTAINER self, LSET aLayerSet)

void
ZONE_CONTAINER::SetLayerSet(LSET aLayerSet) 

Definition at line 25967 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 26409 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 26368 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 26441 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 26348 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 25904 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 25914 of file pcbnew.py.

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

void
ZONE_CONTAINER::SetRawPolysList(SHAPE_POLY_SET &aPolysList)

Function SetFilledPolysList sets the list of filled polygons. 

Definition at line 26949 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 26388 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 26256 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 26235 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 26327 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.SwapData (   self,
  aImage 
)
SwapData(ZONE_CONTAINER self, BOARD_ITEM aImage)

void
ZONE_CONTAINER::SwapData(BOARD_ITEM *aImage) override

Swap data between aItem and aImage.

aItem and aImage should have the same type Used in undo redo command
to swap values between an item and its copy Only values like layer,
size .. which are modified by edition are swapped, not the pointers
like Pnext and Pback because aItem is not changed in the linked list

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

aImage:  = the item image which contains data to swap 

Definition at line 27289 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)
const

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 26520 of file pcbnew.py.

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

void
ZONE_CONTAINER::TransformShapeWithClearanceToPolygon(SHAPE_POLY_SET
&aCornerBuffer, int aClearanceValue, int aCircleToSegmentsCount,
double aCorrectionFactor) const override 

Definition at line 26550 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 26492 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 26631 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 27254 of file pcbnew.py.

def pcbnew.ZONE_CONTAINER.ViewGetLayers (   self,
  aLayers,
  aCount 
)
ViewGetLayers(ZONE_CONTAINER self, int [] aLayers, int & aCount)

void
ZONE_CONTAINER::ViewGetLayers(int aLayers[], int &aCount) const
override

Function ViewGetLayers() Returns the all the layers within the VIEW
the object is painted on.

For instance, a D_PAD spans zero or more copper layers and a few
technical layers. ViewDraw() or PAINTER::Draw() is repeatedly called
for each of the layers returned by ViewGetLayers(), depending on the
rendering order.

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

aLayers[]:  output layer index array

aCount:  number of layer indices in aLayers[] 

Definition at line 26189 of file pcbnew.py.

Member Data Documentation

pcbnew.ZONE_CONTAINER.DIAGONAL_EDGE = _pcbnew.ZONE_CONTAINER_DIAGONAL_EDGE
static

Definition at line 25865 of file pcbnew.py.

pcbnew.ZONE_CONTAINER.DIAGONAL_FULL = _pcbnew.ZONE_CONTAINER_DIAGONAL_FULL
static

Definition at line 25864 of file pcbnew.py.

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

Definition at line 27210 of file pcbnew.py.

pcbnew.ZONE_CONTAINER.NO_HATCH = _pcbnew.ZONE_CONTAINER_NO_HATCH
static

Definition at line 25863 of file pcbnew.py.

pcbnew.ZONE_CONTAINER.this

Definition at line 25878 of file pcbnew.py.


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