Inheritance diagram for pcbnew.PCB_SHAPE:

[legend]

Public Member Functions
def	__init__ (self, *args)

"wxString"	GetClass (self)

"bool"	IsType (self, "KICAD_T const []" aScanTypes)

"void"	SetPosition (self, "wxPoint" aPos)

"wxPoint"	GetPosition (self)

"wxPoint"	GetCenter (self)

"wxPoint const"	GetFocusPosition (self)

"FOOTPRINT *"	GetParentFootprint (self)

"std::shared_ptr< SHAPE >"	GetEffectiveShape (self, *args)

"void"	GetMsgPanelInfo (self, "EDA_DRAW_FRAME *" aFrame, "std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &" aList)

"EDA_RECT const"	GetBoundingBox (self)

"bool"	HitTest (self, *args)

"void"	Move (self, "wxPoint" aMoveVector)

"void"	Rotate (self, "wxPoint" aRotCentre, "double" aAngle)

"void"	Flip (self, "wxPoint" aCentre, "bool" aFlipLeftRight)

"void"	Scale (self, "double" aScale)

"void"	TransformShapeWithClearanceToPolygon (self, "SHAPE_POLY_SET" aCornerBuffer, "PCB_LAYER_ID" aLayer, "int" aClearanceValue, "int" aError, "ERROR_LOC" aErrorLoc, "bool" ignoreLineWidth=False)

"wxString"	GetSelectMenuText (self, "EDA_UNITS" aUnits)

"BITMAPS"	GetMenuImage (self)

"EDA_ITEM *"	Clone (self)

"BOX2I const"	ViewBBox (self)

"void"	SwapData (self, "BOARD_ITEM" aImage)

"double"	GetArcAngleStart (self)

def	GetShapeStr (self)

Public Member Functions inherited from pcbnew.BOARD_ITEM
def	__init__ (self, args, *kwargs)

"void"	SetParentGroup (self, "PCB_GROUP" aGroup)

"PCB_GROUP *"	GetParentGroup (self)

"int"	GetX (self)

"int"	GetY (self)

"wxPoint"	GetCenter (self)

"void"	SetX (self, "int" aX)

"void"	SetY (self, "int" aY)

"bool"	IsConnected (self)

"bool"	IsOnCopperLayer (self)

"std::shared_ptr< SHAPE >"	GetEffectiveShape (self, *args)

"BOARD_ITEM_CONTAINER *"	GetParent (self)

"BOARD_ITEM_CONTAINER *"	GetParentFootprint (self)

"PCB_LAYER_ID"	GetLayer (self)

"LSET"	GetLayerSet (self)

"void"	SetLayerSet (self, "LSET" aLayers)

"void"	SetLayer (self, "PCB_LAYER_ID" aLayer)

"BOARD_ITEM *"	Duplicate (self)

"void"	SwapData (self, "BOARD_ITEM" aImage)

"bool"	IsOnLayer (self, "PCB_LAYER_ID" aLayer)

"bool"	IsTrack (self)

"bool"	IsLocked (self)

"void"	SetLocked (self, "bool" aLocked)

"void"	DeleteStructure (self)

"void"	Move (self, *args)

"void"	Rotate (self, *args)

"void"	Flip (self, *args)

"BOARD *"	GetBoard (self, *args)

"wxString"	GetLayerName (self)

"void"	ViewGetLayers (self, "int []" aLayers, "int &" aCount)

"void"	TransformShapeWithClearanceToPolygon (self, "SHAPE_POLY_SET" aCornerBuffer, "PCB_LAYER_ID" aLayer, "int" aClearanceValue, "int" aError, "ERROR_LOC" aErrorLoc, "bool" ignoreLineWidth=False)

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)

"KICAD_T"	Type (self)

"EDA_ITEM *"	GetParent (self)

"void"	SetParent (self, "EDA_ITEM" aParent)

"bool"	IsModified (self)

"bool"	IsNew (self)

"bool"	IsMoving (self)

"bool"	IsDragging (self)

"bool"	IsWireImage (self)

"bool"	IsSelected (self)

"bool"	IsEntered (self)

"bool"	IsResized (self)

"bool"	IsBrightened (self)

"void"	SetWireImage (self)

"void"	SetSelected (self)

"void"	SetBrightened (self)

"void"	ClearSelected (self)

"void"	ClearBrightened (self)

"void"	SetModified (self)

"int"	GetState (self, "EDA_ITEM_FLAGS" type)

"void"	SetState (self, "EDA_ITEM_FLAGS" type, "bool" state)

"EDA_ITEM_FLAGS"	GetStatus (self)

"void"	SetStatus (self, "EDA_ITEM_FLAGS" aStatus)

"void"	SetFlags (self, "EDA_ITEM_FLAGS" aMask)

"void"	ClearFlags (self, *args)

