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

Public Member Functions

def __init__ (self, aIuScale, aUnits)
 
def GetUserUnits (self)
 
def SetUserUnits (self, aUnits)
 
def GetUnitPair (self, aPrimaryUnit, aSecondaryUnits)
 
def GetIuScale (self)
 
def GetOriginTransforms (self)
 
def StringFromValue (self, *args)
 
def MessageTextFromValue (self, *args)
 
def MessageTextFromMinOptMax (self, aValue)
 
def ValueFromString (self, *args)
 
def AngleValueFromString (self, aTextValue)
 

Properties

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

Detailed Description

Proxy of C++ UNITS_PROVIDER class.

Definition at line 10056 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.UNITS_PROVIDER.__init__ (   self,
  aIuScale,
  aUnits 
)
__init__(UNITS_PROVIDER self, EDA_IU_SCALE aIuScale, EDA_UNITS aUnits) -> UNITS_PROVIDER

Definition at line 10062 of file pcbnew.py.

Member Function Documentation

◆ AngleValueFromString()

def pcbnew.UNITS_PROVIDER.AngleValueFromString (   self,
  aTextValue 
)
AngleValueFromString(UNITS_PROVIDER self, wxString aTextValue) -> EDA_ANGLE

Definition at line 10109 of file pcbnew.py.

◆ GetIuScale()

def pcbnew.UNITS_PROVIDER.GetIuScale (   self)
GetIuScale(UNITS_PROVIDER self) -> EDA_IU_SCALE

Definition at line 10079 of file pcbnew.py.

◆ GetOriginTransforms()

def pcbnew.UNITS_PROVIDER.GetOriginTransforms (   self)
GetOriginTransforms(UNITS_PROVIDER self) -> ORIGIN_TRANSFORMS &

Definition at line 10083 of file pcbnew.py.

◆ GetUnitPair()

def pcbnew.UNITS_PROVIDER.GetUnitPair (   self,
  aPrimaryUnit,
  aSecondaryUnits 
)
GetUnitPair(UNITS_PROVIDER self, EDA_UNITS & aPrimaryUnit, EDA_UNITS & aSecondaryUnits)

Definition at line 10075 of file pcbnew.py.

◆ GetUserUnits()

def pcbnew.UNITS_PROVIDER.GetUserUnits (   self)
GetUserUnits(UNITS_PROVIDER self) -> EDA_UNITS

Definition at line 10067 of file pcbnew.py.

◆ MessageTextFromMinOptMax()

def pcbnew.UNITS_PROVIDER.MessageTextFromMinOptMax (   self,
  aValue 
)
MessageTextFromMinOptMax(UNITS_PROVIDER self, MINOPTMAX< int > const & aValue) -> wxString

Definition at line 10101 of file pcbnew.py.

◆ MessageTextFromValue()

def pcbnew.UNITS_PROVIDER.MessageTextFromValue (   self,
args 
)
    MessageTextFromValue(UNITS_PROVIDER self, double aValue, bool aAddUnitLabel=True, EDA_DATA_TYPE aType=DISTANCE) -> wxString
    MessageTextFromValue(UNITS_PROVIDER self, EDA_ANGLE aValue, bool aAddUnitLabel=True) -> wxString

Definition at line 10094 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetUserUnits()

def pcbnew.UNITS_PROVIDER.SetUserUnits (   self,
  aUnits 
)
SetUserUnits(UNITS_PROVIDER self, EDA_UNITS aUnits)

Definition at line 10071 of file pcbnew.py.

◆ StringFromValue()

def pcbnew.UNITS_PROVIDER.StringFromValue (   self,
args 
)
    StringFromValue(UNITS_PROVIDER self, double aValue, bool aAddUnitLabel=False, EDA_DATA_TYPE aType=DISTANCE) -> wxString
    StringFromValue(UNITS_PROVIDER self, EDA_ANGLE aValue, bool aAddUnitLabel=False) -> wxString

Definition at line 10087 of file pcbnew.py.

Here is the caller graph for this function:

◆ ValueFromString()

def pcbnew.UNITS_PROVIDER.ValueFromString (   self,
args 
)
ValueFromString(UNITS_PROVIDER self, wxString aTextValue, EDA_DATA_TYPE aType=DISTANCE) -> int

Definition at line 10105 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 10059 of file pcbnew.py.


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