KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
Public Member Functions | Properties | List of all members
pcbnew.PCB_DIMENSION_BASE Class Reference
Inheritance diagram for pcbnew.PCB_DIMENSION_BASE:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, *args, **kwargs)
 
def Serialize (self, aContainer)
 
def Deserialize (self, aContainer)
 
def GetStart (self)
 
def SetStart (self, aPoint)
 
def GetEnd (self)
 
def SetEnd (self, aPoint)
 
def GetOverrideTextEnabled (self)
 
def SetOverrideTextEnabled (self, aOverride)
 
def GetOverrideText (self)
 
def SetOverrideText (self, aValue)
 
def ChangeOverrideText (self, aValue)
 
def GetMeasuredValue (self)
 
def SetMeasuredValue (self, aValue)
 
def GetValueText (self)
 
def Update (self)
 
def UpdateUnits (self)
 
def GetPrefix (self)
 
def SetPrefix (self, aPrefix)
 
def ChangePrefix (self, aPrefix)
 
def GetSuffix (self)
 
def SetSuffix (self, aSuffix)
 
def ChangeSuffix (self, aSuffix)
 
def GetArrowDirection (self)
 
def SetArrowDirection (self, aDirection)
 
def ChangeArrowDirection (self, aDirection)
 
def GetUnits (self)
 
def SetUnits (self, aUnits)
 
def GetUnitsMode (self)
 
def SetUnitsMode (self, aMode)
 
def ChangeUnitsMode (self, aMode)
 
def SetAutoUnits (self, aAuto=True)
 
def GetUnitsFormat (self)
 
def SetUnitsFormat (self, aFormat)
 
def ChangeUnitsFormat (self, aFormat)
 
def GetPrecision (self)
 
def SetPrecision (self, aPrecision)
 
def ChangePrecision (self, aPrecision)
 
def GetSuppressZeroes (self)
 
def SetSuppressZeroes (self, aSuppress)
 
def ChangeSuppressZeroes (self, aSuppress)
 
def GetKeepTextAligned (self)
 
def SetKeepTextAligned (self, aKeepAligned)
 
def GetTextAngleDegreesProp (self)
 
def ChangeTextAngleDegrees (self, aDegrees)
 
def ChangeKeepTextAligned (self, aKeepAligned)
 
def SetTextPositionMode (self, aMode)
 
def GetTextPositionMode (self)
 
def GetArrowLength (self)
 
def SetArrowLength (self, aLength)
 
def SetExtensionOffset (self, aOffset)
 
def GetExtensionOffset (self)
 
def GetLineThickness (self)
 
def SetLineThickness (self, aWidth)
 
def GetShapes (self)
 
def HitTest (self, *args)
 
def GetEffectiveShape (self, *args)
 
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, aIgnoreLineWidth=False)
 
def __eq__ (self, *args)
 
- Public Member Functions inherited from pcbnew.PCB_TEXT
def __init__ (self, *args)
 
def Serialize (self, aContainer)
 
def Deserialize (self, aContainer)
 
def KeepUpright (self)
 
def GetShownText (self, aAllowExtraText, aDepth=0)
 
def TextHitTest (self, *args)
 
def HitTest (self, *args)
 
def GetClass (self)
 
def TransformTextToPolySet (self, aBuffer, aClearance, aMaxError, aErrorLoc)
 
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aMaxError, aErrorLoc, aIgnoreLineWidth=False)
 
def GetEffectiveShape (self, *args)
 
def GetKnockoutCache (self, aFont, forResolvedText, aMaxError)
 
def GetTextTypeDescription (self)
 
def ViewGetLOD (self, aLayer, aView)
 
def __eq__ (self, *args)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
def __init__ (self, *args, **kwargs)
 
def CopyFrom (self, aOther)
 
def IsGroupableType (self)
 
def GetX (self)
 
def GetY (self)
 
def GetCenter (self)
 