"EDA_ITEM_FLAGS"	GetFlags (self)

"bool"	HasFlag (self, "EDA_ITEM_FLAGS" aFlag)

"EDA_ITEM_FLAGS"	GetEditFlags (self)

"void"	ClearTempFlags (self)

"void"	ClearEditFlags (self)

"bool"	IsType (self, "KICAD_T const []" aScanTypes)

"void"	SetForceVisible (self, "bool" aEnable)

"bool"	IsForceVisible (self)

"void"	GetMsgPanelInfo (self, "EDA_DRAW_FRAME *" aFrame, "std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &" aList)

"bool"	HitTest (self, *args)

"EDA_RECT const"	GetBoundingBox (self)

"wxPoint"	GetPosition (self)

"void"	SetPosition (self, "wxPoint" aPos)

"wxPoint const"	GetFocusPosition (self)

"EDA_ITEM *"	Clone (self)

"SEARCH_RESULT"	Visit (self, "INSPECTOR" inspector, "void *" testData, "KICAD_T const []" scanTypes)

"wxString"	GetClass (self)

"wxString"	GetSelectMenuText (self, "EDA_UNITS" aUnits)

"BITMAPS"	GetMenuImage (self)

"bool"	Matches (self, "wxFindReplaceData const &" aSearchData, "void *" aAuxData)

"bool"	Replace (self, *args)

"bool"	IsReplaceable (self)

"bool"	__lt__ (self, "EDA_ITEM" aItem)

"BOX2I const"	ViewBBox (self)

"void"	ViewGetLayers (self, "int []" aLayers, "int &" aCount)

Public Member Functions inherited from pcbnew.EDA_SHAPE
def	__init__ (self, args, *kwargs)

"void"	SwapShape (self, "EDA_SHAPE" aImage)

"wxString"	ShowShape (self)

"wxString"	SHAPE_T_asString (self)

"void"	SetFillMode (self, "FILL_T" aFill)

"FILL_T"	GetFillType (self)

"bool"	IsFilled (self)

"void"	SetFilled (self, "bool" aFlag)

"void"	SetWidth (self, "int" aWidth)

"int"	GetWidth (self)

"void"	SetShape (self, "SHAPE_T" aShape)

"SHAPE_T"	GetShape (self)

"wxPoint const &"	GetStart (self)

"int"	GetStartY (self)

"int"	GetStartX (self)

"void"	SetStart (self, "wxPoint" aStart)

"void"	SetStartY (self, "int" y)

"void"	SetStartX (self, "int" x)

"wxPoint const &"	GetEnd (self)

"int"	GetEndY (self)

"int"	GetEndX (self)

"void"	SetEnd (self, "wxPoint" aEnd)

"void"	SetEndY (self, "int" y)

"void"	SetEndX (self, "int" x)

"void"	SetBezierC1 (self, "wxPoint" aPt)

"wxPoint const &"	GetBezierC1 (self)

"void"	SetBezierC2 (self, "wxPoint" aPt)

"wxPoint const &"	GetBezierC2 (self)

"void"	SetCenter (self, "wxPoint" aCenter)

"void"	SetArcAngleAndEnd (self, "double" aAngle, "bool" aCheckNegativeAngle=False)

"double"	GetArcAngle (self)

"bool"	EndsSwapped (self)

"wxPoint"	GetArcMid (self)

"std::vector< wxPoint,std::allocator< wxPoint > >"	GetRectCorners (self)

"void"	CalcArcAngles (self, "double &" aStartAngle, "double &" aEndAngle)

"int"	GetRadius (self)

"void"	SetArcGeometry (self, "wxPoint" aStart, "wxPoint" aMid, "wxPoint" aEnd)

"void"	SetCachedArcData (self, "wxPoint" aStart, "wxPoint" aMid, "wxPoint" aEnd, "wxPoint" aCenter)

"std::vector< wxPoint,std::allocator< wxPoint > > const &"	GetBezierPoints (self)

"void"	DupPolyPointsList (self, "wxPoint_Vector" aBuffer)

"int"	GetPointCount (self)

"SHAPE_POLY_SET const &"	GetPolyShape (self, *args)

"bool"	IsPolyShapeValid (self)

"void"	SetPolyShape (self, "SHAPE_POLY_SET" aShape)

"void"	SetPolyPoints (self, "wxPoint_Vector" aPoints)

"void"	RebuildBezierToSegmentsPointsList (self, "int" aMinSegLen)

"std::vector< SHAPE ,std::allocator< SHAPE > >"	MakeEffectiveShapes (self)

"void"	ShapeGetMsgPanelInfo (self, "EDA_DRAW_FRAME *" aFrame, "std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &" aList)

"double"	GetLength (self)

"void"	TransformShapeWithClearanceToPolygon (self, "SHAPE_POLY_SET" aCornerBuffer, "int" aClearanceValue, "int" aError, "ERROR_LOC" aErrorLoc, "bool" ignoreLineWidth)

