KiCAD pcbnew scripting
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
pcbnew.DIMENSION Class Reference
Inheritance diagram for pcbnew.DIMENSION:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, aParent)
 
def SetValue (self, aValue)
 
def GetValue (self)
 
def GetPosition (self)
 
def SetPosition (self, aPos)
 
def SetTextSize (self, aTextSize)
 
def SetLayer (self, aLayer)
 
def SetShape (self, aShape)
 
def GetShape (self)
 
def GetWidth (self)
 
def SetWidth (self, aWidth)
 
def SetOrigin (self, aOrigin)
 
def GetOrigin (self)
 
def SetEnd (self, aEnd)
 
def GetEnd (self)
 
def SetHeight (self, aHeight)
 
def GetHeight (self)
 
def UpdateHeight (self)
 
def GetAngle (self)
 
def AdjustDimensionDetails (self, aDoNotChangeText=False)
 
def SetText (self, NewText)
 
def GetText (self)
 
def Text (self, args)
 
def Draw (self, args)
 
def Move (self, offset)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre)
 
def Mirror (self, axis_pos)
 
def GetMsgPanelInfo (self, aList)
 
def HitTest (self, args)
 
def GetClass (self)
 
def GetBoundingBox (self)
 
def GetSelectMenuText (self)
 
def GetMenuImage (self)
 
def Clone (self)
 
def ViewBBox (self)
 
def SwapData (self, aImage)
 
- 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 (self, aMask=-1)
 
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

 m_crossBarO = _swig_property(_pcbnew.DIMENSION_m_crossBarO_get, _pcbnew.DIMENSION_m_crossBarO_set)
 
 m_crossBarF = _swig_property(_pcbnew.DIMENSION_m_crossBarF_get, _pcbnew.DIMENSION_m_crossBarF_set)
 
 m_featureLineGO = _swig_property(_pcbnew.DIMENSION_m_featureLineGO_get, _pcbnew.DIMENSION_m_featureLineGO_set)
 
 m_featureLineGF = _swig_property(_pcbnew.DIMENSION_m_featureLineGF_get, _pcbnew.DIMENSION_m_featureLineGF_set)
 
 m_featureLineDO = _swig_property(_pcbnew.DIMENSION_m_featureLineDO_get, _pcbnew.DIMENSION_m_featureLineDO_set)
 
 m_featureLineDF = _swig_property(_pcbnew.DIMENSION_m_featureLineDF_get, _pcbnew.DIMENSION_m_featureLineDF_set)
 
 m_arrowD1F = _swig_property(_pcbnew.DIMENSION_m_arrowD1F_get, _pcbnew.DIMENSION_m_arrowD1F_set)
 
 m_arrowD2F = _swig_property(_pcbnew.DIMENSION_m_arrowD2F_get, _pcbnew.DIMENSION_m_arrowD2F_set)
 
 m_arrowG1F = _swig_property(_pcbnew.DIMENSION_m_arrowG1F_get, _pcbnew.DIMENSION_m_arrowG1F_set)
 
 m_arrowG2F = _swig_property(_pcbnew.DIMENSION_m_arrowG2F_get, _pcbnew.DIMENSION_m_arrowG2F_set)
 
- Static Public Attributes inherited from pcbnew.BOARD_ITEM
 ShowShape = staticmethod(ShowShape)
 
 FormatAngle = staticmethod(FormatAngle)
 
 FormatInternalUnits = staticmethod(FormatInternalUnits)
 
- Static Public Attributes inherited from pcbnew.EDA_ITEM
 IterateForward = staticmethod(IterateForward)
 
 Sort = staticmethod(Sort)
 

Detailed Description

Proxy of C++ DIMENSION class.

Definition at line 14516 of file pcbnew.py.

Constructor & Destructor Documentation

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

Definition at line 14569 of file pcbnew.py.

Member Function Documentation

def pcbnew.DIMENSION.AdjustDimensionDetails (   self,
  aDoNotChangeText = False 
)
AdjustDimensionDetails(DIMENSION self, bool aDoNotChangeText=False)
AdjustDimensionDetails(DIMENSION self)

Definition at line 14669 of file pcbnew.py.

def pcbnew.DIMENSION.Clone (   self)
Clone(DIMENSION self) -> EDA_ITEM

Definition at line 14758 of file pcbnew.py.