def SetX (self, aX)
 
def SetY (self, aY)
 
def IsConnected (self)
 
def Similarity (self, aItem)
 
def __eq__ (self, aItem)
 
def IsOnCopperLayer (self)
 
def HasHole (self)
 
def HasDrilledHole (self)
 
def IsTented (self, aLayer)
 
def GetEffectiveShape (self, *args)
 
def GetEffectiveHoleShape (self)
 
def RunOnChildren (self, aFunction, aMode)
 
def GetParent (self)
 
def GetParentFootprint (self)
 
def GetFPRelativePosition (self)
 
def SetFPRelativePosition (self, aPos)
 
def HasLineStroke (self)
 
def GetStroke (self)
 
def SetStroke (self, aStroke)
 
def GetFontMetrics (self)
 
def GetLayer (self)
 
def BoardLayerCount (self)
 
def BoardCopperLayerCount (self)
 
def BoardLayerSet (self)
 
def GetLayerSet (self)
 
def SetLayerSet (self, aLayers)
 
def IsSideSpecific (self)
 
def SetLayer (self, aLayer)
 
def Duplicate (self, addToParentGroup, aCommit=None)
 
def SwapItemData (self, aImage)
 
def IsOnLayer (self, aLayer)
 
def IsKnockout (self)
 
def SetIsKnockout (self, aKnockout)
 
def GetMaxError (self)
 
def StyleFromSettings (self, settings)
 
def DeleteStructure (self)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre, aFlipDirection)
 
def Mirror (self, aCentre, aFlipDirection)
 
def Normalize (self)
 
def NormalizeForCompare (self)
 
def GetBoard (self, *args)
 
def GetParentAsString (self)
 
def GetLayerName (self)
 
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
def TransformShapeToPolySet (self, aBuffer, aLayer, aClearance, aError, aErrorLoc)
 
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 GetParent (self)
 
def SetParent (self, aParent)
 
def SetParentGroup (self, aGroup)
 
def GetParentGroup (self)
 
def GetParentGroupId (self)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
def IsModified (self)
 
def IsNew (self)
 
def IsMoving (self)
 
def IsSelected (self)
 
def IsEntered (self)
 
def IsBrightened (self)
 
def IsRollover (self)
 
def SetIsRollover (self, aIsRollover)
 
def SetSelected (self)
 
def SetBrightened (self)
 
def ClearSelected (self)
 
def ClearBrightened (self)
 
def SetModified (self)
 
def SetFlags (self, aMask)
 
def XorFlags (self, aMask)
 
def ClearFlags (self, *args)
 
def GetFlags (self)
 
def HasFlag (self, aFlag)
 
def GetEditFlags (self)
 
def ClearEditFlags (self)
 
def GetTempFlags (self)
 
def ClearTempFlags (self)
 
def RenderAsBitmap (self, aWorldScale)
 
def SetIsShownAsBitmap (self, aBitmap)
 
def IsShownAsBitmap (self)
 
def IsType (self, aScanTypes)
 
def SetForceVisible (self, aEnable)
 
def IsForceVisible (self)
 
def GetMsgPanelInfo (self, aFrame, aList)
 
def GetFriendlyName (self)
 
def HitTest (self, *args)
 
def GetBoundingBox (self)
 
def GetPosition (self)
 
def SetPosition (self, aPos)
 
def GetFocusPosition (self)
 
def GetSortPosition (self)
 
def Clone (self)
 
def Visit (self, inspector, testData, aScanTypes)
 
def GetTypeDesc (self)
 
def GetItemDescription (self, aUnitsProvider, aFull)
 
def GetMenuImage (self)
 
def Matches (self, aSearchData, aAuxData)
 
def Replace (self, *args)
 
def IsReplaceable (self)
 
def __lt__ (self, aItem)
 
def ViewBBox (self)
 
def ViewGetLayers (self)
 
def GetEmbeddedFiles (self)
 
