KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
pcbnew.PCB_DIM_ALIGNED Class Reference
Inheritance diagram for pcbnew.PCB_DIM_ALIGNED:

Public Member Functions

 __init__ (self, aParent, aType=PCB_DIM_ALIGNED_T)
 
 Serialize (self, aContainer)
 
 Deserialize (self, aContainer)
 
 GetCrossbarStart (self)
 
 GetCrossbarEnd (self)
 
 SetHeight (self, aHeight)
 
 GetHeight (self)
 
 ChangeHeight (self, aHeight)
 
 UpdateHeight (self, aCrossbarStart, aCrossbarEnd)
 
 SetExtensionHeight (self, aHeight)
 
 GetExtensionHeight (self)
 
 ChangeExtensionHeight (self, aHeight)
 
 GetAngle (self)
 
 GetClass (self)
 
- Public Member Functions inherited from pcbnew.PCB_DIMENSION_BASE
 __init__ (self, *args, **kwargs)
 
 GetStart (self)
 
 SetStart (self, aPoint)
 
 GetEnd (self)
 
 SetEnd (self, aPoint)
 
 GetOverrideTextEnabled (self)
 
 SetOverrideTextEnabled (self, aOverride)
 
 GetOverrideText (self)
 
 SetOverrideText (self, aValue)
 
 ChangeOverrideText (self, aValue)
 
 GetMeasuredValue (self)
 
 SetMeasuredValue (self, aValue)
 
 GetValueText (self)
 
 Update (self)
 
 UpdateUnits (self)
 
 GetPrefix (self)
 
 SetPrefix (self, aPrefix)
 
 ChangePrefix (self, aPrefix)
 
 GetSuffix (self)
 
 SetSuffix (self, aSuffix)
 
 ChangeSuffix (self, aSuffix)
 
 GetArrowDirection (self)
 
 SetArrowDirection (self, aDirection)
 
 ChangeArrowDirection (self, aDirection)
 
 GetUnits (self)
 
 SetUnits (self, aUnits)
 
 GetUnitsMode (self)
 
 SetUnitsMode (self, aMode)
 
 ChangeUnitsMode (self, aMode)
 
 SetAutoUnits (self, aAuto=True)
 
 GetUnitsFormat (self)
 
 SetUnitsFormat (self, aFormat)
 
 ChangeUnitsFormat (self, aFormat)
 
 GetPrecision (self)
 
 SetPrecision (self, aPrecision)
 
 ChangePrecision (self, aPrecision)
 
 GetSuppressZeroes (self)
 
 SetSuppressZeroes (self, aSuppress)
 
 ChangeSuppressZeroes (self, aSuppress)
 
 GetKeepTextAligned (self)
 
 SetKeepTextAligned (self, aKeepAligned)
 
 GetTextAngleDegreesProp (self)
 
 ChangeTextAngleDegrees (self, aDegrees)
 
 ChangeKeepTextAligned (self, aKeepAligned)
 
 SetTextPositionMode (self, aMode)
 
 GetTextPositionMode (self)
 
 GetArrowLength (self)
 
 SetArrowLength (self, aLength)
 
 SetExtensionOffset (self, aOffset)
 
 GetExtensionOffset (self)
 
 GetLineThickness (self)
 
 SetLineThickness (self, aWidth)
 
 GetShapes (self)
 
 HitTest (self, *args)
 
 GetEffectiveShape (self, *args)
 
 TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, aIgnoreLineWidth=False)
 
 __eq__ (self, *args)
 
- Public Member Functions inherited from pcbnew.PCB_TEXT
 __init__ (self, *args)
 
 KeepUpright (self)
 
 GetShownText (self, aAllowExtraText, aDepth=0)
 
 TextHitTest (self, *args)
 
 TransformTextToPolySet (self, aBuffer, aClearance, aMaxError, aErrorLoc)
 
 GetKnockoutCache (self, aFont, forResolvedText, aMaxError)
 
 GetTextTypeDescription (self)
 
 ViewGetLOD (self, aLayer, aView)
 
 __eq__ (self, *args)
 
