pcbnew.FP_SHAPE Class Reference

Inheritance diagram for pcbnew.FP_SHAPE:

Public Member Functions
def	__init__ (self, *args)
"bool"	IsType (self, "KICAD_T const []" aScanTypes)
"void"	SetArcAngleAndEnd0 (self, "double" aAngle, "bool" aCheckNegativeAngle=False)
"void"	SetArcGeometry0 (self, "wxPoint" aStart, "wxPoint" aMid, "wxPoint" aEnd)
"void"	Move (self, "wxPoint" aMoveVector)
"void"	Mirror (self, "wxPoint" aCentre, "bool" aMirrorAroundXAxis)
"void"	Rotate (self, "wxPoint" aRotCentre, "double" aAngle)
"void"	Flip (self, "wxPoint" aCentre, "bool" aFlipLeftRight)
"bool"	IsParentFlipped (self)
"void"	SetStart0 (self, "wxPoint" aPoint)
"wxPoint const &"	GetStart0 (self)
"void"	SetEnd0 (self, "wxPoint" aPoint)
"wxPoint const &"	GetEnd0 (self)
"void"	SetBezierC1_0 (self, "wxPoint" aPoint)
"wxPoint const &"	GetBezierC1_0 (self)
"void"	SetBezierC2_0 (self, "wxPoint" aPoint)
"wxPoint const &"	GetBezierC2_0 (self)
"wxPoint"	GetCenter0 (self)
"void"	SetCenter0 (self, "wxPoint" aPt)
"wxPoint"	GetArcMid0 (self)
"void"	SetLocalCoord (self)
"void"	SetDrawCoord (self)
"void"	GetMsgPanelInfo (self, "EDA_DRAW_FRAME *" aFrame, "std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &" aList)
"wxString"	GetClass (self)
"wxString"	GetParentAsString (self)
"wxString"	GetSelectMenuText (self, "EDA_UNITS" aUnits)
"BITMAPS"	GetMenuImage (self)
"EDA_ITEM *"	Clone (self)
"double"	ViewGetLOD (self, "int" aLayer, "KIGFX::VIEW *" aView)
Public Member Functions inherited from pcbnew.PCB_SHAPE
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)
"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.PCB_SHAPE
	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++ FP_SHAPE class.

Definition at line 14363 of file pcbnew.py.

Constructor & Destructor Documentation

__init__()

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

__init__(FP_SHAPE self, FOOTPRINT parent, SHAPE_T aShape=SEGMENT) -> FP_SHAPE

Reimplemented from pcbnew.PCB_SHAPE.

Definition at line 14369 of file pcbnew.py.

Member Function Documentation

ClassOf()

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

static

ClassOf(EDA_ITEM aItem) -> bool

Reimplemented from pcbnew.PCB_SHAPE.

Definition at line 14375 of file pcbnew.py.

Clone()

"EDA_ITEM *" pcbnew.FP_SHAPE.Clone

(

self

)

Clone(FP_SHAPE self) -> EDA_ITEM

Reimplemented from pcbnew.PCB_SHAPE.

Definition at line 14483 of file pcbnew.py.

Here is the caller graph for this function:

Flip()

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

Flip(FP_SHAPE self, wxPoint aCentre, bool aFlipLeftRight)

Reimplemented from pcbnew.PCB_SHAPE.

Definition at line 14403 of file pcbnew.py.

GetArcMid0()

"wxPoint" pcbnew.FP_SHAPE.GetArcMid0

(

self

)

GetArcMid0(FP_SHAPE self) -> wxPoint

Definition at line 14451 of file pcbnew.py.

GetBezierC1_0()

"wxPoint const &" pcbnew.FP_SHAPE.GetBezierC1_0

(

self

)

GetBezierC1_0(FP_SHAPE self) -> wxPoint

Definition at line 14431 of file pcbnew.py.

GetBezierC2_0()

"wxPoint const &" pcbnew.FP_SHAPE.GetBezierC2_0

(

self

)

GetBezierC2_0(FP_SHAPE self) -> wxPoint

Definition at line 14439 of file pcbnew.py.

GetCenter0()

"wxPoint" pcbnew.FP_SHAPE.GetCenter0

(

self

)

GetCenter0(FP_SHAPE self) -> wxPoint

Definition at line 14443 of file pcbnew.py.

GetClass()

"wxString" pcbnew.FP_SHAPE.GetClass

(

self

)

GetClass(FP_SHAPE self) -> wxString

Reimplemented from pcbnew.PCB_SHAPE.

Definition at line 14467 of file pcbnew.py.

Here is the caller graph for this function:

GetEnd0()

"wxPoint const &" pcbnew.FP_SHAPE.GetEnd0

(

self

)

GetEnd0(FP_SHAPE self) -> wxPoint

Definition at line 14423 of file pcbnew.py.

GetMenuImage()

"BITMAPS" pcbnew.FP_SHAPE.GetMenuImage

(

self

)

GetMenuImage(FP_SHAPE self) -> BITMAPS