def PyGetClass (self)
 
def GetClass (self)
 
- Public Member Functions inherited from pcbnew.EDA_TEXT
def __init__ (self, *args)
 
def Serialize (self, aContainer)
 
def Deserialize (self, aContainer)
 
def GetText (self)
 
def GetShownText (self, aAllowExtraText, aDepth=0)
 
def HasTextVars (self)
 
def SetText (self, aText)
 
def SetTextThickness (self, aWidth)
 
def GetTextThickness (self)
 
def GetTextThicknessProperty (self)
 
def SetAutoThickness (self, aAuto)
 
def GetAutoThickness (self)
 
def GetEffectiveTextPenWidth (self, aDefaultPenWidth=0)
 
def SetTextAngle (self, aAngle)
 
def GetTextAngle (self)
 
def SetTextAngleDegrees (self, aOrientation)
 
def GetTextAngleDegrees (self)
 
def SetItalic (self, aItalic)
 
def SetItalicFlag (self, aItalic)
 
def IsItalic (self)
 
def SetBold (self, aBold)
 
def SetBoldFlag (self, aBold)
 
def IsBold (self)
 
def SetVisible (self, aVisible)
 
def IsVisible (self)
 
def SetMirrored (self, isMirrored)
 
def IsMirrored (self)
 
def SetMultilineAllowed (self, aAllow)
 
def IsMultilineAllowed (self)
 
def SetHorizJustify (self, aType)
 
def GetHorizJustify (self)
 
def SetVertJustify (self, aType)
 
def GetVertJustify (self)
 
def SetKeepUpright (self, aKeepUpright)
 
def IsKeepUpright (self)
 
def FlipHJustify (self)
 
def SwapAttributes (self, aTradingPartner)
 
def SwapText (self, aTradingPartner)
 
def CopyText (self, aSrc)
 
def SetAttributes (self, *args)
 
def GetAttributes (self)
 
def Replace (self, aSearchData)
 
def IsDefaultFormatting (self)
 
def SetFont (self, aFont)
 
def GetFont (self)
 
def SetUnresolvedFontName (self, aFontName)
 
def ResolveFont (self, aEmbeddedFonts)
 
def GetFontName (self)
 
def SetFontIndex (self, aIdx)
 
def GetFontIndex (self)
 
def SetLineSpacing (self, aLineSpacing)
 
def GetLineSpacing (self)
 
def SetTextSize (self, aNewSize, aEnforceMinTextSize=True)
 
def GetTextSize (self)
 
def SetTextWidth (self, aWidth)
 
def GetTextWidth (self)
 
def SetTextHeight (self, aHeight)
 
def GetTextHeight (self)
 
def SetTextColor (self, aColor)
 
def GetTextColor (self)
 
def SetTextPos (self, aPoint)
 
def GetTextPos (self)
 
def SetTextX (self, aX)
 
def SetTextY (self, aY)
 
def Offset (self, aOffset)
 
def Empty (self)
 
def Print (self, aSettings, aOffset, aColor)
 
def GetEffectiveTextShape (self, *args)
 
def TextHitTest (self, *args)
 
def GetTextBox (self, aLine=-1)
 
def GetInterline (self)
 
def GetTextStyleName (self)
 
def GetLinePositions (self, aPositions, aLineCount)
 
def Levenshtein (self, aOther)
 
def Similarity (self, aOther)
 
def Format (self, aFormatter, aControlBits)
 
def GetDrawRotation (self)
 
def GetDrawPos (self)
 
def ClearRenderCache (self)
 
def ClearBoundingBoxCache (self)
 
def GetRenderCache (self, *args)
 
def SetupRenderCache (self, aResolvedText, aFont, aAngle, aOffset)
 
def AddRenderCacheGlyph (self, aPoly)
 
def Compare (self, aOther)
 
def __eq__ (self, aRhs)
 
def __lt__ (self, aRhs)
 
