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

Public Member Functions

def __init__ (self, *args)
def GetImage (self)
def MutableImage (self)
def SetImage (self, aImage)
def GetImageScale (self)
def SetImageScale (self, aScale)
def GetSize (self)
def ViewGetLOD (self, aLayer, aView)
def GetEffectiveShape (self, *args)
def ReadImageFile (self, aFullFilename)
def HitTest (self, *args)
- Public Member Functions inherited from pcbnew.BOARD_ITEM
def __init__ (self, *args, **kwargs)
def SetParentGroup (self, aGroup)
def GetParentGroup (self)
def GetX (self)
def GetY (self)
def GetCenter (self)
def SetX (self, aX)
def SetY (self, aY)
def IsConnected (self)
def IsOnCopperLayer (self)
def HasHole (self)
def IsTented (self)
def GetEffectiveShape (self, *args)
def GetEffectiveHoleShape (self)
def GetParent (self)
def GetParentFootprint (self)
def HasLineStroke (self)
def GetStroke (self)
def SetStroke (self, aStroke)
def GetLayer (self)
def GetLayerSet (self)
def SetLayerSet (self, aLayers)
def SetLayer (self, aLayer)
def Duplicate (self)
def SwapItemData (self, aImage)
def IsOnLayer (self, aLayer)
def IsKnockout (self)
def SetIsKnockout (self, aKnockout)
def IsLocked (self)
def SetLocked (self, aLocked)
def DeleteStructure (self)
def Move (self, aMoveVector)
def Rotate (self, aRotCentre, aAngle)
def Flip (self, aCentre, aFlipLeftRight)
def GetBoard (self, *args)
def GetLayerName (self)
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, 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)
def Type (self)
def GetParent (self)
def SetParent (self, aParent)
def IsModified (self)
def IsNew (self)
def IsMoving (self)
def IsSelected (self)
def IsEntered (self)
def IsBrightened (self)
def IsRollover (self)
def SetSelected (self)
def SetBrightened (self)
def ClearSelected (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 XorFlags (self, aMask)
def ClearFlags (self, *args)
def GetFlags (self)
def HasFlag (self, aFlag)
def GetEditFlags (self)
def ClearTempFlags (self)
def ClearEditFlags (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 GetClass (self)
def GetTypeDesc (self)
def GetItemDescription (self, aUnitsProvider)
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, aLayers, aCount)

Static Public Member Functions

def ClassOf (aItem)
- Static Public Member Functions inherited from pcbnew.EDA_ITEM
def Sort (aLeft, aRight)


 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_BITMAP class.

Definition at line 17163 of file

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.PCB_BITMAP.__init__ (   self,
    __init__(PCB_BITMAP self, BOARD_ITEM aParent, VECTOR2I pos=VECTOR2I( 0, 0 ), PCB_LAYER_ID aLayer=F_Cu) -> PCB_BITMAP
    __init__(PCB_BITMAP self, PCB_BITMAP aPcbBitmap) -> PCB_BITMAP

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 17169 of file

Here is the caller graph for this function:

Member Function Documentation

◆ ClassOf()

def pcbnew.PCB_BITMAP.ClassOf (   aItem)
ClassOf(EDA_ITEM aItem) -> bool

Definition at line 17198 of file

◆ GetEffectiveShape()

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

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 17210 of file

◆ GetImage()

def pcbnew.PCB_BITMAP.GetImage (   self)
GetImage(PCB_BITMAP self) -> BITMAP_BASE const *

Definition at line 17177 of file

◆ GetImageScale()

def pcbnew.PCB_BITMAP.GetImageScale (   self)
GetImageScale(PCB_BITMAP self) -> double

Definition at line 17189 of file

◆ GetSize()

def pcbnew.PCB_BITMAP.GetSize (   self)
GetSize(PCB_BITMAP self) -> VECTOR2I

Definition at line 17202 of file

◆ HitTest()

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 17218 of file

Here is the caller graph for this function:

◆ MutableImage()

def pcbnew.PCB_BITMAP.MutableImage (   self)
MutableImage(PCB_BITMAP self) -> BITMAP_BASE *

Definition at line 17181 of file

◆ ReadImageFile()

def pcbnew.PCB_BITMAP.ReadImageFile (   self,
ReadImageFile(PCB_BITMAP self, wxString aFullFilename) -> bool

Definition at line 17214 of file

◆ SetImage()

def pcbnew.PCB_BITMAP.SetImage (   self,
SetImage(PCB_BITMAP self, wxImage * aImage)

Definition at line 17185 of file

◆ SetImageScale()

def pcbnew.PCB_BITMAP.SetImageScale (   self,
SetImageScale(PCB_BITMAP self, double aScale)

Definition at line 17193 of file

◆ ViewGetLOD()

def pcbnew.PCB_BITMAP.ViewGetLOD (   self,
ViewGetLOD(PCB_BITMAP self, int aLayer, KIGFX::VIEW * aView) -> double

Definition at line 17206 of file

Property Documentation

◆ thisown

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

Definition at line 17166 of file

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