"int"	Compare (self, "EDA_SHAPE" aOther)

Static Public Member Functions
"bool"	ClassOf ("EDA_ITEM" aItem)

Static Public Member Functions inherited from pcbnew.EDA_ITEM
"bool"	Sort ("EDA_ITEM" aLeft, "EDA_ITEM" aRight)

Properties
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Properties inherited from pcbnew.BOARD_ITEM
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Properties inherited from pcbnew.EDA_ITEM
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

	m_Uuid = property(_pcbnew.EDA_ITEM_m_Uuid_get, doc=)

Properties inherited from pcbnew.EDA_SHAPE
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Detailed Description

Proxy of C++ PCB_SHAPE class.

Definition at line 13377 of file pcbnew.py.

Constructor & Destructor Documentation

◆ init()

def pcbnew.PCB_SHAPE.__init__	(		self,
		*	args
	)

    __init__(PCB_SHAPE self, BOARD_ITEM aParent, KICAD_T idtype, SHAPE_T shapetype) -> PCB_SHAPE
    __init__(PCB_SHAPE self, BOARD_ITEM aParent=None, SHAPE_T shapetype=SEGMENT) -> PCB_SHAPE

Reimplemented from pcbnew.BOARD_ITEM.

Reimplemented in pcbnew.FP_SHAPE.

Definition at line 13383 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ ClassOf()

"bool" pcbnew.PCB_SHAPE.ClassOf ( "EDA_ITEM" aItem )

static

ClassOf(EDA_ITEM aItem) -> bool

Reimplemented in pcbnew.FP_SHAPE.

Definition at line 13392 of file pcbnew.py.

◆ Clone()

"EDA_ITEM *" pcbnew.PCB_SHAPE.Clone ( self )

Clone(PCB_SHAPE self) -> EDA_ITEM

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.FP_SHAPE.

Definition at line 13471 of file pcbnew.py.

Here is the caller graph for this function:

◆ Flip()

"void" pcbnew.PCB_SHAPE.Flip	(		self,
		"wxPoint"	aCentre,
		"bool"	aFlipLeftRight
	)

Flip(PCB_SHAPE self, wxPoint aCentre, bool aFlipLeftRight)

Reimplemented from pcbnew.BOARD_ITEM.

Reimplemented in pcbnew.FP_SHAPE.

Definition at line 13451 of file pcbnew.py.

◆ GetArcAngleStart()

"double" pcbnew.PCB_SHAPE.GetArcAngleStart ( self )

GetArcAngleStart(PCB_SHAPE self) -> double

Definition at line 13483 of file pcbnew.py.

◆ GetBoundingBox()

"EDA_RECT const" pcbnew.PCB_SHAPE.GetBoundingBox ( self )

GetBoundingBox(PCB_SHAPE self) -> EDA_RECT

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 13432 of file pcbnew.py.

◆ GetCenter()

"wxPoint" pcbnew.PCB_SHAPE.GetCenter ( self )

GetCenter(PCB_SHAPE self) -> wxPoint

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 13412 of file pcbnew.py.

◆ GetClass()

"wxString" pcbnew.PCB_SHAPE.GetClass ( self )

GetClass(PCB_SHAPE self) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.FP_SHAPE.

Definition at line 13396 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetEffectiveShape()

"std.shared_ptr< SHAPE >" pcbnew.PCB_SHAPE.GetEffectiveShape	(		self,
		*	args
	)

GetEffectiveShape(PCB_SHAPE self, PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=DEFAULT) -> std::shared_ptr< SHAPE >

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 13424 of file pcbnew.py.

◆ GetFocusPosition()

"wxPoint const" pcbnew.PCB_SHAPE.GetFocusPosition ( self )

GetFocusPosition(PCB_SHAPE self) -> wxPoint

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 13416 of file pcbnew.py.

◆ GetMenuImage()

"BITMAPS" pcbnew.PCB_SHAPE.GetMenuImage ( self )

GetMenuImage(PCB_SHAPE self) -> BITMAPS

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.FP_SHAPE.

Definition at line 13467 of file pcbnew.py.

◆ GetMsgPanelInfo()

"void" pcbnew.PCB_SHAPE.GetMsgPanelInfo	(		self,
		"EDA_DRAW_FRAME *"	aFrame,
		"std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &"	aList
	)

GetMsgPanelInfo(PCB_SHAPE self, EDA_DRAW_FRAME * aFrame, std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > & aList)

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.FP_SHAPE.

Definition at line 13428 of file pcbnew.py.

◆ GetParentFootprint()

"FOOTPRINT *" pcbnew.PCB_SHAPE.GetParentFootprint ( self )

GetParentFootprint(PCB_SHAPE self) -> FOOTPRINT

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 13420 of file pcbnew.py.