def __gt__ (self, aRhs)
 
def HasHyperlink (self)
 
def GetHyperlink (self)
 
def SetHyperlink (self, aLink)
 
def RemoveHyperlink (self)
 

Properties

property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.PCB_TEXT
property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.BOARD_ITEM
property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.EDA_ITEM
property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
property m_Uuid = property(_pcbnew.EDA_ITEM_m_Uuid_get, doc=)
 
- Properties inherited from pcbnew.EDA_TEXT
property thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 

Additional Inherited Members

- Static Public Member Functions inherited from pcbnew.PCB_TEXT
def ClassOf (aItem)
 
- Static Public Member Functions inherited from pcbnew.EDA_ITEM
def Sort (aLeft, aRight)
 
- Static Public Member Functions inherited from pcbnew.EDA_TEXT
def MapHorizJustify (aHorizJustify)
 
def MapVertJustify (aVertJustify)
 
def ValidateHyperlink (aURL)
 
def IsGotoPageHref (aHref, aDestination=None)
 
def GotoPageHref (aDestination)
 
- Static Public Attributes inherited from pcbnew.BOARD_ITEM
_pcbnew DRC = _pcbnew.BOARD_ITEM_DRC
 
_pcbnew INSTANCE_TO_INSTANCE = _pcbnew.BOARD_ITEM_INSTANCE_TO_INSTANCE
 

Detailed Description

Proxy of C++ PCB_DIMENSION_BASE class.

Definition at line 17451 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.PCB_DIMENSION_BASE.__init__ (   self,
args,
**  kwargs 
)
    __init__(PCB_TEXT self, BOARD_ITEM parent, KICAD_T idtype=PCB_TEXT_T) -> PCB_TEXT
    __init__(PCB_TEXT self, FOOTPRINT aParent, KICAD_T idtype=PCB_TEXT_T) -> PCB_TEXT

Reimplemented from pcbnew.PCB_TEXT.

Reimplemented in pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_DIM_RADIAL, pcbnew.PCB_DIM_LEADER, pcbnew.PCB_DIM_CENTER, and pcbnew.PCB_DIM_ALIGNED.

Definition at line 17456 of file pcbnew.py.

Member Function Documentation

◆ __eq__()

def pcbnew.PCB_DIMENSION_BASE.__eq__ (   self,
args 
)
    __eq__(PCB_DIMENSION_BASE self, PCB_DIMENSION_BASE aOther) -> bool
    __eq__(PCB_DIMENSION_BASE self, BOARD_ITEM aBoardItem) -> bool

Reimplemented from pcbnew.PCB_TEXT.

Definition at line 17691 of file pcbnew.py.

Here is the caller graph for this function:

◆ ChangeArrowDirection()

def pcbnew.PCB_DIMENSION_BASE.ChangeArrowDirection (   self,
  aDirection 
)
ChangeArrowDirection(PCB_DIMENSION_BASE self, DIM_ARROW_DIRECTION const & aDirection)

Definition at line 17556 of file pcbnew.py.

◆ ChangeKeepTextAligned()

def pcbnew.PCB_DIMENSION_BASE.ChangeKeepTextAligned (   self,
  aKeepAligned 
)
ChangeKeepTextAligned(PCB_DIMENSION_BASE self, bool aKeepAligned)

Definition at line 17636 of file pcbnew.py.

◆ ChangeOverrideText()

def pcbnew.PCB_DIMENSION_BASE.ChangeOverrideText (   self,
  aValue 
)
ChangeOverrideText(PCB_DIMENSION_BASE self, wxString aValue)

Definition at line 17500 of file pcbnew.py.

◆ ChangePrecision()

def pcbnew.PCB_DIMENSION_BASE.ChangePrecision (   self,
  aPrecision 
)
ChangePrecision(PCB_DIMENSION_BASE self, DIM_PRECISION aPrecision)