def pcbnew.DIMENSION.Draw (   self,
  args 
)
Draw(DIMENSION self, EDA_DRAW_PANEL * panel, wxDC * DC, GR_DRAWMODE aColorMode, wxPoint offset)
Draw(DIMENSION self, EDA_DRAW_PANEL * panel, wxDC * DC, GR_DRAWMODE aColorMode)

Definition at line 14695 of file pcbnew.py.

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

Definition at line 14713 of file pcbnew.py.

def pcbnew.DIMENSION.GetAngle (   self)
GetAngle(DIMENSION self) -> double

Definition at line 14664 of file pcbnew.py.

def pcbnew.DIMENSION.GetBoundingBox (   self)
GetBoundingBox(DIMENSION self) -> EDA_RECT

Definition at line 14743 of file pcbnew.py.

def pcbnew.DIMENSION.GetClass (   self)
GetClass(DIMENSION self) -> wxString

Definition at line 14738 of file pcbnew.py.

def pcbnew.DIMENSION.GetEnd (   self)
GetEnd(DIMENSION self) -> wxPoint

Definition at line 14644 of file pcbnew.py.

def pcbnew.DIMENSION.GetHeight (   self)
GetHeight(DIMENSION self) -> int

Definition at line 14654 of file pcbnew.py.

def pcbnew.DIMENSION.GetMenuImage (   self)
GetMenuImage(DIMENSION self) -> BITMAP_DEF

Definition at line 14753 of file pcbnew.py.

def pcbnew.DIMENSION.GetMsgPanelInfo (   self,
  aList 
)
GetMsgPanelInfo(DIMENSION self, std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > & aList)

Definition at line 14723 of file pcbnew.py.

def pcbnew.DIMENSION.GetOrigin (   self)
GetOrigin(DIMENSION self) -> wxPoint

Definition at line 14634 of file pcbnew.py.

def pcbnew.DIMENSION.GetPosition (   self)
GetPosition(DIMENSION self) -> wxPoint

Definition at line 14589 of file pcbnew.py.

def pcbnew.DIMENSION.GetSelectMenuText (   self)
GetSelectMenuText(DIMENSION self) -> wxString

Definition at line 14748 of file pcbnew.py.

def pcbnew.DIMENSION.GetShape (   self)
GetShape(DIMENSION self) -> int

Definition at line 14614 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.DIMENSION.GetText (   self)
GetText(DIMENSION self) -> wxString

Definition at line 14682 of file pcbnew.py.

def pcbnew.DIMENSION.GetValue (   self)
GetValue(DIMENSION self) -> int

Definition at line 14584 of file pcbnew.py.

def pcbnew.DIMENSION.GetWidth (   self)
GetWidth(DIMENSION self) -> int

Definition at line 14619 of file pcbnew.py.

def pcbnew.DIMENSION.HitTest (   self,
  args 
)
HitTest(DIMENSION self, wxPoint aPosition) -> bool
HitTest(DIMENSION self, EDA_RECT aRect, bool aContained=True, int aAccuracy=0) -> bool
HitTest(DIMENSION self, EDA_RECT aRect, bool aContained=True) -> bool
HitTest(DIMENSION self, EDA_RECT aRect) -> bool

Definition at line 14728 of file pcbnew.py.

def pcbnew.DIMENSION.Mirror (   self,
  axis_pos 
)
Mirror(DIMENSION self, wxPoint axis_pos)

Definition at line 14718 of file pcbnew.py.

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

Definition at line 14703 of file pcbnew.py.

def pcbnew.DIMENSION.Rotate (   self,
  aRotCentre,
  aAngle 
)
Rotate(DIMENSION self, wxPoint aRotCentre, double aAngle)

Definition at line 14708 of file pcbnew.py.

def pcbnew.DIMENSION.SetEnd (   self,
  aEnd 
)
SetEnd(DIMENSION self, wxPoint aEnd)

Definition at line 14639 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.DIMENSION.SetHeight (   self,
  aHeight 
)
SetHeight(DIMENSION self, int aHeight)

Definition at line 14649 of file pcbnew.py.

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

Definition at line 14604 of file pcbnew.py.

def pcbnew.DIMENSION.SetOrigin (   self,
  aOrigin 
)
SetOrigin(DIMENSION self, wxPoint aOrigin)

Definition at line 14629 of file pcbnew.py.