- 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)
 
 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)
 
 TransformShapeToPolySet (self, aBuffer, aLayer, aClearance, aError, aErrorLoc)
 
 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)
 
 SetIsRollover (self, aIsRollover)
 
 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)
 
 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_TEXT
 __init__ (self, *args)
 
 GetText (self)
 
 HasTextVars (self)
 
 SetText (self, aText)
 
 EvaluateText (self, aText)
 
 SetTextThickness (self, aWidth)
 
 GetTextThickness (self)
 
 GetTextThicknessProperty (self)
 
 SetAutoThickness (self, aAuto)
 
 GetAutoThickness (self)
 
 GetEffectiveTextPenWidth (self, aDefaultPenWidth=0)
 
 SetTextAngle (self, aAngle)
 
 GetTextAngle (self)
 
 SetTextAngleDegrees (self, aOrientation)
 
 GetTextAngleDegrees (self)
 
 SetItalic (self, aItalic)
 
 SetItalicFlag (self, aItalic)
 
 IsItalic (self)
 
 SetBold (self, aBold)
 
 SetBoldFlag (self, aBold)
 
 IsBold (self)
 
 SetVisible (self, aVisible)
 
 IsVisible (self)
 
 SetMirrored (self, isMirrored)
 
 IsMirrored (self)
 
 SetMultilineAllowed (self, aAllow)
 
 IsMultilineAllowed (self)
 
 SetHorizJustify (self, aType)
 
 GetHorizJustify (self)
 
 SetVertJustify (self, aType)
 
 GetVertJustify (self)
 
 SetKeepUpright (self, aKeepUpright)
 
 IsKeepUpright (self)
 
 FlipHJustify (self)
 
 SwapAttributes (self, aTradingPartner)
 
 SwapText (self, aTradingPartner)
 
 CopyText (self, aSrc)
 
 SetAttributes (self, *args)
 
 GetAttributes (self)
 
 Replace (self, aSearchData)
 
 IsDefaultFormatting (self)
 
 SetFont (self, aFont)
 
 GetFont (self)
 
 SetUnresolvedFontName (self, aFontName)
 
 ResolveFont (self, aEmbeddedFonts)
 
 GetFontName (self)
 
 SetFontProp (self, aFontName)
 
 GetFontProp (self)
 
 SetLineSpacing (self, aLineSpacing)
 
 GetLineSpacing (self)
 
 SetTextSize (self, aNewSize, aEnforceMinTextSize=True)
 
 GetTextSize (self)
 
 SetTextWidth (self, aWidth)
 
 GetTextWidth (self)
 
 SetTextHeight (self, aHeight)
 
 GetTextHeight (self)
 
 SetTextColor (self, aColor)
 
 GetTextColor (self)
 
 SetTextPos (self, aPoint)
 
 GetTextPos (self)
 
 SetTextX (self, aX)
 
 SetTextY (self, aY)
 
 Offset (self, aOffset)
 
 Empty (self)
 
 Print (self, aSettings, aOffset, aColor)
 
 GetEffectiveTextShape (self, *args)
 
 GetTextBox (self, aSettings, aLine=-1)
 
 GetInterline (self, aSettings)
 
 GetTextStyleName (self)
 
 GetLinePositions (self, aSettings, aPositions, aLineCount)
 
 Levenshtein (self, aOther)
 
 Similarity (self, aOther)
 
 Format (self, aFormatter, aControlBits)
 
 GetDrawRotation (self)
 
 GetDrawPos (self)
 
 GetDrawFont (self, aSettings)
 
 ClearRenderCache (self)
 
 ClearBoundingBoxCache (self)
 
 GetRenderCache (self, *args)
 
 SetupRenderCache (self, aResolvedText, aFont, aAngle, aOffset)
 
 AddRenderCacheGlyph (self, aPoly)
 
 Compare (self, aOther)
 
 __eq__ (self, aRhs)
 
 __lt__ (self, aRhs)
 
 __gt__ (self, aRhs)
 
 HasHyperlink (self)
 
 GetHyperlink (self)
 
 SetHyperlink (self, aLink)
 
 RemoveHyperlink (self)
 

Static Public Member Functions

 ClassOf (aItem)
 
- Static Public Member Functions inherited from pcbnew.EDA_ITEM
 Sort (aLeft, aRight)
 
- Static Public Member Functions inherited from pcbnew.EDA_TEXT
 MapHorizJustify (aHorizJustify)
 
 MapVertJustify (aVertJustify)
 
 ValidateHyperlink (aURL)
 
 IsGotoPageHref (aHref, aDestination=None)
 
 GotoPageHref (aDestination)
 

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.PCB_TEXT
 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_TEXT
 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_DIM_ALIGNED class.