Definition at line 17604 of file pcbnew.py.

◆ ChangePrefix()

def pcbnew.PCB_DIMENSION_BASE.ChangePrefix (   self,
  aPrefix 
)
ChangePrefix(PCB_DIMENSION_BASE self, wxString aPrefix)

Definition at line 17532 of file pcbnew.py.

◆ ChangeSuffix()

def pcbnew.PCB_DIMENSION_BASE.ChangeSuffix (   self,
  aSuffix 
)
ChangeSuffix(PCB_DIMENSION_BASE self, wxString aSuffix)

Definition at line 17544 of file pcbnew.py.

◆ ChangeSuppressZeroes()

def pcbnew.PCB_DIMENSION_BASE.ChangeSuppressZeroes (   self,
  aSuppress 
)
ChangeSuppressZeroes(PCB_DIMENSION_BASE self, bool aSuppress)

Definition at line 17616 of file pcbnew.py.

◆ ChangeTextAngleDegrees()

def pcbnew.PCB_DIMENSION_BASE.ChangeTextAngleDegrees (   self,
  aDegrees 
)
ChangeTextAngleDegrees(PCB_DIMENSION_BASE self, double aDegrees)

Definition at line 17632 of file pcbnew.py.

◆ ChangeUnitsFormat()

def pcbnew.PCB_DIMENSION_BASE.ChangeUnitsFormat (   self,
  aFormat 
)
ChangeUnitsFormat(PCB_DIMENSION_BASE self, DIM_UNITS_FORMAT const aFormat)

Definition at line 17592 of file pcbnew.py.

◆ ChangeUnitsMode()

def pcbnew.PCB_DIMENSION_BASE.ChangeUnitsMode (   self,
  aMode 
)
ChangeUnitsMode(PCB_DIMENSION_BASE self, DIM_UNITS_MODE aMode)

Definition at line 17576 of file pcbnew.py.

◆ Deserialize()

def pcbnew.PCB_DIMENSION_BASE.Deserialize (   self,
  aContainer 
)
Deserialize(PCB_DIMENSION_BASE self, google::protobuf::Any const & aContainer) -> bool

Reimplemented from pcbnew.PCB_TEXT.

Reimplemented in pcbnew.PCB_DIM_ALIGNED, pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_DIM_RADIAL, pcbnew.PCB_DIM_LEADER, and pcbnew.PCB_DIM_CENTER.

Definition at line 17464 of file pcbnew.py.

◆ GetArrowDirection()

def pcbnew.PCB_DIMENSION_BASE.GetArrowDirection (   self)
GetArrowDirection(PCB_DIMENSION_BASE self) -> DIM_ARROW_DIRECTION

Definition at line 17548 of file pcbnew.py.

◆ GetArrowLength()

def pcbnew.PCB_DIMENSION_BASE.GetArrowLength (   self)
GetArrowLength(PCB_DIMENSION_BASE self) -> int

Definition at line 17648 of file pcbnew.py.

◆ GetEffectiveShape()

def pcbnew.PCB_DIMENSION_BASE.GetEffectiveShape (   self,
args 
)
GetEffectiveShape(PCB_DIMENSION_BASE self, PCB_LAYER_ID aLayer, FLASHING aFlash=DEFAULT) -> std::shared_ptr< SHAPE >

Reimplemented from pcbnew.PCB_TEXT.

Definition at line 17683 of file pcbnew.py.

◆ GetEnd()

def pcbnew.PCB_DIMENSION_BASE.GetEnd (   self)
GetEnd(PCB_DIMENSION_BASE self) -> VECTOR2I

Definition at line 17476 of file pcbnew.py.

◆ GetExtensionOffset()

def pcbnew.PCB_DIMENSION_BASE.GetExtensionOffset (   self)
GetExtensionOffset(PCB_DIMENSION_BASE self) -> int

Definition at line 17660 of file pcbnew.py.