Reimplemented from pcbnew.PCB_SHAPE.

Definition at line 14479 of file pcbnew.py.

GetMsgPanelInfo()

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

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

Reimplemented from pcbnew.PCB_SHAPE.

Definition at line 14463 of file pcbnew.py.

GetParentAsString()

"wxString" pcbnew.FP_SHAPE.GetParentAsString

(

self

)

GetParentAsString(FP_SHAPE self) -> wxString

Definition at line 14471 of file pcbnew.py.

GetSelectMenuText()

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

GetSelectMenuText(FP_SHAPE self, EDA_UNITS aUnits) -> wxString

Reimplemented from pcbnew.PCB_SHAPE.

Definition at line 14475 of file pcbnew.py.

GetStart0()

"wxPoint const &" pcbnew.FP_SHAPE.GetStart0

(

self

)

GetStart0(FP_SHAPE self) -> wxPoint

Definition at line 14415 of file pcbnew.py.

IsParentFlipped()

"bool" pcbnew.FP_SHAPE.IsParentFlipped

(

self

)

IsParentFlipped(FP_SHAPE self) -> bool

Definition at line 14407 of file pcbnew.py.

IsType()

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

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

Reimplemented from pcbnew.PCB_SHAPE.

Definition at line 14379 of file pcbnew.py.

Mirror()

"void" pcbnew.FP_SHAPE.Mirror	(		self,
		"wxPoint"	aCentre,
		"bool"	aMirrorAroundXAxis
	)

Mirror(FP_SHAPE self, wxPoint aCentre, bool aMirrorAroundXAxis)

Definition at line 14395 of file pcbnew.py.

Move()

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

Move(FP_SHAPE self, wxPoint aMoveVector)

Reimplemented from pcbnew.PCB_SHAPE.

Definition at line 14391 of file pcbnew.py.

Rotate()

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

Rotate(FP_SHAPE self, wxPoint aRotCentre, double aAngle)

Reimplemented from pcbnew.PCB_SHAPE.

Definition at line 14399 of file pcbnew.py.

SetArcAngleAndEnd0()

"void" pcbnew.FP_SHAPE.SetArcAngleAndEnd0	(		self,
		"double"	aAngle,
		"bool"	aCheckNegativeAngle = False
	)

SetArcAngleAndEnd0(FP_SHAPE self, double aAngle, bool aCheckNegativeAngle=False)

Definition at line 14383 of file pcbnew.py.

SetArcGeometry0()

"void" pcbnew.FP_SHAPE.SetArcGeometry0	(		self,
		"wxPoint"	aStart,
		"wxPoint"	aMid,
		"wxPoint"	aEnd
	)

SetArcGeometry0(FP_SHAPE self, wxPoint aStart, wxPoint aMid, wxPoint aEnd)

Definition at line 14387 of file pcbnew.py.

SetBezierC1_0()

"void" pcbnew.FP_SHAPE.SetBezierC1_0	(		self,
		"wxPoint"	aPoint
	)

SetBezierC1_0(FP_SHAPE self, wxPoint aPoint)

Definition at line 14427 of file pcbnew.py.

SetBezierC2_0()

"void" pcbnew.FP_SHAPE.SetBezierC2_0	(		self,
		"wxPoint"	aPoint
	)

SetBezierC2_0(FP_SHAPE self, wxPoint aPoint)

Definition at line 14435 of file pcbnew.py.

SetCenter0()

"void" pcbnew.FP_SHAPE.SetCenter0	(		self,
		"wxPoint"	aPt
	)

SetCenter0(FP_SHAPE self, wxPoint aPt)

Definition at line 14447 of file pcbnew.py.

SetDrawCoord()

"void" pcbnew.FP_SHAPE.SetDrawCoord

(

self

)

SetDrawCoord(FP_SHAPE self)

Definition at line 14459 of file pcbnew.py.

SetEnd0()

"void" pcbnew.FP_SHAPE.SetEnd0	(		self,
		"wxPoint"	aPoint
	)

SetEnd0(FP_SHAPE self, wxPoint aPoint)

Definition at line 14419 of file pcbnew.py.

Here is the caller graph for this function:

SetLocalCoord()

"void" pcbnew.FP_SHAPE.SetLocalCoord

(

self

)

SetLocalCoord(FP_SHAPE self)

Definition at line 14455 of file pcbnew.py.

SetStart0()

"void" pcbnew.FP_SHAPE.SetStart0	(		self,
		"wxPoint"	aPoint
	)

SetStart0(FP_SHAPE self, wxPoint aPoint)

Definition at line 14411 of file pcbnew.py.

Here is the caller graph for this function:

ViewGetLOD()

"double" pcbnew.FP_SHAPE.ViewGetLOD	(		self,
		"int"	aLayer,
		"KIGFX::VIEW *"	aView
	)

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

Definition at line 14487 of file pcbnew.py.

Property Documentation

thisown

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

static

Definition at line 14366 of file pcbnew.py.

---

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

• pcbnew.py