def pcbnew.DIMENSION.SetPosition (   self,
  aPos 
)
SetPosition(DIMENSION self, wxPoint aPos)

Definition at line 14594 of file pcbnew.py.

def pcbnew.DIMENSION.SetShape (   self,
  aShape 
)
SetShape(DIMENSION self, int aShape)

Definition at line 14609 of file pcbnew.py.

def pcbnew.DIMENSION.SetText (   self,
  NewText 
)
SetText(DIMENSION self, wxString NewText)

Definition at line 14677 of file pcbnew.py.

def pcbnew.DIMENSION.SetTextSize (   self,
  aTextSize 
)
SetTextSize(DIMENSION self, wxSize aTextSize)

Definition at line 14599 of file pcbnew.py.

def pcbnew.DIMENSION.SetValue (   self,
  aValue 
)
SetValue(DIMENSION self, int aValue)

Definition at line 14579 of file pcbnew.py.

def pcbnew.DIMENSION.SetWidth (   self,
  aWidth 
)
SetWidth(DIMENSION self, int aWidth)

Definition at line 14624 of file pcbnew.py.

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

Definition at line 14768 of file pcbnew.py.

def pcbnew.DIMENSION.Text (   self,
  args 
)
Text(DIMENSION self) -> TEXTE_PCB
Text(DIMENSION self) -> TEXTE_PCB

Definition at line 14687 of file pcbnew.py.

def pcbnew.DIMENSION.UpdateHeight (   self)
UpdateHeight(DIMENSION self)

Definition at line 14659 of file pcbnew.py.

def pcbnew.DIMENSION.ViewBBox (   self)
ViewBBox(DIMENSION self) -> BOX2I const

Definition at line 14763 of file pcbnew.py.

Member Data Documentation

pcbnew.DIMENSION.m_arrowD1F = _swig_property(_pcbnew.DIMENSION_m_arrowD1F_get, _pcbnew.DIMENSION_m_arrowD1F_set)
static

Definition at line 14555 of file pcbnew.py.

pcbnew.DIMENSION.m_arrowD2F = _swig_property(_pcbnew.DIMENSION_m_arrowD2F_get, _pcbnew.DIMENSION_m_arrowD2F_set)
static

Definition at line 14559 of file pcbnew.py.

pcbnew.DIMENSION.m_arrowG1F = _swig_property(_pcbnew.DIMENSION_m_arrowG1F_get, _pcbnew.DIMENSION_m_arrowG1F_set)
static

Definition at line 14563 of file pcbnew.py.

pcbnew.DIMENSION.m_arrowG2F = _swig_property(_pcbnew.DIMENSION_m_arrowG2F_get, _pcbnew.DIMENSION_m_arrowG2F_set)
static

Definition at line 14567 of file pcbnew.py.

pcbnew.DIMENSION.m_crossBarF = _swig_property(_pcbnew.DIMENSION_m_crossBarF_get, _pcbnew.DIMENSION_m_crossBarF_set)
static

Definition at line 14535 of file pcbnew.py.

pcbnew.DIMENSION.m_crossBarO = _swig_property(_pcbnew.DIMENSION_m_crossBarO_get, _pcbnew.DIMENSION_m_crossBarO_set)
static

Definition at line 14531 of file pcbnew.py.

pcbnew.DIMENSION.m_featureLineDF = _swig_property(_pcbnew.DIMENSION_m_featureLineDF_get, _pcbnew.DIMENSION_m_featureLineDF_set)
static

Definition at line 14551 of file pcbnew.py.

pcbnew.DIMENSION.m_featureLineDO = _swig_property(_pcbnew.DIMENSION_m_featureLineDO_get, _pcbnew.DIMENSION_m_featureLineDO_set)
static

Definition at line 14547 of file pcbnew.py.

pcbnew.DIMENSION.m_featureLineGF = _swig_property(_pcbnew.DIMENSION_m_featureLineGF_get, _pcbnew.DIMENSION_m_featureLineGF_set)
static

Definition at line 14543 of file pcbnew.py.

pcbnew.DIMENSION.m_featureLineGO = _swig_property(_pcbnew.DIMENSION_m_featureLineGO_get, _pcbnew.DIMENSION_m_featureLineGO_set)
static

Definition at line 14539 of file pcbnew.py.

pcbnew.DIMENSION.this

Definition at line 14575 of file pcbnew.py.


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