◆ GetKeepTextAligned()

def pcbnew.PCB_DIMENSION_BASE.GetKeepTextAligned (   self)
GetKeepTextAligned(PCB_DIMENSION_BASE self) -> bool

Definition at line 17620 of file pcbnew.py.

◆ GetLineThickness()

def pcbnew.PCB_DIMENSION_BASE.GetLineThickness (   self)
GetLineThickness(PCB_DIMENSION_BASE self) -> int

Definition at line 17664 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetMeasuredValue()

def pcbnew.PCB_DIMENSION_BASE.GetMeasuredValue (   self)
GetMeasuredValue(PCB_DIMENSION_BASE self) -> int

Definition at line 17504 of file pcbnew.py.

◆ GetOverrideText()

def pcbnew.PCB_DIMENSION_BASE.GetOverrideText (   self)
GetOverrideText(PCB_DIMENSION_BASE self) -> wxString

Definition at line 17492 of file pcbnew.py.

◆ GetOverrideTextEnabled()

def pcbnew.PCB_DIMENSION_BASE.GetOverrideTextEnabled (   self)
GetOverrideTextEnabled(PCB_DIMENSION_BASE self) -> bool

Definition at line 17484 of file pcbnew.py.

◆ GetPrecision()

def pcbnew.PCB_DIMENSION_BASE.GetPrecision (   self)
GetPrecision(PCB_DIMENSION_BASE self) -> DIM_PRECISION

Definition at line 17596 of file pcbnew.py.

◆ GetPrefix()

def pcbnew.PCB_DIMENSION_BASE.GetPrefix (   self)
GetPrefix(PCB_DIMENSION_BASE self) -> wxString

Definition at line 17524 of file pcbnew.py.

◆ GetShapes()

def pcbnew.PCB_DIMENSION_BASE.GetShapes (   self)
GetShapes(PCB_DIMENSION_BASE self) -> VECTOR_SHAPEPTR

Definition at line 17672 of file pcbnew.py.

◆ GetStart()

def pcbnew.PCB_DIMENSION_BASE.GetStart (   self)
GetStart(PCB_DIMENSION_BASE self) -> VECTOR2I

Definition at line 17468 of file pcbnew.py.

◆ GetSuffix()

def pcbnew.PCB_DIMENSION_BASE.GetSuffix (   self)
GetSuffix(PCB_DIMENSION_BASE self) -> wxString

Definition at line 17536 of file pcbnew.py.

◆ GetSuppressZeroes()

def pcbnew.PCB_DIMENSION_BASE.GetSuppressZeroes (   self)
GetSuppressZeroes(PCB_DIMENSION_BASE self) -> bool

Definition at line 17608 of file pcbnew.py.

◆ GetTextAngleDegreesProp()

def pcbnew.PCB_DIMENSION_BASE.GetTextAngleDegreesProp (   self)
GetTextAngleDegreesProp(PCB_DIMENSION_BASE self) -> double

Definition at line 17628 of file pcbnew.py.

◆ GetTextPositionMode()

def pcbnew.PCB_DIMENSION_BASE.GetTextPositionMode (   self)
GetTextPositionMode(PCB_DIMENSION_BASE self) -> DIM_TEXT_POSITION

Definition at line 17644 of file pcbnew.py.

◆ GetUnits()

def pcbnew.PCB_DIMENSION_BASE.GetUnits (   self)
GetUnits(PCB_DIMENSION_BASE self) -> EDA_UNITS

Definition at line 17560 of file pcbnew.py.

◆ GetUnitsFormat()

def pcbnew.PCB_DIMENSION_BASE.GetUnitsFormat (   self)
GetUnitsFormat(PCB_DIMENSION_BASE self) -> DIM_UNITS_FORMAT

Definition at line 17584 of file pcbnew.py.

◆ GetUnitsMode()

