pcbnew.PCB_DIMENSION_BASE Class Reference
Inheritance diagram for pcbnew.PCB_DIMENSION_BASE:
Public Member Functions | |
| __init__ (self, *args, **kwargs) | |
| Serialize (self, aContainer) | |
| Deserialize (self, aContainer) | |
| 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) | |
| GetClass (self) | |
| 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, aCheckSide) | |
| 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, aRenderSettings=None) | |
| LayerMaskDescribe (self) | |
| 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) | |
| GetRolloverPos (self) | |
| SetIsRollover (self, aIsRollover, aMousePos) | |
| 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) | |
| DisambiguateItemDescription (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) | |
| SetActiveUrl (self, aUrl) | |
| 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) | |
Properties | |
| 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 Member Functions inherited from pcbnew.PCB_TEXT | |
| ClassOf (aItem) | |
| ShowSyntaxHelp (aParentWindow) | |
| 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) | |
| Static Public Attributes inherited from pcbnew.BOARD_ITEM | |
| DRC = _pcbnew.BOARD_ITEM_DRC | |
| INSTANCE_TO_INSTANCE = _pcbnew.BOARD_ITEM_INSTANCE_TO_INSTANCE | |
Detailed Description
Constructor & Destructor Documentation
◆ __init__()
| pcbnew.PCB_DIMENSION_BASE.__init__ | ( | self, | |
| * | args, | ||
| ** | kwargs ) |
Member Function Documentation
◆ __eq__()
| pcbnew.PCB_DIMENSION_BASE.__eq__ | ( | self, | |
| * | args ) |
◆ ChangeArrowDirection()
| pcbnew.PCB_DIMENSION_BASE.ChangeArrowDirection | ( | self, | |
| aDirection ) |
◆ ChangeKeepTextAligned()
| pcbnew.PCB_DIMENSION_BASE.ChangeKeepTextAligned | ( | self, | |
| aKeepAligned ) |
◆ ChangeOverrideText()
| pcbnew.PCB_DIMENSION_BASE.ChangeOverrideText | ( | self, | |
| aValue ) |
◆ ChangePrecision()
| pcbnew.PCB_DIMENSION_BASE.ChangePrecision | ( | self, | |
| aPrecision ) |
◆ ChangePrefix()
| pcbnew.PCB_DIMENSION_BASE.ChangePrefix | ( | self, | |
| aPrefix ) |
◆ ChangeSuffix()
| pcbnew.PCB_DIMENSION_BASE.ChangeSuffix | ( | self, | |
| aSuffix ) |
◆ ChangeSuppressZeroes()
| pcbnew.PCB_DIMENSION_BASE.ChangeSuppressZeroes | ( | self, | |
| aSuppress ) |
◆ ChangeTextAngleDegrees()
| pcbnew.PCB_DIMENSION_BASE.ChangeTextAngleDegrees | ( | self, | |
| aDegrees ) |
◆ ChangeUnitsFormat()
| pcbnew.PCB_DIMENSION_BASE.ChangeUnitsFormat | ( | self, | |
| aFormat ) |
◆ ChangeUnitsMode()
| pcbnew.PCB_DIMENSION_BASE.ChangeUnitsMode | ( | self, | |
| aMode ) |
◆ Deserialize()
| 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_CENTER, pcbnew.PCB_DIM_LEADER, pcbnew.PCB_DIM_ORTHOGONAL, and pcbnew.PCB_DIM_RADIAL.
◆ GetArrowDirection()
| pcbnew.PCB_DIMENSION_BASE.GetArrowDirection | ( | self | ) |
◆ GetArrowLength()
| pcbnew.PCB_DIMENSION_BASE.GetArrowLength | ( | self | ) |
◆ GetEffectiveShape()
| pcbnew.PCB_DIMENSION_BASE.GetEffectiveShape | ( | self, | |
| * | args ) |
GetEffectiveShape(PCB_DIMENSION_BASE self, PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=DEFAULT) -> std::shared_ptr< SHAPE >
Reimplemented from pcbnew.PCB_TEXT.
◆ GetEnd()
| pcbnew.PCB_DIMENSION_BASE.GetEnd | ( | self | ) |
◆ GetExtensionOffset()
| pcbnew.PCB_DIMENSION_BASE.GetExtensionOffset | ( | self | ) |
◆ GetKeepTextAligned()
| pcbnew.PCB_DIMENSION_BASE.GetKeepTextAligned | ( | self | ) |
◆ GetLineThickness()
| pcbnew.PCB_DIMENSION_BASE.GetLineThickness | ( | self | ) |
◆ GetMeasuredValue()
| pcbnew.PCB_DIMENSION_BASE.GetMeasuredValue | ( | self | ) |
◆ GetOverrideText()
| pcbnew.PCB_DIMENSION_BASE.GetOverrideText | ( | self | ) |
◆ GetOverrideTextEnabled()
| pcbnew.PCB_DIMENSION_BASE.GetOverrideTextEnabled | ( | self | ) |
◆ GetPrecision()
| pcbnew.PCB_DIMENSION_BASE.GetPrecision | ( | self | ) |
◆ GetPrefix()
| pcbnew.PCB_DIMENSION_BASE.GetPrefix | ( | self | ) |
◆ GetShapes()
| pcbnew.PCB_DIMENSION_BASE.GetShapes | ( | self | ) |
◆ GetStart()
| pcbnew.PCB_DIMENSION_BASE.GetStart | ( | self | ) |
◆ GetSuffix()
| pcbnew.PCB_DIMENSION_BASE.GetSuffix | ( | self | ) |
◆ GetSuppressZeroes()
| pcbnew.PCB_DIMENSION_BASE.GetSuppressZeroes | ( | self | ) |
◆ GetTextAngleDegreesProp()
| pcbnew.PCB_DIMENSION_BASE.GetTextAngleDegreesProp | ( | self | ) |
◆ GetTextPositionMode()
| pcbnew.PCB_DIMENSION_BASE.GetTextPositionMode | ( | self | ) |
◆ GetUnits()
| pcbnew.PCB_DIMENSION_BASE.GetUnits | ( | self | ) |
◆ GetUnitsFormat()
| pcbnew.PCB_DIMENSION_BASE.GetUnitsFormat | ( | self | ) |
◆ GetUnitsMode()
| pcbnew.PCB_DIMENSION_BASE.GetUnitsMode | ( | self | ) |
◆ GetValueText()
| pcbnew.PCB_DIMENSION_BASE.GetValueText | ( | self | ) |
◆ HitTest()
| 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
HitTest(PCB_DIMENSION_BASE self, SHAPE_LINE_CHAIN aPoly, bool aContained) -> bool
Reimplemented from pcbnew.PCB_TEXT.
◆ Serialize()
| 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_CENTER, pcbnew.PCB_DIM_LEADER, pcbnew.PCB_DIM_ORTHOGONAL, and pcbnew.PCB_DIM_RADIAL.
◆ SetArrowDirection()
| pcbnew.PCB_DIMENSION_BASE.SetArrowDirection | ( | self, | |
| aDirection ) |
◆ SetArrowLength()
| pcbnew.PCB_DIMENSION_BASE.SetArrowLength | ( | self, | |
| aLength ) |
◆ SetAutoUnits()
| pcbnew.PCB_DIMENSION_BASE.SetAutoUnits | ( | self, | |
| aAuto = True ) |
◆ SetEnd()
| pcbnew.PCB_DIMENSION_BASE.SetEnd | ( | self, | |
| aPoint ) |
◆ SetExtensionOffset()
| pcbnew.PCB_DIMENSION_BASE.SetExtensionOffset | ( | self, | |
| aOffset ) |
◆ SetKeepTextAligned()
| pcbnew.PCB_DIMENSION_BASE.SetKeepTextAligned | ( | self, | |
| aKeepAligned ) |
◆ SetLineThickness()
| pcbnew.PCB_DIMENSION_BASE.SetLineThickness | ( | self, | |
| aWidth ) |
◆ SetMeasuredValue()
| pcbnew.PCB_DIMENSION_BASE.SetMeasuredValue | ( | self, | |
| aValue ) |
◆ SetOverrideText()
| pcbnew.PCB_DIMENSION_BASE.SetOverrideText | ( | self, | |
| aValue ) |
◆ SetOverrideTextEnabled()
| pcbnew.PCB_DIMENSION_BASE.SetOverrideTextEnabled | ( | self, | |
| aOverride ) |
◆ SetPrecision()
| pcbnew.PCB_DIMENSION_BASE.SetPrecision | ( | self, | |
| aPrecision ) |
◆ SetPrefix()
| pcbnew.PCB_DIMENSION_BASE.SetPrefix | ( | self, | |
| aPrefix ) |
◆ SetStart()
| pcbnew.PCB_DIMENSION_BASE.SetStart | ( | self, | |
| aPoint ) |
◆ SetSuffix()
| pcbnew.PCB_DIMENSION_BASE.SetSuffix | ( | self, | |
| aSuffix ) |
◆ SetSuppressZeroes()
| pcbnew.PCB_DIMENSION_BASE.SetSuppressZeroes | ( | self, | |
| aSuppress ) |
◆ SetTextPositionMode()
| pcbnew.PCB_DIMENSION_BASE.SetTextPositionMode | ( | self, | |
| aMode ) |
◆ SetUnits()
| pcbnew.PCB_DIMENSION_BASE.SetUnits | ( | self, | |
| aUnits ) |
◆ SetUnitsFormat()
| pcbnew.PCB_DIMENSION_BASE.SetUnitsFormat | ( | self, | |
| aFormat ) |
◆ SetUnitsMode()
| pcbnew.PCB_DIMENSION_BASE.SetUnitsMode | ( | self, | |
| aMode ) |
◆ TransformShapeToPolygon()
| 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.
◆ Update()
| pcbnew.PCB_DIMENSION_BASE.Update | ( | self | ) |
◆ UpdateUnits()
| pcbnew.PCB_DIMENSION_BASE.UpdateUnits | ( | self | ) |
Property Documentation
◆ thisown
|
static |
The documentation for this class was generated from the following file:
Generated on Tue Mar 10 2026 00:12:56 for KiCad Pcbnew Python Scripting by
1.13.2