Inheritance diagram for pcbnew.PCB_SHAPE:

[legend]

Public Member Functions
	__init__ (self, *args)

	GetClass (self)

	Serialize (self, aContainer)

	Deserialize (self, aContainer)

	GetConnectionPoints (self)

	GetCorners (self)

	GetEffectiveShape (self, *args)

	SetIsProxyItem (self, aIsProxy=True)

	HitTest (self, *args)

	Scale (self, aScale)

	TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)

	TransformShapeToPolySet (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, aRenderSettings=None)

	ViewGetLOD (self, aLayer, aView)

	__eq__ (self, *args)

	SetHasSolderMask (self, aVal)

	HasSolderMask (self)

	SetLocalSolderMaskMargin (self, aMargin)

	GetLocalSolderMaskMargin (self)

	GetSolderMaskExpansion (self)

	GetArcAngleStart (self)

	GetShapeStr (self)

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

	GetNet (self)

	SetNet (self, aNetInfo)

	UnpackNet (self, aProto)

	PackNet (self, aProto)

	GetNetCode (self)

	SetNetCode (self, *args)

	GetNetname (self)

	GetNetnameMsg (self)

	GetShortNetname (self)

	GetDisplayNetname (self)

	GetOwnClearance (self, aLayer, aSource=None)

	GetClearanceOverrides (self, aSource)

	GetLocalClearance (self, *args)

	GetEffectiveNetClass (self)

	GetNetClassName (self)

	SetLocalRatsnestVisible (self, aVisible)

	GetLocalRatsnestVisible (self)

	GetTeardropParams (self, *args)

	SetTeardropsEnabled (self, aEnable)

	GetTeardropsEnabled (self)

	SetTeardropBestLengthRatio (self, aRatio)

	GetTeardropBestLengthRatio (self)

	SetTeardropMaxLength (self, aMaxLength)

	GetTeardropMaxLength (self)

	SetTeardropBestWidthRatio (self, aRatio)

	GetTeardropBestWidthRatio (self)

	SetTeardropMaxWidth (self, aMaxWidth)

	GetTeardropMaxWidth (self)

	SetTeardropCurved (self, aCurve)

	GetTeardropCurved (self)

	SetTeardropPreferZoneConnections (self, aPrefer)

	GetTeardropPreferZoneConnections (self)

	SetTeardropAllowSpanTwoTracks (self, aAllow)

	GetTeardropAllowSpanTwoTracks (self)

	SetTeardropMaxTrackWidth (self, aRatio)

	GetTeardropMaxTrackWidth (self)

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

	CopyFrom (self, aOther)

	IsGroupableType (self)

	GetX (self)

	GetY (self)

	GetCenter (self)

	SetX (self, aX)

	SetY (self, aY)

	IsConnected (self)

	Similarity (self, aItem)

	__eq__ (self, aItem)

	IsOnCopperLayer (self)

	HasHole (self)

	HasDrilledHole (self)

	IsTented (self, aLayer)

	GetEffectiveHoleShape (self)

	RunOnChildren (self, aFunction, aMode)

	GetParent (self)

	GetParentFootprint (self)

	GetFPRelativePosition (self)

	SetFPRelativePosition (self, aPos)

	HasLineStroke (self)

	GetStroke (self)

	SetStroke (self, aStroke)

	GetFontMetrics (self)

	GetLayer (self)

	BoardLayerCount (self)

	BoardCopperLayerCount (self)

	BoardLayerSet (self)

	GetLayerSet (self)

	SetLayerSet (self, aLayers)

	IsSideSpecific (self)

	SetLayer (self, aLayer)

	Duplicate (self, addToParentGroup, aCommit=None)

	SwapItemData (self, aImage)

	IsOnLayer (self, aLayer)

	IsKnockout (self)

	SetIsKnockout (self, aKnockout)

	GetMaxError (self)

	StyleFromSettings (self, settings, aCheckSide)

	DeleteStructure (self)

	Move (self, aMoveVector)

	Rotate (self, aRotCentre, aAngle)

	Flip (self, aCentre, aFlipDirection)

	Mirror (self, aCentre, aFlipDirection)

	Normalize (self)

	NormalizeForCompare (self)

	GetBoard (self, *args)

	GetParentAsString (self)

	GetLayerName (self)

	LayerMaskDescribe (self)

	Cast (self)

	Duplicate (self)

	SetPos (self, p)

	SetStartEnd (self, start, end)

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

	Type (self)

	SetParent (self, aParent)

	SetParentGroup (self, aGroup)

	GetParentGroup (self)

	GetParentGroupId (self)

	IsLocked (self)

	SetLocked (self, aLocked)

	IsModified (self)

	IsNew (self)

	IsMoving (self)

	IsSelected (self)

	IsEntered (self)

	IsBrightened (self)

	IsRollover (self)

	GetRolloverPos (self)

	SetIsRollover (self, aIsRollover, aMousePos)

	SetSelected (self)

	SetBrightened (self)

	ClearSelected (self)

	ClearBrightened (self)

	SetModified (self)

	SetFlags (self, aMask)

	XorFlags (self, aMask)

	ClearFlags (self, *args)

	GetFlags (self)

	HasFlag (self, aFlag)

	GetEditFlags (self)

	ClearEditFlags (self)

	GetTempFlags (self)

	ClearTempFlags (self)

	RenderAsBitmap (self, aWorldScale)

	SetIsShownAsBitmap (self, aBitmap)

	IsShownAsBitmap (self)

	IsType (self, aScanTypes)

	SetForceVisible (self, aEnable)

	IsForceVisible (self)

	GetMsgPanelInfo (self, aFrame, aList)

	GetFriendlyName (self)

	GetBoundingBox (self)

	GetPosition (self)

	SetPosition (self, aPos)

	GetFocusPosition (self)

	GetSortPosition (self)

	Clone (self)

	Visit (self, inspector, testData, aScanTypes)

	GetTypeDesc (self)

	GetItemDescription (self, aUnitsProvider, aFull)

	DisambiguateItemDescription (self, aUnitsProvider, aFull)

	GetMenuImage (self)

	Matches (self, aSearchData, aAuxData)

	Replace (self, *args)

	IsReplaceable (self)

	__lt__ (self, aItem)

	ViewBBox (self)

	ViewGetLayers (self)

	GetEmbeddedFiles (self)

	GetEmbeddedFonts (self)

	PyGetClass (self)

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

	SwapShape (self, aImage)

	ShowShape (self)

	SHAPE_T_asString (self)

	IsProxyItem (self)

	IsAnyFill (self)

	IsSolidFill (self)

	IsHatchedFill (self)

	IsFilledForHitTesting (self)

	SetFilled (self, aFlag)

	SetFillMode (self, aFill)

	GetFillMode (self)

	SetFillModeProp (self, arg2)

	GetFillModeProp (self)

	SetHatchingDirty (self)

	GetHatching (self)

	GetHatchLines (self)

	IsClosed (self)

	GetFillColor (self)

	SetFillColor (self, aColor)

	SetWidth (self, aWidth)

	GetWidth (self)

	GetEffectiveWidth (self)

	GetHatchLineWidth (self)

	GetHatchLineSpacing (self)

	SetLineStyle (self, aStyle)

	GetLineStyle (self)

	SetLineColor (self, aColor)

	GetLineColor (self)

	SetShape (self, aShape)

	GetShape (self)

	GetStart (self)

	GetStartY (self)

	GetStartX (self)

	SetStart (self, aStart)

	SetStartY (self, y)

	SetStartX (self, x)

	SetCenterY (self, y)

	SetCenterX (self, x)

	GetEnd (self)

	GetEndY (self)

	GetEndX (self)

	SetEnd (self, aEnd)

	SetEndY (self, aY)

	SetEndX (self, aX)

	SetRadius (self, aX)

	GetTopLeft (self)

	GetBotRight (self)

	SetTop (self, val)

	SetLeft (self, val)

	SetRight (self, val)

	SetBottom (self, val)

	SetBezierC1 (self, aPt)

	GetBezierC1 (self)

	SetBezierC2 (self, aPt)

	GetBezierC2 (self)

	SetCenter (self, aCenter)

	SetArcAngleAndEnd (self, aAngle, aCheckNegativeAngle=False)

	GetArcAngle (self)

	GetSegmentAngle (self)

	EndsSwapped (self)

	GetArcMid (self)

	GetRectCorners (self)

	GetCornersInSequence (self, angle)

	CalcArcAngles (self, aStartAngle, aEndAngle)

	GetRadius (self)

	SetArcGeometry (self, aStart, aMid, aEnd)

	SetCachedArcData (self, aStart, aMid, aEnd, aCenter)

	GetBezierPoints (self)

	GetPolyPoints (self)

	GetPointCount (self)

	GetPolyShape (self, *args)

	IsPolyShapeValid (self)

	SetPolyShape (self, aShape)

	SetPolyPoints (self, aPoints)

	RebuildBezierToSegmentsPointsList (self, aMaxError)

	MakeEffectiveShapes (self, aEdgeOnly=False)

	MakeEffectiveShapesForHitTesting (self)

	ShapeGetMsgPanelInfo (self, aFrame, aList)

	SetRectangleHeight (self, aHeight)

	SetRectangleWidth (self, aWidth)

	SetRectangle (self, aHeight, aWidth)

	SetCornerRadius (self, aRadius)

	GetCornerRadius (self)

	IsClockwiseArc (self)

	GetLength (self)

	GetRectangleHeight (self)

	GetRectangleWidth (self)

	UpdateHatching (self)

	Compare (self, aOther)

	Similarity (self, aOther)

	__eq__ (self, aOther)

