pcbnew.PCB_REFERENCE_IMAGE Class Reference

Inheritance diagram for pcbnew.PCB_REFERENCE_IMAGE:

Public Member Functions
	__init__ (self, *args)
	GetReferenceImage (self, *args)
	GetClass (self)
	ViewGetLOD (self, aLayer, aView)
	GetEffectiveShape (self, *args)
	HitTest (self, *args)
	__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)
	TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
	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)

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

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

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

Definition at line 20033 of file pcbnew.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 20039 of file pcbnew.py.

Member Function Documentation

__eq__()

pcbnew.PCB_REFERENCE_IMAGE.__eq__	(		self,
		*	args )

    __eq__(PCB_REFERENCE_IMAGE self, PCB_REFERENCE_IMAGE aOther) -> bool
    __eq__(PCB_REFERENCE_IMAGE self, BOARD_ITEM aBoardItem) -> bool

Definition at line 20079 of file pcbnew.py.

ClassOf()

pcbnew.PCB_REFERENCE_IMAGE.ClassOf ( aItem )

static

ClassOf(EDA_ITEM aItem) -> bool

Definition at line 20055 of file pcbnew.py.

GetClass()

pcbnew.PCB_REFERENCE_IMAGE.GetClass

(

self

)

GetClass(PCB_REFERENCE_IMAGE self) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 20059 of file pcbnew.py.

GetEffectiveShape()

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 20067 of file pcbnew.py.

GetReferenceImage()

pcbnew.PCB_REFERENCE_IMAGE.GetReferenceImage	(		self,
		*	args )

    GetReferenceImage(PCB_REFERENCE_IMAGE self) -> REFERENCE_IMAGE
    GetReferenceImage(PCB_REFERENCE_IMAGE self) -> REFERENCE_IMAGE const &

Definition at line 20047 of file pcbnew.py.

HitTest()

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
    HitTest(PCB_REFERENCE_IMAGE self, SHAPE_LINE_CHAIN aPoly, bool aContained) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 20071 of file pcbnew.py.

ViewGetLOD()

pcbnew.PCB_REFERENCE_IMAGE.ViewGetLOD	(		self,
			aLayer,
			aView )

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

Definition at line 20063 of file pcbnew.py.

Property Documentation

thisown

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 20036 of file pcbnew.py.

---

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

• pcbnew.py