KiCad Pcbnew Python Scripting
Public Member Functions | Static Public Member Functions | Properties | List of all members
pcbnew.PCB_DIM_CENTER Class Reference
Inheritance diagram for pcbnew.PCB_DIM_CENTER:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, "BOARD_ITEM" aParent)
 
"EDA_ITEM *" Clone (self)
 
"void" SwapData (self, "BOARD_ITEM" aImage)
 
"BITMAPS" GetMenuImage (self)
 
"wxString" GetClass (self)
 
"EDA_RECT const" GetBoundingBox (self)
 
"BOX2I const" ViewBBox (self)
 
- Public Member Functions inherited from pcbnew.PCB_DIMENSION_BASE
def __init__ (self, *args, **kwargs)
 
"bool" IsType (self, "KICAD_T const []" aScanTypes)
 
"void" SetParent (self, "EDA_ITEM" aParent)
 
"wxPoint const &" GetStart (self)
 
"void" SetStart (self, "wxPoint" aPoint)
 
"wxPoint const &" GetEnd (self)
 
"void" SetEnd (self, "wxPoint" aPoint)
 
"wxPoint" GetPosition (self)
 
"void" SetPosition (self, "wxPoint" aPos)
 
"bool" GetOverrideTextEnabled (self)
 
"void" SetOverrideTextEnabled (self, "bool" aOverride)
 
"wxString" GetOverrideText (self)
 
"void" SetOverrideText (self, "wxString" aValue)
 
"int" GetMeasuredValue (self)
 
"void" SetMeasuredValue (self, "int" aValue)
 
"wxString" GetValueText (self)
 
"void" Update (self)
 
"wxString" GetPrefix (self)
 
"void" SetPrefix (self, "wxString" aPrefix)
 
"wxString" GetSuffix (self)
 
"void" SetSuffix (self, "wxString" aSuffix)
 
"void" GetUnits (self, "EDA_UNITS &" aUnits)
 
"void" SetUnits (self, "EDA_UNITS" aUnits)
 
"DIM_UNITS_MODE" GetUnitsMode (self)
 
"void" SetUnitsMode (self, "DIM_UNITS_MODE" aMode)
 
"void" SetAutoUnits (self, "bool" aAuto=True)
 
"DIM_UNITS_FORMAT" GetUnitsFormat (self)
 
"void" SetUnitsFormat (self, "DIM_UNITS_FORMAT const" aFormat)
 
"int" GetPrecision (self)
 
"void" SetPrecision (self, "int" aPrecision)
 
"bool" GetSuppressZeroes (self)
 
"void" SetSuppressZeroes (self, "bool" aSuppress)
 
"bool" GetKeepTextAligned (self)
 
"void" SetKeepTextAligned (self, "bool" aKeepAligned)
 
"void" SetTextPositionMode (self, "DIM_TEXT_POSITION" aMode)
 
"DIM_TEXT_POSITION" GetTextPositionMode (self)
 
"int" GetArrowLength (self)
 
"void" SetArrowLength (self, "int" aLength)
 
"void" SetExtensionOffset (self, "int" aOffset)
 
"int" GetExtensionOffset (self)
 
"int" GetLineThickness (self)
 
"void" SetLineThickness (self, "int" aWidth)
 
"void" SetLayer (self, "PCB_LAYER_ID" aLayer)
 
"void" SetTextSize (self, "wxSize" aTextSize)
 
"void" SetText (self, "wxString" aNewText)
 
"wxString const" GetText (self)
 
"PCB_TEXT const &" Text (self, *args)
 
"std::vector< std::shared_ptr< SHAPE >,std::allocator< std::shared_ptr< SHAPE > > > const &" GetShapes (self)
 
"void" Move (self, "wxPoint" offset)
 
"void" Rotate (self, "wxPoint" aRotCentre, "double" aAngle)
 
"void" Flip (self, "wxPoint" aCentre, "bool" aFlipLeftRight)
 
"void" Mirror (self, "wxPoint" axis_pos, "bool" aMirrorLeftRight=False)
 
"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)
 
"std::shared_ptr< SHAPE >" GetEffectiveShape (self, *args)
 
"wxString" GetSelectMenuText (self, "EDA_UNITS" aUnits)
 
"BOX2I const" ViewBBox (self)
 
"void" TransformShapeWithClearanceToPolygon (self, "SHAPE_POLY_SET" aCornerBuffer, "PCB_LAYER_ID" aLayer, "int" aClearance, "int" aError, "ERROR_LOC" aErrorLoc, "bool" aIgnoreLineWidth)
 
- 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)
 

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.PCB_DIMENSION_BASE
 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=)
 

Detailed Description

Proxy of C++ PCB_DIM_CENTER class.

Definition at line 14085 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.PCB_DIM_CENTER.__init__ (   self,
"BOARD_ITEM"  aParent 
)
__init__(PCB_DIM_CENTER self, BOARD_ITEM aParent) -> PCB_DIM_CENTER

Reimplemented from pcbnew.PCB_DIMENSION_BASE.

Definition at line 14091 of file pcbnew.py.

Member Function Documentation

◆ ClassOf()

"bool" pcbnew.PCB_DIM_CENTER.ClassOf ( "EDA_ITEM"  aItem)
static
ClassOf(EDA_ITEM aItem) -> bool

Definition at line 14096 of file pcbnew.py.

◆ Clone()

"EDA_ITEM *" pcbnew.PCB_DIM_CENTER.Clone (   self)
Clone(PCB_DIM_CENTER self) -> EDA_ITEM

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14100 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetBoundingBox()

"EDA_RECT const" pcbnew.PCB_DIM_CENTER.GetBoundingBox (   self)
GetBoundingBox(PCB_DIM_CENTER self) -> EDA_RECT

Reimplemented from pcbnew.PCB_DIMENSION_BASE.

Definition at line 14116 of file pcbnew.py.

◆ GetClass()

"wxString" pcbnew.PCB_DIM_CENTER.GetClass (   self)
GetClass(PCB_DIM_CENTER self) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14112 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetMenuImage()

"BITMAPS" pcbnew.PCB_DIM_CENTER.GetMenuImage (   self)
GetMenuImage(PCB_DIM_CENTER self) -> BITMAPS

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 14108 of file pcbnew.py.

◆ SwapData()

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

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 14104 of file pcbnew.py.

◆ ViewBBox()

"BOX2I const" pcbnew.PCB_DIM_CENTER.ViewBBox (   self)
ViewBBox(PCB_DIM_CENTER self) -> BOX2I const

Reimplemented from pcbnew.PCB_DIMENSION_BASE.

Definition at line 14120 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 14088 of file pcbnew.py.


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