◆ GetPosition()

"wxPoint" pcbnew.PCB_SHAPE.GetPosition ( self )

GetPosition(PCB_SHAPE self) -> wxPoint

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 13408 of file pcbnew.py.

◆ GetSelectMenuText()

"wxString" pcbnew.PCB_SHAPE.GetSelectMenuText	(		self,
		"EDA_UNITS"	aUnits
	)

GetSelectMenuText(PCB_SHAPE self, EDA_UNITS aUnits) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.FP_SHAPE.

Definition at line 13463 of file pcbnew.py.

◆ GetShapeStr()

def pcbnew.PCB_SHAPE.GetShapeStr ( self )

Definition at line 13487 of file pcbnew.py.

◆ HitTest()

"bool" pcbnew.PCB_SHAPE.HitTest	(		self,
		*	args
	)

    HitTest(PCB_SHAPE self, wxPoint aPosition, int aAccuracy=0) -> bool
    HitTest(PCB_SHAPE self, EDA_RECT aRect, bool aContained, int aAccuracy=0) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 13436 of file pcbnew.py.

Here is the caller graph for this function:

◆ IsType()

"bool" pcbnew.PCB_SHAPE.IsType	(		self,
		"KICAD_T const []"	aScanTypes
	)

IsType(PCB_SHAPE self, KICAD_T const [] aScanTypes) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.FP_SHAPE.

Definition at line 13400 of file pcbnew.py.

◆ Move()

"void" pcbnew.PCB_SHAPE.Move	(		self,
		"wxPoint"	aMoveVector
	)

Move(PCB_SHAPE self, wxPoint aMoveVector)

Reimplemented from pcbnew.BOARD_ITEM.

Reimplemented in pcbnew.FP_SHAPE.

Definition at line 13443 of file pcbnew.py.

◆ Rotate()

"void" pcbnew.PCB_SHAPE.Rotate	(		self,
		"wxPoint"	aRotCentre,
		"double"	aAngle
	)

Rotate(PCB_SHAPE self, wxPoint aRotCentre, double aAngle)

Reimplemented from pcbnew.BOARD_ITEM.

Reimplemented in pcbnew.FP_SHAPE.

Definition at line 13447 of file pcbnew.py.

◆ Scale()

"void" pcbnew.PCB_SHAPE.Scale	(		self,
		"double"	aScale
	)

Scale(PCB_SHAPE self, double aScale)

Definition at line 13455 of file pcbnew.py.

◆ SetPosition()

"void" pcbnew.PCB_SHAPE.SetPosition	(		self,
		"wxPoint"	aPos
	)

SetPosition(PCB_SHAPE self, wxPoint aPos)

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 13404 of file pcbnew.py.

Here is the caller graph for this function:

◆ SwapData()

"void" pcbnew.PCB_SHAPE.SwapData	(		self,
		"BOARD_ITEM"	aImage
	)

SwapData(PCB_SHAPE self, BOARD_ITEM aImage)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 13479 of file pcbnew.py.

◆ TransformShapeWithClearanceToPolygon()

"void" pcbnew.PCB_SHAPE.TransformShapeWithClearanceToPolygon	(		self,
		"SHAPE_POLY_SET"	aCornerBuffer,
		"PCB_LAYER_ID"	aLayer,
		"int"	aClearanceValue,
		"int"	aError,
		"ERROR_LOC"	aErrorLoc,
		"bool"	ignoreLineWidth = `False`
	)

TransformShapeWithClearanceToPolygon(PCB_SHAPE self, SHAPE_POLY_SET aCornerBuffer, PCB_LAYER_ID aLayer, int aClearanceValue, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=False)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 13459 of file pcbnew.py.

◆ ViewBBox()

"BOX2I const" pcbnew.PCB_SHAPE.ViewBBox ( self )

ViewBBox(PCB_SHAPE self) -> BOX2I const

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 13475 of file pcbnew.py.

Property Documentation

◆ thisown

pcbnew.PCB_SHAPE.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

static

Definition at line 13380 of file pcbnew.py.

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

pcbnew.py

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ ClassOf()

◆ Clone()

◆ Flip()

◆ GetArcAngleStart()

◆ GetBoundingBox()

◆ GetCenter()

◆ GetClass()

◆ GetEffectiveShape()

◆ GetFocusPosition()

◆ GetMenuImage()

◆ GetMsgPanelInfo()

◆ GetParentFootprint()

◆ GetPosition()

◆ GetSelectMenuText()

◆ GetShapeStr()

◆ HitTest()

◆ IsType()

◆ Move()

◆ Rotate()

◆ Scale()

◆ SetPosition()

◆ SwapData()

◆ TransformShapeWithClearanceToPolygon()

◆ ViewBBox()

Property Documentation

◆ thisown

◆ init()