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

Public Member Functions

def __init__ (self, *args)
 
def GetImage (self)
 
def MutableImage (self)
 
def GetImageScale (self)
 
def SetImageScale (self, aScale)
 
def GetSize (self)
 
def ViewGetLOD (self, aLayer, aView)
 
def GetEffectiveShape (self, *args)
 
def ReadImageFile (self, *args)
 
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 Similarity (self, aItem)
 
def __eq__ (self, aItem)
 
def IsOnCopperLayer (self)
 
def HasHole (self)
 
def IsTented (self)
 
def GetEffectiveShape (self, *args)
 
def GetEffectiveHoleShape (self)
 
def RunOnChildren (self, aFunction)
 
def RunOnDescendants (self, aFunction, aDepth=0)
 
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 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 StyleFromSettings (self, settings)
 
def DeleteStructure (self)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre, aFlipLeftRight)
 
def Normalize (self)
 
def GetBoard (self, *args)
 
def GetParentAsString (self)
 
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 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 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)
 

Properties

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=)
 

Additional Inherited Members

- Static Public Attributes inherited from pcbnew.BOARD_ITEM
_pcbnew DRC = _pcbnew.BOARD_ITEM_DRC
 

Detailed Description

Proxy of C++ PCB_REFERENCE_IMAGE class.

Definition at line 17199 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 17205 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ ClassOf()

def pcbnew.PCB_REFERENCE_IMAGE.ClassOf (   aItem)
static
ClassOf(EDA_ITEM aItem) -> bool

Definition at line 17230 of file pcbnew.py.

◆ GetEffectiveShape()

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

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 17242 of file pcbnew.py.

◆ GetImage()

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

Definition at line 17213 of file pcbnew.py.

◆ GetImageScale()

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

Definition at line 17221 of file pcbnew.py.

◆ GetSize()

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

Definition at line 17234 of file pcbnew.py.

◆ HitTest()

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

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 17253 of file pcbnew.py.

Here is the caller graph for this function:

◆ MutableImage()

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

Definition at line 17217 of file pcbnew.py.

◆ ReadImageFile()

def pcbnew.PCB_REFERENCE_IMAGE.ReadImageFile (   self,
args 
)
    ReadImageFile(PCB_REFERENCE_IMAGE self, wxString aFullFilename) -> bool
    ReadImageFile(PCB_REFERENCE_IMAGE self, wxMemoryBuffer & aBuf) -> bool

Definition at line 17246 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetImageScale()

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

Definition at line 17225 of file pcbnew.py.

◆ ViewGetLOD()

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

Definition at line 17238 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 17202 of file pcbnew.py.


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