def pcbnew.PCB_DIMENSION_BASE.GetUnitsMode (   self)
GetUnitsMode(PCB_DIMENSION_BASE self) -> DIM_UNITS_MODE

Definition at line 17568 of file pcbnew.py.

◆ GetValueText()

def pcbnew.PCB_DIMENSION_BASE.GetValueText (   self)
GetValueText(PCB_DIMENSION_BASE self) -> wxString

Definition at line 17512 of file pcbnew.py.

◆ HitTest()

def pcbnew.PCB_DIMENSION_BASE.HitTest (   self,
args 
)
    HitTest(PCB_DIMENSION_BASE self, VECTOR2I aPosition, int aAccuracy) -> bool
    HitTest(PCB_DIMENSION_BASE self, BOX2I aRect, bool aContained, int aAccuracy=0) -> bool

Reimplemented from pcbnew.PCB_TEXT.

Definition at line 17676 of file pcbnew.py.

Here is the caller graph for this function:

◆ Serialize()

def pcbnew.PCB_DIMENSION_BASE.Serialize (   self,
  aContainer 
)
Serialize(PCB_DIMENSION_BASE self, google::protobuf::Any & aContainer)

Reimplemented from pcbnew.PCB_TEXT.

Reimplemented in pcbnew.PCB_DIM_ALIGNED, pcbnew.PCB_DIM_ORTHOGONAL, pcbnew.PCB_DIM_RADIAL, pcbnew.PCB_DIM_LEADER, and pcbnew.PCB_DIM_CENTER.

Definition at line 17460 of file pcbnew.py.

◆ SetArrowDirection()

def pcbnew.PCB_DIMENSION_BASE.SetArrowDirection (   self,
  aDirection 
)
SetArrowDirection(PCB_DIMENSION_BASE self, DIM_ARROW_DIRECTION const & aDirection)

Definition at line 17552 of file pcbnew.py.

◆ SetArrowLength()

def pcbnew.PCB_DIMENSION_BASE.SetArrowLength (   self,
  aLength 
)
SetArrowLength(PCB_DIMENSION_BASE self, int aLength)

Definition at line 17652 of file pcbnew.py.

◆ SetAutoUnits()

def pcbnew.PCB_DIMENSION_BASE.SetAutoUnits (   self,
  aAuto = True 
)
SetAutoUnits(PCB_DIMENSION_BASE self, bool aAuto=True)

Definition at line 17580 of file pcbnew.py.

◆ SetEnd()

def pcbnew.PCB_DIMENSION_BASE.SetEnd (   self,
  aPoint 
)
SetEnd(PCB_DIMENSION_BASE self, VECTOR2I aPoint)

Definition at line 17480 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetExtensionOffset()

def pcbnew.PCB_DIMENSION_BASE.SetExtensionOffset (   self,
  aOffset 
)
SetExtensionOffset(PCB_DIMENSION_BASE self, int aOffset)

Definition at line 17656 of file pcbnew.py.

◆ SetKeepTextAligned()

def pcbnew.PCB_DIMENSION_BASE.SetKeepTextAligned (   self,
  aKeepAligned 
)
SetKeepTextAligned(PCB_DIMENSION_BASE self, bool aKeepAligned)

Definition at line 17624 of file pcbnew.py.

◆ SetLineThickness()

def pcbnew.PCB_DIMENSION_BASE.SetLineThickness (   self,
  aWidth 
)
SetLineThickness(PCB_DIMENSION_BASE self, int aWidth)

Definition at line 17668 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetMeasuredValue()

def pcbnew.PCB_DIMENSION_BASE.SetMeasuredValue (   self,
  aValue 
)
SetMeasuredValue(PCB_DIMENSION_BASE self, int aValue)

Definition at line 17508 of file pcbnew.py.

◆ SetOverrideText()

def pcbnew.PCB_DIMENSION_BASE.SetOverrideText (   self,
  aValue 
)
SetOverrideText(PCB_DIMENSION_BASE self, wxString aValue)