Static Public Member Functions
	ClassOf (aItem)

Static Public Member Functions inherited from pcbnew.EDA_ITEM
	Sort (aLeft, 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_CONNECTED_ITEM
	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")

Additional Inherited Members
Static Public Attributes inherited from pcbnew.BOARD_ITEM
	DRC = _pcbnew.BOARD_ITEM_DRC

	INSTANCE_TO_INSTANCE = _pcbnew.BOARD_ITEM_INSTANCE_TO_INSTANCE

Detailed Description

Proxy of C++ PCB_SHAPE class.

Definition at line 18156 of file pcbnew.py.

Constructor & Destructor Documentation

◆ init()

pcbnew.PCB_SHAPE.__init__	(		self,
		*	args )

    __init__(PCB_SHAPE self, BOARD_ITEM aParent, KICAD_T aItemType, SHAPE_T aShapeType) -> PCB_SHAPE
    __init__(PCB_SHAPE self, BOARD_ITEM aParent=None, SHAPE_T aShapeType=SEGMENT) -> PCB_SHAPE

Definition at line 18162 of file pcbnew.py.

Member Function Documentation

◆ eq()

pcbnew.PCB_SHAPE.__eq__	(		self,
		*	args )

    __eq__(PCB_SHAPE self, PCB_SHAPE aShape) -> bool
    __eq__(PCB_SHAPE self, BOARD_ITEM aBoardItem) -> bool

Definition at line 18227 of file pcbnew.py.

◆ ClassOf()

pcbnew.PCB_SHAPE.ClassOf ( aItem )

static

ClassOf(EDA_ITEM aItem) -> bool

Reimplemented from pcbnew.BOARD_CONNECTED_ITEM.

Reimplemented in pcbnew.PCB_TEXTBOX.

Definition at line 18171 of file pcbnew.py.

◆ Deserialize()

pcbnew.PCB_SHAPE.Deserialize	(		self,
			aContainer )

Deserialize(PCB_SHAPE self, google::protobuf::Any const & aContainer) -> bool

Reimplemented from pcbnew.EDA_SHAPE.

Reimplemented in pcbnew.PCB_TEXTBOX.

Definition at line 18183 of file pcbnew.py.

◆ GetArcAngleStart()

pcbnew.PCB_SHAPE.GetArcAngleStart ( self )

GetArcAngleStart(PCB_SHAPE self) -> EDA_ANGLE

Definition at line 18254 of file pcbnew.py.

◆ GetClass()

pcbnew.PCB_SHAPE.GetClass ( self )

GetClass(PCB_SHAPE self) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.PCB_TEXTBOX.

Definition at line 18175 of file pcbnew.py.

◆ GetConnectionPoints()

pcbnew.PCB_SHAPE.GetConnectionPoints ( self )

GetConnectionPoints(PCB_SHAPE self) -> VECTOR_VECTOR2I

Definition at line 18187 of file pcbnew.py.

◆ GetCorners()

pcbnew.PCB_SHAPE.GetCorners ( self )

GetCorners(PCB_SHAPE self) -> VECTOR_VECTOR2I

Definition at line 18191 of file pcbnew.py.

◆ GetEffectiveShape()

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.

Reimplemented in pcbnew.PCB_TEXTBOX.

Definition at line 18195 of file pcbnew.py.

◆ GetLocalSolderMaskMargin()

pcbnew.PCB_SHAPE.GetLocalSolderMaskMargin ( self )

GetLocalSolderMaskMargin(PCB_SHAPE self) -> std::optional< int >

Definition at line 18246 of file pcbnew.py.

◆ GetShapeStr()

pcbnew.PCB_SHAPE.GetShapeStr ( self )

Definition at line 18258 of file pcbnew.py.

◆ GetSolderMaskExpansion()

pcbnew.PCB_SHAPE.GetSolderMaskExpansion ( self )

GetSolderMaskExpansion(PCB_SHAPE self) -> int

Definition at line 18250 of file pcbnew.py.

◆ HasSolderMask()

pcbnew.PCB_SHAPE.HasSolderMask ( self )

HasSolderMask(PCB_SHAPE self) -> bool

Definition at line 18238 of file pcbnew.py.

◆ HitTest()

pcbnew.PCB_SHAPE.HitTest	(		self,
		*	args )

    HitTest(PCB_SHAPE self, VECTOR2I aPosition, int aAccuracy=0) -> bool
    HitTest(PCB_SHAPE self, BOX2I aRect, bool aContained, int aAccuracy=0) -> bool
    HitTest(PCB_SHAPE self, SHAPE_LINE_CHAIN aPoly, bool aContained) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Reimplemented in pcbnew.PCB_TEXTBOX.

Definition at line 18203 of file pcbnew.py.

◆ Scale()

pcbnew.PCB_SHAPE.Scale	(		self,
			aScale )

Scale(PCB_SHAPE self, double aScale)

Definition at line 18211 of file pcbnew.py.

◆ Serialize()

pcbnew.PCB_SHAPE.Serialize	(		self,
			aContainer )

Serialize(PCB_SHAPE self, google::protobuf::Any & aContainer)

Reimplemented from pcbnew.EDA_SHAPE.

Reimplemented in pcbnew.PCB_TEXTBOX.

Definition at line 18179 of file pcbnew.py.

◆ SetHasSolderMask()

pcbnew.PCB_SHAPE.SetHasSolderMask	(		self,
			aVal )

SetHasSolderMask(PCB_SHAPE self, bool aVal)

Definition at line 18234 of file pcbnew.py.

◆ SetIsProxyItem()

pcbnew.PCB_SHAPE.SetIsProxyItem	(		self,
			aIsProxy = True )

SetIsProxyItem(PCB_SHAPE self, bool aIsProxy=True)

Reimplemented from pcbnew.EDA_SHAPE.

Definition at line 18199 of file pcbnew.py.

◆ SetLocalSolderMaskMargin()

pcbnew.PCB_SHAPE.SetLocalSolderMaskMargin	(		self,
			aMargin )

SetLocalSolderMaskMargin(PCB_SHAPE self, std::optional< int > aMargin)

Definition at line 18242 of file pcbnew.py.

◆ TransformShapeToPolygon()

pcbnew.PCB_SHAPE.TransformShapeToPolygon	(	self,
		aBuffer,
		aLayer,
		aClearance,
		aError,
		aErrorLoc,
		ignoreLineWidth = False )

TransformShapeToPolygon(PCB_SHAPE self, SHAPE_POLY_SET aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=False)

Reimplemented from pcbnew.BOARD_ITEM.

Reimplemented in pcbnew.PCB_TEXTBOX.

Definition at line 18215 of file pcbnew.py.

◆ TransformShapeToPolySet()

pcbnew.PCB_SHAPE.TransformShapeToPolySet	(	self,
		aBuffer,
		aLayer,
		aClearance,
		aError,
		aErrorLoc,
		aRenderSettings = None )

TransformShapeToPolySet(PCB_SHAPE self, SHAPE_POLY_SET aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, KIGFX::RENDER_SETTINGS * aRenderSettings=None)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 18219 of file pcbnew.py.

◆ ViewGetLOD()

pcbnew.PCB_SHAPE.ViewGetLOD	(	self,
		aLayer,
		aView )

ViewGetLOD(PCB_SHAPE self, int aLayer, KIGFX::VIEW const * aView) -> double

Reimplemented in pcbnew.PCB_TEXTBOX.

Definition at line 18223 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 18159 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

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __eq__()

◆ ClassOf()

◆ Deserialize()

◆ GetArcAngleStart()

◆ GetClass()

◆ GetConnectionPoints()

◆ GetCorners()

◆ GetEffectiveShape()

◆ GetLocalSolderMaskMargin()

◆ GetShapeStr()

◆ GetSolderMaskExpansion()

◆ HasSolderMask()

◆ HitTest()

◆ Scale()

◆ Serialize()

◆ SetHasSolderMask()

◆ SetIsProxyItem()

◆ SetLocalSolderMaskMargin()

◆ TransformShapeToPolygon()

◆ TransformShapeToPolySet()

◆ ViewGetLOD()

Property Documentation

◆ thisown

◆ init()

◆ eq()