Definition at line 17981 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

pcbnew.PCB_DIM_ALIGNED.__init__ ( self,
aParent,
aType = PCB_DIM_ALIGNED_T )
__init__(PCB_DIM_ALIGNED self, BOARD_ITEM aParent, KICAD_T aType=PCB_DIM_ALIGNED_T) -> PCB_DIM_ALIGNED

Definition at line 17987 of file pcbnew.py.

Member Function Documentation

◆ ChangeExtensionHeight()

pcbnew.PCB_DIM_ALIGNED.ChangeExtensionHeight ( self,
aHeight )
ChangeExtensionHeight(PCB_DIM_ALIGNED self, int aHeight)

Definition at line 18037 of file pcbnew.py.

◆ ChangeHeight()

pcbnew.PCB_DIM_ALIGNED.ChangeHeight ( self,
aHeight )
ChangeHeight(PCB_DIM_ALIGNED self, int aHeight)

Definition at line 18021 of file pcbnew.py.

◆ ClassOf()

pcbnew.PCB_DIM_ALIGNED.ClassOf ( aItem)
static
ClassOf(EDA_ITEM aItem) -> bool

Reimplemented from pcbnew.PCB_TEXT.

Reimplemented in pcbnew.PCB_DIM_ORTHOGONAL.

Definition at line 18001 of file pcbnew.py.

◆ Deserialize()

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

Reimplemented from pcbnew.PCB_DIMENSION_BASE.

Reimplemented in pcbnew.PCB_DIM_ORTHOGONAL.

Definition at line 17996 of file pcbnew.py.

◆ GetAngle()

pcbnew.PCB_DIM_ALIGNED.GetAngle ( self)
GetAngle(PCB_DIM_ALIGNED self) -> double

Definition at line 18041 of file pcbnew.py.

◆ GetClass()

pcbnew.PCB_DIM_ALIGNED.GetClass ( self)
GetClass(PCB_DIM_ALIGNED self) -> wxString

Reimplemented from pcbnew.PCB_TEXT.

Reimplemented in pcbnew.PCB_DIM_ORTHOGONAL.

Definition at line 18045 of file pcbnew.py.

◆ GetCrossbarEnd()

pcbnew.PCB_DIM_ALIGNED.GetCrossbarEnd ( self)
GetCrossbarEnd(PCB_DIM_ALIGNED self) -> VECTOR2I

Definition at line 18009 of file pcbnew.py.

◆ GetCrossbarStart()

pcbnew.PCB_DIM_ALIGNED.GetCrossbarStart ( self)
GetCrossbarStart(PCB_DIM_ALIGNED self) -> VECTOR2I

Definition at line 18005 of file pcbnew.py.

◆ GetExtensionHeight()

pcbnew.PCB_DIM_ALIGNED.GetExtensionHeight ( self)
GetExtensionHeight(PCB_DIM_ALIGNED self) -> int

Definition at line 18033 of file pcbnew.py.

◆ GetHeight()

pcbnew.PCB_DIM_ALIGNED.GetHeight ( self)
GetHeight(PCB_DIM_ALIGNED self) -> int

Definition at line 18017 of file pcbnew.py.

◆ Serialize()

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

Reimplemented from pcbnew.PCB_DIMENSION_BASE.

Reimplemented in pcbnew.PCB_DIM_ORTHOGONAL.

Definition at line 17992 of file pcbnew.py.

◆ SetExtensionHeight()

pcbnew.PCB_DIM_ALIGNED.SetExtensionHeight ( self,
aHeight )
SetExtensionHeight(PCB_DIM_ALIGNED self, int aHeight)

Definition at line 18029 of file pcbnew.py.

◆ SetHeight()

pcbnew.PCB_DIM_ALIGNED.SetHeight ( self,
aHeight )
SetHeight(PCB_DIM_ALIGNED self, int aHeight)

Definition at line 18013 of file pcbnew.py.

◆ UpdateHeight()

pcbnew.PCB_DIM_ALIGNED.UpdateHeight ( self,
aCrossbarStart,
aCrossbarEnd )
UpdateHeight(PCB_DIM_ALIGNED self, VECTOR2I aCrossbarStart, VECTOR2I aCrossbarEnd)

Definition at line 18025 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 17984 of file pcbnew.py.


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