Definition at line 17496 of file pcbnew.py.

◆ SetOverrideTextEnabled()

def pcbnew.PCB_DIMENSION_BASE.SetOverrideTextEnabled (   self,
  aOverride 
)
SetOverrideTextEnabled(PCB_DIMENSION_BASE self, bool aOverride)

Definition at line 17488 of file pcbnew.py.

◆ SetPrecision()

def pcbnew.PCB_DIMENSION_BASE.SetPrecision (   self,
  aPrecision 
)
SetPrecision(PCB_DIMENSION_BASE self, DIM_PRECISION aPrecision)

Definition at line 17600 of file pcbnew.py.

◆ SetPrefix()

def pcbnew.PCB_DIMENSION_BASE.SetPrefix (   self,
  aPrefix 
)
SetPrefix(PCB_DIMENSION_BASE self, wxString aPrefix)

Definition at line 17528 of file pcbnew.py.

◆ SetStart()

def pcbnew.PCB_DIMENSION_BASE.SetStart (   self,
  aPoint 
)
SetStart(PCB_DIMENSION_BASE self, VECTOR2I aPoint)

Definition at line 17472 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetSuffix()

def pcbnew.PCB_DIMENSION_BASE.SetSuffix (   self,
  aSuffix 
)
SetSuffix(PCB_DIMENSION_BASE self, wxString aSuffix)

Definition at line 17540 of file pcbnew.py.

◆ SetSuppressZeroes()

def pcbnew.PCB_DIMENSION_BASE.SetSuppressZeroes (   self,
  aSuppress 
)
SetSuppressZeroes(PCB_DIMENSION_BASE self, bool aSuppress)

Definition at line 17612 of file pcbnew.py.

◆ SetTextPositionMode()

def pcbnew.PCB_DIMENSION_BASE.SetTextPositionMode (   self,
  aMode 
)
SetTextPositionMode(PCB_DIMENSION_BASE self, DIM_TEXT_POSITION aMode)

Definition at line 17640 of file pcbnew.py.

◆ SetUnits()

def pcbnew.PCB_DIMENSION_BASE.SetUnits (   self,
  aUnits 
)
SetUnits(PCB_DIMENSION_BASE self, EDA_UNITS aUnits)

Definition at line 17564 of file pcbnew.py.

◆ SetUnitsFormat()

def pcbnew.PCB_DIMENSION_BASE.SetUnitsFormat (   self,
  aFormat 
)
SetUnitsFormat(PCB_DIMENSION_BASE self, DIM_UNITS_FORMAT const aFormat)

Definition at line 17588 of file pcbnew.py.

◆ SetUnitsMode()

def pcbnew.PCB_DIMENSION_BASE.SetUnitsMode (   self,
  aMode 
)
SetUnitsMode(PCB_DIMENSION_BASE self, DIM_UNITS_MODE aMode)

Definition at line 17572 of file pcbnew.py.

◆ TransformShapeToPolygon()

def pcbnew.PCB_DIMENSION_BASE.TransformShapeToPolygon (   self,
  aBuffer,
  aLayer,
  aClearance,
  aError,
  aErrorLoc,
  aIgnoreLineWidth = False 
)
TransformShapeToPolygon(PCB_DIMENSION_BASE self, SHAPE_POLY_SET aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool aIgnoreLineWidth=False)

Reimplemented from pcbnew.PCB_TEXT.

Definition at line 17687 of file pcbnew.py.

◆ Update()

def pcbnew.PCB_DIMENSION_BASE.Update (   self)
Update(PCB_DIMENSION_BASE self)

Definition at line 17516 of file pcbnew.py.

◆ UpdateUnits()

def pcbnew.PCB_DIMENSION_BASE.UpdateUnits (   self)
UpdateUnits(PCB_DIMENSION_BASE self)

Definition at line 17520 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 17454 of file pcbnew.py.


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