KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
pcbnew.py
Go to the documentation of this file.
1# This file was automatically generated by SWIG (https://www.swig.org).
2# Version 4.1.1
3#
4# Do not make changes to this file unless you know what you are doing - modify
5# the SWIG interface file instead.
6
7from sys import version_info as _swig_python_version_info
8# Import the low-level C/C++ module
9if __package__ or "." in __name__:
10 from . import _pcbnew
11else:
12 import _pcbnew
13
14try:
15 import builtins as __builtin__
16except ImportError:
17 import __builtin__
18
19def _swig_repr(self):
20 try:
21 strthis = "proxy of " + self.this.__repr__()
22 except __builtin__.Exception:
23 strthis = ""
24 return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
25
26
28 def set_instance_attr(self, name, value):
29 if name == "this":
30 set(self, name, value)
31 elif name == "thisown":
32 self.this.own(value)
33 elif hasattr(self, name) and isinstance(getattr(type(self), name), property):
34 set(self, name, value)
35 else:
36 raise AttributeError("You cannot add instance attributes to %s" % self)
37 return set_instance_attr
38
39
40def _swig_setattr_nondynamic_class_variable(set):
41 def set_class_attr(cls, name, value):
42 if hasattr(cls, name) and not isinstance(getattr(cls, name), property):
43 set(cls, name, value)
44 else:
45 raise AttributeError("You cannot add class attributes to %s" % cls)
46 return set_class_attr
47
48
49def _swig_add_metaclass(metaclass):
50 """Class decorator for adding a metaclass to a SWIG wrapped class - a slimmed down version of six.add_metaclass"""
51 def wrapper(cls):
52 return metaclass(cls.__name__, cls.__bases__, cls.__dict__.copy())
53 return wrapper
54
55
57 """Meta class to enforce nondynamic attributes (no new attributes) for a class"""
58 __setattr__ = _swig_setattr_nondynamic_class_variable(type.__setattr__)
59
60
61
62import warnings
63warnings.warn("The SWIG-based Python interface to the PCB editor is deprecated and will be removed "
64 "in a future version of KiCad. Please plan to move to the new IPC API and/or make "
65 "use of the kicad-cli tool for your KiCad automation needs.",
66 category=DeprecationWarning)
67
68class SwigPyIterator(object):
69 r"""Proxy of C++ swig::SwigPyIterator class."""
70
71 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
72
73 def __init__(self, *args, **kwargs):
74 raise AttributeError("No constructor defined - class is abstract")
75 __repr__ = _swig_repr
76 __swig_destroy__ = _pcbnew.delete_SwigPyIterator
77
78 def value(self):
79 r"""value(SwigPyIterator self) -> PyObject *"""
80 return _pcbnew.SwigPyIterator_value(self)
81
82 def incr(self, n=1):
83 r"""incr(SwigPyIterator self, size_t n=1) -> SwigPyIterator"""
84 return _pcbnew.SwigPyIterator_incr(self, n)
85
86 def decr(self, n=1):
87 r"""decr(SwigPyIterator self, size_t n=1) -> SwigPyIterator"""
88 return _pcbnew.SwigPyIterator_decr(self, n)
89
90 def distance(self, x):
91 r"""distance(SwigPyIterator self, SwigPyIterator x) -> ptrdiff_t"""
92 return _pcbnew.SwigPyIterator_distance(self, x)
93
94 def equal(self, x):
95 r"""equal(SwigPyIterator self, SwigPyIterator x) -> bool"""
96 return _pcbnew.SwigPyIterator_equal(self, x)
97
98 def copy(self):
99 r"""copy(SwigPyIterator self) -> SwigPyIterator"""
100 return _pcbnew.SwigPyIterator_copy(self)
101
102 def next(self):
103 r"""next(SwigPyIterator self) -> PyObject *"""
104 return _pcbnew.SwigPyIterator_next(self)
105
106 def __next__(self):
107 r"""__next__(SwigPyIterator self) -> PyObject *"""
108 return _pcbnew.SwigPyIterator___next__(self)
109
110 def previous(self):
111 r"""previous(SwigPyIterator self) -> PyObject *"""
112 return _pcbnew.SwigPyIterator_previous(self)
113
114 def advance(self, n):
115 r"""advance(SwigPyIterator self, ptrdiff_t n) -> SwigPyIterator"""
116 return _pcbnew.SwigPyIterator_advance(self, n)
117
118 def __eq__(self, x):
119 r"""__eq__(SwigPyIterator self, SwigPyIterator x) -> bool"""
120 return _pcbnew.SwigPyIterator___eq__(self, x)
121
122 def __ne__(self, x):
123 r"""__ne__(SwigPyIterator self, SwigPyIterator x) -> bool"""
124 return _pcbnew.SwigPyIterator___ne__(self, x)
125
126 def __iadd__(self, n):
127 r"""__iadd__(SwigPyIterator self, ptrdiff_t n) -> SwigPyIterator"""
128 return _pcbnew.SwigPyIterator___iadd__(self, n)
129
130 def __isub__(self, n):
131 r"""__isub__(SwigPyIterator self, ptrdiff_t n) -> SwigPyIterator"""
132 return _pcbnew.SwigPyIterator___isub__(self, n)
133
134 def __add__(self, n):
135 r"""__add__(SwigPyIterator self, ptrdiff_t n) -> SwigPyIterator"""
136 return _pcbnew.SwigPyIterator___add__(self, n)
137
138 def __sub__(self, *args):
139 r"""
140 __sub__(SwigPyIterator self, ptrdiff_t n) -> SwigPyIterator
141 __sub__(SwigPyIterator self, SwigPyIterator x) -> ptrdiff_t
142 """
143 return _pcbnew.SwigPyIterator___sub__(self, *args)
144 def __iter__(self):
145 return self
146
147# Register SwigPyIterator in _pcbnew:
148_pcbnew.SwigPyIterator_swigregister(SwigPyIterator)
150 r"""Proxy of C++ std::basic_string< char > class."""
151
152 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
153 __repr__ = _swig_repr
154
155 def length(self):
156 r"""length(string self) -> std::basic_string< char >::size_type"""
157 return _pcbnew.string_length(self)
158
159 def max_size(self):
160 r"""max_size(string self) -> std::basic_string< char >::size_type"""
161 return _pcbnew.string_max_size(self)
162
163 def capacity(self):
164 r"""capacity(string self) -> std::basic_string< char >::size_type"""
165 return _pcbnew.string_capacity(self)
166
167 def reserve(self, __res_arg):
168 r"""reserve(string self, std::basic_string< char >::size_type __res_arg)"""
169 return _pcbnew.string_reserve(self, __res_arg)
170
171 def shrink_to_fit(self):
172 r"""shrink_to_fit(string self)"""
173 return _pcbnew.string_shrink_to_fit(self)
174
175 def copy(self, __s, __n, __pos=0):
176 r"""copy(string self, char * __s, std::basic_string< char >::size_type __n, std::basic_string< char >::size_type __pos=0) -> std::basic_string< char >::size_type"""
177 return _pcbnew.string_copy(self, __s, __n, __pos)
178
179 def c_str(self):
180 r"""c_str(string self) -> char const *"""
181 return _pcbnew.string_c_str(self)
182
183 def find(self, *args):
184 r"""
185 find(string self, char const * __s, std::basic_string< char >::size_type __pos, std::basic_string< char >::size_type __n) -> std::basic_string< char >::size_type
186 find(string self, string __str, std::basic_string< char >::size_type __pos=0) -> std::basic_string< char >::size_type
187 find(string self, char __c, std::basic_string< char >::size_type __pos=0) -> std::basic_string< char >::size_type
188 """
189 return _pcbnew.string_find(self, *args)
190
191 def rfind(self, *args):
192 r"""
193 rfind(string self, string __str, std::basic_string< char >::size_type __pos=std::basic_string< char >::npos) -> std::basic_string< char >::size_type
194 rfind(string self, char const * __s, std::basic_string< char >::size_type __pos, std::basic_string< char >::size_type __n) -> std::basic_string< char >::size_type
195 rfind(string self, char __c, std::basic_string< char >::size_type __pos=std::basic_string< char >::npos) -> std::basic_string< char >::size_type
196 """
197 return _pcbnew.string_rfind(self, *args)
198
199 def find_first_of(self, *args):
200 r"""
201 find_first_of(string self, string __str, std::basic_string< char >::size_type __pos=0) -> std::basic_string< char >::size_type
202 find_first_of(string self, char const * __s, std::basic_string< char >::size_type __pos, std::basic_string< char >::size_type __n) -> std::basic_string< char >::size_type
203 find_first_of(string self, char __c, std::basic_string< char >::size_type __pos=0) -> std::basic_string< char >::size_type
204 """
205 return _pcbnew.string_find_first_of(self, *args)
206
207 def find_last_of(self, *args):
208 r"""
209 find_last_of(string self, string __str, std::basic_string< char >::size_type __pos=std::basic_string< char >::npos) -> std::basic_string< char >::size_type
210 find_last_of(string self, char const * __s, std::basic_string< char >::size_type __pos, std::basic_string< char >::size_type __n) -> std::basic_string< char >::size_type
211 find_last_of(string self, char __c, std::basic_string< char >::size_type __pos=std::basic_string< char >::npos) -> std::basic_string< char >::size_type
212 """
213 return _pcbnew.string_find_last_of(self, *args)
214
215 def find_first_not_of(self, *args):
216 r"""
217 find_first_not_of(string self, string __str, std::basic_string< char >::size_type __pos=0) -> std::basic_string< char >::size_type
218 find_first_not_of(string self, char const * __s, std::basic_string< char >::size_type __pos, std::basic_string< char >::size_type __n) -> std::basic_string< char >::size_type
219 find_first_not_of(string self, char __c, std::basic_string< char >::size_type __pos=0) -> std::basic_string< char >::size_type
220 """
221 return _pcbnew.string_find_first_not_of(self, *args)
222
223 def find_last_not_of(self, *args):
224 r"""
225 find_last_not_of(string self, string __str, std::basic_string< char >::size_type __pos=std::basic_string< char >::npos) -> std::basic_string< char >::size_type
226 find_last_not_of(string self, char const * __s, std::basic_string< char >::size_type __pos, std::basic_string< char >::size_type __n) -> std::basic_string< char >::size_type
227 find_last_not_of(string self, char __c, std::basic_string< char >::size_type __pos=std::basic_string< char >::npos) -> std::basic_string< char >::size_type
228 """
229 return _pcbnew.string_find_last_not_of(self, *args)
230
231 def substr(self, *args):
232 r"""substr(string self, std::basic_string< char >::size_type __pos=0, std::basic_string< char >::size_type __n=std::basic_string< char >::npos) -> string"""
233 return _pcbnew.string_substr(self, *args)
234
235 def empty(self):
236 r"""empty(string self) -> bool"""
237 return _pcbnew.string_empty(self)
238
239 def size(self):
240 r"""size(string self) -> std::basic_string< char >::size_type"""
241 return _pcbnew.string_size(self)
242
243 def swap(self, v):
244 r"""swap(string self, string v)"""
245 return _pcbnew.string_swap(self, v)
246
247 def begin(self):
248 r"""begin(string self) -> std::basic_string< char >::iterator"""
249 return _pcbnew.string_begin(self)
250
251 def end(self):
252 r"""end(string self) -> std::basic_string< char >::iterator"""
253 return _pcbnew.string_end(self)
254
255 def rbegin(self):
256 r"""rbegin(string self) -> std::basic_string< char >::reverse_iterator"""
257 return _pcbnew.string_rbegin(self)
258
259 def rend(self):
260 r"""rend(string self) -> std::basic_string< char >::reverse_iterator"""
261 return _pcbnew.string_rend(self)
262
263 def get_allocator(self):
264 r"""get_allocator(string self) -> std::basic_string< char >::allocator_type"""
265 return _pcbnew.string_get_allocator(self)
266
267 def erase(self, *args):
268 r"""
269 erase(string self, std::basic_string< char >::size_type __pos=0, std::basic_string< char >::size_type __n=std::basic_string< char >::npos) -> string
270 erase(string self, std::basic_string< char >::iterator pos) -> std::basic_string< char >::iterator
271 erase(string self, std::basic_string< char >::iterator first, std::basic_string< char >::iterator last) -> std::basic_string< char >::iterator
272 """
273 return _pcbnew.string_erase(self, *args)
274
275 def __init__(self, *args):
276 r"""
277 __init__(string self, char const * __s, std::basic_string< char >::size_type __n) -> string
278 __init__(string self) -> string
279 __init__(string self, string other) -> string
280 __init__(string self, std::basic_string< char >::size_type size, std::basic_string< char >::value_type value) -> string
281 """
282 _pcbnew.string_swiginit(self, _pcbnew.new_string(*args))
283
284 def assign(self, *args):
285 r"""
286 assign(string self, string __str) -> string
287 assign(string self, string __str, std::basic_string< char >::size_type __pos, std::basic_string< char >::size_type __n) -> string
288 assign(string self, char const * __s, std::basic_string< char >::size_type __n) -> string
289 assign(string self, std::basic_string< char >::size_type n, std::basic_string< char >::value_type x)
290 """
291 return _pcbnew.string_assign(self, *args)
292
293 def resize(self, *args):
294 r"""
295 resize(string self, std::basic_string< char >::size_type new_size)
296 resize(string self, std::basic_string< char >::size_type new_size, std::basic_string< char >::value_type x)
297 """
298 return _pcbnew.string_resize(self, *args)
299
300 def iterator(self):
301 r"""iterator(string self) -> SwigPyIterator"""
302 return _pcbnew.string_iterator(self)
303 def __iter__(self):
304 return self.iterator()
305
306 def __nonzero__(self):
307 r"""__nonzero__(string self) -> bool"""
308 return _pcbnew.string___nonzero__(self)
309
310 def __bool__(self):
311 r"""__bool__(string self) -> bool"""
312 return _pcbnew.string___bool__(self)
313
314 def __len__(self):
315 r"""__len__(string self) -> std::basic_string< char >::size_type"""
316 return _pcbnew.string___len__(self)
317
318 def __getslice__(self, i, j):
319 r"""__getslice__(string self, std::basic_string< char >::difference_type i, std::basic_string< char >::difference_type j) -> string"""
320 return _pcbnew.string___getslice__(self, i, j)
321
322 def __setslice__(self, *args):
323 r"""
324 __setslice__(string self, std::basic_string< char >::difference_type i, std::basic_string< char >::difference_type j)
325 __setslice__(string self, std::basic_string< char >::difference_type i, std::basic_string< char >::difference_type j, string v)
326 """
327 return _pcbnew.string___setslice__(self, *args)
328
329 def __delslice__(self, i, j):
330 r"""__delslice__(string self, std::basic_string< char >::difference_type i, std::basic_string< char >::difference_type j)"""
331 return _pcbnew.string___delslice__(self, i, j)
332
333 def __delitem__(self, *args):
334 r"""
335 __delitem__(string self, std::basic_string< char >::difference_type i)
336 __delitem__(string self, SWIGPY_SLICEOBJECT * slice)
337 """
338 return _pcbnew.string___delitem__(self, *args)
339
340 def __getitem__(self, *args):
341 r"""
342 __getitem__(string self, SWIGPY_SLICEOBJECT * slice) -> string
343 __getitem__(string self, std::basic_string< char >::difference_type i) -> std::basic_string< char >::value_type
344 """
345 return _pcbnew.string___getitem__(self, *args)
346
347 def __setitem__(self, *args):
348 r"""
349 __setitem__(string self, SWIGPY_SLICEOBJECT * slice, string v)
350 __setitem__(string self, SWIGPY_SLICEOBJECT * slice)
351 __setitem__(string self, std::basic_string< char >::difference_type i, std::basic_string< char >::value_type x)
352 """
353 return _pcbnew.string___setitem__(self, *args)
354
355 def insert(self, *args):
356 r"""
357 insert(string self, std::basic_string< char >::size_type __pos1, string __str) -> string
358 insert(string self, std::basic_string< char >::size_type __pos1, string __str, std::basic_string< char >::size_type __pos2, std::basic_string< char >::size_type __n) -> string
359 insert(string self, std::basic_string< char >::size_type __pos, char const * __s, std::basic_string< char >::size_type __n) -> string
360 insert(string self, std::basic_string< char >::size_type __pos, std::basic_string< char >::size_type __n, char __c) -> string
361 insert(string self, std::basic_string< char >::iterator pos, std::basic_string< char >::value_type x) -> std::basic_string< char >::iterator
362 insert(string self, std::basic_string< char >::iterator pos, std::basic_string< char >::size_type n, std::basic_string< char >::value_type x)
363 insert(string self, std::basic_string< char >::iterator __p, std::basic_string< char >::size_type __n, char __c)
364 """
365 return _pcbnew.string_insert(self, *args)
366
367 def replace(self, *args):
368 r"""
369 replace(string self, std::basic_string< char >::size_type __pos, std::basic_string< char >::size_type __n, string __str) -> string
370 replace(string self, std::basic_string< char >::size_type __pos1, std::basic_string< char >::size_type __n1, string __str, std::basic_string< char >::size_type __pos2, std::basic_string< char >::size_type __n2) -> string
371 replace(string self, std::basic_string< char >::size_type __pos, std::basic_string< char >::size_type __n1, char const * __s, std::basic_string< char >::size_type __n2) -> string
372 replace(string self, std::basic_string< char >::size_type __pos, std::basic_string< char >::size_type __n1, std::basic_string< char >::size_type __n2, char __c) -> string
373 replace(string self, std::basic_string< char >::iterator __i1, std::basic_string< char >::iterator __i2, string __str) -> string
374 replace(string self, std::basic_string< char >::iterator __i1, std::basic_string< char >::iterator __i2, char const * __s, std::basic_string< char >::size_type __n) -> string
375 replace(string self, std::basic_string< char >::iterator __i1, std::basic_string< char >::iterator __i2, std::basic_string< char >::size_type __n, char __c) -> string
376 replace(string self, std::basic_string< char >::iterator __i1, std::basic_string< char >::iterator __i2, char const * __k1, char const * __k2) -> string
377 replace(string self, std::basic_string< char >::iterator __i1, std::basic_string< char >::iterator __i2, std::basic_string< char >::const_iterator __k1, std::basic_string< char >::const_iterator __k2) -> string
378 """
379 return _pcbnew.string_replace(self, *args)
380
381 def __iadd__(self, v):
382 r"""__iadd__(string self, string v) -> string"""
383 return _pcbnew.string___iadd__(self, v)
384
385 def __add__(self, v):
386 r"""__add__(string self, string v) -> string"""
387 return _pcbnew.string___add__(self, v)
388
389 def __radd__(self, v):
390 r"""__radd__(string self, string v) -> string"""
391 return _pcbnew.string___radd__(self, v)
392
393 def __str__(self):
394 r"""__str__(string self) -> string"""
395 return _pcbnew.string___str__(self)
396
397 def __rlshift__(self, out):
398 r"""__rlshift__(string self, std::basic_ostream< char,std::char_traits< char > > & out) -> std::basic_ostream< char,std::char_traits< char > > &"""
399 return _pcbnew.string___rlshift__(self, out)
400
401 def __eq__(self, v):
402 r"""__eq__(string self, string v) -> bool"""
403 return _pcbnew.string___eq__(self, v)
404
405 def __ne__(self, v):
406 r"""__ne__(string self, string v) -> bool"""
407 return _pcbnew.string___ne__(self, v)
408
409 def __gt__(self, v):
410 r"""__gt__(string self, string v) -> bool"""
411 return _pcbnew.string___gt__(self, v)
412
413 def __lt__(self, v):
414 r"""__lt__(string self, string v) -> bool"""
415 return _pcbnew.string___lt__(self, v)
416
417 def __ge__(self, v):
418 r"""__ge__(string self, string v) -> bool"""
419 return _pcbnew.string___ge__(self, v)
420
421 def __le__(self, v):
422 r"""__le__(string self, string v) -> bool"""
423 return _pcbnew.string___le__(self, v)
424 __swig_destroy__ = _pcbnew.delete_string
425
426# Register string in _pcbnew:
427_pcbnew.string_swigregister(string)
428cvar = _pcbnew.cvar
429string.npos = _pcbnew.cvar.string_npos
430
431SHARED_PTR_DISOWN = _pcbnew.SHARED_PTR_DISOWN
432
434 r"""Proxy of C++ KI_PARAM_ERROR class."""
435
436 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
437 __repr__ = _swig_repr
438
439 def __init__(self, *args):
440 r"""
441 __init__(KI_PARAM_ERROR self, wxString aMessage) -> KI_PARAM_ERROR
442 __init__(KI_PARAM_ERROR self) -> KI_PARAM_ERROR
443 """
444 _pcbnew.KI_PARAM_ERROR_swiginit(self, _pcbnew.new_KI_PARAM_ERROR(*args))
445
446 def What(self):
447 r"""What(KI_PARAM_ERROR self) -> wxString"""
448 return _pcbnew.KI_PARAM_ERROR_What(self)
449 __swig_destroy__ = _pcbnew.delete_KI_PARAM_ERROR
450
451# Register KI_PARAM_ERROR in _pcbnew:
452_pcbnew.KI_PARAM_ERROR_swigregister(KI_PARAM_ERROR)
454 r"""Proxy of C++ IO_ERROR class."""
455
456 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
457 __repr__ = _swig_repr
458
459 def __init__(self, *args):
460 r"""
461 __init__(IO_ERROR self, wxString aProblem, char const * aThrowersFile, char const * aThrowersFunction, int aThrowersLineNumber) -> IO_ERROR
462 __init__(IO_ERROR self) -> IO_ERROR
463 """
464 _pcbnew.IO_ERROR_swiginit(self, _pcbnew.new_IO_ERROR(*args))
465
466 def init(self, aProblem, aThrowersFile, aThrowersFunction, aThrowersLineNumber):
467 r"""init(IO_ERROR self, wxString aProblem, char const * aThrowersFile, char const * aThrowersFunction, int aThrowersLineNumber)"""
468 return _pcbnew.IO_ERROR_init(self, aProblem, aThrowersFile, aThrowersFunction, aThrowersLineNumber)
469
470 def Problem(self):
471 r"""Problem(IO_ERROR self) -> wxString"""
472 return _pcbnew.IO_ERROR_Problem(self)
473
474 def Where(self):
475 r"""Where(IO_ERROR self) -> wxString"""
476 return _pcbnew.IO_ERROR_Where(self)
477
478 def What(self):
479 r"""What(IO_ERROR self) -> wxString"""
480 return _pcbnew.IO_ERROR_What(self)
481 __swig_destroy__ = _pcbnew.delete_IO_ERROR
482
483# Register IO_ERROR in _pcbnew:
484_pcbnew.IO_ERROR_swigregister(IO_ERROR)
485
487 r"""wxSetDefaultPyEncoding(char const * encoding)"""
488 return _pcbnew.wxSetDefaultPyEncoding(encoding)
489
491 r"""wxGetDefaultPyEncoding() -> char const *"""
492 return _pcbnew.wxGetDefaultPyEncoding()
494 r"""Proxy of C++ wxRect class."""
495
496 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
497 __repr__ = _swig_repr
498
499 def __init__(self, *args):
500 r"""
501 __init__(wxRect self) -> wxRect
502 __init__(wxRect self, int xx, int yy, int ww, int hh) -> wxRect
503 __init__(wxRect self, wxPoint topLeft, wxPoint bottomRight) -> wxRect
504 __init__(wxRect self, wxPoint pt, wxSize size) -> wxRect
505 __init__(wxRect self, wxSize size) -> wxRect
506 """
507 _pcbnew.wxRect_swiginit(self, _pcbnew.new_wxRect(*args))
508
509 def GetX(self):
510 r"""GetX(wxRect self) -> int"""
511 return _pcbnew.wxRect_GetX(self)
512
513 def SetX(self, xx):
514 r"""SetX(wxRect self, int xx)"""
515 return _pcbnew.wxRect_SetX(self, xx)
516
517 def GetY(self):
518 r"""GetY(wxRect self) -> int"""
519 return _pcbnew.wxRect_GetY(self)
520
521 def SetY(self, yy):
522 r"""SetY(wxRect self, int yy)"""
523 return _pcbnew.wxRect_SetY(self, yy)
524
525 def GetWidth(self):
526 r"""GetWidth(wxRect self) -> int"""
527 return _pcbnew.wxRect_GetWidth(self)
528
529 def SetWidth(self, w):
530 r"""SetWidth(wxRect self, int w)"""
531 return _pcbnew.wxRect_SetWidth(self, w)
532
533 def GetHeight(self):
534 r"""GetHeight(wxRect self) -> int"""
535 return _pcbnew.wxRect_GetHeight(self)
536
537 def SetHeight(self, h):
538 r"""SetHeight(wxRect self, int h)"""
539 return _pcbnew.wxRect_SetHeight(self, h)
540
541 def GetPosition(self):
542 r"""GetPosition(wxRect self) -> wxPoint"""
543 return _pcbnew.wxRect_GetPosition(self)
544
545 def SetPosition(self, p):
546 r"""SetPosition(wxRect self, wxPoint p)"""
547 return _pcbnew.wxRect_SetPosition(self, p)
548 x = property(_pcbnew.wxRect_x_get, _pcbnew.wxRect_x_set, doc=r"""x : int""")
549 y = property(_pcbnew.wxRect_y_get, _pcbnew.wxRect_y_set, doc=r"""y : int""")
550 width = property(_pcbnew.wxRect_width_get, _pcbnew.wxRect_width_set, doc=r"""width : int""")
551 height = property(_pcbnew.wxRect_height_get, _pcbnew.wxRect_height_set, doc=r"""height : int""")
552
553 def Get(self):
554 r"""Get(wxRect self) -> PyObject *"""
555 return _pcbnew.wxRect_Get(self)
556
557
558 def __eq__(self,other):
559 return self.xx==other.x and self.yy==other.y and self.widthwidth==other.width and self.heightheight==other.height
560 def __str__(self): return str(self.Get())
561 def __repr__(self): return 'wxRect'+str(self.Get())
562 def __len__(self): return len(self.Get())
563 def __getitem__(self, index): return self.Get()[index]
564 def __setitem__(self, index, val):
565 if index == 0: self.SetX(val)
566 elif index == 1: self.SetY(val)
567 elif index == 2: self.SetWidth(val)
568 elif index == 3: self.SetHeight(val)
569 else: raise IndexError
570 def __nonzero__(self): return self.Get() != (0,0,0,0)
571 __safe_for_unpickling__ = True
572
573 __swig_destroy__ = _pcbnew.delete_wxRect
574
575# Register wxRect in _pcbnew:
576_pcbnew.wxRect_swigregister(wxRect)
578 r"""Proxy of C++ wxSize class."""
579
580 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
581 __repr__ = _swig_repr
582 x = property(_pcbnew.wxSize_x_get, _pcbnew.wxSize_x_set, doc=r"""x : int""")
583 y = property(_pcbnew.wxSize_y_get, _pcbnew.wxSize_y_set, doc=r"""y : int""")
584
585 def __init__(self, *args):
586 r"""
587 __init__(wxSize self, int xx, int yy) -> wxSize
588 __init__(wxSize self, double xx, double yy) -> wxSize
589 """
590 _pcbnew.wxSize_swiginit(self, _pcbnew.new_wxSize(*args))
591
592 def Get(self):
593 r"""Get(wxSize self) -> PyObject *"""
594 return _pcbnew.wxSize_Get(self)
595 __swig_destroy__ = _pcbnew.delete_wxSize
596
597 def SetWidth(self, w):
598 r"""SetWidth(wxSize self, int w)"""
599 return _pcbnew.wxSize_SetWidth(self, w)
600
601 def SetHeight(self, h):
602 r"""SetHeight(wxSize self, int h)"""
603 return _pcbnew.wxSize_SetHeight(self, h)
604
605 def GetWidth(self):
606 r"""GetWidth(wxSize self) -> int"""
607 return _pcbnew.wxSize_GetWidth(self)
608
609 def GetHeight(self):
610 r"""GetHeight(wxSize self) -> int"""
611 return _pcbnew.wxSize_GetHeight(self)
612
613 def Scale(self,xscale,yscale):
614 return wxSize(self.x*xscale,self.y*yscale)
615 def __eq__(self,other):
616 return self.GetWidth()==other.GetWidth() and self.GetHeight()==other.GetHeight()
617 def __str__(self): return str(self.Get())
618 def __repr__(self): return 'wxSize'+str(self.Get())
619 def __len__(self): return len(self.Get())
620 def __getitem__(self, index): return self.Get()[index]
621 def __setitem__(self, index, val):
622 if index == 0: self.SetWidth(val)
623 elif index == 1: self.SetHeight(val)
624 else: raise IndexError
625 def __nonzero__(self): return self.Get() != (0,0)
626 __safe_for_unpickling__ = True
627
628
629
630# Register wxSize in _pcbnew:
631_pcbnew.wxSize_swigregister(wxSize)
633 r"""Proxy of C++ wxPoint class."""
634
635 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
636 __repr__ = _swig_repr
637 x = property(_pcbnew.wxPoint_x_get, _pcbnew.wxPoint_x_set, doc=r"""x : int""")
638 y = property(_pcbnew.wxPoint_y_get, _pcbnew.wxPoint_y_set, doc=r"""y : int""")
639
640 def __init__(self, *args):
641 r"""
642 __init__(wxPoint self, int xx, int yy) -> wxPoint
643 __init__(wxPoint self, double xx, double yy) -> wxPoint
644 """
645 _pcbnew.wxPoint_swiginit(self, _pcbnew.new_wxPoint(*args))
646 __swig_destroy__ = _pcbnew.delete_wxPoint
647
648 def __add__(self, pt):
649 r"""__add__(wxPoint self, wxPoint pt) -> wxPoint"""
650 return _pcbnew.wxPoint___add__(self, pt)
651
652 def __sub__(self, pt):
653 r"""__sub__(wxPoint self, wxPoint pt) -> wxPoint"""
654 return _pcbnew.wxPoint___sub__(self, pt)
655
656 def Set(self, x, y):
657 r"""Set(wxPoint self, long x, long y)"""
658 return _pcbnew.wxPoint_Set(self, x, y)
659
660 def Get(self):
661 r"""Get(wxPoint self) -> PyObject *"""
662 return _pcbnew.wxPoint_Get(self)
663
664 def __eq__(self,other): return (self.xx==other.x and self.yy==other.y)
665 def __ne__(self,other): return not (self==other)
666 def __str__(self): return str(self.Get())
667 def __repr__(self): return 'wxPoint'+str(self.Get())
668 def __len__(self): return len(self.Get())
669 def __getitem__(self, index): return self.Get()[index]
670 def __setitem__(self, index, val):
671 if index == 0:
672 self.xx = val
673 elif index == 1:
674 self.yy = val
675 else:
676 raise IndexError
677 def __nonzero__(self): return self.Get() != (0,0)
678
679
680
681# Register wxPoint in _pcbnew:
682_pcbnew.wxPoint_swigregister(wxPoint)
684 r"""Proxy of C++ wxString class."""
685
686 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
687 __repr__ = _swig_repr
688 __swig_destroy__ = _pcbnew.delete_wxString
689
690 def __str__(self):
691 r"""__str__(wxString self) -> PyObject *"""
692 return _pcbnew.wxString___str__(self)
693
694 def __repr__(self): return 'wxString(\'' + self.__str__() + '\')'
695
696
697 def __init__(self):
698 r"""__init__(wxString self) -> wxString"""
699 _pcbnew.wxString_swiginit(self, _pcbnew.new_wxString())
700
701# Register wxString in _pcbnew:
702_pcbnew.wxString_swigregister(wxString)
704 r"""Proxy of C++ std::vector< wxPoint > class."""
705
706 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
707 __repr__ = _swig_repr
708
709 def iterator(self):
710 r"""iterator(wxPoint_Vector self) -> SwigPyIterator"""
711 return _pcbnew.wxPoint_Vector_iterator(self)
712 def __iter__(self):
713 return self.iterator()
714
715 def __nonzero__(self):
716 r"""__nonzero__(wxPoint_Vector self) -> bool"""
717 return _pcbnew.wxPoint_Vector___nonzero__(self)
718
719 def __bool__(self):
720 r"""__bool__(wxPoint_Vector self) -> bool"""
721 return _pcbnew.wxPoint_Vector___bool__(self)
722
723 def __len__(self):
724 r"""__len__(wxPoint_Vector self) -> std::vector< wxPoint >::size_type"""
725 return _pcbnew.wxPoint_Vector___len__(self)
726
727 def __getslice__(self, i, j):
728 r"""__getslice__(wxPoint_Vector self, std::vector< wxPoint >::difference_type i, std::vector< wxPoint >::difference_type j) -> wxPoint_Vector"""
729 return _pcbnew.wxPoint_Vector___getslice__(self, i, j)
730
731 def __setslice__(self, *args):
732 r"""
733 __setslice__(wxPoint_Vector self, std::vector< wxPoint >::difference_type i, std::vector< wxPoint >::difference_type j)
734 __setslice__(wxPoint_Vector self, std::vector< wxPoint >::difference_type i, std::vector< wxPoint >::difference_type j, wxPoint_Vector v)
735 """
736 return _pcbnew.wxPoint_Vector___setslice__(self, *args)
737
738 def __delslice__(self, i, j):
739 r"""__delslice__(wxPoint_Vector self, std::vector< wxPoint >::difference_type i, std::vector< wxPoint >::difference_type j)"""
740 return _pcbnew.wxPoint_Vector___delslice__(self, i, j)
741
742 def __delitem__(self, *args):
743 r"""
744 __delitem__(wxPoint_Vector self, std::vector< wxPoint >::difference_type i)
745 __delitem__(wxPoint_Vector self, SWIGPY_SLICEOBJECT * slice)
746 """
747 return _pcbnew.wxPoint_Vector___delitem__(self, *args)
748
749 def __getitem__(self, *args):
750 r"""
751 __getitem__(wxPoint_Vector self, SWIGPY_SLICEOBJECT * slice) -> wxPoint_Vector
752 __getitem__(wxPoint_Vector self, std::vector< wxPoint >::difference_type i) -> wxPoint
753 """
754 return _pcbnew.wxPoint_Vector___getitem__(self, *args)
755
756 def __setitem__(self, *args):
757 r"""
758 __setitem__(wxPoint_Vector self, SWIGPY_SLICEOBJECT * slice, wxPoint_Vector v)
759 __setitem__(wxPoint_Vector self, SWIGPY_SLICEOBJECT * slice)
760 __setitem__(wxPoint_Vector self, std::vector< wxPoint >::difference_type i, wxPoint x)
761 """
762 return _pcbnew.wxPoint_Vector___setitem__(self, *args)
763
764 def pop(self):
765 r"""pop(wxPoint_Vector self) -> wxPoint"""
766 return _pcbnew.wxPoint_Vector_pop(self)
767
768 def append(self, x):
769 r"""append(wxPoint_Vector self, wxPoint x)"""
770 return _pcbnew.wxPoint_Vector_append(self, x)
771
772 def empty(self):
773 r"""empty(wxPoint_Vector self) -> bool"""
774 return _pcbnew.wxPoint_Vector_empty(self)
775
776 def size(self):
777 r"""size(wxPoint_Vector self) -> std::vector< wxPoint >::size_type"""
778 return _pcbnew.wxPoint_Vector_size(self)
779
780 def swap(self, v):
781 r"""swap(wxPoint_Vector self, wxPoint_Vector v)"""
782 return _pcbnew.wxPoint_Vector_swap(self, v)
783
784 def begin(self):
785 r"""begin(wxPoint_Vector self) -> std::vector< wxPoint >::iterator"""
786 return _pcbnew.wxPoint_Vector_begin(self)
787
788 def end(self):
789 r"""end(wxPoint_Vector self) -> std::vector< wxPoint >::iterator"""
790 return _pcbnew.wxPoint_Vector_end(self)
791
792 def rbegin(self):
793 r"""rbegin(wxPoint_Vector self) -> std::vector< wxPoint >::reverse_iterator"""
794 return _pcbnew.wxPoint_Vector_rbegin(self)
795
796 def rend(self):
797 r"""rend(wxPoint_Vector self) -> std::vector< wxPoint >::reverse_iterator"""
798 return _pcbnew.wxPoint_Vector_rend(self)
799
800 def clear(self):
801 r"""clear(wxPoint_Vector self)"""
802 return _pcbnew.wxPoint_Vector_clear(self)
803
804 def get_allocator(self):
805 r"""get_allocator(wxPoint_Vector self) -> std::vector< wxPoint >::allocator_type"""
806 return _pcbnew.wxPoint_Vector_get_allocator(self)
807
808 def pop_back(self):
809 r"""pop_back(wxPoint_Vector self)"""
810 return _pcbnew.wxPoint_Vector_pop_back(self)
811
812 def erase(self, *args):
813 r"""
814 erase(wxPoint_Vector self, std::vector< wxPoint >::iterator pos) -> std::vector< wxPoint >::iterator
815 erase(wxPoint_Vector self, std::vector< wxPoint >::iterator first, std::vector< wxPoint >::iterator last) -> std::vector< wxPoint >::iterator
816 """
817 return _pcbnew.wxPoint_Vector_erase(self, *args)
818
819 def __init__(self, *args):
820 r"""
821 __init__(wxPoint_Vector self) -> wxPoint_Vector
822 __init__(wxPoint_Vector self, wxPoint_Vector other) -> wxPoint_Vector
823 __init__(wxPoint_Vector self, std::vector< wxPoint >::size_type size) -> wxPoint_Vector
824 __init__(wxPoint_Vector self, std::vector< wxPoint >::size_type size, wxPoint value) -> wxPoint_Vector
825 """
826 _pcbnew.wxPoint_Vector_swiginit(self, _pcbnew.new_wxPoint_Vector(*args))
827
828 def push_back(self, x):
829 r"""push_back(wxPoint_Vector self, wxPoint x)"""
830 return _pcbnew.wxPoint_Vector_push_back(self, x)
831
832 def front(self):
833 r"""front(wxPoint_Vector self) -> wxPoint"""
834 return _pcbnew.wxPoint_Vector_front(self)
835
836 def back(self):
837 r"""back(wxPoint_Vector self) -> wxPoint"""
838 return _pcbnew.wxPoint_Vector_back(self)
839
840 def assign(self, n, x):
841 r"""assign(wxPoint_Vector self, std::vector< wxPoint >::size_type n, wxPoint x)"""
842 return _pcbnew.wxPoint_Vector_assign(self, n, x)
843
844 def resize(self, *args):
845 r"""
846 resize(wxPoint_Vector self, std::vector< wxPoint >::size_type new_size)
847 resize(wxPoint_Vector self, std::vector< wxPoint >::size_type new_size, wxPoint x)
848 """
849 return _pcbnew.wxPoint_Vector_resize(self, *args)
850
851 def insert(self, *args):
852 r"""
853 insert(wxPoint_Vector self, std::vector< wxPoint >::iterator pos, wxPoint x) -> std::vector< wxPoint >::iterator
854 insert(wxPoint_Vector self, std::vector< wxPoint >::iterator pos, std::vector< wxPoint >::size_type n, wxPoint x)
855 """
856 return _pcbnew.wxPoint_Vector_insert(self, *args)
857
858 def reserve(self, n):
859 r"""reserve(wxPoint_Vector self, std::vector< wxPoint >::size_type n)"""
860 return _pcbnew.wxPoint_Vector_reserve(self, n)
861
862 def capacity(self):
863 r"""capacity(wxPoint_Vector self) -> std::vector< wxPoint >::size_type"""
864 return _pcbnew.wxPoint_Vector_capacity(self)
865 __swig_destroy__ = _pcbnew.delete_wxPoint_Vector
866
867# Register wxPoint_Vector in _pcbnew:
868_pcbnew.wxPoint_Vector_swigregister(wxPoint_Vector)
869SKETCH = _pcbnew.SKETCH
870
871FILLED = _pcbnew.FILLED
872
874 r"""Proxy of C++ KIID class."""
875
876 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
877 __repr__ = _swig_repr
878
879 def __init__(self, *args):
880 r"""
881 __init__(KIID self) -> KIID
882 __init__(KIID self, int null) -> KIID
883 __init__(KIID self, string aString) -> KIID
884 __init__(KIID self, char const * aString) -> KIID
885 __init__(KIID self, wxString aString) -> KIID
886 __init__(KIID self, timestamp_t aTimestamp) -> KIID
887 """
888 _pcbnew.KIID_swiginit(self, _pcbnew.new_KIID(*args))
889
890 def Clone(self, aUUID):
891 r"""Clone(KIID self, KIID aUUID)"""
892 return _pcbnew.KIID_Clone(self, aUUID)
893
894 def Hash(self):
895 r"""Hash(KIID self) -> size_t"""
896 return _pcbnew.KIID_Hash(self)
897
899 r"""IsLegacyTimestamp(KIID self) -> bool"""
900 return _pcbnew.KIID_IsLegacyTimestamp(self)
901
903 r"""AsLegacyTimestamp(KIID self) -> timestamp_t"""
904 return _pcbnew.KIID_AsLegacyTimestamp(self)
905
906 def AsString(self):
907 r"""AsString(KIID self) -> wxString"""
908 return _pcbnew.KIID_AsString(self)
909
911 r"""AsLegacyTimestampString(KIID self) -> wxString"""
912 return _pcbnew.KIID_AsLegacyTimestampString(self)
913
914 def AsStdString(self):
915 r"""AsStdString(KIID self) -> string"""
916 return _pcbnew.KIID_AsStdString(self)
917
918 @staticmethod
919 def SniffTest(aCandidate):
920 r"""SniffTest(wxString aCandidate) -> bool"""
921 return _pcbnew.KIID_SniffTest(aCandidate)
922
923 @staticmethod
924 def CreateNilUuids(aNil=True):
925 r"""CreateNilUuids(bool aNil=True)"""
926 return _pcbnew.KIID_CreateNilUuids(aNil)
927
928 @staticmethod
929 def SeedGenerator(aSeed):
930 r"""SeedGenerator(unsigned int aSeed)"""
931 return _pcbnew.KIID_SeedGenerator(aSeed)
932
934 r"""ConvertTimestampToUuid(KIID self)"""
935 return _pcbnew.KIID_ConvertTimestampToUuid(self)
936
937 def Increment(self):
938 r"""Increment(KIID self)"""
939 return _pcbnew.KIID_Increment(self)
940
941 def __eq__(self, rhs):
942 r"""__eq__(KIID self, KIID rhs) -> bool"""
943 return _pcbnew.KIID___eq__(self, rhs)
944
945 def __ne__(self, rhs):
946 r"""__ne__(KIID self, KIID rhs) -> bool"""
947 return _pcbnew.KIID___ne__(self, rhs)
948
949 def __lt__(self, rhs):
950 r"""__lt__(KIID self, KIID rhs) -> bool"""
951 return _pcbnew.KIID___lt__(self, rhs)
952
953 def __gt__(self, rhs):
954 r"""__gt__(KIID self, KIID rhs) -> bool"""
955 return _pcbnew.KIID___gt__(self, rhs)
956 __swig_destroy__ = _pcbnew.delete_KIID
957
958# Register KIID in _pcbnew:
959_pcbnew.KIID_swigregister(KIID)
960
962 r"""NilUuid() -> KIID"""
963 return _pcbnew.NilUuid()
965 r"""Proxy of C++ std::vector< KIID > class."""
966
967 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
968 __repr__ = _swig_repr
969
970 def iterator(self):
971 r"""iterator(KIID_VECT_LIST self) -> SwigPyIterator"""
972 return _pcbnew.KIID_VECT_LIST_iterator(self)
973 def __iter__(self):
974 return self.iterator()
975
976 def __nonzero__(self):
977 r"""__nonzero__(KIID_VECT_LIST self) -> bool"""
978 return _pcbnew.KIID_VECT_LIST___nonzero__(self)
979
980 def __bool__(self):
981 r"""__bool__(KIID_VECT_LIST self) -> bool"""
982 return _pcbnew.KIID_VECT_LIST___bool__(self)
983
984 def __len__(self):
985 r"""__len__(KIID_VECT_LIST self) -> std::vector< KIID >::size_type"""
986 return _pcbnew.KIID_VECT_LIST___len__(self)
987
988 def __getslice__(self, i, j):
989 r"""__getslice__(KIID_VECT_LIST self, std::vector< KIID >::difference_type i, std::vector< KIID >::difference_type j) -> KIID_VECT_LIST"""
990 return _pcbnew.KIID_VECT_LIST___getslice__(self, i, j)
991
992 def __setslice__(self, *args):
993 r"""
994 __setslice__(KIID_VECT_LIST self, std::vector< KIID >::difference_type i, std::vector< KIID >::difference_type j)
995 __setslice__(KIID_VECT_LIST self, std::vector< KIID >::difference_type i, std::vector< KIID >::difference_type j, KIID_VECT_LIST v)
996 """
997 return _pcbnew.KIID_VECT_LIST___setslice__(self, *args)
998
999 def __delslice__(self, i, j):
1000 r"""__delslice__(KIID_VECT_LIST self, std::vector< KIID >::difference_type i, std::vector< KIID >::difference_type j)"""
1001 return _pcbnew.KIID_VECT_LIST___delslice__(self, i, j)
1002
1003 def __delitem__(self, *args):
1004 r"""
1005 __delitem__(KIID_VECT_LIST self, std::vector< KIID >::difference_type i)
1006 __delitem__(KIID_VECT_LIST self, SWIGPY_SLICEOBJECT * slice)
1007 """
1008 return _pcbnew.KIID_VECT_LIST___delitem__(self, *args)
1009
1010 def __getitem__(self, *args):
1011 r"""
1012 __getitem__(KIID_VECT_LIST self, SWIGPY_SLICEOBJECT * slice) -> KIID_VECT_LIST
1013 __getitem__(KIID_VECT_LIST self, std::vector< KIID >::difference_type i) -> KIID
1014 """
1015 return _pcbnew.KIID_VECT_LIST___getitem__(self, *args)
1016
1017 def __setitem__(self, *args):
1018 r"""
1019 __setitem__(KIID_VECT_LIST self, SWIGPY_SLICEOBJECT * slice, KIID_VECT_LIST v)
1020 __setitem__(KIID_VECT_LIST self, SWIGPY_SLICEOBJECT * slice)
1021 __setitem__(KIID_VECT_LIST self, std::vector< KIID >::difference_type i, KIID x)
1022 """
1023 return _pcbnew.KIID_VECT_LIST___setitem__(self, *args)
1024
1025 def pop(self):
1026 r"""pop(KIID_VECT_LIST self) -> KIID"""
1027 return _pcbnew.KIID_VECT_LIST_pop(self)
1028
1029 def append(self, x):
1030 r"""append(KIID_VECT_LIST self, KIID x)"""
1031 return _pcbnew.KIID_VECT_LIST_append(self, x)
1032
1033 def empty(self):
1034 r"""empty(KIID_VECT_LIST self) -> bool"""
1035 return _pcbnew.KIID_VECT_LIST_empty(self)
1036
1037 def size(self):
1038 r"""size(KIID_VECT_LIST self) -> std::vector< KIID >::size_type"""
1039 return _pcbnew.KIID_VECT_LIST_size(self)
1040
1041 def swap(self, v):
1042 r"""swap(KIID_VECT_LIST self, KIID_VECT_LIST v)"""
1043 return _pcbnew.KIID_VECT_LIST_swap(self, v)
1044
1045 def begin(self):
1046 r"""begin(KIID_VECT_LIST self) -> std::vector< KIID >::iterator"""
1047 return _pcbnew.KIID_VECT_LIST_begin(self)
1048
1049 def end(self):
1050 r"""end(KIID_VECT_LIST self) -> std::vector< KIID >::iterator"""
1051 return _pcbnew.KIID_VECT_LIST_end(self)
1052
1053 def rbegin(self):
1054 r"""rbegin(KIID_VECT_LIST self) -> std::vector< KIID >::reverse_iterator"""
1055 return _pcbnew.KIID_VECT_LIST_rbegin(self)
1056
1057 def rend(self):
1058 r"""rend(KIID_VECT_LIST self) -> std::vector< KIID >::reverse_iterator"""
1059 return _pcbnew.KIID_VECT_LIST_rend(self)
1060
1061 def clear(self):
1062 r"""clear(KIID_VECT_LIST self)"""
1063 return _pcbnew.KIID_VECT_LIST_clear(self)
1064
1065 def get_allocator(self):
1066 r"""get_allocator(KIID_VECT_LIST self) -> std::vector< KIID >::allocator_type"""
1067 return _pcbnew.KIID_VECT_LIST_get_allocator(self)
1068
1069 def pop_back(self):
1070 r"""pop_back(KIID_VECT_LIST self)"""
1071 return _pcbnew.KIID_VECT_LIST_pop_back(self)
1072
1073 def erase(self, *args):
1074 r"""
1075 erase(KIID_VECT_LIST self, std::vector< KIID >::iterator pos) -> std::vector< KIID >::iterator
1076 erase(KIID_VECT_LIST self, std::vector< KIID >::iterator first, std::vector< KIID >::iterator last) -> std::vector< KIID >::iterator
1077 """
1078 return _pcbnew.KIID_VECT_LIST_erase(self, *args)
1079
1080 def __init__(self, *args):
1081 r"""
1082 __init__(KIID_VECT_LIST self) -> KIID_VECT_LIST
1083 __init__(KIID_VECT_LIST self, KIID_VECT_LIST other) -> KIID_VECT_LIST
1084 __init__(KIID_VECT_LIST self, std::vector< KIID >::size_type size) -> KIID_VECT_LIST
1085 __init__(KIID_VECT_LIST self, std::vector< KIID >::size_type size, KIID value) -> KIID_VECT_LIST
1086 """
1087 _pcbnew.KIID_VECT_LIST_swiginit(self, _pcbnew.new_KIID_VECT_LIST(*args))
1088
1089 def push_back(self, x):
1090 r"""push_back(KIID_VECT_LIST self, KIID x)"""
1091 return _pcbnew.KIID_VECT_LIST_push_back(self, x)
1092
1093 def front(self):
1094 r"""front(KIID_VECT_LIST self) -> KIID"""
1095 return _pcbnew.KIID_VECT_LIST_front(self)
1096
1097 def back(self):
1098 r"""back(KIID_VECT_LIST self) -> KIID"""
1099 return _pcbnew.KIID_VECT_LIST_back(self)
1100
1101 def assign(self, n, x):
1102 r"""assign(KIID_VECT_LIST self, std::vector< KIID >::size_type n, KIID x)"""
1103 return _pcbnew.KIID_VECT_LIST_assign(self, n, x)
1104
1105 def resize(self, *args):
1106 r"""
1107 resize(KIID_VECT_LIST self, std::vector< KIID >::size_type new_size)
1108 resize(KIID_VECT_LIST self, std::vector< KIID >::size_type new_size, KIID x)
1109 """
1110 return _pcbnew.KIID_VECT_LIST_resize(self, *args)
1111
1112 def insert(self, *args):
1113 r"""
1114 insert(KIID_VECT_LIST self, std::vector< KIID >::iterator pos, KIID x) -> std::vector< KIID >::iterator
1115 insert(KIID_VECT_LIST self, std::vector< KIID >::iterator pos, std::vector< KIID >::size_type n, KIID x)
1116 """
1117 return _pcbnew.KIID_VECT_LIST_insert(self, *args)
1118
1119 def reserve(self, n):
1120 r"""reserve(KIID_VECT_LIST self, std::vector< KIID >::size_type n)"""
1121 return _pcbnew.KIID_VECT_LIST_reserve(self, n)
1122
1123 def capacity(self):
1124 r"""capacity(KIID_VECT_LIST self) -> std::vector< KIID >::size_type"""
1125 return _pcbnew.KIID_VECT_LIST_capacity(self)
1126 __swig_destroy__ = _pcbnew.delete_KIID_VECT_LIST
1127
1128# Register KIID_VECT_LIST in _pcbnew:
1129_pcbnew.KIID_VECT_LIST_swigregister(KIID_VECT_LIST)
1131 r"""Proxy of C++ KIID_PATH class."""
1132
1133 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
1134 __repr__ = _swig_repr
1135
1136 def __init__(self, *args):
1137 r"""
1138 __init__(KIID_PATH self) -> KIID_PATH
1139 __init__(KIID_PATH self, wxString aString) -> KIID_PATH
1140 """
1141 _pcbnew.KIID_PATH_swiginit(self, _pcbnew.new_KIID_PATH(*args))
1142
1143 def MakeRelativeTo(self, aPath):
1144 r"""MakeRelativeTo(KIID_PATH self, KIID_PATH aPath) -> bool"""
1145 return _pcbnew.KIID_PATH_MakeRelativeTo(self, aPath)
1146
1147 def EndsWith(self, aPath):
1148 r"""EndsWith(KIID_PATH self, KIID_PATH aPath) -> bool"""
1149 return _pcbnew.KIID_PATH_EndsWith(self, aPath)
1150
1151 def AsString(self):
1152 r"""AsString(KIID_PATH self) -> wxString"""
1153 return _pcbnew.KIID_PATH_AsString(self)
1154
1155 def __eq__(self, rhs):
1156 r"""__eq__(KIID_PATH self, KIID_PATH rhs) -> bool"""
1157 return _pcbnew.KIID_PATH___eq__(self, rhs)
1158
1159 def __lt__(self, rhs):
1160 r"""__lt__(KIID_PATH self, KIID_PATH rhs) -> bool"""
1161 return _pcbnew.KIID_PATH___lt__(self, rhs)
1162
1163 def __gt__(self, rhs):
1164 r"""__gt__(KIID_PATH self, KIID_PATH rhs) -> bool"""
1165 return _pcbnew.KIID_PATH___gt__(self, rhs)
1166
1167 def __iadd__(self, aRhs):
1168 r"""__iadd__(KIID_PATH self, KIID_PATH aRhs) -> KIID_PATH"""
1169 return _pcbnew.KIID_PATH___iadd__(self, aRhs)
1170 __swig_destroy__ = _pcbnew.delete_KIID_PATH
1171
1172# Register KIID_PATH in _pcbnew:
1173_pcbnew.KIID_PATH_swigregister(KIID_PATH)
1175 r"""Proxy of C++ KIID_NIL_SET_RESET class."""
1176
1177 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
1178 __repr__ = _swig_repr
1179
1180 def __init__(self):
1181 r"""__init__(KIID_NIL_SET_RESET self) -> KIID_NIL_SET_RESET"""
1182 _pcbnew.KIID_NIL_SET_RESET_swiginit(self, _pcbnew.new_KIID_NIL_SET_RESET())
1183 __swig_destroy__ = _pcbnew.delete_KIID_NIL_SET_RESET
1184
1185# Register KIID_NIL_SET_RESET in _pcbnew:
1186_pcbnew.KIID_NIL_SET_RESET_swigregister(KIID_NIL_SET_RESET)
1187NOT_USED = _pcbnew.NOT_USED
1188
1189TYPE_NOT_INIT = _pcbnew.TYPE_NOT_INIT
1190
1191PCB_T = _pcbnew.PCB_T
1192
1193SCREEN_T = _pcbnew.SCREEN_T
1194
1195PCB_FOOTPRINT_T = _pcbnew.PCB_FOOTPRINT_T
1196
1197PCB_PAD_T = _pcbnew.PCB_PAD_T
1198
1199PCB_SHAPE_T = _pcbnew.PCB_SHAPE_T
1200
1201PCB_REFERENCE_IMAGE_T = _pcbnew.PCB_REFERENCE_IMAGE_T
1202
1203PCB_FIELD_T = _pcbnew.PCB_FIELD_T
1204
1205PCB_GENERATOR_T = _pcbnew.PCB_GENERATOR_T
1206
1207PCB_TEXT_T = _pcbnew.PCB_TEXT_T
1208
1209PCB_TEXTBOX_T = _pcbnew.PCB_TEXTBOX_T
1210
1211PCB_TABLE_T = _pcbnew.PCB_TABLE_T
1212
1213PCB_TABLECELL_T = _pcbnew.PCB_TABLECELL_T
1214
1215PCB_TRACE_T = _pcbnew.PCB_TRACE_T
1216
1217PCB_VIA_T = _pcbnew.PCB_VIA_T
1218
1219PCB_ARC_T = _pcbnew.PCB_ARC_T
1220
1221PCB_MARKER_T = _pcbnew.PCB_MARKER_T
1222
1223PCB_DIMENSION_T = _pcbnew.PCB_DIMENSION_T
1224
1225PCB_DIM_ALIGNED_T = _pcbnew.PCB_DIM_ALIGNED_T
1226
1227PCB_DIM_LEADER_T = _pcbnew.PCB_DIM_LEADER_T
1228
1229PCB_DIM_CENTER_T = _pcbnew.PCB_DIM_CENTER_T
1230
1231PCB_DIM_RADIAL_T = _pcbnew.PCB_DIM_RADIAL_T
1232
1233PCB_DIM_ORTHOGONAL_T = _pcbnew.PCB_DIM_ORTHOGONAL_T
1234
1235PCB_TARGET_T = _pcbnew.PCB_TARGET_T
1236
1237PCB_ZONE_T = _pcbnew.PCB_ZONE_T
1238
1239PCB_ITEM_LIST_T = _pcbnew.PCB_ITEM_LIST_T
1240
1241PCB_NETINFO_T = _pcbnew.PCB_NETINFO_T
1242
1243PCB_GROUP_T = _pcbnew.PCB_GROUP_T
1244
1245PCB_FIELD_LOCATE_REFERENCE_T = _pcbnew.PCB_FIELD_LOCATE_REFERENCE_T
1246
1247PCB_FIELD_LOCATE_VALUE_T = _pcbnew.PCB_FIELD_LOCATE_VALUE_T
1248
1249PCB_FIELD_LOCATE_FOOTPRINT_T = _pcbnew.PCB_FIELD_LOCATE_FOOTPRINT_T
1250
1251PCB_FIELD_LOCATE_DATASHEET_T = _pcbnew.PCB_FIELD_LOCATE_DATASHEET_T
1252
1253PCB_LOCATE_STDVIA_T = _pcbnew.PCB_LOCATE_STDVIA_T
1254
1255PCB_LOCATE_UVIA_T = _pcbnew.PCB_LOCATE_UVIA_T
1256
1257PCB_LOCATE_BBVIA_T = _pcbnew.PCB_LOCATE_BBVIA_T
1258
1259PCB_LOCATE_TEXT_T = _pcbnew.PCB_LOCATE_TEXT_T
1260
1261PCB_LOCATE_HOLE_T = _pcbnew.PCB_LOCATE_HOLE_T
1262
1263PCB_LOCATE_PTH_T = _pcbnew.PCB_LOCATE_PTH_T
1264
1265PCB_LOCATE_NPTH_T = _pcbnew.PCB_LOCATE_NPTH_T
1266
1267PCB_LOCATE_BOARD_EDGE_T = _pcbnew.PCB_LOCATE_BOARD_EDGE_T
1268
1269PCB_SHAPE_LOCATE_SEGMENT_T = _pcbnew.PCB_SHAPE_LOCATE_SEGMENT_T
1270
1271PCB_SHAPE_LOCATE_RECT_T = _pcbnew.PCB_SHAPE_LOCATE_RECT_T
1272
1273PCB_SHAPE_LOCATE_CIRCLE_T = _pcbnew.PCB_SHAPE_LOCATE_CIRCLE_T
1274
1275PCB_SHAPE_LOCATE_ARC_T = _pcbnew.PCB_SHAPE_LOCATE_ARC_T
1276
1277PCB_SHAPE_LOCATE_POLY_T = _pcbnew.PCB_SHAPE_LOCATE_POLY_T
1278
1279PCB_SHAPE_LOCATE_BEZIER_T = _pcbnew.PCB_SHAPE_LOCATE_BEZIER_T
1280
1281LIB_SYMBOL_T = _pcbnew.LIB_SYMBOL_T
1282
1283SCH_SHAPE_T = _pcbnew.SCH_SHAPE_T
1284
1285SCH_FIELD_T = _pcbnew.SCH_FIELD_T
1286
1287SCH_TEXT_T = _pcbnew.SCH_TEXT_T
1288
1289SCH_TEXTBOX_T = _pcbnew.SCH_TEXTBOX_T
1290
1291SCH_PIN_T = _pcbnew.SCH_PIN_T
1292
1293SCH_MARKER_T = _pcbnew.SCH_MARKER_T
1294
1295SCH_JUNCTION_T = _pcbnew.SCH_JUNCTION_T
1296
1297SCH_NO_CONNECT_T = _pcbnew.SCH_NO_CONNECT_T
1298
1299SCH_BUS_WIRE_ENTRY_T = _pcbnew.SCH_BUS_WIRE_ENTRY_T
1300
1301SCH_BUS_BUS_ENTRY_T = _pcbnew.SCH_BUS_BUS_ENTRY_T
1302
1303SCH_LINE_T = _pcbnew.SCH_LINE_T
1304
1305SCH_BITMAP_T = _pcbnew.SCH_BITMAP_T
1306
1307SCH_TABLE_T = _pcbnew.SCH_TABLE_T
1308
1309SCH_TABLECELL_T = _pcbnew.SCH_TABLECELL_T
1310
1311SCH_LABEL_T = _pcbnew.SCH_LABEL_T
1312
1313SCH_GLOBAL_LABEL_T = _pcbnew.SCH_GLOBAL_LABEL_T
1314
1315SCH_HIER_LABEL_T = _pcbnew.SCH_HIER_LABEL_T
1316
1317SCH_RULE_AREA_T = _pcbnew.SCH_RULE_AREA_T
1318
1319SCH_DIRECTIVE_LABEL_T = _pcbnew.SCH_DIRECTIVE_LABEL_T
1320
1321SCH_SYMBOL_T = _pcbnew.SCH_SYMBOL_T
1322
1323SCH_SHEET_PIN_T = _pcbnew.SCH_SHEET_PIN_T
1324
1325SCH_SHEET_T = _pcbnew.SCH_SHEET_T
1326
1327SCH_FIELD_LOCATE_REFERENCE_T = _pcbnew.SCH_FIELD_LOCATE_REFERENCE_T
1328
1329SCH_FIELD_LOCATE_VALUE_T = _pcbnew.SCH_FIELD_LOCATE_VALUE_T
1330
1331SCH_FIELD_LOCATE_FOOTPRINT_T = _pcbnew.SCH_FIELD_LOCATE_FOOTPRINT_T
1332
1333SCH_FIELD_LOCATE_DATASHEET_T = _pcbnew.SCH_FIELD_LOCATE_DATASHEET_T
1334
1335SCH_ITEM_LOCATE_WIRE_T = _pcbnew.SCH_ITEM_LOCATE_WIRE_T
1336
1337SCH_ITEM_LOCATE_BUS_T = _pcbnew.SCH_ITEM_LOCATE_BUS_T
1338
1339SCH_ITEM_LOCATE_GRAPHIC_LINE_T = _pcbnew.SCH_ITEM_LOCATE_GRAPHIC_LINE_T
1340
1341SCH_LABEL_LOCATE_ANY_T = _pcbnew.SCH_LABEL_LOCATE_ANY_T
1342
1343SCH_LABEL_LOCATE_WIRE_T = _pcbnew.SCH_LABEL_LOCATE_WIRE_T
1344
1345SCH_LABEL_LOCATE_BUS_T = _pcbnew.SCH_LABEL_LOCATE_BUS_T
1346
1347SCH_SYMBOL_LOCATE_POWER_T = _pcbnew.SCH_SYMBOL_LOCATE_POWER_T
1348
1349SCH_LOCATE_ANY_T = _pcbnew.SCH_LOCATE_ANY_T
1350
1351SCH_SCREEN_T = _pcbnew.SCH_SCREEN_T
1352
1353SCHEMATIC_T = _pcbnew.SCHEMATIC_T
1354
1355GERBER_LAYOUT_T = _pcbnew.GERBER_LAYOUT_T
1356
1357GERBER_DRAW_ITEM_T = _pcbnew.GERBER_DRAW_ITEM_T
1358
1359GERBER_IMAGE_T = _pcbnew.GERBER_IMAGE_T
1360
1361WSG_LINE_T = _pcbnew.WSG_LINE_T
1362
1363WSG_RECT_T = _pcbnew.WSG_RECT_T
1364
1365WSG_POLY_T = _pcbnew.WSG_POLY_T
1366
1367WSG_TEXT_T = _pcbnew.WSG_TEXT_T
1368
1369WSG_BITMAP_T = _pcbnew.WSG_BITMAP_T
1370
1371WSG_PAGE_T = _pcbnew.WSG_PAGE_T
1372
1373WS_PROXY_UNDO_ITEM_T = _pcbnew.WS_PROXY_UNDO_ITEM_T
1374
1375WS_PROXY_UNDO_ITEM_PLUS_T = _pcbnew.WS_PROXY_UNDO_ITEM_PLUS_T
1376
1377SYMBOL_LIB_TABLE_T = _pcbnew.SYMBOL_LIB_TABLE_T
1378
1379FP_LIB_TABLE_T = _pcbnew.FP_LIB_TABLE_T
1380
1381DESIGN_BLOCK_LIB_TABLE_T = _pcbnew.DESIGN_BLOCK_LIB_TABLE_T
1382
1383SYMBOL_LIBS_T = _pcbnew.SYMBOL_LIBS_T
1384
1385SEARCH_STACK_T = _pcbnew.SEARCH_STACK_T
1386
1387S3D_CACHE_T = _pcbnew.S3D_CACHE_T
1388
1389MAX_STRUCT_TYPE_ID = _pcbnew.MAX_STRUCT_TYPE_ID
1390
1391
1392def BaseType(aType):
1393 r"""BaseType(KICAD_T const aType) -> KICAD_T"""
1394 return _pcbnew.BaseType(aType)
1395
1396def IsNullType(aType):
1397 r"""IsNullType(KICAD_T const aType) -> bool"""
1398 return _pcbnew.IsNullType(aType)
1399
1401 r"""IsInstantiableType(KICAD_T const aType) -> bool"""
1402 return _pcbnew.IsInstantiableType(aType)
1403
1405 r"""IsEeschemaType(KICAD_T const aType) -> bool"""
1406 return _pcbnew.IsEeschemaType(aType)
1407
1408def IsPcbnewType(aType):
1409 r"""IsPcbnewType(KICAD_T const aType) -> bool"""
1410 return _pcbnew.IsPcbnewType(aType)
1411
1413 r"""IsGerbviewType(KICAD_T const aType) -> bool"""
1414 return _pcbnew.IsGerbviewType(aType)
1415
1417 r"""IsPageLayoutEditorType(KICAD_T const aType) -> bool"""
1418 return _pcbnew.IsPageLayoutEditorType(aType)
1419
1420def IsMiscType(aType):
1421 r"""IsMiscType(KICAD_T const aType) -> bool"""
1422 return _pcbnew.IsMiscType(aType)
1423
1424def IsTypeCorrect(aType):
1425 r"""IsTypeCorrect(KICAD_T aType) -> bool"""
1426 return _pcbnew.IsTypeCorrect(aType)
1427INSPECT_RESULT_QUIT = _pcbnew.INSPECT_RESULT_QUIT
1428
1429INSPECT_RESULT_CONTINUE = _pcbnew.INSPECT_RESULT_CONTINUE
1430
1432 r"""Proxy of C++ EDA_ITEM class."""
1433
1434 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
1435
1436 def __init__(self, *args, **kwargs):
1437 raise AttributeError("No constructor defined - class is abstract")
1438 __repr__ = _swig_repr
1439 __swig_destroy__ = _pcbnew.delete_EDA_ITEM
1440
1441 def Type(self):
1442 r"""Type(EDA_ITEM self) -> KICAD_T"""
1443 return _pcbnew.EDA_ITEM_Type(self)
1444
1445 def GetParent(self):
1446 r"""GetParent(EDA_ITEM self) -> EDA_ITEM"""
1447 return _pcbnew.EDA_ITEM_GetParent(self)
1448
1449 def SetParent(self, aParent):
1450 r"""SetParent(EDA_ITEM self, EDA_ITEM aParent)"""
1451 return _pcbnew.EDA_ITEM_SetParent(self, aParent)
1452
1453 def IsModified(self):
1454 r"""IsModified(EDA_ITEM self) -> bool"""
1455 return _pcbnew.EDA_ITEM_IsModified(self)
1456
1457 def IsNew(self):
1458 r"""IsNew(EDA_ITEM self) -> bool"""
1459 return _pcbnew.EDA_ITEM_IsNew(self)
1460
1461 def IsMoving(self):
1462 r"""IsMoving(EDA_ITEM self) -> bool"""
1463 return _pcbnew.EDA_ITEM_IsMoving(self)
1464
1465 def IsSelected(self):
1466 r"""IsSelected(EDA_ITEM self) -> bool"""
1467 return _pcbnew.EDA_ITEM_IsSelected(self)
1468
1469 def IsEntered(self):
1470 r"""IsEntered(EDA_ITEM self) -> bool"""
1471 return _pcbnew.EDA_ITEM_IsEntered(self)
1472
1473 def IsBrightened(self):
1474 r"""IsBrightened(EDA_ITEM self) -> bool"""
1475 return _pcbnew.EDA_ITEM_IsBrightened(self)
1476
1477 def IsRollover(self):
1478 r"""IsRollover(EDA_ITEM self) -> bool"""
1479 return _pcbnew.EDA_ITEM_IsRollover(self)
1480
1481 def SetSelected(self):
1482 r"""SetSelected(EDA_ITEM self)"""
1483 return _pcbnew.EDA_ITEM_SetSelected(self)
1484
1485 def SetBrightened(self):
1486 r"""SetBrightened(EDA_ITEM self)"""
1487 return _pcbnew.EDA_ITEM_SetBrightened(self)
1488
1489 def ClearSelected(self):
1490 r"""ClearSelected(EDA_ITEM self)"""
1491 return _pcbnew.EDA_ITEM_ClearSelected(self)
1492
1494 r"""ClearBrightened(EDA_ITEM self)"""
1495 return _pcbnew.EDA_ITEM_ClearBrightened(self)
1496
1497 def SetModified(self):
1498 r"""SetModified(EDA_ITEM self)"""
1499 return _pcbnew.EDA_ITEM_SetModified(self)
1500
1501 def SetFlags(self, aMask):
1502 r"""SetFlags(EDA_ITEM self, EDA_ITEM_FLAGS aMask)"""
1503 return _pcbnew.EDA_ITEM_SetFlags(self, aMask)
1504
1505 def XorFlags(self, aMask):
1506 r"""XorFlags(EDA_ITEM self, EDA_ITEM_FLAGS aMask)"""
1507 return _pcbnew.EDA_ITEM_XorFlags(self, aMask)
1508
1509 def ClearFlags(self, *args):
1510 r"""ClearFlags(EDA_ITEM self, EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)"""
1511 return _pcbnew.EDA_ITEM_ClearFlags(self, *args)
1512
1513 def GetFlags(self):
1514 r"""GetFlags(EDA_ITEM self) -> EDA_ITEM_FLAGS"""
1515 return _pcbnew.EDA_ITEM_GetFlags(self)
1516
1517 def HasFlag(self, aFlag):
1518 r"""HasFlag(EDA_ITEM self, EDA_ITEM_FLAGS aFlag) -> bool"""
1519 return _pcbnew.EDA_ITEM_HasFlag(self, aFlag)
1520
1521 def GetEditFlags(self):
1522 r"""GetEditFlags(EDA_ITEM self) -> EDA_ITEM_FLAGS"""
1523 return _pcbnew.EDA_ITEM_GetEditFlags(self)
1524
1526 r"""ClearEditFlags(EDA_ITEM self)"""
1527 return _pcbnew.EDA_ITEM_ClearEditFlags(self)
1528
1529 def GetTempFlags(self):
1530 r"""GetTempFlags(EDA_ITEM self) -> EDA_ITEM_FLAGS"""
1531 return _pcbnew.EDA_ITEM_GetTempFlags(self)
1532
1534 r"""ClearTempFlags(EDA_ITEM self)"""
1535 return _pcbnew.EDA_ITEM_ClearTempFlags(self)
1536
1537 def RenderAsBitmap(self, aWorldScale):
1538 r"""RenderAsBitmap(EDA_ITEM self, double aWorldScale) -> bool"""
1539 return _pcbnew.EDA_ITEM_RenderAsBitmap(self, aWorldScale)
1540
1541 def SetIsShownAsBitmap(self, aBitmap):
1542 r"""SetIsShownAsBitmap(EDA_ITEM self, bool aBitmap)"""
1543 return _pcbnew.EDA_ITEM_SetIsShownAsBitmap(self, aBitmap)
1544
1546 r"""IsShownAsBitmap(EDA_ITEM self) -> bool"""
1547 return _pcbnew.EDA_ITEM_IsShownAsBitmap(self)
1548
1549 def IsType(self, aScanTypes):
1550 r"""IsType(EDA_ITEM self, std::vector< KICAD_T,std::allocator< KICAD_T > > const & aScanTypes) -> bool"""
1551 return _pcbnew.EDA_ITEM_IsType(self, aScanTypes)
1552
1553 def SetForceVisible(self, aEnable):
1554 r"""SetForceVisible(EDA_ITEM self, bool aEnable)"""
1555 return _pcbnew.EDA_ITEM_SetForceVisible(self, aEnable)
1556
1558 r"""IsForceVisible(EDA_ITEM self) -> bool"""
1559 return _pcbnew.EDA_ITEM_IsForceVisible(self)
1560
1561 def GetMsgPanelInfo(self, aFrame, aList):
1562 r"""GetMsgPanelInfo(EDA_ITEM self, EDA_DRAW_FRAME * aFrame, std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > & aList)"""
1563 return _pcbnew.EDA_ITEM_GetMsgPanelInfo(self, aFrame, aList)
1564
1566 r"""GetFriendlyName(EDA_ITEM self) -> wxString"""
1567 return _pcbnew.EDA_ITEM_GetFriendlyName(self)
1568
1569 def HitTest(self, *args):
1570 r"""
1571 HitTest(EDA_ITEM self, VECTOR2I aPosition, int aAccuracy=0) -> bool
1572 HitTest(EDA_ITEM self, BOX2I aRect, bool aContained, int aAccuracy=0) -> bool
1573 """
1574 return _pcbnew.EDA_ITEM_HitTest(self, *args)
1575
1577 r"""GetBoundingBox(EDA_ITEM self) -> BOX2I"""
1578 return _pcbnew.EDA_ITEM_GetBoundingBox(self)
1579
1580 def GetPosition(self):
1581 r"""GetPosition(EDA_ITEM self) -> VECTOR2I"""
1582 return _pcbnew.EDA_ITEM_GetPosition(self)
1583
1584 def SetPosition(self, aPos):
1585 r"""SetPosition(EDA_ITEM self, VECTOR2I aPos)"""
1586 return _pcbnew.EDA_ITEM_SetPosition(self, aPos)
1587
1589 r"""GetFocusPosition(EDA_ITEM self) -> VECTOR2I"""
1590 return _pcbnew.EDA_ITEM_GetFocusPosition(self)
1591
1593 r"""GetSortPosition(EDA_ITEM self) -> VECTOR2I"""
1594 return _pcbnew.EDA_ITEM_GetSortPosition(self)
1595
1596 def Clone(self):
1597 r"""Clone(EDA_ITEM self) -> EDA_ITEM"""
1598 return _pcbnew.EDA_ITEM_Clone(self)
1599
1600 def Visit(self, inspector, testData, aScanTypes):
1601 r"""Visit(EDA_ITEM self, INSPECTOR inspector, void * testData, std::vector< KICAD_T,std::allocator< KICAD_T > > const & aScanTypes) -> INSPECT_RESULT"""
1602 return _pcbnew.EDA_ITEM_Visit(self, inspector, testData, aScanTypes)
1603
1604 def GetClass(self):
1605 r"""GetClass(EDA_ITEM self) -> wxString"""
1606 return _pcbnew.EDA_ITEM_GetClass(self)
1607
1608 def GetTypeDesc(self):
1609 r"""GetTypeDesc(EDA_ITEM self) -> wxString"""
1610 return _pcbnew.EDA_ITEM_GetTypeDesc(self)
1611
1612 def GetItemDescription(self, aUnitsProvider, aFull):
1613 r"""GetItemDescription(EDA_ITEM self, UNITS_PROVIDER aUnitsProvider, bool aFull) -> wxString"""
1614 return _pcbnew.EDA_ITEM_GetItemDescription(self, aUnitsProvider, aFull)
1615
1616 def GetMenuImage(self):
1617 r"""GetMenuImage(EDA_ITEM self) -> BITMAPS"""
1618 return _pcbnew.EDA_ITEM_GetMenuImage(self)
1619
1620 def Matches(self, aSearchData, aAuxData):
1621 r"""Matches(EDA_ITEM self, EDA_SEARCH_DATA const & aSearchData, void * aAuxData) -> bool"""
1622 return _pcbnew.EDA_ITEM_Matches(self, aSearchData, aAuxData)
1623
1624 def Replace(self, *args):
1625 r"""
1626 Replace(EDA_ITEM self, EDA_SEARCH_DATA const & aSearchData, wxString aText) -> bool
1627 Replace(EDA_ITEM self, EDA_SEARCH_DATA const & aSearchData, void * aAuxData=None) -> bool
1628 """
1629 return _pcbnew.EDA_ITEM_Replace(self, *args)
1630
1631 def IsReplaceable(self):
1632 r"""IsReplaceable(EDA_ITEM self) -> bool"""
1633 return _pcbnew.EDA_ITEM_IsReplaceable(self)
1634
1635 def __lt__(self, aItem):
1636 r"""__lt__(EDA_ITEM self, EDA_ITEM aItem) -> bool"""
1637 return _pcbnew.EDA_ITEM___lt__(self, aItem)
1638
1639 @staticmethod
1640 def Sort(aLeft, aRight):
1641 r"""Sort(EDA_ITEM aLeft, EDA_ITEM aRight) -> bool"""
1642 return _pcbnew.EDA_ITEM_Sort(aLeft, aRight)
1643
1644 def ViewBBox(self):
1645 r"""ViewBBox(EDA_ITEM self) -> BOX2I"""
1646 return _pcbnew.EDA_ITEM_ViewBBox(self)
1647
1648 def ViewGetLayers(self):
1649 r"""ViewGetLayers(EDA_ITEM self) -> intVector"""
1650 return _pcbnew.EDA_ITEM_ViewGetLayers(self)
1651
1653 r"""GetEmbeddedFiles(EDA_ITEM self) -> EMBEDDED_FILES *"""
1654 return _pcbnew.EDA_ITEM_GetEmbeddedFiles(self)
1655 m_Uuid = property(_pcbnew.EDA_ITEM_m_Uuid_get, doc=r"""m_Uuid : q(const).KIID""")
1656
1657# Register EDA_ITEM in _pcbnew:
1658_pcbnew.EDA_ITEM_swigregister(EDA_ITEM)
1659
1660def new_clone(aItem):
1661 r"""new_clone(EDA_ITEM aItem) -> EDA_ITEM"""
1662 return _pcbnew.new_clone(aItem)
1664 r"""Proxy of C++ CompareByUuid class."""
1665
1666 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
1667 __repr__ = _swig_repr
1668
1669 def __call__(self, item1, item2):
1670 r"""__call__(CompareByUuid self, EDA_ITEM item1, EDA_ITEM item2) -> bool"""
1671 return _pcbnew.CompareByUuid___call__(self, item1, item2)
1672
1673 def __init__(self):
1674 r"""__init__(CompareByUuid self) -> CompareByUuid"""
1675 _pcbnew.CompareByUuid_swiginit(self, _pcbnew.new_CompareByUuid())
1676 __swig_destroy__ = _pcbnew.delete_CompareByUuid
1677
1678# Register CompareByUuid in _pcbnew:
1679_pcbnew.CompareByUuid_swigregister(CompareByUuid)
1681 r"""Proxy of C++ EDA_IU_SCALE class."""
1682
1683 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
1684 __repr__ = _swig_repr
1685 IU_PER_MM = property(_pcbnew.EDA_IU_SCALE_IU_PER_MM_get, doc=r"""IU_PER_MM : q(const).double""")
1686 IU_PER_MILS = property(_pcbnew.EDA_IU_SCALE_IU_PER_MILS_get, doc=r"""IU_PER_MILS : q(const).double""")
1687 MM_PER_IU = property(_pcbnew.EDA_IU_SCALE_MM_PER_IU_get, doc=r"""MM_PER_IU : q(const).double""")
1688
1689 def __init__(self, aIUPerMM):
1690 r"""__init__(EDA_IU_SCALE self, double aIUPerMM) -> EDA_IU_SCALE"""
1691 _pcbnew.EDA_IU_SCALE_swiginit(self, _pcbnew.new_EDA_IU_SCALE(aIUPerMM))
1692
1693 def IUTomm(self, iu):
1694 r"""IUTomm(EDA_IU_SCALE self, int iu) -> double"""
1695 return _pcbnew.EDA_IU_SCALE_IUTomm(self, iu)
1696
1697 def mmToIU(self, mm):
1698 r"""mmToIU(EDA_IU_SCALE self, double mm) -> int"""
1699 return _pcbnew.EDA_IU_SCALE_mmToIU(self, mm)
1700
1701 def MilsToIU(self, mils):
1702 r"""MilsToIU(EDA_IU_SCALE self, int mils) -> int"""
1703 return _pcbnew.EDA_IU_SCALE_MilsToIU(self, mils)
1704
1705 def IUToMils(self, iu):
1706 r"""IUToMils(EDA_IU_SCALE self, int iu) -> int"""
1707 return _pcbnew.EDA_IU_SCALE_IUToMils(self, iu)
1708 __swig_destroy__ = _pcbnew.delete_EDA_IU_SCALE
1709
1710# Register EDA_IU_SCALE in _pcbnew:
1711_pcbnew.EDA_IU_SCALE_swigregister(EDA_IU_SCALE)
1712GERB_IU_PER_MM = cvar.GERB_IU_PER_MM
1713PCB_IU_PER_MM = cvar.PCB_IU_PER_MM
1714PL_IU_PER_MM = cvar.PL_IU_PER_MM
1715SCH_IU_PER_MM = cvar.SCH_IU_PER_MM
1716
1717EDA_DATA_TYPE_DISTANCE = _pcbnew.EDA_DATA_TYPE_DISTANCE
1718
1719EDA_DATA_TYPE_AREA = _pcbnew.EDA_DATA_TYPE_AREA
1720
1721EDA_DATA_TYPE_VOLUME = _pcbnew.EDA_DATA_TYPE_VOLUME
1722
1723EDA_DATA_TYPE_UNITLESS = _pcbnew.EDA_DATA_TYPE_UNITLESS
1724
1725EDA_UNITS_INCHES = _pcbnew.EDA_UNITS_INCHES
1726
1727EDA_UNITS_MILLIMETRES = _pcbnew.EDA_UNITS_MILLIMETRES
1728
1729EDA_UNITS_UNSCALED = _pcbnew.EDA_UNITS_UNSCALED
1730
1731EDA_UNITS_DEGREES = _pcbnew.EDA_UNITS_DEGREES
1732
1733EDA_UNITS_PERCENT = _pcbnew.EDA_UNITS_PERCENT
1734
1735EDA_UNITS_MILS = _pcbnew.EDA_UNITS_MILS
1736
1737EDA_UNITS_MICROMETRES = _pcbnew.EDA_UNITS_MICROMETRES
1738
1739EDA_UNITS_CENTIMETRES = _pcbnew.EDA_UNITS_CENTIMETRES
1740
1741
1743 r"""IsImperialUnit(EDA_UNITS aUnit) -> bool"""
1744 return _pcbnew.IsImperialUnit(aUnit)
1745
1746def IsMetricUnit(aUnit):
1747 r"""IsMetricUnit(EDA_UNITS aUnit) -> bool"""
1748 return _pcbnew.IsMetricUnit(aUnit)
1749
1750def Mm2mils(aVal):
1751 r"""Mm2mils(double aVal) -> int"""
1752 return _pcbnew.Mm2mils(aVal)
1753
1754def Mils2mm(aVal):
1755 r"""Mils2mm(double aVal) -> int"""
1756 return _pcbnew.Mils2mm(aVal)
1757
1758def FetchUnitsFromString(aTextValue, aUnits):
1759 r"""FetchUnitsFromString(wxString aTextValue, EDA_UNITS & aUnits) -> bool"""
1760 return _pcbnew.FetchUnitsFromString(aTextValue, aUnits)
1761
1762def GetText(*args):
1763 r"""GetText(EDA_UNITS aUnits, EDA_DATA_TYPE aType=DISTANCE) -> wxString"""
1764 return _pcbnew.GetText(*args)
1765
1766def GetLabel(*args):
1767 r"""GetLabel(EDA_UNITS aUnits, EDA_DATA_TYPE aType=DISTANCE) -> wxString"""
1768 return _pcbnew.GetLabel(*args)
1769
1770def FormatAngle(aAngle):
1771 r"""FormatAngle(EDA_ANGLE aAngle) -> string"""
1772 return _pcbnew.FormatAngle(aAngle)
1773
1775 r"""
1776 FormatInternalUnits(EDA_IU_SCALE aIuScale, int aValue) -> string
1777 FormatInternalUnits(EDA_IU_SCALE aIuScale, VECTOR2I aPoint) -> string
1778 """
1779 return _pcbnew.FormatInternalUnits(*args)
1780
1781def Mils2IU(aIuScale, mils):
1782 r"""Mils2IU(EDA_IU_SCALE aIuScale, int mils) -> int"""
1783 return _pcbnew.Mils2IU(aIuScale, mils)
1784
1785def ToUserUnit(aIuScale, aUnit, aValue):
1786 r"""ToUserUnit(EDA_IU_SCALE aIuScale, EDA_UNITS aUnit, double aValue) -> double"""
1787 return _pcbnew.ToUserUnit(aIuScale, aUnit, aValue)
1788
1790 r"""StringFromValue(EDA_IU_SCALE aIuScale, EDA_UNITS aUnits, double aValue, bool aAddUnitsText=False, EDA_DATA_TYPE aType=DISTANCE) -> wxString"""
1791 return _pcbnew.StringFromValue(*args)
1792
1794 r"""
1795 MessageTextFromValue(EDA_IU_SCALE aIuScale, EDA_UNITS aUnits, double aValue, bool aAddUnitsText=True, EDA_DATA_TYPE aType=DISTANCE) -> wxString
1796 MessageTextFromValue(EDA_IU_SCALE aIuScale, EDA_UNITS aUnits, int aValue, bool aAddUnitLabel=True, EDA_DATA_TYPE aType=DISTANCE) -> wxString
1797 MessageTextFromValue(EDA_IU_SCALE aIuScale, EDA_UNITS aUnits, long long aValue, bool aAddUnitLabel=True, EDA_DATA_TYPE aType=DISTANCE) -> wxString
1798 MessageTextFromValue(EDA_ANGLE aValue, bool aAddUnitLabel=True) -> wxString
1799 """
1800 return _pcbnew.MessageTextFromValue(*args)
1801
1802def MessageTextFromMinOptMax(aIuScale, aUnits, aValue):
1803 r"""MessageTextFromMinOptMax(EDA_IU_SCALE aIuScale, EDA_UNITS aUnits, MINOPTMAX< int > const & aValue) -> wxString"""
1804 return _pcbnew.MessageTextFromMinOptMax(aIuScale, aUnits, aValue)
1805
1806def FromUserUnit(aIuScale, aUnit, aValue):
1807 r"""FromUserUnit(EDA_IU_SCALE aIuScale, EDA_UNITS aUnit, double aValue) -> double"""
1808 return _pcbnew.FromUserUnit(aIuScale, aUnit, aValue)
1809
1811 r"""
1812 DoubleValueFromString(EDA_IU_SCALE aIuScale, EDA_UNITS aUnits, wxString aTextValue, EDA_DATA_TYPE aType=DISTANCE) -> double
1813 DoubleValueFromString(wxString aTextValue) -> double
1814 """
1815 return _pcbnew.DoubleValueFromString(*args)
1816
1818 r"""
1819 ValueFromString(EDA_IU_SCALE aIuScale, EDA_UNITS aUnits, wxString aTextValue, EDA_DATA_TYPE aType=DISTANCE) -> long long
1820 ValueFromString(wxString aTextValue) -> long long
1821 """
1822 return _pcbnew.ValueFromString(*args)
1823
1825 r"""SearchHelpFileFullPath(wxString aBaseName) -> wxString"""
1826 return _pcbnew.SearchHelpFileFullPath(aBaseName)
1827
1828def EnsureFileDirectoryExists(aTargetFullFileName, aBaseFilename, aReporter=None):
1829 r"""EnsureFileDirectoryExists(wxFileName * aTargetFullFileName, wxString aBaseFilename, REPORTER * aReporter=None) -> bool"""
1830 return _pcbnew.EnsureFileDirectoryExists(aTargetFullFileName, aBaseFilename, aReporter)
1831
1832def EnsureFileExtension(aFilename, aExtension):
1833 r"""EnsureFileExtension(wxString aFilename, wxString aExtension) -> wxString"""
1834 return _pcbnew.EnsureFileExtension(aFilename, aExtension)
1835
1836def ExpandEnvVarSubstitutions(aString, aProject):
1837 r"""ExpandEnvVarSubstitutions(wxString aString, PROJECT const * aProject) -> wxString"""
1838 return _pcbnew.ExpandEnvVarSubstitutions(aString, aProject)
1839FOR_ERC_DRC = _pcbnew.FOR_ERC_DRC
1840
1841
1843 r"""
1844 ExpandTextVars(wxString aSource, std::function< bool (wxString *) > const * aResolver, int aFlags=0) -> wxString
1845 ExpandTextVars(wxString aSource, PROJECT const * aProject, int aFlags=0) -> wxString
1846 """
1847 return _pcbnew.ExpandTextVars(*args)
1848
1849def GetTextVars(aSource):
1850 r"""GetTextVars(wxString aSource) -> wxString"""
1851 return _pcbnew.GetTextVars(aSource)
1852
1853def IsTextVar(aSource):
1854 r"""IsTextVar(wxString aSource) -> bool"""
1855 return _pcbnew.IsTextVar(aSource)
1856
1857def ResolveUriByEnvVars(aUri, aProject):
1858 r"""ResolveUriByEnvVars(wxString aUri, PROJECT const * aProject) -> wxString"""
1859 return _pcbnew.ResolveUriByEnvVars(aUri, aProject)
1860
1861def TimestampDir(aDirPath, aFilespec):
1862 r"""TimestampDir(wxString aDirPath, wxString aFilespec) -> long long"""
1863 return _pcbnew.TimestampDir(aDirPath, aFilespec)
1864
1866 r"""WarnUserIfOperatingSystemUnsupported() -> bool"""
1867 return _pcbnew.WarnUserIfOperatingSystemUnsupported()
1868
1869def StrPrintf(*args):
1870 r"""
1871 StrPrintf(string aResult, char const * aFormat) -> int
1872 StrPrintf(char const * format) -> string
1873 """
1874 return _pcbnew.StrPrintf(*args)
1875
1876def SafeReadFile(aFilePath, aReadType):
1877 r"""SafeReadFile(wxString aFilePath, wxString aReadType) -> wxString"""
1878 return _pcbnew.SafeReadFile(aFilePath, aReadType)
1879LINE_READER_LINE_DEFAULT_MAX = _pcbnew.LINE_READER_LINE_DEFAULT_MAX
1880
1881LINE_READER_LINE_INITIAL_SIZE = _pcbnew.LINE_READER_LINE_INITIAL_SIZE
1882
1884 r"""Proxy of C++ LINE_READER class."""
1885
1886 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
1887
1888 def __init__(self, *args, **kwargs):
1889 raise AttributeError("No constructor defined - class is abstract")
1890 __repr__ = _swig_repr
1891 __swig_destroy__ = _pcbnew.delete_LINE_READER
1892
1893 def ReadLine(self):
1894 r"""ReadLine(LINE_READER self) -> char *"""
1895 return _pcbnew.LINE_READER_ReadLine(self)
1896
1897 def GetSource(self):
1898 r"""GetSource(LINE_READER self) -> wxString"""
1899 return _pcbnew.LINE_READER_GetSource(self)
1900
1901 def Line(self):
1902 r"""Line(LINE_READER self) -> char *"""
1903 return _pcbnew.LINE_READER_Line(self)
1904
1905 def LineNumber(self):
1906 r"""LineNumber(LINE_READER self) -> unsigned int"""
1907 return _pcbnew.LINE_READER_LineNumber(self)
1908
1909 def Length(self):
1910 r"""Length(LINE_READER self) -> unsigned int"""
1911 return _pcbnew.LINE_READER_Length(self)
1912
1913# Register LINE_READER in _pcbnew:
1914_pcbnew.LINE_READER_swigregister(LINE_READER)
1915gerbIUScale = cvar.gerbIUScale
1916pcbIUScale = cvar.pcbIUScale
1917drawSheetIUScale = cvar.drawSheetIUScale
1918schIUScale = cvar.schIUScale
1919unityScale = cvar.unityScale
1920
1922 r"""Proxy of C++ FILE_LINE_READER class."""
1923
1924 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
1925 __repr__ = _swig_repr
1926
1927 def __init__(self, *args):
1928 r"""
1929 __init__(FILE_LINE_READER self, wxString aFileName, unsigned int aStartingLineNumber=0, unsigned int aMaxLineLength=1000000) -> FILE_LINE_READER
1930 __init__(FILE_LINE_READER self, FILE * aFile, wxString aFileName, bool doOwn=True, unsigned int aStartingLineNumber=0, unsigned int aMaxLineLength=1000000) -> FILE_LINE_READER
1931 """
1932 _pcbnew.FILE_LINE_READER_swiginit(self, _pcbnew.new_FILE_LINE_READER(*args))
1933 __swig_destroy__ = _pcbnew.delete_FILE_LINE_READER
1934
1935 def Rewind(self):
1936 r"""Rewind(FILE_LINE_READER self)"""
1937 return _pcbnew.FILE_LINE_READER_Rewind(self)
1938
1939 def FileLength(self):
1940 r"""FileLength(FILE_LINE_READER self) -> long"""
1941 return _pcbnew.FILE_LINE_READER_FileLength(self)
1942
1943 def CurPos(self):
1944 r"""CurPos(FILE_LINE_READER self) -> long"""
1945 return _pcbnew.FILE_LINE_READER_CurPos(self)
1946
1947# Register FILE_LINE_READER in _pcbnew:
1948_pcbnew.FILE_LINE_READER_swigregister(FILE_LINE_READER)
1950 r"""Proxy of C++ STRING_LINE_READER class."""
1951
1952 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
1953 __repr__ = _swig_repr
1954
1955 def __init__(self, *args):
1956 r"""
1957 __init__(STRING_LINE_READER self, string aString, wxString aSource) -> STRING_LINE_READER
1958 __init__(STRING_LINE_READER self, STRING_LINE_READER aStartingPoint) -> STRING_LINE_READER
1959 """
1960 _pcbnew.STRING_LINE_READER_swiginit(self, _pcbnew.new_STRING_LINE_READER(*args))
1961 __swig_destroy__ = _pcbnew.delete_STRING_LINE_READER
1962
1963# Register STRING_LINE_READER in _pcbnew:
1964_pcbnew.STRING_LINE_READER_swigregister(STRING_LINE_READER)
1966 r"""Proxy of C++ INPUTSTREAM_LINE_READER class."""
1967
1968 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
1969 __repr__ = _swig_repr
1970
1971 def __init__(self, aStream, aSource):
1972 r"""__init__(INPUTSTREAM_LINE_READER self, wxInputStream * aStream, wxString aSource) -> INPUTSTREAM_LINE_READER"""
1973 _pcbnew.INPUTSTREAM_LINE_READER_swiginit(self, _pcbnew.new_INPUTSTREAM_LINE_READER(aStream, aSource))
1974 __swig_destroy__ = _pcbnew.delete_INPUTSTREAM_LINE_READER
1975
1976# Register INPUTSTREAM_LINE_READER in _pcbnew:
1977_pcbnew.INPUTSTREAM_LINE_READER_swigregister(INPUTSTREAM_LINE_READER)
1978OUTPUTFMTBUFZ = _pcbnew.OUTPUTFMTBUFZ
1979
1981 r"""Proxy of C++ OUTPUTFORMATTER class."""
1982
1983 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
1984
1985 def __init__(self, *args, **kwargs):
1986 raise AttributeError("No constructor defined - class is abstract")
1987 __repr__ = _swig_repr
1988 __swig_destroy__ = _pcbnew.delete_OUTPUTFORMATTER
1989
1990 def Print(self, *args):
1991 r"""
1992 Print(OUTPUTFORMATTER self, int nestLevel, char const * fmt) -> int
1993 Print(OUTPUTFORMATTER self, char const * fmt) -> int
1994 """
1995 return _pcbnew.OUTPUTFORMATTER_Print(self, *args)
1996
1997 def GetQuoteChar(self, wrapee):
1998 r"""GetQuoteChar(OUTPUTFORMATTER self, char const * wrapee) -> char const *"""
1999 return _pcbnew.OUTPUTFORMATTER_GetQuoteChar(self, wrapee)
2000
2001 def Quotes(self, aWrapee):
2002 r"""Quotes(OUTPUTFORMATTER self, string aWrapee) -> string"""
2003 return _pcbnew.OUTPUTFORMATTER_Quotes(self, aWrapee)
2004
2005 def Quotew(self, aWrapee):
2006 r"""Quotew(OUTPUTFORMATTER self, wxString aWrapee) -> string"""
2007 return _pcbnew.OUTPUTFORMATTER_Quotew(self, aWrapee)
2008
2009 def Finish(self):
2010 r"""Finish(OUTPUTFORMATTER self) -> bool"""
2011 return _pcbnew.OUTPUTFORMATTER_Finish(self)
2012
2013# Register OUTPUTFORMATTER in _pcbnew:
2014_pcbnew.OUTPUTFORMATTER_swigregister(OUTPUTFORMATTER)
2016 r"""Proxy of C++ STRING_FORMATTER class."""
2017
2018 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
2019 __repr__ = _swig_repr
2020
2021 def __init__(self, *args):
2022 r"""__init__(STRING_FORMATTER self, int aReserve=500, char aQuoteChar='\"') -> STRING_FORMATTER"""
2023 _pcbnew.STRING_FORMATTER_swiginit(self, _pcbnew.new_STRING_FORMATTER(*args))
2024
2025 def Clear(self):
2026 r"""Clear(STRING_FORMATTER self)"""
2027 return _pcbnew.STRING_FORMATTER_Clear(self)
2028
2029 def StripUseless(self):
2030 r"""StripUseless(STRING_FORMATTER self)"""
2031 return _pcbnew.STRING_FORMATTER_StripUseless(self)
2032
2033 def GetString(self):
2034 r"""GetString(STRING_FORMATTER self) -> string"""
2035 return _pcbnew.STRING_FORMATTER_GetString(self)
2036 __swig_destroy__ = _pcbnew.delete_STRING_FORMATTER
2037
2038# Register STRING_FORMATTER in _pcbnew:
2039_pcbnew.STRING_FORMATTER_swigregister(STRING_FORMATTER)
2041 r"""Proxy of C++ FILE_OUTPUTFORMATTER class."""
2042
2043 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
2044 __repr__ = _swig_repr
2045
2046 def __init__(self, *args):
2047 r"""__init__(FILE_OUTPUTFORMATTER self, wxString aFileName, wxChar const * aMode=wxT( "wt" ), char aQuoteChar='\"') -> FILE_OUTPUTFORMATTER"""
2048 _pcbnew.FILE_OUTPUTFORMATTER_swiginit(self, _pcbnew.new_FILE_OUTPUTFORMATTER(*args))
2049 __swig_destroy__ = _pcbnew.delete_FILE_OUTPUTFORMATTER
2050
2051# Register FILE_OUTPUTFORMATTER in _pcbnew:
2052_pcbnew.FILE_OUTPUTFORMATTER_swigregister(FILE_OUTPUTFORMATTER)
2054 r"""Proxy of C++ PRETTIFIED_FILE_OUTPUTFORMATTER class."""
2055
2056 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
2057 __repr__ = _swig_repr
2058
2059 def __init__(self, *args):
2060 r"""__init__(PRETTIFIED_FILE_OUTPUTFORMATTER self, wxString aFileName, wxChar const * aMode=wxT( "wt" ), char aQuoteChar='\"') -> PRETTIFIED_FILE_OUTPUTFORMATTER"""
2061 _pcbnew.PRETTIFIED_FILE_OUTPUTFORMATTER_swiginit(self, _pcbnew.new_PRETTIFIED_FILE_OUTPUTFORMATTER(*args))
2062 __swig_destroy__ = _pcbnew.delete_PRETTIFIED_FILE_OUTPUTFORMATTER
2063
2064# Register PRETTIFIED_FILE_OUTPUTFORMATTER in _pcbnew:
2065_pcbnew.PRETTIFIED_FILE_OUTPUTFORMATTER_swigregister(PRETTIFIED_FILE_OUTPUTFORMATTER)
2067 r"""Proxy of C++ TITLE_BLOCK class."""
2068
2069 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
2070 __repr__ = _swig_repr
2071
2072 def __init__(self):
2073 r"""__init__(TITLE_BLOCK self) -> TITLE_BLOCK"""
2074 _pcbnew.TITLE_BLOCK_swiginit(self, _pcbnew.new_TITLE_BLOCK())
2075 __swig_destroy__ = _pcbnew.delete_TITLE_BLOCK
2076
2077 def SetTitle(self, aTitle):
2078 r"""SetTitle(TITLE_BLOCK self, wxString aTitle)"""
2079 return _pcbnew.TITLE_BLOCK_SetTitle(self, aTitle)
2080
2081 def GetTitle(self):
2082 r"""GetTitle(TITLE_BLOCK self) -> wxString"""
2083 return _pcbnew.TITLE_BLOCK_GetTitle(self)
2084
2085 def SetDate(self, aDate):
2086 r"""SetDate(TITLE_BLOCK self, wxString aDate)"""
2087 return _pcbnew.TITLE_BLOCK_SetDate(self, aDate)
2088
2089 def GetDate(self):
2090 r"""GetDate(TITLE_BLOCK self) -> wxString"""
2091 return _pcbnew.TITLE_BLOCK_GetDate(self)
2092
2093 def SetRevision(self, aRevision):
2094 r"""SetRevision(TITLE_BLOCK self, wxString aRevision)"""
2095 return _pcbnew.TITLE_BLOCK_SetRevision(self, aRevision)
2096
2097 def GetRevision(self):
2098 r"""GetRevision(TITLE_BLOCK self) -> wxString"""
2099 return _pcbnew.TITLE_BLOCK_GetRevision(self)
2100
2101 def SetCompany(self, aCompany):
2102 r"""SetCompany(TITLE_BLOCK self, wxString aCompany)"""
2103 return _pcbnew.TITLE_BLOCK_SetCompany(self, aCompany)
2104
2105 def GetCompany(self):
2106 r"""GetCompany(TITLE_BLOCK self) -> wxString"""
2107 return _pcbnew.TITLE_BLOCK_GetCompany(self)
2108
2109 def SetComment(self, aIdx, aComment):
2110 r"""SetComment(TITLE_BLOCK self, int aIdx, wxString aComment)"""
2111 return _pcbnew.TITLE_BLOCK_SetComment(self, aIdx, aComment)
2112
2113 def GetComment(self, aIdx):
2114 r"""GetComment(TITLE_BLOCK self, int aIdx) -> wxString"""
2115 return _pcbnew.TITLE_BLOCK_GetComment(self, aIdx)
2116
2117 def Clear(self):
2118 r"""Clear(TITLE_BLOCK self)"""
2119 return _pcbnew.TITLE_BLOCK_Clear(self)
2120
2121 @staticmethod
2123 r"""GetContextualTextVars(wxArrayString * aVars)"""
2124 return _pcbnew.TITLE_BLOCK_GetContextualTextVars(aVars)
2125
2126 def TextVarResolver(self, aToken, aProject, aFlags=0):
2127 r"""TextVarResolver(TITLE_BLOCK self, wxString aToken, PROJECT const * aProject, int aFlags=0) -> bool"""
2128 return _pcbnew.TITLE_BLOCK_TextVarResolver(self, aToken, aProject, aFlags)
2129
2130 def Format(self, aFormatter):
2131 r"""Format(TITLE_BLOCK self, OUTPUTFORMATTER aFormatter)"""
2132 return _pcbnew.TITLE_BLOCK_Format(self, aFormatter)
2133
2134 @staticmethod
2136 r"""GetCurrentDate() -> wxString"""
2137 return _pcbnew.TITLE_BLOCK_GetCurrentDate()
2138
2139# Register TITLE_BLOCK in _pcbnew:
2140_pcbnew.TITLE_BLOCK_swigregister(TITLE_BLOCK)
2141UNSPECIFIED_COLOR = _pcbnew.UNSPECIFIED_COLOR
2142
2143BLACK = _pcbnew.BLACK
2144
2145DARKDARKGRAY = _pcbnew.DARKDARKGRAY
2146
2147DARKGRAY = _pcbnew.DARKGRAY
2148
2149LIGHTGRAY = _pcbnew.LIGHTGRAY
2150
2151WHITE = _pcbnew.WHITE
2152
2153LIGHTYELLOW = _pcbnew.LIGHTYELLOW
2154
2155DARKBLUE = _pcbnew.DARKBLUE
2156
2157DARKGREEN = _pcbnew.DARKGREEN
2158
2159DARKCYAN = _pcbnew.DARKCYAN
2160
2161DARKRED = _pcbnew.DARKRED
2162
2163DARKMAGENTA = _pcbnew.DARKMAGENTA
2164
2165DARKBROWN = _pcbnew.DARKBROWN
2166
2167BLUE = _pcbnew.BLUE
2168
2169GREEN = _pcbnew.GREEN
2170
2171CYAN = _pcbnew.CYAN
2172
2173RED = _pcbnew.RED
2174
2175MAGENTA = _pcbnew.MAGENTA
2176
2177BROWN = _pcbnew.BROWN
2178
2179LIGHTBLUE = _pcbnew.LIGHTBLUE
2180
2181LIGHTGREEN = _pcbnew.LIGHTGREEN
2182
2183LIGHTCYAN = _pcbnew.LIGHTCYAN
2184
2185LIGHTRED = _pcbnew.LIGHTRED
2186
2187LIGHTMAGENTA = _pcbnew.LIGHTMAGENTA
2188
2189YELLOW = _pcbnew.YELLOW
2190
2191PUREBLUE = _pcbnew.PUREBLUE
2192
2193PUREGREEN = _pcbnew.PUREGREEN
2194
2195PURECYAN = _pcbnew.PURECYAN
2196
2197PURERED = _pcbnew.PURERED
2198
2199PUREMAGENTA = _pcbnew.PUREMAGENTA
2200
2201PUREYELLOW = _pcbnew.PUREYELLOW
2202
2203LIGHTERORANGE = _pcbnew.LIGHTERORANGE
2204
2205DARKORANGE = _pcbnew.DARKORANGE
2206
2207ORANGE = _pcbnew.ORANGE
2208
2209LIGHTORANGE = _pcbnew.LIGHTORANGE
2210
2211PUREORANGE = _pcbnew.PUREORANGE
2212
2213NBCOLORS = _pcbnew.NBCOLORS
2214
2215HIGHLIGHT_FLAG = _pcbnew.HIGHLIGHT_FLAG
2216
2217MASKCOLOR = _pcbnew.MASKCOLOR
2218
2220 r"""Proxy of C++ StructColors class."""
2221
2222 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
2223 __repr__ = _swig_repr
2224 m_Blue = property(_pcbnew.StructColors_m_Blue_get, _pcbnew.StructColors_m_Blue_set, doc=r"""m_Blue : unsigned char""")
2225 m_Green = property(_pcbnew.StructColors_m_Green_get, _pcbnew.StructColors_m_Green_set, doc=r"""m_Green : unsigned char""")
2226 m_Red = property(_pcbnew.StructColors_m_Red_get, _pcbnew.StructColors_m_Red_set, doc=r"""m_Red : unsigned char""")
2227 m_Numcolor = property(_pcbnew.StructColors_m_Numcolor_get, _pcbnew.StructColors_m_Numcolor_set, doc=r"""m_Numcolor : EDA_COLOR_T""")
2228 m_ColorName = property(_pcbnew.StructColors_m_ColorName_get, _pcbnew.StructColors_m_ColorName_set, doc=r"""m_ColorName : std::string""")
2229 m_LightColor = property(_pcbnew.StructColors_m_LightColor_get, _pcbnew.StructColors_m_LightColor_set, doc=r"""m_LightColor : EDA_COLOR_T""")
2230
2231 def __init__(self):
2232 r"""__init__(StructColors self) -> StructColors"""
2233 _pcbnew.StructColors_swiginit(self, _pcbnew.new_StructColors())
2234 __swig_destroy__ = _pcbnew.delete_StructColors
2235
2236# Register StructColors in _pcbnew:
2237_pcbnew.StructColors_swigregister(StructColors)
2238
2240 r"""colorRefs() -> StructColors"""
2241 return _pcbnew.colorRefs()
2243 r"""Proxy of C++ KIGFX::COLOR4D class."""
2244
2245 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
2246 __repr__ = _swig_repr
2247
2248 def FromCSSRGBA(self, aRed, aGreen, aBlue, aAlpha=1.0):
2249 r"""FromCSSRGBA(COLOR4D self, int aRed, int aGreen, int aBlue, double aAlpha=1.0) -> COLOR4D"""
2250 return _pcbnew.COLOR4D_FromCSSRGBA(self, aRed, aGreen, aBlue, aAlpha)
2251
2252 def __init__(self, *args):
2253 r"""
2254 __init__(COLOR4D self) -> COLOR4D
2255 __init__(COLOR4D self, double aRed, double aGreen, double aBlue, double aAlpha) -> COLOR4D
2256 __init__(COLOR4D self, EDA_COLOR_T aColor) -> COLOR4D
2257 __init__(COLOR4D self, wxString aColorStr) -> COLOR4D
2258 __init__(COLOR4D self, wxColour const & aColor) -> COLOR4D
2259 """
2260 _pcbnew.COLOR4D_swiginit(self, _pcbnew.new_COLOR4D(*args))
2261
2262 def SetFromWxString(self, aColorString):
2263 r"""SetFromWxString(COLOR4D self, wxString aColorString) -> bool"""
2264 return _pcbnew.COLOR4D_SetFromWxString(self, aColorString)
2265
2266 def ToCSSString(self):
2267 r"""ToCSSString(COLOR4D self) -> wxString"""
2268 return _pcbnew.COLOR4D_ToCSSString(self)
2269
2270 def SetFromHexString(self, aColorString):
2271 r"""SetFromHexString(COLOR4D self, wxString aColorString) -> bool"""
2272 return _pcbnew.COLOR4D_SetFromHexString(self, aColorString)
2273
2274 def ToHexString(self):
2275 r"""ToHexString(COLOR4D self) -> wxString"""
2276 return _pcbnew.COLOR4D_ToHexString(self)
2277
2278 def ToColour(self):
2279 r"""ToColour(COLOR4D self) -> wxColour"""
2280 return _pcbnew.COLOR4D_ToColour(self)
2281
2282 def LegacyMix(self, aColor):
2283 r"""LegacyMix(COLOR4D self, COLOR4D aColor) -> COLOR4D"""
2284 return _pcbnew.COLOR4D_LegacyMix(self, aColor)
2285
2286 def ToHSL(self, aOutHue, aOutSaturation, aOutLightness):
2287 r"""ToHSL(COLOR4D self, double & aOutHue, double & aOutSaturation, double & aOutLightness)"""
2288 return _pcbnew.COLOR4D_ToHSL(self, aOutHue, aOutSaturation, aOutLightness)
2289
2290 def FromHSL(self, aInHue, aInSaturation, aInLightness):
2291 r"""FromHSL(COLOR4D self, double aInHue, double aInSaturation, double aInLightness)"""
2292 return _pcbnew.COLOR4D_FromHSL(self, aInHue, aInSaturation, aInLightness)
2293
2294 def Brighten(self, aFactor):
2295 r"""Brighten(COLOR4D self, double aFactor) -> COLOR4D"""
2296 return _pcbnew.COLOR4D_Brighten(self, aFactor)
2297
2298 def Darken(self, aFactor):
2299 r"""Darken(COLOR4D self, double aFactor) -> COLOR4D"""
2300 return _pcbnew.COLOR4D_Darken(self, aFactor)
2301
2302 def Invert(self):
2303 r"""Invert(COLOR4D self) -> COLOR4D"""
2304 return _pcbnew.COLOR4D_Invert(self)
2305
2306 def Saturate(self, aFactor):
2307 r"""Saturate(COLOR4D self, double aFactor) -> COLOR4D"""
2308 return _pcbnew.COLOR4D_Saturate(self, aFactor)
2309
2310 def Desaturate(self):
2311 r"""Desaturate(COLOR4D self) -> COLOR4D"""
2312 return _pcbnew.COLOR4D_Desaturate(self)
2313
2314 def Brightened(self, aFactor):
2315 r"""Brightened(COLOR4D self, double aFactor) -> COLOR4D"""
2316 return _pcbnew.COLOR4D_Brightened(self, aFactor)
2317
2318 def Darkened(self, aFactor):
2319 r"""Darkened(COLOR4D self, double aFactor) -> COLOR4D"""
2320 return _pcbnew.COLOR4D_Darkened(self, aFactor)
2321
2322 def Mix(self, aColor, aFactor):
2323 r"""Mix(COLOR4D self, COLOR4D aColor, double aFactor) -> COLOR4D"""
2324 return _pcbnew.COLOR4D_Mix(self, aColor, aFactor)
2325
2326 def WithAlpha(self, aAlpha):
2327 r"""WithAlpha(COLOR4D self, double aAlpha) -> COLOR4D"""
2328 return _pcbnew.COLOR4D_WithAlpha(self, aAlpha)
2329
2330 def Inverted(self):
2331 r"""Inverted(COLOR4D self) -> COLOR4D"""
2332 return _pcbnew.COLOR4D_Inverted(self)
2333
2334 def GetBrightness(self):
2335 r"""GetBrightness(COLOR4D self) -> double"""
2336 return _pcbnew.COLOR4D_GetBrightness(self)
2337
2338 def ToHSV(self, aOutHue, aOutSaturation, aOutValue, aAlwaysDefineHue=False):
2339 r"""ToHSV(COLOR4D self, double & aOutHue, double & aOutSaturation, double & aOutValue, bool aAlwaysDefineHue=False)"""
2340 return _pcbnew.COLOR4D_ToHSV(self, aOutHue, aOutSaturation, aOutValue, aAlwaysDefineHue)
2341
2342 def FromHSV(self, aInH, aInS, aInV):
2343 r"""FromHSV(COLOR4D self, double aInH, double aInS, double aInV)"""
2344 return _pcbnew.COLOR4D_FromHSV(self, aInH, aInS, aInV)
2345
2346 def Distance(self, other):
2347 r"""Distance(COLOR4D self, COLOR4D other) -> double"""
2348 return _pcbnew.COLOR4D_Distance(self, other)
2349
2350 def Compare(self, aRhs):
2351 r"""Compare(COLOR4D self, COLOR4D aRhs) -> int"""
2352 return _pcbnew.COLOR4D_Compare(self, aRhs)
2353
2355 r"""RelativeLuminance(COLOR4D self) -> double"""
2356 return _pcbnew.COLOR4D_RelativeLuminance(self)
2357
2358 @staticmethod
2359 def ContrastRatio(aLeft, aRight):
2360 r"""ContrastRatio(COLOR4D aLeft, COLOR4D aRight) -> double"""
2361 return _pcbnew.COLOR4D_ContrastRatio(aLeft, aRight)
2362
2363 @staticmethod
2364 def FindNearestLegacyColor(aR, aG, aB):
2365 r"""FindNearestLegacyColor(int aR, int aG, int aB) -> EDA_COLOR_T"""
2366 return _pcbnew.COLOR4D_FindNearestLegacyColor(aR, aG, aB)
2367 r = property(_pcbnew.COLOR4D_r_get, _pcbnew.COLOR4D_r_set, doc=r"""r : double""")
2368 g = property(_pcbnew.COLOR4D_g_get, _pcbnew.COLOR4D_g_set, doc=r"""g : double""")
2369 b = property(_pcbnew.COLOR4D_b_get, _pcbnew.COLOR4D_b_set, doc=r"""b : double""")
2370 a = property(_pcbnew.COLOR4D_a_get, _pcbnew.COLOR4D_a_set, doc=r"""a : double""")
2371 __swig_destroy__ = _pcbnew.delete_COLOR4D
2372
2373# Register COLOR4D in _pcbnew:
2374_pcbnew.COLOR4D_swigregister(COLOR4D)
2375COLOR4D.UNSPECIFIED = _pcbnew.cvar.COLOR4D_UNSPECIFIED
2376COLOR4D.WHITE = _pcbnew.cvar.COLOR4D_WHITE
2377COLOR4D.BLACK = _pcbnew.cvar.COLOR4D_BLACK
2378COLOR4D.CLEAR = _pcbnew.cvar.COLOR4D_CLEAR
2379
2380
2381def __eq__(lhs, rhs):
2382 r"""__eq__(COLOR4D lhs, COLOR4D rhs) -> bool"""
2383 return _pcbnew.__eq__(lhs, rhs)
2384
2385def __ne__(lhs, rhs):
2386 r"""__ne__(COLOR4D lhs, COLOR4D rhs) -> bool"""
2387 return _pcbnew.__ne__(lhs, rhs)
2388
2389def __lt__(lhs, rhs):
2390 r"""__lt__(COLOR4D lhs, COLOR4D rhs) -> bool"""
2391 return _pcbnew.__lt__(lhs, rhs)
2392
2393def __lshift__(aStream, aColor):
2394 r"""__lshift__(std::ostream & aStream, COLOR4D aColor) -> std::ostream &"""
2395 return _pcbnew.__lshift__(aStream, aColor)
2397 r"""Proxy of C++ MARKER_BASE class."""
2398
2399 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
2400
2401 def __init__(self, *args, **kwargs):
2402 raise AttributeError("No constructor defined - class is abstract")
2403 __repr__ = _swig_repr
2404 MARKER_UNSPEC = _pcbnew.MARKER_BASE_MARKER_UNSPEC
2405
2406 MARKER_ERC = _pcbnew.MARKER_BASE_MARKER_ERC
2407
2408 MARKER_DRC = _pcbnew.MARKER_BASE_MARKER_DRC
2409
2410 MARKER_DRAWING_SHEET = _pcbnew.MARKER_BASE_MARKER_DRAWING_SHEET
2411
2412 MARKER_RATSNEST = _pcbnew.MARKER_BASE_MARKER_RATSNEST
2413
2414 MARKER_PARITY = _pcbnew.MARKER_BASE_MARKER_PARITY
2415
2416 MARKER_SIMUL = _pcbnew.MARKER_BASE_MARKER_SIMUL
2417
2418 __swig_destroy__ = _pcbnew.delete_MARKER_BASE
2419
2420 def MarkerScale(self):
2421 r"""MarkerScale(MARKER_BASE self) -> int"""
2422 return _pcbnew.MARKER_BASE_MarkerScale(self)
2423
2424 def SetMarkerScale(self, aScale):
2425 r"""SetMarkerScale(MARKER_BASE self, int aScale)"""
2426 return _pcbnew.MARKER_BASE_SetMarkerScale(self, aScale)
2427
2428 def ShapeToPolygon(self, aPolygon, aScale=-1):
2429 r"""ShapeToPolygon(MARKER_BASE self, SHAPE_LINE_CHAIN aPolygon, int aScale=-1)"""
2430 return _pcbnew.MARKER_BASE_ShapeToPolygon(self, aPolygon, aScale)
2431
2432 def PrintMarker(self, aSettings, aOffset):
2433 r"""PrintMarker(MARKER_BASE self, RENDER_SETTINGS const * aSettings, VECTOR2I aOffset)"""
2434 return _pcbnew.MARKER_BASE_PrintMarker(self, aSettings, aOffset)
2435
2436 def GetPos(self):
2437 r"""GetPos(MARKER_BASE self) -> VECTOR2I"""
2438 return _pcbnew.MARKER_BASE_GetPos(self)
2439
2440 def GetUUID(self):
2441 r"""GetUUID(MARKER_BASE self) -> KIID"""
2442 return _pcbnew.MARKER_BASE_GetUUID(self)
2443
2444 def SetMarkerType(self, aMarkerType):
2445 r"""SetMarkerType(MARKER_BASE self, enum MARKER_BASE::MARKER_T aMarkerType)"""
2446 return _pcbnew.MARKER_BASE_SetMarkerType(self, aMarkerType)
2447
2448 def GetMarkerType(self):
2449 r"""GetMarkerType(MARKER_BASE self) -> enum MARKER_BASE::MARKER_T"""
2450 return _pcbnew.MARKER_BASE_GetMarkerType(self)
2451
2452 def IsExcluded(self):
2453 r"""IsExcluded(MARKER_BASE self) -> bool"""
2454 return _pcbnew.MARKER_BASE_IsExcluded(self)
2455
2456 def SetExcluded(self, *args):
2457 r"""SetExcluded(MARKER_BASE self, bool aExcluded, wxString aComment=wxEmptyString)"""
2458 return _pcbnew.MARKER_BASE_SetExcluded(self, *args)
2459
2460 def GetComment(self):
2461 r"""GetComment(MARKER_BASE self) -> wxString"""
2462 return _pcbnew.MARKER_BASE_GetComment(self)
2463
2464 def GetSeverity(self):
2465 r"""GetSeverity(MARKER_BASE self) -> SEVERITY"""
2466 return _pcbnew.MARKER_BASE_GetSeverity(self)
2467
2468 def GetRCItem(self):
2469 r"""GetRCItem(MARKER_BASE self) -> std::shared_ptr< RC_ITEM >"""
2470 return _pcbnew.MARKER_BASE_GetRCItem(self)
2471
2472 def HitTestMarker(self, *args):
2473 r"""
2474 HitTestMarker(MARKER_BASE self, VECTOR2I aHitPosition, int aAccuracy) -> bool
2475 HitTestMarker(MARKER_BASE self, BOX2I aRect, bool aContained, int aAccuracy=0) -> bool
2476 """
2477 return _pcbnew.MARKER_BASE_HitTestMarker(self, *args)
2478
2480 r"""GetBoundingBoxMarker(MARKER_BASE self) -> BOX2I"""
2481 return _pcbnew.MARKER_BASE_GetBoundingBoxMarker(self)
2482 m_Pos = property(_pcbnew.MARKER_BASE_m_Pos_get, _pcbnew.MARKER_BASE_m_Pos_set, doc=r"""m_Pos : VECTOR2I""")
2483
2484# Register MARKER_BASE in _pcbnew:
2485_pcbnew.MARKER_BASE_swigregister(MARKER_BASE)
2486TEXT_MIN_SIZE_MM = _pcbnew.TEXT_MIN_SIZE_MM
2487
2488TEXT_MAX_SIZE_MM = _pcbnew.TEXT_MAX_SIZE_MM
2489
2490DEFAULT_SIZE_TEXT = _pcbnew.DEFAULT_SIZE_TEXT
2491
2493 r"""Proxy of C++ EDA_TEXT class."""
2494
2495 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
2496 __repr__ = _swig_repr
2497
2498 def __init__(self, *args):
2499 r"""
2500 __init__(EDA_TEXT self, EDA_IU_SCALE aIuScale, wxString aText=wxEmptyString) -> EDA_TEXT
2501 __init__(EDA_TEXT self, EDA_TEXT aText) -> EDA_TEXT
2502 """
2503 _pcbnew.EDA_TEXT_swiginit(self, _pcbnew.new_EDA_TEXT(*args))
2504 __swig_destroy__ = _pcbnew.delete_EDA_TEXT
2505
2506 def Serialize(self, aContainer):
2507 r"""Serialize(EDA_TEXT self, google::protobuf::Any & aContainer)"""
2508 return _pcbnew.EDA_TEXT_Serialize(self, aContainer)
2509
2510 def Deserialize(self, aContainer):
2511 r"""Deserialize(EDA_TEXT self, google::protobuf::Any const & aContainer) -> bool"""
2512 return _pcbnew.EDA_TEXT_Deserialize(self, aContainer)
2513
2514 def GetText(self):
2515 r"""GetText(EDA_TEXT self) -> wxString"""
2516 return _pcbnew.EDA_TEXT_GetText(self)
2517
2518 def GetShownText(self, aAllowExtraText, aDepth=0):
2519 r"""GetShownText(EDA_TEXT self, bool aAllowExtraText, int aDepth=0) -> wxString"""
2520 return _pcbnew.EDA_TEXT_GetShownText(self, aAllowExtraText, aDepth)
2521
2522 def HasTextVars(self):
2523 r"""HasTextVars(EDA_TEXT self) -> bool"""
2524 return _pcbnew.EDA_TEXT_HasTextVars(self)
2525
2526 def SetText(self, aText):
2527 r"""SetText(EDA_TEXT self, wxString aText)"""
2528 return _pcbnew.EDA_TEXT_SetText(self, aText)
2529
2530 def SetTextThickness(self, aWidth):
2531 r"""SetTextThickness(EDA_TEXT self, int aWidth)"""
2532 return _pcbnew.EDA_TEXT_SetTextThickness(self, aWidth)
2533
2535 r"""GetTextThickness(EDA_TEXT self) -> int"""
2536 return _pcbnew.EDA_TEXT_GetTextThickness(self)
2537
2538 def GetEffectiveTextPenWidth(self, aDefaultPenWidth=0):
2539 r"""GetEffectiveTextPenWidth(EDA_TEXT self, int aDefaultPenWidth=0) -> int"""
2540 return _pcbnew.EDA_TEXT_GetEffectiveTextPenWidth(self, aDefaultPenWidth)
2541
2542 def SetTextAngle(self, aAngle):
2543 r"""SetTextAngle(EDA_TEXT self, EDA_ANGLE aAngle)"""
2544 return _pcbnew.EDA_TEXT_SetTextAngle(self, aAngle)
2545
2546 def GetTextAngle(self):
2547 r"""GetTextAngle(EDA_TEXT self) -> EDA_ANGLE"""
2548 return _pcbnew.EDA_TEXT_GetTextAngle(self)
2549
2550 def SetTextAngleDegrees(self, aOrientation):
2551 r"""SetTextAngleDegrees(EDA_TEXT self, double aOrientation)"""
2552 return _pcbnew.EDA_TEXT_SetTextAngleDegrees(self, aOrientation)
2553
2555 r"""GetTextAngleDegrees(EDA_TEXT self) -> double"""
2556 return _pcbnew.EDA_TEXT_GetTextAngleDegrees(self)
2557
2558 def SetItalic(self, aItalic):
2559 r"""SetItalic(EDA_TEXT self, bool aItalic)"""
2560 return _pcbnew.EDA_TEXT_SetItalic(self, aItalic)
2561
2562 def SetItalicFlag(self, aItalic):
2563 r"""SetItalicFlag(EDA_TEXT self, bool aItalic)"""
2564 return _pcbnew.EDA_TEXT_SetItalicFlag(self, aItalic)
2565
2566 def IsItalic(self):
2567 r"""IsItalic(EDA_TEXT self) -> bool"""
2568 return _pcbnew.EDA_TEXT_IsItalic(self)
2569
2570 def SetBold(self, aBold):
2571 r"""SetBold(EDA_TEXT self, bool aBold)"""
2572 return _pcbnew.EDA_TEXT_SetBold(self, aBold)
2573
2574 def SetBoldFlag(self, aBold):
2575 r"""SetBoldFlag(EDA_TEXT self, bool aBold)"""
2576 return _pcbnew.EDA_TEXT_SetBoldFlag(self, aBold)
2577
2578 def IsBold(self):
2579 r"""IsBold(EDA_TEXT self) -> bool"""
2580 return _pcbnew.EDA_TEXT_IsBold(self)
2581
2582 def SetVisible(self, aVisible):
2583 r"""SetVisible(EDA_TEXT self, bool aVisible)"""
2584 return _pcbnew.EDA_TEXT_SetVisible(self, aVisible)
2585
2586 def IsVisible(self):
2587 r"""IsVisible(EDA_TEXT self) -> bool"""
2588 return _pcbnew.EDA_TEXT_IsVisible(self)
2589
2590 def SetMirrored(self, isMirrored):
2591 r"""SetMirrored(EDA_TEXT self, bool isMirrored)"""
2592 return _pcbnew.EDA_TEXT_SetMirrored(self, isMirrored)
2593
2594 def IsMirrored(self):
2595 r"""IsMirrored(EDA_TEXT self) -> bool"""
2596 return _pcbnew.EDA_TEXT_IsMirrored(self)
2597
2598 def SetMultilineAllowed(self, aAllow):
2599 r"""SetMultilineAllowed(EDA_TEXT self, bool aAllow)"""
2600 return _pcbnew.EDA_TEXT_SetMultilineAllowed(self, aAllow)
2601
2603 r"""IsMultilineAllowed(EDA_TEXT self) -> bool"""
2604 return _pcbnew.EDA_TEXT_IsMultilineAllowed(self)
2605
2606 def SetHorizJustify(self, aType):
2607 r"""SetHorizJustify(EDA_TEXT self, GR_TEXT_H_ALIGN_T aType)"""
2608 return _pcbnew.EDA_TEXT_SetHorizJustify(self, aType)
2609
2611 r"""GetHorizJustify(EDA_TEXT self) -> GR_TEXT_H_ALIGN_T"""
2612 return _pcbnew.EDA_TEXT_GetHorizJustify(self)
2613
2614 def SetVertJustify(self, aType):
2615 r"""SetVertJustify(EDA_TEXT self, GR_TEXT_V_ALIGN_T aType)"""
2616 return _pcbnew.EDA_TEXT_SetVertJustify(self, aType)
2617
2619 r"""GetVertJustify(EDA_TEXT self) -> GR_TEXT_V_ALIGN_T"""
2620 return _pcbnew.EDA_TEXT_GetVertJustify(self)
2621
2622 def SetKeepUpright(self, aKeepUpright):
2623 r"""SetKeepUpright(EDA_TEXT self, bool aKeepUpright)"""
2624 return _pcbnew.EDA_TEXT_SetKeepUpright(self, aKeepUpright)
2625
2626 def IsKeepUpright(self):
2627 r"""IsKeepUpright(EDA_TEXT self) -> bool"""
2628 return _pcbnew.EDA_TEXT_IsKeepUpright(self)
2629
2630 def FlipHJustify(self):
2631 r"""FlipHJustify(EDA_TEXT self)"""
2632 return _pcbnew.EDA_TEXT_FlipHJustify(self)
2633
2634 def SwapAttributes(self, aTradingPartner):
2635 r"""SwapAttributes(EDA_TEXT self, EDA_TEXT aTradingPartner)"""
2636 return _pcbnew.EDA_TEXT_SwapAttributes(self, aTradingPartner)
2637
2638 def SwapText(self, aTradingPartner):
2639 r"""SwapText(EDA_TEXT self, EDA_TEXT aTradingPartner)"""
2640 return _pcbnew.EDA_TEXT_SwapText(self, aTradingPartner)
2641
2642 def CopyText(self, aSrc):
2643 r"""CopyText(EDA_TEXT self, EDA_TEXT aSrc)"""
2644 return _pcbnew.EDA_TEXT_CopyText(self, aSrc)
2645
2646 def SetAttributes(self, *args):
2647 r"""
2648 SetAttributes(EDA_TEXT self, EDA_TEXT aSrc, bool aSetPosition=True)
2649 SetAttributes(EDA_TEXT self, TEXT_ATTRIBUTES aTextAttrs)
2650 """
2651 return _pcbnew.EDA_TEXT_SetAttributes(self, *args)
2652
2653 def GetAttributes(self):
2654 r"""GetAttributes(EDA_TEXT self) -> TEXT_ATTRIBUTES"""
2655 return _pcbnew.EDA_TEXT_GetAttributes(self)
2656
2657 def Replace(self, aSearchData):
2658 r"""Replace(EDA_TEXT self, EDA_SEARCH_DATA const & aSearchData) -> bool"""
2659 return _pcbnew.EDA_TEXT_Replace(self, aSearchData)
2660
2662 r"""IsDefaultFormatting(EDA_TEXT self) -> bool"""
2663 return _pcbnew.EDA_TEXT_IsDefaultFormatting(self)
2664
2665 def SetFont(self, aFont):
2666 r"""SetFont(EDA_TEXT self, KIFONT::FONT * aFont)"""
2667 return _pcbnew.EDA_TEXT_SetFont(self, aFont)
2668
2669 def GetFont(self):
2670 r"""GetFont(EDA_TEXT self) -> KIFONT::FONT *"""
2671 return _pcbnew.EDA_TEXT_GetFont(self)
2672
2673 def SetUnresolvedFontName(self, aFontName):
2674 r"""SetUnresolvedFontName(EDA_TEXT self, wxString aFontName)"""
2675 return _pcbnew.EDA_TEXT_SetUnresolvedFontName(self, aFontName)
2676
2677 def ResolveFont(self, aEmbeddedFonts):
2678 r"""ResolveFont(EDA_TEXT self, std::vector< wxString,std::allocator< wxString > > const * aEmbeddedFonts) -> bool"""
2679 return _pcbnew.EDA_TEXT_ResolveFont(self, aEmbeddedFonts)
2680
2681 def GetFontName(self):
2682 r"""GetFontName(EDA_TEXT self) -> wxString"""
2683 return _pcbnew.EDA_TEXT_GetFontName(self)
2684
2685 def SetFontIndex(self, aIdx):
2686 r"""SetFontIndex(EDA_TEXT self, int aIdx)"""
2687 return _pcbnew.EDA_TEXT_SetFontIndex(self, aIdx)
2688
2689 def GetFontIndex(self):
2690 r"""GetFontIndex(EDA_TEXT self) -> int"""
2691 return _pcbnew.EDA_TEXT_GetFontIndex(self)
2692
2693 def SetLineSpacing(self, aLineSpacing):
2694 r"""SetLineSpacing(EDA_TEXT self, double aLineSpacing)"""
2695 return _pcbnew.EDA_TEXT_SetLineSpacing(self, aLineSpacing)
2696
2698 r"""GetLineSpacing(EDA_TEXT self) -> double"""
2699 return _pcbnew.EDA_TEXT_GetLineSpacing(self)
2700
2701 def SetTextSize(self, aNewSize, aEnforceMinTextSize=True):
2702 r"""SetTextSize(EDA_TEXT self, VECTOR2I aNewSize, bool aEnforceMinTextSize=True)"""
2703 return _pcbnew.EDA_TEXT_SetTextSize(self, aNewSize, aEnforceMinTextSize)
2704
2705 def GetTextSize(self):
2706 r"""GetTextSize(EDA_TEXT self) -> VECTOR2I"""
2707 return _pcbnew.EDA_TEXT_GetTextSize(self)
2708
2709 def SetTextWidth(self, aWidth):
2710 r"""SetTextWidth(EDA_TEXT self, int aWidth)"""
2711 return _pcbnew.EDA_TEXT_SetTextWidth(self, aWidth)
2712
2713 def GetTextWidth(self):
2714 r"""GetTextWidth(EDA_TEXT self) -> int"""
2715 return _pcbnew.EDA_TEXT_GetTextWidth(self)
2716
2717 def SetTextHeight(self, aHeight):
2718 r"""SetTextHeight(EDA_TEXT self, int aHeight)"""
2719 return _pcbnew.EDA_TEXT_SetTextHeight(self, aHeight)
2720
2721 def GetTextHeight(self):
2722 r"""GetTextHeight(EDA_TEXT self) -> int"""
2723 return _pcbnew.EDA_TEXT_GetTextHeight(self)
2724
2725 def SetTextColor(self, aColor):
2726 r"""SetTextColor(EDA_TEXT self, COLOR4D aColor)"""
2727 return _pcbnew.EDA_TEXT_SetTextColor(self, aColor)
2728
2729 def GetTextColor(self):
2730 r"""GetTextColor(EDA_TEXT self) -> COLOR4D"""
2731 return _pcbnew.EDA_TEXT_GetTextColor(self)
2732
2733 def SetTextPos(self, aPoint):
2734 r"""SetTextPos(EDA_TEXT self, VECTOR2I aPoint)"""
2735 return _pcbnew.EDA_TEXT_SetTextPos(self, aPoint)
2736
2737 def GetTextPos(self):
2738 r"""GetTextPos(EDA_TEXT self) -> VECTOR2I"""
2739 return _pcbnew.EDA_TEXT_GetTextPos(self)
2740
2741 def SetTextX(self, aX):
2742 r"""SetTextX(EDA_TEXT self, int aX)"""
2743 return _pcbnew.EDA_TEXT_SetTextX(self, aX)
2744
2745 def SetTextY(self, aY):
2746 r"""SetTextY(EDA_TEXT self, int aY)"""
2747 return _pcbnew.EDA_TEXT_SetTextY(self, aY)
2748
2749 def Offset(self, aOffset):
2750 r"""Offset(EDA_TEXT self, VECTOR2I aOffset)"""
2751 return _pcbnew.EDA_TEXT_Offset(self, aOffset)
2752
2753 def Empty(self):
2754 r"""Empty(EDA_TEXT self)"""
2755 return _pcbnew.EDA_TEXT_Empty(self)
2756
2757 @staticmethod
2758 def MapHorizJustify(aHorizJustify):
2759 r"""MapHorizJustify(int aHorizJustify) -> GR_TEXT_H_ALIGN_T"""
2760 return _pcbnew.EDA_TEXT_MapHorizJustify(aHorizJustify)
2761
2762 @staticmethod
2763 def MapVertJustify(aVertJustify):
2764 r"""MapVertJustify(int aVertJustify) -> GR_TEXT_V_ALIGN_T"""
2765 return _pcbnew.EDA_TEXT_MapVertJustify(aVertJustify)
2766
2767 def Print(self, aSettings, aOffset, aColor, aDisplay_mode=FILLED):
2768 r"""Print(EDA_TEXT self, RENDER_SETTINGS const * aSettings, VECTOR2I aOffset, COLOR4D aColor, OUTLINE_MODE aDisplay_mode=FILLED)"""
2769 return _pcbnew.EDA_TEXT_Print(self, aSettings, aOffset, aColor, aDisplay_mode)
2770
2771 def GetEffectiveTextShape(self, *args):
2772 r"""GetEffectiveTextShape(EDA_TEXT self, bool aTriangulate=True, BOX2I aBBox=BOX2I(), EDA_ANGLE aAngle=ANGLE_0) -> std::shared_ptr< SHAPE_COMPOUND >"""
2773 return _pcbnew.EDA_TEXT_GetEffectiveTextShape(self, *args)
2774
2775 def TextHitTest(self, *args):
2776 r"""
2777 TextHitTest(EDA_TEXT self, VECTOR2I aPoint, int aAccuracy=0) -> bool
2778 TextHitTest(EDA_TEXT self, BOX2I aRect, bool aContains, int aAccuracy=0) -> bool
2779 """
2780 return _pcbnew.EDA_TEXT_TextHitTest(self, *args)
2781
2782 def GetTextBox(self, aLine=-1):
2783 r"""GetTextBox(EDA_TEXT self, int aLine=-1) -> BOX2I"""
2784 return _pcbnew.EDA_TEXT_GetTextBox(self, aLine)
2785
2786 def GetInterline(self):
2787 r"""GetInterline(EDA_TEXT self) -> int"""
2788 return _pcbnew.EDA_TEXT_GetInterline(self)
2789
2791 r"""GetTextStyleName(EDA_TEXT self) -> wxString"""
2792 return _pcbnew.EDA_TEXT_GetTextStyleName(self)
2793
2794 def GetLinePositions(self, aPositions, aLineCount):
2795 r"""GetLinePositions(EDA_TEXT self, VECTOR_VECTOR2I aPositions, int aLineCount)"""
2796 return _pcbnew.EDA_TEXT_GetLinePositions(self, aPositions, aLineCount)
2797
2798 def Levenshtein(self, aOther):
2799 r"""Levenshtein(EDA_TEXT self, EDA_TEXT aOther) -> double"""
2800 return _pcbnew.EDA_TEXT_Levenshtein(self, aOther)
2801
2802 def Similarity(self, aOther):
2803 r"""Similarity(EDA_TEXT self, EDA_TEXT aOther) -> double"""
2804 return _pcbnew.EDA_TEXT_Similarity(self, aOther)
2805
2806 def Format(self, aFormatter, aControlBits):
2807 r"""Format(EDA_TEXT self, OUTPUTFORMATTER aFormatter, int aControlBits)"""
2808 return _pcbnew.EDA_TEXT_Format(self, aFormatter, aControlBits)
2809
2811 r"""GetDrawRotation(EDA_TEXT self) -> EDA_ANGLE"""
2812 return _pcbnew.EDA_TEXT_GetDrawRotation(self)
2813
2814 def GetDrawPos(self):
2815 r"""GetDrawPos(EDA_TEXT self) -> VECTOR2I"""
2816 return _pcbnew.EDA_TEXT_GetDrawPos(self)
2817
2819 r"""ClearRenderCache(EDA_TEXT self)"""
2820 return _pcbnew.EDA_TEXT_ClearRenderCache(self)
2821
2823 r"""ClearBoundingBoxCache(EDA_TEXT self)"""
2824 return _pcbnew.EDA_TEXT_ClearBoundingBoxCache(self)
2825
2826 def GetRenderCache(self, *args):
2827 r"""GetRenderCache(EDA_TEXT self, KIFONT::FONT const * aFont, wxString forResolvedText, VECTOR2I aOffset={ 0, 0 }) -> std::vector< std::unique_ptr< KIFONT::GLYPH >,std::allocator< std::unique_ptr< KIFONT::GLYPH > > >"""
2828 return _pcbnew.EDA_TEXT_GetRenderCache(self, *args)
2829
2830 def SetupRenderCache(self, aResolvedText, aFont, aAngle, aOffset):
2831 r"""SetupRenderCache(EDA_TEXT self, wxString aResolvedText, KIFONT::FONT const * aFont, EDA_ANGLE aAngle, VECTOR2I aOffset)"""
2832 return _pcbnew.EDA_TEXT_SetupRenderCache(self, aResolvedText, aFont, aAngle, aOffset)
2833
2834 def AddRenderCacheGlyph(self, aPoly):
2835 r"""AddRenderCacheGlyph(EDA_TEXT self, SHAPE_POLY_SET aPoly)"""
2836 return _pcbnew.EDA_TEXT_AddRenderCacheGlyph(self, aPoly)
2837
2838 def Compare(self, aOther):
2839 r"""Compare(EDA_TEXT self, EDA_TEXT aOther) -> int"""
2840 return _pcbnew.EDA_TEXT_Compare(self, aOther)
2841
2842 def __eq__(self, aRhs):
2843 r"""__eq__(EDA_TEXT self, EDA_TEXT aRhs) -> bool"""
2844 return _pcbnew.EDA_TEXT___eq__(self, aRhs)
2845
2846 def __lt__(self, aRhs):
2847 r"""__lt__(EDA_TEXT self, EDA_TEXT aRhs) -> bool"""
2848 return _pcbnew.EDA_TEXT___lt__(self, aRhs)
2849
2850 def __gt__(self, aRhs):
2851 r"""__gt__(EDA_TEXT self, EDA_TEXT aRhs) -> bool"""
2852 return _pcbnew.EDA_TEXT___gt__(self, aRhs)
2853
2854 def HasHyperlink(self):
2855 r"""HasHyperlink(EDA_TEXT self) -> bool"""
2856 return _pcbnew.EDA_TEXT_HasHyperlink(self)
2857
2858 def GetHyperlink(self):
2859 r"""GetHyperlink(EDA_TEXT self) -> wxString"""
2860 return _pcbnew.EDA_TEXT_GetHyperlink(self)
2861
2862 def SetHyperlink(self, aLink):
2863 r"""SetHyperlink(EDA_TEXT self, wxString aLink)"""
2864 return _pcbnew.EDA_TEXT_SetHyperlink(self, aLink)
2865
2867 r"""RemoveHyperlink(EDA_TEXT self)"""
2868 return _pcbnew.EDA_TEXT_RemoveHyperlink(self)
2869
2870 @staticmethod
2872 r"""ValidateHyperlink(wxString aURL) -> bool"""
2873 return _pcbnew.EDA_TEXT_ValidateHyperlink(aURL)
2874
2875 @staticmethod
2876 def IsGotoPageHref(aHref, aDestination=None):
2877 r"""IsGotoPageHref(wxString aHref, wxString aDestination=None) -> bool"""
2878 return _pcbnew.EDA_TEXT_IsGotoPageHref(aHref, aDestination)
2879
2880 @staticmethod
2881 def GotoPageHref(aDestination):
2882 r"""GotoPageHref(wxString aDestination) -> wxString"""
2883 return _pcbnew.EDA_TEXT_GotoPageHref(aDestination)
2884
2885# Register EDA_TEXT in _pcbnew:
2886_pcbnew.EDA_TEXT_swigregister(EDA_TEXT)
2887
2889 r"""GetBuildVersion() -> wxString"""
2890 return _pcbnew.GetBuildVersion()
2891
2893 r"""GetBaseVersion() -> wxString"""
2894 return _pcbnew.GetBaseVersion()
2895
2897 r"""GetPlatformGetBitnessName() -> wxString"""
2898 return _pcbnew.GetPlatformGetBitnessName()
2899
2901 r"""GetSemanticVersion() -> wxString"""
2902 return _pcbnew.GetSemanticVersion()
2903
2905 r"""GetMajorMinorVersion() -> wxString"""
2906 return _pcbnew.GetMajorMinorVersion()
2907
2909 r"""GetMajorMinorPatchVersion() -> wxString"""
2910 return _pcbnew.GetMajorMinorPatchVersion()
2911
2913 r"""GetBuildDate() -> wxString"""
2914 return _pcbnew.GetBuildDate()
2915
2917 r"""GetCommitHash() -> wxString"""
2918 return _pcbnew.GetCommitHash()
2919
2921 r"""GetMajorMinorPatchTuple() -> std::tuple< int,int,int > const &"""
2922 return _pcbnew.GetMajorMinorPatchTuple()
2923
2925 r"""IsNightlyVersion() -> bool"""
2926 return _pcbnew.IsNightlyVersion()
2927
2928def SetOpenGLInfo(aRenderer, aVendor, aVersion):
2929 r"""SetOpenGLInfo(char const * aRenderer, char const * aVendor, char const * aVersion)"""
2930 return _pcbnew.SetOpenGLInfo(aRenderer, aVendor, aVersion)
2931
2932def GetVersionInfoData(aTitle, aHtml=False, aBrief=False):
2933 r"""GetVersionInfoData(wxString aTitle, bool aHtml=False, bool aBrief=False) -> wxString"""
2934 return _pcbnew.GetVersionInfoData(aTitle, aHtml, aBrief)
2935UNDEFINED_LAYER = _pcbnew.UNDEFINED_LAYER
2936
2937UNSELECTED_LAYER = _pcbnew.UNSELECTED_LAYER
2938
2939F_Cu = _pcbnew.F_Cu
2940
2941B_Cu = _pcbnew.B_Cu
2942
2943In1_Cu = _pcbnew.In1_Cu
2944
2945In2_Cu = _pcbnew.In2_Cu
2946
2947In3_Cu = _pcbnew.In3_Cu
2948
2949In4_Cu = _pcbnew.In4_Cu
2950
2951In5_Cu = _pcbnew.In5_Cu
2952
2953In6_Cu = _pcbnew.In6_Cu
2954
2955In7_Cu = _pcbnew.In7_Cu
2956
2957In8_Cu = _pcbnew.In8_Cu
2958
2959In9_Cu = _pcbnew.In9_Cu
2960
2961In10_Cu = _pcbnew.In10_Cu
2962
2963In11_Cu = _pcbnew.In11_Cu
2964
2965In12_Cu = _pcbnew.In12_Cu
2966
2967In13_Cu = _pcbnew.In13_Cu
2968
2969In14_Cu = _pcbnew.In14_Cu
2970
2971In15_Cu = _pcbnew.In15_Cu
2972
2973In16_Cu = _pcbnew.In16_Cu
2974
2975In17_Cu = _pcbnew.In17_Cu
2976
2977In18_Cu = _pcbnew.In18_Cu
2978
2979In19_Cu = _pcbnew.In19_Cu
2980
2981In20_Cu = _pcbnew.In20_Cu
2982
2983In21_Cu = _pcbnew.In21_Cu
2984
2985In22_Cu = _pcbnew.In22_Cu
2986
2987In23_Cu = _pcbnew.In23_Cu
2988
2989In24_Cu = _pcbnew.In24_Cu
2990
2991In25_Cu = _pcbnew.In25_Cu
2992
2993In26_Cu = _pcbnew.In26_Cu
2994
2995In27_Cu = _pcbnew.In27_Cu
2996
2997In28_Cu = _pcbnew.In28_Cu
2998
2999In29_Cu = _pcbnew.In29_Cu
3000
3001In30_Cu = _pcbnew.In30_Cu
3002
3003F_Mask = _pcbnew.F_Mask
3004
3005B_Mask = _pcbnew.B_Mask
3006
3007F_SilkS = _pcbnew.F_SilkS
3008
3009B_SilkS = _pcbnew.B_SilkS
3010
3011F_Adhes = _pcbnew.F_Adhes
3012
3013B_Adhes = _pcbnew.B_Adhes
3014
3015F_Paste = _pcbnew.F_Paste
3016
3017B_Paste = _pcbnew.B_Paste
3018
3019Dwgs_User = _pcbnew.Dwgs_User
3020
3021Cmts_User = _pcbnew.Cmts_User
3022
3023Eco1_User = _pcbnew.Eco1_User
3024
3025Eco2_User = _pcbnew.Eco2_User
3026
3027Edge_Cuts = _pcbnew.Edge_Cuts
3028
3029Margin = _pcbnew.Margin
3030
3031B_CrtYd = _pcbnew.B_CrtYd
3032
3033F_CrtYd = _pcbnew.F_CrtYd
3034
3035B_Fab = _pcbnew.B_Fab
3036
3037F_Fab = _pcbnew.F_Fab
3038
3039Rescue = _pcbnew.Rescue
3040
3041User_1 = _pcbnew.User_1
3042
3043User_2 = _pcbnew.User_2
3044
3045User_3 = _pcbnew.User_3
3046
3047User_4 = _pcbnew.User_4
3048
3049User_5 = _pcbnew.User_5
3050
3051User_6 = _pcbnew.User_6
3052
3053User_7 = _pcbnew.User_7
3054
3055User_8 = _pcbnew.User_8
3056
3057User_9 = _pcbnew.User_9
3058
3059User_10 = _pcbnew.User_10
3060
3061User_11 = _pcbnew.User_11
3062
3063User_12 = _pcbnew.User_12
3064
3065User_13 = _pcbnew.User_13
3066
3067User_14 = _pcbnew.User_14
3068
3069User_15 = _pcbnew.User_15
3070
3071User_16 = _pcbnew.User_16
3072
3073User_17 = _pcbnew.User_17
3074
3075User_18 = _pcbnew.User_18
3076
3077User_19 = _pcbnew.User_19
3078
3079User_20 = _pcbnew.User_20
3080
3081User_21 = _pcbnew.User_21
3082
3083User_22 = _pcbnew.User_22
3084
3085User_23 = _pcbnew.User_23
3086
3087User_24 = _pcbnew.User_24
3088
3089User_25 = _pcbnew.User_25
3090
3091User_26 = _pcbnew.User_26
3092
3093User_27 = _pcbnew.User_27
3094
3095User_28 = _pcbnew.User_28
3096
3097User_29 = _pcbnew.User_29
3098
3099User_30 = _pcbnew.User_30
3100
3101User_31 = _pcbnew.User_31
3102
3103User_32 = _pcbnew.User_32
3104
3105User_33 = _pcbnew.User_33
3106
3107User_34 = _pcbnew.User_34
3108
3109User_35 = _pcbnew.User_35
3110
3111User_36 = _pcbnew.User_36
3112
3113User_37 = _pcbnew.User_37
3114
3115User_38 = _pcbnew.User_38
3116
3117User_39 = _pcbnew.User_39
3118
3119User_40 = _pcbnew.User_40
3120
3121User_41 = _pcbnew.User_41
3122
3123User_42 = _pcbnew.User_42
3124
3125User_43 = _pcbnew.User_43
3126
3127User_44 = _pcbnew.User_44
3128
3129User_45 = _pcbnew.User_45
3130
3131PCB_LAYER_ID_COUNT = _pcbnew.PCB_LAYER_ID_COUNT
3132
3133MAX_CU_LAYERS = _pcbnew.MAX_CU_LAYERS
3134
3135MAX_USER_DEFINED_LAYERS = _pcbnew.MAX_USER_DEFINED_LAYERS
3136
3137FLASHING_DEFAULT = _pcbnew.FLASHING_DEFAULT
3138
3139FLASHING_ALWAYS_FLASHED = _pcbnew.FLASHING_ALWAYS_FLASHED
3140
3141FLASHING_NEVER_FLASHED = _pcbnew.FLASHING_NEVER_FLASHED
3142
3143NETNAMES_LAYER_ID_START = _pcbnew.NETNAMES_LAYER_ID_START
3144
3145NETNAMES_LAYER_ID_RESERVED = _pcbnew.NETNAMES_LAYER_ID_RESERVED
3146
3147LAYER_PAD_FR_NETNAMES = _pcbnew.LAYER_PAD_FR_NETNAMES
3148
3149LAYER_PAD_BK_NETNAMES = _pcbnew.LAYER_PAD_BK_NETNAMES
3150
3151LAYER_PAD_NETNAMES = _pcbnew.LAYER_PAD_NETNAMES
3152
3153LAYER_VIA_NETNAMES = _pcbnew.LAYER_VIA_NETNAMES
3154
3155NETNAMES_LAYER_ID_END = _pcbnew.NETNAMES_LAYER_ID_END
3156
3157GAL_UI_LAYER_COUNT = _pcbnew.GAL_UI_LAYER_COUNT
3158
3159GAL_LAYER_ID_START = _pcbnew.GAL_LAYER_ID_START
3160
3161LAYER_VIAS = _pcbnew.LAYER_VIAS
3162
3163LAYER_VIA_MICROVIA = _pcbnew.LAYER_VIA_MICROVIA
3164
3165LAYER_VIA_BBLIND = _pcbnew.LAYER_VIA_BBLIND
3166
3167LAYER_VIA_THROUGH = _pcbnew.LAYER_VIA_THROUGH
3168
3169LAYER_NON_PLATEDHOLES = _pcbnew.LAYER_NON_PLATEDHOLES
3170
3171LAYER_FP_TEXT = _pcbnew.LAYER_FP_TEXT
3172
3173LAYER_ANCHOR = _pcbnew.LAYER_ANCHOR
3174
3175LAYER_RATSNEST = _pcbnew.LAYER_RATSNEST
3176
3177LAYER_GRID = _pcbnew.LAYER_GRID
3178
3179LAYER_GRID_AXES = _pcbnew.LAYER_GRID_AXES
3180
3181LAYER_FOOTPRINTS_FR = _pcbnew.LAYER_FOOTPRINTS_FR
3182
3183LAYER_FOOTPRINTS_BK = _pcbnew.LAYER_FOOTPRINTS_BK
3184
3185LAYER_FP_VALUES = _pcbnew.LAYER_FP_VALUES
3186
3187LAYER_FP_REFERENCES = _pcbnew.LAYER_FP_REFERENCES
3188
3189LAYER_TRACKS = _pcbnew.LAYER_TRACKS
3190
3191LAYER_PAD_PLATEDHOLES = _pcbnew.LAYER_PAD_PLATEDHOLES
3192
3193LAYER_VIA_HOLES = _pcbnew.LAYER_VIA_HOLES
3194
3195LAYER_DRC_ERROR = _pcbnew.LAYER_DRC_ERROR
3196
3197LAYER_DRAWINGSHEET = _pcbnew.LAYER_DRAWINGSHEET
3198
3199LAYER_GP_OVERLAY = _pcbnew.LAYER_GP_OVERLAY
3200
3201LAYER_SELECT_OVERLAY = _pcbnew.LAYER_SELECT_OVERLAY
3202
3203LAYER_PCB_BACKGROUND = _pcbnew.LAYER_PCB_BACKGROUND
3204
3205LAYER_CURSOR = _pcbnew.LAYER_CURSOR
3206
3207LAYER_AUX_ITEMS = _pcbnew.LAYER_AUX_ITEMS
3208
3209LAYER_DRAW_BITMAPS = _pcbnew.LAYER_DRAW_BITMAPS
3210
3211GAL_LAYER_ID_BITMASK_END = _pcbnew.GAL_LAYER_ID_BITMASK_END
3212
3213LAYER_PADS = _pcbnew.LAYER_PADS
3214
3215LAYER_ZONES = _pcbnew.LAYER_ZONES
3216
3217LAYER_PAD_HOLEWALLS = _pcbnew.LAYER_PAD_HOLEWALLS
3218
3219LAYER_VIA_HOLEWALLS = _pcbnew.LAYER_VIA_HOLEWALLS
3220
3221LAYER_DRC_WARNING = _pcbnew.LAYER_DRC_WARNING
3222
3223LAYER_DRC_EXCLUSION = _pcbnew.LAYER_DRC_EXCLUSION
3224
3225LAYER_MARKER_SHADOWS = _pcbnew.LAYER_MARKER_SHADOWS
3226
3227LAYER_LOCKED_ITEM_SHADOW = _pcbnew.LAYER_LOCKED_ITEM_SHADOW
3228
3229LAYER_CONFLICTS_SHADOW = _pcbnew.LAYER_CONFLICTS_SHADOW
3230
3231LAYER_SHAPES = _pcbnew.LAYER_SHAPES
3232
3233LAYER_DRC_SHAPE1 = _pcbnew.LAYER_DRC_SHAPE1
3234
3235LAYER_DRC_SHAPE2 = _pcbnew.LAYER_DRC_SHAPE2
3236
3237LAYER_DRAWINGSHEET_PAGE1 = _pcbnew.LAYER_DRAWINGSHEET_PAGE1
3238
3239LAYER_DRAWINGSHEET_PAGEn = _pcbnew.LAYER_DRAWINGSHEET_PAGEn
3240
3241LAYER_PAGE_LIMITS = _pcbnew.LAYER_PAGE_LIMITS
3242
3243LAYER_ZONE_START = _pcbnew.LAYER_ZONE_START
3244
3245LAYER_ZONE_END = _pcbnew.LAYER_ZONE_END
3246
3247LAYER_PAD_COPPER_START = _pcbnew.LAYER_PAD_COPPER_START
3248
3249LAYER_PAD_COPPER_END = _pcbnew.LAYER_PAD_COPPER_END
3250
3251LAYER_VIA_COPPER_START = _pcbnew.LAYER_VIA_COPPER_START
3252
3253LAYER_VIA_COPPER_END = _pcbnew.LAYER_VIA_COPPER_END
3254
3255LAYER_CLEARANCE_START = _pcbnew.LAYER_CLEARANCE_START
3256
3257LAYER_CLEARANCE_END = _pcbnew.LAYER_CLEARANCE_END
3258
3259LAYER_BITMAP_START = _pcbnew.LAYER_BITMAP_START
3260
3261LAYER_BITMAP_END = _pcbnew.LAYER_BITMAP_END
3262
3263LAYER_UI_START = _pcbnew.LAYER_UI_START
3264
3265LAYER_UI_END = _pcbnew.LAYER_UI_END
3266
3267GAL_LAYER_ID_END = _pcbnew.GAL_LAYER_ID_END
3268
3269
3270def ToGalLayer(aInteger):
3271 r"""ToGalLayer(int aInteger) -> GAL_LAYER_ID"""
3272 return _pcbnew.ToGalLayer(aInteger)
3274 r"""Proxy of C++ GAL_SET class."""
3275
3276 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
3277 __repr__ = _swig_repr
3278
3279 def __init__(self, *args):
3280 r"""
3281 __init__(GAL_SET self) -> GAL_SET
3282 __init__(GAL_SET self, GAL_SET aOther) -> GAL_SET
3283 __init__(GAL_SET self, GAL_LAYER_ID const * aArray, unsigned int aCount) -> GAL_SET
3284 """
3285 _pcbnew.GAL_SET_swiginit(self, _pcbnew.new_GAL_SET(*args))
3286
3287 def set(self, *args):
3288 r"""
3289 set(GAL_SET self) -> GAL_SET
3290 set(GAL_SET self, int aPos, bool aVal=True) -> GAL_SET
3291 set(GAL_SET self, GAL_LAYER_ID aPos, bool aVal=True) -> GAL_SET
3292 """
3293 return _pcbnew.GAL_SET_set(self, *args)
3294
3295 def Contains(self, aPos):
3296 r"""Contains(GAL_SET self, GAL_LAYER_ID aPos) -> bool"""
3297 return _pcbnew.GAL_SET_Contains(self, aPos)
3298
3299 def Seq(self):
3300 r"""Seq(GAL_SET self) -> std::vector< GAL_LAYER_ID,std::allocator< GAL_LAYER_ID > >"""
3301 return _pcbnew.GAL_SET_Seq(self)
3302
3303 @staticmethod
3305 r"""DefaultVisible() -> GAL_SET"""
3306 return _pcbnew.GAL_SET_DefaultVisible()
3307 __swig_destroy__ = _pcbnew.delete_GAL_SET
3308
3309# Register GAL_SET in _pcbnew:
3310_pcbnew.GAL_SET_swigregister(GAL_SET)
3311PCBNEW_LAYER_ID_START = cvar.PCBNEW_LAYER_ID_START
3312GAL_LAYER_ID_COUNT = cvar.GAL_LAYER_ID_COUNT
3313
3314SCH_LAYER_ID_START = _pcbnew.SCH_LAYER_ID_START
3315
3316LAYER_WIRE = _pcbnew.LAYER_WIRE
3317
3318LAYER_BUS = _pcbnew.LAYER_BUS
3319
3320LAYER_JUNCTION = _pcbnew.LAYER_JUNCTION
3321
3322LAYER_LOCLABEL = _pcbnew.LAYER_LOCLABEL
3323
3324LAYER_GLOBLABEL = _pcbnew.LAYER_GLOBLABEL
3325
3326LAYER_HIERLABEL = _pcbnew.LAYER_HIERLABEL
3327
3328LAYER_PINNUM = _pcbnew.LAYER_PINNUM
3329
3330LAYER_PINNAM = _pcbnew.LAYER_PINNAM
3331
3332LAYER_REFERENCEPART = _pcbnew.LAYER_REFERENCEPART
3333
3334LAYER_VALUEPART = _pcbnew.LAYER_VALUEPART
3335
3336LAYER_FIELDS = _pcbnew.LAYER_FIELDS
3337
3338LAYER_INTERSHEET_REFS = _pcbnew.LAYER_INTERSHEET_REFS
3339
3340LAYER_NETCLASS_REFS = _pcbnew.LAYER_NETCLASS_REFS
3341
3342LAYER_RULE_AREAS = _pcbnew.LAYER_RULE_AREAS
3343
3344LAYER_DEVICE = _pcbnew.LAYER_DEVICE
3345
3346LAYER_NOTES = _pcbnew.LAYER_NOTES
3347
3348LAYER_PRIVATE_NOTES = _pcbnew.LAYER_PRIVATE_NOTES
3349
3350LAYER_NOTES_BACKGROUND = _pcbnew.LAYER_NOTES_BACKGROUND
3351
3352LAYER_PIN = _pcbnew.LAYER_PIN
3353
3354LAYER_SHEET = _pcbnew.LAYER_SHEET
3355
3356LAYER_SHEETNAME = _pcbnew.LAYER_SHEETNAME
3357
3358LAYER_SHEETFILENAME = _pcbnew.LAYER_SHEETFILENAME
3359
3360LAYER_SHEETFIELDS = _pcbnew.LAYER_SHEETFIELDS
3361
3362LAYER_SHEETLABEL = _pcbnew.LAYER_SHEETLABEL
3363
3364LAYER_NOCONNECT = _pcbnew.LAYER_NOCONNECT
3365
3366LAYER_DANGLING = _pcbnew.LAYER_DANGLING
3367
3368LAYER_DNP_MARKER = _pcbnew.LAYER_DNP_MARKER
3369
3370LAYER_ERC_WARN = _pcbnew.LAYER_ERC_WARN
3371
3372LAYER_ERC_ERR = _pcbnew.LAYER_ERC_ERR
3373
3374LAYER_ERC_EXCLUSION = _pcbnew.LAYER_ERC_EXCLUSION
3375
3376LAYER_EXCLUDED_FROM_SIM = _pcbnew.LAYER_EXCLUDED_FROM_SIM
3377
3378LAYER_SHAPES_BACKGROUND = _pcbnew.LAYER_SHAPES_BACKGROUND
3379
3380LAYER_DEVICE_BACKGROUND = _pcbnew.LAYER_DEVICE_BACKGROUND
3381
3382LAYER_SHEET_BACKGROUND = _pcbnew.LAYER_SHEET_BACKGROUND
3383
3384LAYER_SCHEMATIC_GRID = _pcbnew.LAYER_SCHEMATIC_GRID
3385
3386LAYER_SCHEMATIC_GRID_AXES = _pcbnew.LAYER_SCHEMATIC_GRID_AXES
3387
3388LAYER_SCHEMATIC_BACKGROUND = _pcbnew.LAYER_SCHEMATIC_BACKGROUND
3389
3390LAYER_SCHEMATIC_CURSOR = _pcbnew.LAYER_SCHEMATIC_CURSOR
3391
3392LAYER_HOVERED = _pcbnew.LAYER_HOVERED
3393
3394LAYER_BRIGHTENED = _pcbnew.LAYER_BRIGHTENED
3395
3396LAYER_HIDDEN = _pcbnew.LAYER_HIDDEN
3397
3398LAYER_NET_COLOR_HIGHLIGHT = _pcbnew.LAYER_NET_COLOR_HIGHLIGHT
3399
3400LAYER_SELECTION_SHADOWS = _pcbnew.LAYER_SELECTION_SHADOWS
3401
3402LAYER_SCHEMATIC_DRAWINGSHEET = _pcbnew.LAYER_SCHEMATIC_DRAWINGSHEET
3403
3404LAYER_SCHEMATIC_PAGE_LIMITS = _pcbnew.LAYER_SCHEMATIC_PAGE_LIMITS
3405
3406LAYER_BUS_JUNCTION = _pcbnew.LAYER_BUS_JUNCTION
3407
3408LAYER_SCHEMATIC_AUX_ITEMS = _pcbnew.LAYER_SCHEMATIC_AUX_ITEMS
3409
3410LAYER_SCHEMATIC_ANCHOR = _pcbnew.LAYER_SCHEMATIC_ANCHOR
3411
3412LAYER_OP_VOLTAGES = _pcbnew.LAYER_OP_VOLTAGES
3413
3414LAYER_OP_CURRENTS = _pcbnew.LAYER_OP_CURRENTS
3415
3416SCH_LAYER_ID_END = _pcbnew.SCH_LAYER_ID_END
3417
3418GERBVIEW_LAYER_ID_START = _pcbnew.GERBVIEW_LAYER_ID_START
3419
3420GERBVIEW_LAYER_ID_RESERVED = _pcbnew.GERBVIEW_LAYER_ID_RESERVED
3421
3422LAYER_DCODES = _pcbnew.LAYER_DCODES
3423
3424LAYER_NEGATIVE_OBJECTS = _pcbnew.LAYER_NEGATIVE_OBJECTS
3425
3426LAYER_GERBVIEW_GRID = _pcbnew.LAYER_GERBVIEW_GRID
3427
3428LAYER_GERBVIEW_AXES = _pcbnew.LAYER_GERBVIEW_AXES
3429
3430LAYER_GERBVIEW_BACKGROUND = _pcbnew.LAYER_GERBVIEW_BACKGROUND
3431
3432LAYER_GERBVIEW_DRAWINGSHEET = _pcbnew.LAYER_GERBVIEW_DRAWINGSHEET
3433
3434LAYER_GERBVIEW_PAGE_LIMITS = _pcbnew.LAYER_GERBVIEW_PAGE_LIMITS
3435
3436GERBVIEW_LAYER_ID_END = _pcbnew.GERBVIEW_LAYER_ID_END
3437
3438LAYER_3D_START = _pcbnew.LAYER_3D_START
3439
3440LAYER_3D_BACKGROUND_BOTTOM = _pcbnew.LAYER_3D_BACKGROUND_BOTTOM
3441
3442LAYER_3D_BACKGROUND_TOP = _pcbnew.LAYER_3D_BACKGROUND_TOP
3443
3444LAYER_3D_BOARD = _pcbnew.LAYER_3D_BOARD
3445
3446LAYER_3D_COPPER_TOP = _pcbnew.LAYER_3D_COPPER_TOP
3447
3448LAYER_3D_COPPER_BOTTOM = _pcbnew.LAYER_3D_COPPER_BOTTOM
3449
3450LAYER_3D_SILKSCREEN_BOTTOM = _pcbnew.LAYER_3D_SILKSCREEN_BOTTOM
3451
3452LAYER_3D_SILKSCREEN_TOP = _pcbnew.LAYER_3D_SILKSCREEN_TOP
3453
3454LAYER_3D_SOLDERMASK_BOTTOM = _pcbnew.LAYER_3D_SOLDERMASK_BOTTOM
3455
3456LAYER_3D_SOLDERMASK_TOP = _pcbnew.LAYER_3D_SOLDERMASK_TOP
3457
3458LAYER_3D_SOLDERPASTE = _pcbnew.LAYER_3D_SOLDERPASTE
3459
3460LAYER_3D_ADHESIVE = _pcbnew.LAYER_3D_ADHESIVE
3461
3462LAYER_3D_USER_COMMENTS = _pcbnew.LAYER_3D_USER_COMMENTS
3463
3464LAYER_3D_USER_DRAWINGS = _pcbnew.LAYER_3D_USER_DRAWINGS
3465
3466LAYER_3D_USER_ECO1 = _pcbnew.LAYER_3D_USER_ECO1
3467
3468LAYER_3D_USER_ECO2 = _pcbnew.LAYER_3D_USER_ECO2
3469
3470LAYER_3D_TH_MODELS = _pcbnew.LAYER_3D_TH_MODELS
3471
3472LAYER_3D_SMD_MODELS = _pcbnew.LAYER_3D_SMD_MODELS
3473
3474LAYER_3D_VIRTUAL_MODELS = _pcbnew.LAYER_3D_VIRTUAL_MODELS
3475
3476LAYER_3D_MODELS_NOT_IN_POS = _pcbnew.LAYER_3D_MODELS_NOT_IN_POS
3477
3478LAYER_3D_MODELS_MARKED_DNP = _pcbnew.LAYER_3D_MODELS_MARKED_DNP
3479
3480LAYER_3D_AXES = _pcbnew.LAYER_3D_AXES
3481
3482LAYER_3D_BOUNDING_BOXES = _pcbnew.LAYER_3D_BOUNDING_BOXES
3483
3484LAYER_3D_OFF_BOARD_SILK = _pcbnew.LAYER_3D_OFF_BOARD_SILK
3485
3486LAYER_3D_END = _pcbnew.LAYER_3D_END
3487
3488
3489def LayerName(aLayer):
3490 r"""LayerName(int aLayer) -> wxString"""
3491 return _pcbnew.LayerName(aLayer)
3492
3493def IsValidLayer(aLayerId):
3494 r"""IsValidLayer(int aLayerId) -> bool"""
3495 return _pcbnew.IsValidLayer(aLayerId)
3496
3497def IsPcbLayer(aLayer):
3498 r"""IsPcbLayer(int aLayer) -> bool"""
3499 return _pcbnew.IsPcbLayer(aLayer)
3500
3502 r"""IsExternalCopperLayer(int aLayerId) -> bool"""
3503 return _pcbnew.IsExternalCopperLayer(aLayerId)
3504
3506 r"""IsInnerCopperLayer(int aLayerId) -> bool"""
3507 return _pcbnew.IsInnerCopperLayer(aLayerId)
3508
3509def IsNonCopperLayer(aLayerId):
3510 r"""IsNonCopperLayer(int aLayerId) -> bool"""
3511 return _pcbnew.IsNonCopperLayer(aLayerId)
3512
3513def IsCopperLayer(*args):
3514 r"""
3515 IsCopperLayer(int aLayerId) -> bool
3516 IsCopperLayer(int aLayerId, bool aIncludeSyntheticCopperLayers) -> bool
3517 """
3518 return _pcbnew.IsCopperLayer(*args)
3519
3520def IsViaPadLayer(aLayer):
3521 r"""IsViaPadLayer(int aLayer) -> bool"""
3522 return _pcbnew.IsViaPadLayer(aLayer)
3523
3524def IsHoleLayer(aLayer):
3525 r"""IsHoleLayer(int aLayer) -> bool"""
3526 return _pcbnew.IsHoleLayer(aLayer)
3527
3529 r"""IsSolderMaskLayer(int aLayer) -> bool"""
3530 return _pcbnew.IsSolderMaskLayer(aLayer)
3531
3532def IsUserLayer(aLayerId):
3533 r"""IsUserLayer(PCB_LAYER_ID aLayerId) -> bool"""
3534 return _pcbnew.IsUserLayer(aLayerId)
3535
3536def IsFrontLayer(aLayerId):
3537 r"""IsFrontLayer(PCB_LAYER_ID aLayerId) -> bool"""
3538 return _pcbnew.IsFrontLayer(aLayerId)
3539
3540def IsBackLayer(aLayerId):
3541 r"""IsBackLayer(PCB_LAYER_ID aLayerId) -> bool"""
3542 return _pcbnew.IsBackLayer(aLayerId)
3543
3544def IsCopperLayerLowerThan(aLayerA, aLayerB):
3545 r"""IsCopperLayerLowerThan(PCB_LAYER_ID aLayerA, PCB_LAYER_ID aLayerB) -> bool"""
3546 return _pcbnew.IsCopperLayerLowerThan(aLayerA, aLayerB)
3547
3548def FlipLayer(aLayerId, aCopperLayersCount=0):
3549 r"""FlipLayer(PCB_LAYER_ID aLayerId, int aCopperLayersCount=0) -> PCB_LAYER_ID"""
3550 return _pcbnew.FlipLayer(aLayerId, aCopperLayersCount)
3551
3553 r"""GetNetnameLayer(int aLayer) -> int"""
3554 return _pcbnew.GetNetnameLayer(aLayer)
3555
3556def IsNetnameLayer(aLayer):
3557 r"""IsNetnameLayer(int aLayer) -> bool"""
3558 return _pcbnew.IsNetnameLayer(aLayer)
3559
3561 r"""IsZoneFillLayer(int aLayer) -> bool"""
3562 return _pcbnew.IsZoneFillLayer(aLayer)
3563
3565 r"""IsPadCopperLayer(int aLayer) -> bool"""
3566 return _pcbnew.IsPadCopperLayer(aLayer)
3567
3569 r"""IsViaCopperLayer(int aLayer) -> bool"""
3570 return _pcbnew.IsViaCopperLayer(aLayer)
3571
3573 r"""IsClearanceLayer(int aLayer) -> bool"""
3574 return _pcbnew.IsClearanceLayer(aLayer)
3575
3576def IsDCodeLayer(aLayer):
3577 r"""IsDCodeLayer(int aLayer) -> bool"""
3578 return _pcbnew.IsDCodeLayer(aLayer)
3579
3581 r"""CopperLayerToOrdinal(PCB_LAYER_ID aLayer) -> size_t"""
3582 return _pcbnew.CopperLayerToOrdinal(aLayer)
3583
3585 r"""BoardLayerFromLegacyId(int aLegacyId) -> PCB_LAYER_ID"""
3586 return _pcbnew.BoardLayerFromLegacyId(aLegacyId)
3587
3588def ToLAYER_ID(aLayer):
3589 r"""ToLAYER_ID(int aLayer) -> PCB_LAYER_ID"""
3590 return _pcbnew.ToLAYER_ID(aLayer)
3592 r"""Proxy of C++ SETTINGS_MANAGER class."""
3593
3594 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
3595 __repr__ = _swig_repr
3596
3597 def __init__(self, aHeadless=False):
3598 r"""__init__(SETTINGS_MANAGER self, bool aHeadless=False) -> SETTINGS_MANAGER"""
3599 _pcbnew.SETTINGS_MANAGER_swiginit(self, _pcbnew.new_SETTINGS_MANAGER(aHeadless))
3600 __swig_destroy__ = _pcbnew.delete_SETTINGS_MANAGER
3601
3602 def IsOK(self):
3603 r"""IsOK(SETTINGS_MANAGER self) -> bool"""
3604 return _pcbnew.SETTINGS_MANAGER_IsOK(self)
3605
3606 def SetKiway(self, aKiway):
3607 r"""SetKiway(SETTINGS_MANAGER self, KIWAY * aKiway)"""
3608 return _pcbnew.SETTINGS_MANAGER_SetKiway(self, aKiway)
3609
3610 def Load(self, *args):
3611 r"""
3612 Load(SETTINGS_MANAGER self)
3613 Load(SETTINGS_MANAGER self, JSON_SETTINGS * aSettings)
3614 """
3615 return _pcbnew.SETTINGS_MANAGER_Load(self, *args)
3616
3617 def Save(self, *args):
3618 r"""
3619 Save(SETTINGS_MANAGER self)
3620 Save(SETTINGS_MANAGER self, JSON_SETTINGS * aSettings)
3621 """
3622 return _pcbnew.SETTINGS_MANAGER_Save(self, *args)
3623
3624 def FlushAndRelease(self, aSettings, aSave=True):
3625 r"""FlushAndRelease(SETTINGS_MANAGER self, JSON_SETTINGS * aSettings, bool aSave=True)"""
3626 return _pcbnew.SETTINGS_MANAGER_FlushAndRelease(self, aSettings, aSave)
3627
3628 def GetColorSettings(self, *args):
3629 r"""GetColorSettings(SETTINGS_MANAGER self, wxString aName="user") -> COLOR_SETTINGS"""
3630 return _pcbnew.SETTINGS_MANAGER_GetColorSettings(self, *args)
3631
3633 r"""GetColorSettingsList(SETTINGS_MANAGER self) -> std::vector< COLOR_SETTINGS *,std::allocator< COLOR_SETTINGS * > >"""
3634 return _pcbnew.SETTINGS_MANAGER_GetColorSettingsList(self)
3635
3636 def SaveColorSettings(self, *args):
3637 r"""SaveColorSettings(SETTINGS_MANAGER self, COLOR_SETTINGS * aSettings, string aNamespace="")"""
3638 return _pcbnew.SETTINGS_MANAGER_SaveColorSettings(self, *args)
3639
3640 def AddNewColorSettings(self, aFilename):
3641 r"""AddNewColorSettings(SETTINGS_MANAGER self, wxString aFilename) -> COLOR_SETTINGS *"""
3642 return _pcbnew.SETTINGS_MANAGER_AddNewColorSettings(self, aFilename)
3643
3645 r"""GetMigratedColorSettings(SETTINGS_MANAGER self) -> COLOR_SETTINGS *"""
3646 return _pcbnew.SETTINGS_MANAGER_GetMigratedColorSettings(self)
3647
3649 r"""GetCommonSettings(SETTINGS_MANAGER self) -> COMMON_SETTINGS *"""
3650 return _pcbnew.SETTINGS_MANAGER_GetCommonSettings(self)
3651
3652 def GetPathForSettingsFile(self, aSettings):
3653 r"""GetPathForSettingsFile(SETTINGS_MANAGER self, JSON_SETTINGS * aSettings) -> wxString"""
3654 return _pcbnew.SETTINGS_MANAGER_GetPathForSettingsFile(self, aSettings)
3655
3657 r"""MigrateIfNeeded(SETTINGS_MANAGER self) -> bool"""
3658 return _pcbnew.SETTINGS_MANAGER_MigrateIfNeeded(self)
3659
3660 def SetMigrationSource(self, aSource):
3661 r"""SetMigrationSource(SETTINGS_MANAGER self, wxString aSource)"""
3662 return _pcbnew.SETTINGS_MANAGER_SetMigrationSource(self, aSource)
3663
3664 def SetMigrateLibraryTables(self, aMigrate=True):
3665 r"""SetMigrateLibraryTables(SETTINGS_MANAGER self, bool aMigrate=True)"""
3666 return _pcbnew.SETTINGS_MANAGER_SetMigrateLibraryTables(self, aMigrate)
3667
3668 def GetPreviousVersionPaths(self, aName=None):
3669 r"""GetPreviousVersionPaths(SETTINGS_MANAGER self, std::vector< wxString,std::allocator< wxString > > * aName=None) -> bool"""
3670 return _pcbnew.SETTINGS_MANAGER_GetPreviousVersionPaths(self, aName)
3671
3673 r"""ReloadColorSettings(SETTINGS_MANAGER self)"""
3674 return _pcbnew.SETTINGS_MANAGER_ReloadColorSettings(self)
3675
3676 def LoadProject(self, aFullPath, aSetActive=True):
3677 r"""LoadProject(SETTINGS_MANAGER self, wxString aFullPath, bool aSetActive=True) -> bool"""
3678 return _pcbnew.SETTINGS_MANAGER_LoadProject(self, aFullPath, aSetActive)
3679
3680 def UnloadProject(self, aProject, aSave=True):
3681 r"""UnloadProject(SETTINGS_MANAGER self, PROJECT * aProject, bool aSave=True) -> bool"""
3682 return _pcbnew.SETTINGS_MANAGER_UnloadProject(self, aProject, aSave)
3683
3684 def IsProjectOpen(self):
3685 r"""IsProjectOpen(SETTINGS_MANAGER self) -> bool"""
3686 return _pcbnew.SETTINGS_MANAGER_IsProjectOpen(self)
3687
3689 r"""IsProjectOpenNotDummy(SETTINGS_MANAGER self) -> bool"""
3690 return _pcbnew.SETTINGS_MANAGER_IsProjectOpenNotDummy(self)
3691
3692 def Prj(self):
3693 r"""Prj(SETTINGS_MANAGER self) -> PROJECT &"""
3694 return _pcbnew.SETTINGS_MANAGER_Prj(self)
3695
3696 def GetProject(self, aFullPath):
3697 r"""GetProject(SETTINGS_MANAGER self, wxString aFullPath) -> PROJECT *"""
3698 return _pcbnew.SETTINGS_MANAGER_GetProject(self, aFullPath)
3699
3701 r"""GetOpenProjects(SETTINGS_MANAGER self) -> std::vector< wxString,std::allocator< wxString > >"""
3702 return _pcbnew.SETTINGS_MANAGER_GetOpenProjects(self)
3703
3704 def SaveProject(self, *args):
3705 r"""SaveProject(SETTINGS_MANAGER self, wxString aFullPath=wxEmptyString, PROJECT * aProject=None) -> bool"""
3706 return _pcbnew.SETTINGS_MANAGER_SaveProject(self, *args)
3707
3708 def SaveProjectAs(self, aFullPath, aProject=None):
3709 r"""SaveProjectAs(SETTINGS_MANAGER self, wxString aFullPath, PROJECT * aProject=None)"""
3710 return _pcbnew.SETTINGS_MANAGER_SaveProjectAs(self, aFullPath, aProject)
3711
3712 def SaveProjectCopy(self, aFullPath, aProject=None):
3713 r"""SaveProjectCopy(SETTINGS_MANAGER self, wxString aFullPath, PROJECT * aProject=None)"""
3714 return _pcbnew.SETTINGS_MANAGER_SaveProjectCopy(self, aFullPath, aProject)
3715
3717 r"""GetProjectBackupsPath(SETTINGS_MANAGER self) -> wxString"""
3718 return _pcbnew.SETTINGS_MANAGER_GetProjectBackupsPath(self)
3719
3720 def BackupProject(self, aReporter, aTarget):
3721 r"""BackupProject(SETTINGS_MANAGER self, REPORTER & aReporter, wxFileName & aTarget) -> bool"""
3722 return _pcbnew.SETTINGS_MANAGER_BackupProject(self, aReporter, aTarget)
3723
3724 def TriggerBackupIfNeeded(self, aReporter):
3725 r"""TriggerBackupIfNeeded(SETTINGS_MANAGER self, REPORTER & aReporter) -> bool"""
3726 return _pcbnew.SETTINGS_MANAGER_TriggerBackupIfNeeded(self, aReporter)
3727
3728 @staticmethod
3730 r"""IsSettingsPathValid(wxString aPath) -> bool"""
3731 return _pcbnew.SETTINGS_MANAGER_IsSettingsPathValid(aPath)
3732
3733 @staticmethod
3735 r"""GetColorSettingsPath() -> wxString"""
3736 return _pcbnew.SETTINGS_MANAGER_GetColorSettingsPath()
3737
3738 @staticmethod
3740 r"""GetSettingsVersion() -> string"""
3741 return _pcbnew.SETTINGS_MANAGER_GetSettingsVersion()
3742
3743 @staticmethod
3745 r"""GetUserSettingsPath() -> wxString"""
3746 return _pcbnew.SETTINGS_MANAGER_GetUserSettingsPath()
3747
3748# Register SETTINGS_MANAGER in _pcbnew:
3749_pcbnew.SETTINGS_MANAGER_swigregister(SETTINGS_MANAGER)
3751 r"""Proxy of C++ UTILS_BOX3D class."""
3752
3753 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
3754 __repr__ = _swig_repr
3755
3756 def Min(self):
3757 r"""Min(UTILS_BOX3D self) -> VECTOR3D"""
3758 return _pcbnew.UTILS_BOX3D_Min(self)
3759
3760 def Max(self):
3761 r"""Max(UTILS_BOX3D self) -> VECTOR3D"""
3762 return _pcbnew.UTILS_BOX3D_Max(self)
3763
3764 def GetCenter(self):
3765 r"""GetCenter(UTILS_BOX3D self) -> VECTOR3D"""
3766 return _pcbnew.UTILS_BOX3D_GetCenter(self)
3767
3768 def GetSize(self):
3769 r"""GetSize(UTILS_BOX3D self) -> VECTOR3D"""
3770 return _pcbnew.UTILS_BOX3D_GetSize(self)
3771
3772 def __init__(self):
3773 r"""__init__(UTILS_BOX3D self) -> UTILS_BOX3D"""
3774 _pcbnew.UTILS_BOX3D_swiginit(self, _pcbnew.new_UTILS_BOX3D())
3775 __swig_destroy__ = _pcbnew.delete_UTILS_BOX3D
3776
3777# Register UTILS_BOX3D in _pcbnew:
3778_pcbnew.UTILS_BOX3D_swigregister(UTILS_BOX3D)
3780 r"""Proxy of C++ UTILS_STEP_MODEL class."""
3781
3782 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
3783 __repr__ = _swig_repr
3784
3786 r"""GetBoundingBox(UTILS_STEP_MODEL self) -> UTILS_BOX3D"""
3787 return _pcbnew.UTILS_STEP_MODEL_GetBoundingBox(self)
3788
3789 def Translate(self, aX, aY, aZ):
3790 r"""Translate(UTILS_STEP_MODEL self, double aX, double aY, double aZ)"""
3791 return _pcbnew.UTILS_STEP_MODEL_Translate(self, aX, aY, aZ)
3792
3793 def Scale(self, aScale):
3794 r"""Scale(UTILS_STEP_MODEL self, double aScale)"""
3795 return _pcbnew.UTILS_STEP_MODEL_Scale(self, aScale)
3796
3797 def SaveSTEP(self, aFileName):
3798 r"""SaveSTEP(UTILS_STEP_MODEL self, wxString aFileName) -> bool"""
3799 return _pcbnew.UTILS_STEP_MODEL_SaveSTEP(self, aFileName)
3800
3801 @staticmethod
3802 def LoadSTEP(aFileName):
3803 r"""LoadSTEP(wxString aFileName) -> UTILS_STEP_MODEL"""
3804 return _pcbnew.UTILS_STEP_MODEL_LoadSTEP(aFileName)
3805
3806 def __init__(self):
3807 r"""__init__(UTILS_STEP_MODEL self) -> UTILS_STEP_MODEL"""
3808 _pcbnew.UTILS_STEP_MODEL_swiginit(self, _pcbnew.new_UTILS_STEP_MODEL())
3809
3810# Register UTILS_STEP_MODEL in _pcbnew:
3811_pcbnew.UTILS_STEP_MODEL_swigregister(UTILS_STEP_MODEL)
3813 r"""Proxy of C++ std::vector< int > class."""
3814
3815 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
3816 __repr__ = _swig_repr
3817
3818 def iterator(self):
3819 r"""iterator(intVector self) -> SwigPyIterator"""
3820 return _pcbnew.intVector_iterator(self)
3821 def __iter__(self):
3822 return self.iterator()
3823
3824 def __nonzero__(self):
3825 r"""__nonzero__(intVector self) -> bool"""
3826 return _pcbnew.intVector___nonzero__(self)
3827
3828 def __bool__(self):
3829 r"""__bool__(intVector self) -> bool"""
3830 return _pcbnew.intVector___bool__(self)
3831
3832 def __len__(self):
3833 r"""__len__(intVector self) -> std::vector< int >::size_type"""
3834 return _pcbnew.intVector___len__(self)
3835
3836 def __getslice__(self, i, j):
3837 r"""__getslice__(intVector self, std::vector< int >::difference_type i, std::vector< int >::difference_type j) -> intVector"""
3838 return _pcbnew.intVector___getslice__(self, i, j)
3839
3840 def __setslice__(self, *args):
3841 r"""
3842 __setslice__(intVector self, std::vector< int >::difference_type i, std::vector< int >::difference_type j)
3843 __setslice__(intVector self, std::vector< int >::difference_type i, std::vector< int >::difference_type j, intVector v)
3844 """
3845 return _pcbnew.intVector___setslice__(self, *args)
3846
3847 def __delslice__(self, i, j):
3848 r"""__delslice__(intVector self, std::vector< int >::difference_type i, std::vector< int >::difference_type j)"""
3849 return _pcbnew.intVector___delslice__(self, i, j)
3850
3851 def __delitem__(self, *args):
3852 r"""
3853 __delitem__(intVector self, std::vector< int >::difference_type i)
3854 __delitem__(intVector self, SWIGPY_SLICEOBJECT * slice)
3855 """
3856 return _pcbnew.intVector___delitem__(self, *args)
3857
3858 def __getitem__(self, *args):
3859 r"""
3860 __getitem__(intVector self, SWIGPY_SLICEOBJECT * slice) -> intVector
3861 __getitem__(intVector self, std::vector< int >::difference_type i) -> std::vector< int >::value_type const &
3862 """
3863 return _pcbnew.intVector___getitem__(self, *args)
3864
3865 def __setitem__(self, *args):
3866 r"""
3867 __setitem__(intVector self, SWIGPY_SLICEOBJECT * slice, intVector v)
3868 __setitem__(intVector self, SWIGPY_SLICEOBJECT * slice)
3869 __setitem__(intVector self, std::vector< int >::difference_type i, std::vector< int >::value_type const & x)
3870 """
3871 return _pcbnew.intVector___setitem__(self, *args)
3872
3873 def pop(self):
3874 r"""pop(intVector self) -> std::vector< int >::value_type"""
3875 return _pcbnew.intVector_pop(self)
3876
3877 def append(self, x):
3878 r"""append(intVector self, std::vector< int >::value_type const & x)"""
3879 return _pcbnew.intVector_append(self, x)
3880
3881 def empty(self):
3882 r"""empty(intVector self) -> bool"""
3883 return _pcbnew.intVector_empty(self)
3884
3885 def size(self):
3886 r"""size(intVector self) -> std::vector< int >::size_type"""
3887 return _pcbnew.intVector_size(self)
3888
3889 def swap(self, v):
3890 r"""swap(intVector self, intVector v)"""
3891 return _pcbnew.intVector_swap(self, v)
3892
3893 def begin(self):
3894 r"""begin(intVector self) -> std::vector< int >::iterator"""
3895 return _pcbnew.intVector_begin(self)
3896
3897 def end(self):
3898 r"""end(intVector self) -> std::vector< int >::iterator"""
3899 return _pcbnew.intVector_end(self)
3900
3901 def rbegin(self):
3902 r"""rbegin(intVector self) -> std::vector< int >::reverse_iterator"""
3903 return _pcbnew.intVector_rbegin(self)
3904
3905 def rend(self):
3906 r"""rend(intVector self) -> std::vector< int >::reverse_iterator"""
3907 return _pcbnew.intVector_rend(self)
3908
3909 def clear(self):
3910 r"""clear(intVector self)"""
3911 return _pcbnew.intVector_clear(self)
3912
3913 def get_allocator(self):
3914 r"""get_allocator(intVector self) -> std::vector< int >::allocator_type"""
3915 return _pcbnew.intVector_get_allocator(self)
3916
3917 def pop_back(self):
3918 r"""pop_back(intVector self)"""
3919 return _pcbnew.intVector_pop_back(self)
3920
3921 def erase(self, *args):
3922 r"""
3923 erase(intVector self, std::vector< int >::iterator pos) -> std::vector< int >::iterator
3924 erase(intVector self, std::vector< int >::iterator first, std::vector< int >::iterator last) -> std::vector< int >::iterator
3925 """
3926 return _pcbnew.intVector_erase(self, *args)
3927
3928 def __init__(self, *args):
3929 r"""
3930 __init__(intVector self) -> intVector
3931 __init__(intVector self, intVector other) -> intVector
3932 __init__(intVector self, std::vector< int >::size_type size) -> intVector
3933 __init__(intVector self, std::vector< int >::size_type size, std::vector< int >::value_type const & value) -> intVector
3934 """
3935 _pcbnew.intVector_swiginit(self, _pcbnew.new_intVector(*args))
3936
3937 def push_back(self, x):
3938 r"""push_back(intVector self, std::vector< int >::value_type const & x)"""
3939 return _pcbnew.intVector_push_back(self, x)
3940
3941 def front(self):
3942 r"""front(intVector self) -> std::vector< int >::value_type const &"""
3943 return _pcbnew.intVector_front(self)
3944
3945 def back(self):
3946 r"""back(intVector self) -> std::vector< int >::value_type const &"""
3947 return _pcbnew.intVector_back(self)
3948
3949 def assign(self, n, x):
3950 r"""assign(intVector self, std::vector< int >::size_type n, std::vector< int >::value_type const & x)"""
3951 return _pcbnew.intVector_assign(self, n, x)
3952
3953 def resize(self, *args):
3954 r"""
3955 resize(intVector self, std::vector< int >::size_type new_size)
3956 resize(intVector self, std::vector< int >::size_type new_size, std::vector< int >::value_type const & x)
3957 """
3958 return _pcbnew.intVector_resize(self, *args)
3959
3960 def insert(self, *args):
3961 r"""
3962 insert(intVector self, std::vector< int >::iterator pos, std::vector< int >::value_type const & x) -> std::vector< int >::iterator
3963 insert(intVector self, std::vector< int >::iterator pos, std::vector< int >::size_type n, std::vector< int >::value_type const & x)
3964 """
3965 return _pcbnew.intVector_insert(self, *args)
3966
3967 def reserve(self, n):
3968 r"""reserve(intVector self, std::vector< int >::size_type n)"""
3969 return _pcbnew.intVector_reserve(self, n)
3970
3971 def capacity(self):
3972 r"""capacity(intVector self) -> std::vector< int >::size_type"""
3973 return _pcbnew.intVector_capacity(self)
3974 __swig_destroy__ = _pcbnew.delete_intVector
3975
3976# Register intVector in _pcbnew:
3977_pcbnew.intVector_swigregister(intVector)
3979 r"""Proxy of C++ std::map< std::string,UTF8 > class."""
3980
3981 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
3982 __repr__ = _swig_repr
3983
3984 def iterator(self):
3985 r"""iterator(str_utf8_Map self) -> SwigPyIterator"""
3986 return _pcbnew.str_utf8_Map_iterator(self)
3987 def __iter__(self):
3988 return self.iterator()
3989
3990 def __nonzero__(self):
3991 r"""__nonzero__(str_utf8_Map self) -> bool"""
3992 return _pcbnew.str_utf8_Map___nonzero__(self)
3993
3994 def __bool__(self):
3995 r"""__bool__(str_utf8_Map self) -> bool"""
3996 return _pcbnew.str_utf8_Map___bool__(self)
3997
3998 def __len__(self):
3999 r"""__len__(str_utf8_Map self) -> std::map< std::basic_string< char,std::char_traits< char >,std::allocator< char > >,UTF8 >::size_type"""
4000 return _pcbnew.str_utf8_Map___len__(self)
4001 def __iter__(self):
4002 return self.key_iterator()
4003 def iterkeys(self):
4004 return self.key_iterator()
4005 def itervalues(self):
4006 return self.value_iterator()
4007 def iteritems(self):
4008 return self.iterator()
4009
4010 def __getitem__(self, key):
4011 r"""__getitem__(str_utf8_Map self, string key) -> UTF8"""
4012 return _pcbnew.str_utf8_Map___getitem__(self, key)
4013
4014 def __delitem__(self, key):
4015 r"""__delitem__(str_utf8_Map self, string key)"""
4016 return _pcbnew.str_utf8_Map___delitem__(self, key)
4017
4018 def has_key(self, key):
4019 r"""has_key(str_utf8_Map self, string key) -> bool"""
4020 return _pcbnew.str_utf8_Map_has_key(self, key)
4021
4022 def keys(self):
4023 r"""keys(str_utf8_Map self) -> PyObject *"""
4024 return _pcbnew.str_utf8_Map_keys(self)
4025
4026 def values(self):
4027 r"""values(str_utf8_Map self) -> PyObject *"""
4028 return _pcbnew.str_utf8_Map_values(self)
4029
4030 def items(self):
4031 r"""items(str_utf8_Map self) -> PyObject *"""
4032 return _pcbnew.str_utf8_Map_items(self)
4033
4034 def __contains__(self, key):
4035 r"""__contains__(str_utf8_Map self, string key) -> bool"""
4036 return _pcbnew.str_utf8_Map___contains__(self, key)
4037
4038 def key_iterator(self):
4039 r"""key_iterator(str_utf8_Map self) -> SwigPyIterator"""
4040 return _pcbnew.str_utf8_Map_key_iterator(self)
4041
4043 r"""value_iterator(str_utf8_Map self) -> SwigPyIterator"""
4044 return _pcbnew.str_utf8_Map_value_iterator(self)
4045
4046 def __setitem__(self, *args):
4047 r"""
4048 __setitem__(str_utf8_Map self, string key)
4049 __setitem__(str_utf8_Map self, string key, UTF8 x)
4050 """
4051 return _pcbnew.str_utf8_Map___setitem__(self, *args)
4052
4053 def asdict(self):
4054 r"""asdict(str_utf8_Map self) -> PyObject *"""
4055 return _pcbnew.str_utf8_Map_asdict(self)
4056
4057 def __init__(self, *args):
4058 r"""
4059 __init__(str_utf8_Map self, std::less< std::basic_string< char,std::char_traits< char >,std::allocator< char > > > const & other) -> str_utf8_Map
4060 __init__(str_utf8_Map self) -> str_utf8_Map
4061 __init__(str_utf8_Map self, str_utf8_Map other) -> str_utf8_Map
4062 """
4063 _pcbnew.str_utf8_Map_swiginit(self, _pcbnew.new_str_utf8_Map(*args))
4064
4065 def empty(self):
4066 r"""empty(str_utf8_Map self) -> bool"""
4067 return _pcbnew.str_utf8_Map_empty(self)
4068
4069 def size(self):
4070 r"""size(str_utf8_Map self) -> std::map< std::basic_string< char,std::char_traits< char >,std::allocator< char > >,UTF8 >::size_type"""
4071 return _pcbnew.str_utf8_Map_size(self)
4072
4073 def swap(self, v):
4074 r"""swap(str_utf8_Map self, str_utf8_Map v)"""
4075 return _pcbnew.str_utf8_Map_swap(self, v)
4076
4077 def begin(self):
4078 r"""begin(str_utf8_Map self) -> std::map< std::basic_string< char,std::char_traits< char >,std::allocator< char > >,UTF8 >::iterator"""
4079 return _pcbnew.str_utf8_Map_begin(self)
4080
4081 def end(self):
4082 r"""end(str_utf8_Map self) -> std::map< std::basic_string< char,std::char_traits< char >,std::allocator< char > >,UTF8 >::iterator"""
4083 return _pcbnew.str_utf8_Map_end(self)
4084
4085 def rbegin(self):
4086 r"""rbegin(str_utf8_Map self) -> std::map< std::basic_string< char,std::char_traits< char >,std::allocator< char > >,UTF8 >::reverse_iterator"""
4087 return _pcbnew.str_utf8_Map_rbegin(self)
4088
4089 def rend(self):
4090 r"""rend(str_utf8_Map self) -> std::map< std::basic_string< char,std::char_traits< char >,std::allocator< char > >,UTF8 >::reverse_iterator"""
4091 return _pcbnew.str_utf8_Map_rend(self)
4092
4093 def clear(self):
4094 r"""clear(str_utf8_Map self)"""
4095 return _pcbnew.str_utf8_Map_clear(self)
4096
4097 def get_allocator(self):
4098 r"""get_allocator(str_utf8_Map self) -> std::map< std::basic_string< char,std::char_traits< char >,std::allocator< char > >,UTF8 >::allocator_type"""
4099 return _pcbnew.str_utf8_Map_get_allocator(self)
4100
4101 def count(self, x):
4102 r"""count(str_utf8_Map self, string x) -> std::map< std::basic_string< char,std::char_traits< char >,std::allocator< char > >,UTF8 >::size_type"""
4103 return _pcbnew.str_utf8_Map_count(self, x)
4104
4105 def erase(self, *args):
4106 r"""
4107 erase(str_utf8_Map self, string x) -> std::map< std::basic_string< char,std::char_traits< char >,std::allocator< char > >,UTF8 >::size_type
4108 erase(str_utf8_Map self, std::map< std::basic_string< char,std::char_traits< char >,std::allocator< char > >,UTF8 >::iterator position)
4109 erase(str_utf8_Map self, std::map< std::basic_string< char,std::char_traits< char >,std::allocator< char > >,UTF8 >::iterator first, std::map< std::basic_string< char,std::char_traits< char >,std::allocator< char > >,UTF8 >::iterator last)
4110 """
4111 return _pcbnew.str_utf8_Map_erase(self, *args)
4112
4113 def find(self, x):
4114 r"""find(str_utf8_Map self, string x) -> std::map< std::basic_string< char,std::char_traits< char >,std::allocator< char > >,UTF8 >::iterator"""
4115 return _pcbnew.str_utf8_Map_find(self, x)
4116
4117 def lower_bound(self, x):
4118 r"""lower_bound(str_utf8_Map self, string x) -> std::map< std::basic_string< char,std::char_traits< char >,std::allocator< char > >,UTF8 >::iterator"""
4119 return _pcbnew.str_utf8_Map_lower_bound(self, x)
4120
4121 def upper_bound(self, x):
4122 r"""upper_bound(str_utf8_Map self, string x) -> std::map< std::basic_string< char,std::char_traits< char >,std::allocator< char > >,UTF8 >::iterator"""
4123 return _pcbnew.str_utf8_Map_upper_bound(self, x)
4124 __swig_destroy__ = _pcbnew.delete_str_utf8_Map
4125
4126# Register str_utf8_Map in _pcbnew:
4127_pcbnew.str_utf8_Map_swigregister(str_utf8_Map)
4128
4129
4130KICAD_PLUGINS={} # the list of loaded footprint wizards
4131
4132""" the list of not loaded python scripts
4133 (usually because there is a syntax error in python script)
4134 this is the python script full filenames list.
4135 filenames are separated by '\n'
4136"""
4137NOT_LOADED_WIZARDS=""
4138
4139""" the list of paths used to search python scripts.
4140 Stored here to be displayed on request in Pcbnew
4141 paths are separated by '\n'
4142"""
4143PLUGIN_DIRECTORIES_SEARCH=""
4144
4145"""
4146 the trace of errors during execution of footprint wizards scripts
4147 Warning: strings (internally unicode) are returned as UTF-8 compatible C strings
4148"""
4149
4150FULL_BACK_TRACE=""
4151
4152def GetUnLoadableWizards():
4153 global NOT_LOADED_WIZARDS
4154 import sys
4155
4156 if sys.version_info[0] < 3:
4157 utf8_str = NOT_LOADED_WIZARDS.encode( 'UTF-8' )
4158 else:
4159 utf8_str = NOT_LOADED_WIZARDS
4160
4161 return utf8_str
4162
4164 global PLUGIN_DIRECTORIES_SEARCH
4165 import sys
4166
4167 if sys.version_info[0] < 3:
4168 utf8_str = PLUGIN_DIRECTORIES_SEARCH.encode( 'UTF-8' )
4169 else:
4170 utf8_str = PLUGIN_DIRECTORIES_SEARCH
4171
4172 return utf8_str
4173
4175 global FULL_BACK_TRACE # Already correct format
4176 return FULL_BACK_TRACE
4177
4178
4179def LoadPluginModule(Dirname, ModuleName, FileName):
4180 """
4181 Load the plugin module named ModuleName located in the folder Dirname.
4182 The module can be either inside a file called FileName or a subdirectory
4183 called FileName that contains a __init__.py file.
4184 If this module cannot be loaded, its name is stored in failed_wizards_list
4185 and the error trace is stored in FULL_BACK_TRACE
4186 """
4187 import os
4188 import sys
4189 import traceback
4190
4191 global NOT_LOADED_WIZARDS
4192 global FULL_BACK_TRACE
4193 global KICAD_PLUGINS
4194
4195 try: # If there is an error loading the script, skip it
4196
4197 module_filename = os.path.join( Dirname, FileName )
4198 mtime = os.path.getmtime( module_filename )
4199 mods_before = set( sys.modules )
4200
4201 if ModuleName in KICAD_PLUGINS:
4202 plugin = KICAD_PLUGINS[ModuleName]
4203
4204 for dependency in plugin["dependencies"]:
4205 if dependency in sys.modules:
4206 del sys.modules[dependency]
4207
4208 mods_before = set( sys.modules )
4209
4210 if sys.version_info >= (3,0,0):
4211 import importlib
4212 mod = importlib.import_module( ModuleName )
4213 else:
4214 mod = __import__( ModuleName, locals(), globals() )
4215
4216 mods_after = set( sys.modules ).difference( mods_before )
4217 dependencies = [m for m in mods_after if m.startswith(ModuleName)]
4218
4219 KICAD_PLUGINS[ModuleName]={ "filename":module_filename,
4220 "modification_time":mtime,
4221 "ModuleName":mod,
4222 "dependencies": dependencies }
4223
4224 except:
4225 if ModuleName in KICAD_PLUGINS:
4226 del KICAD_PLUGINS[ModuleName]
4227
4228 if NOT_LOADED_WIZARDS != "" :
4229 NOT_LOADED_WIZARDS += "\n"
4230 NOT_LOADED_WIZARDS += module_filename
4231 FULL_BACK_TRACE += traceback.format_exc()
4232
4233
4234def LoadPlugins(bundlepath=None, userpath=None, thirdpartypath=None):
4235 """
4236 Initialise Scripting/Plugin python environment and load plugins.
4237
4238 Arguments:
4239 Note: bundlepath and userpath are given utf8 encoded, to be compatible with asimple C string
4240 bundlepath -- The path to the bundled scripts.
4241 The bundled Plugins are relative to this path, in the
4242 "plugins" subdirectory.
4243 WARNING: bundlepath must use '/' as path separator, and not '\'
4244 because it creates issues:
4245 \n and \r are seen as a escaped seq when passing this string to this method
4246 I am thinking this is due to the fact LoadPlugins is called from C++ code by
4247 PyRun_SimpleString()
4248
4249 NOTE: These are all of the possible "default" search paths for kicad
4250 python scripts. These paths will ONLY be added to the python
4251 search path ONLY IF they already exist.
4252
4253 The Scripts bundled with the KiCad installation:
4254 <bundlepath>/
4255 <bundlepath>/plugins/
4256
4257 The Scripts relative to the KiCad Users configuration:
4258 <userpath>/
4259 <userpath>/plugins/
4260
4261 The plugins from 3rd party packages:
4262 $KICAD_3RD_PARTY/plugins/
4263 """
4264 import os
4265 import sys
4266 import traceback
4267 import pcbnew
4268
4269 if sys.version_info >= (3,3,0):
4270 import importlib
4271 importlib.invalidate_caches()
4272
4273 """
4274 bundlepath and userpath are strings utf-8 encoded (compatible "C" strings).
4275 So convert these utf8 encoding to unicode strings to avoid any encoding issue.
4276 """
4277 try:
4278 bundlepath = bundlepath.decode( 'UTF-8' )
4279 userpath = userpath.decode( 'UTF-8' )
4280 thirdpartypath = thirdpartypath.decode( 'UTF-8' )
4281 except AttributeError:
4282 pass
4283
4285 plugin_directories=[]
4286
4287 """
4288 To be consistent with others paths, on windows, convert the unix '/' separator
4289 to the windows separator, although using '/' works
4290 """
4291 if sys.platform.startswith('win32'):
4292 if bundlepath:
4293 bundlepath = bundlepath.replace("/","\\")
4294 if thirdpartypath:
4295 thirdpartypath = thirdpartypath.replace("/","\\")
4296
4297 if bundlepath:
4298 plugin_directories.append(bundlepath)
4299 plugin_directories.append(os.path.join(bundlepath, 'plugins'))
4300
4301 if config_path:
4302 plugin_directories.append(os.path.join(config_path, 'scripting'))
4303 plugin_directories.append(os.path.join(config_path, 'scripting', 'plugins'))
4304
4305 if userpath:
4306 plugin_directories.append(userpath)
4307 plugin_directories.append(os.path.join(userpath, 'plugins'))
4308
4309 if thirdpartypath:
4310 plugin_directories.append(thirdpartypath)
4311
4312 global PLUGIN_DIRECTORIES_SEARCH
4313 PLUGIN_DIRECTORIES_SEARCH=""
4314 for plugins_dir in plugin_directories: # save search path list for later use
4315 if PLUGIN_DIRECTORIES_SEARCH != "" :
4316 PLUGIN_DIRECTORIES_SEARCH += "\n"
4317 PLUGIN_DIRECTORIES_SEARCH += plugins_dir
4318
4319 global FULL_BACK_TRACE
4320 FULL_BACK_TRACE="" # clear any existing trace
4321
4322 global NOT_LOADED_WIZARDS
4323 NOT_LOADED_WIZARDS = "" # save not loaded wizards names list for later use
4324
4325 global KICAD_PLUGINS
4326
4327 for plugins_dir in plugin_directories:
4328 if not os.path.isdir( plugins_dir ):
4329 continue
4330
4331 if plugins_dir not in sys.path:
4332 sys.path.append( plugins_dir )
4333
4334 for module in os.listdir(plugins_dir):
4335 fullPath = os.path.join( plugins_dir, module )
4336
4337 if os.path.isdir( fullPath ):
4338 if os.path.exists( os.path.join( fullPath, '__init__.py' ) ):
4339 LoadPluginModule( plugins_dir, module, module )
4340 else:
4341 if NOT_LOADED_WIZARDS != "" :
4342 NOT_LOADED_WIZARDS += "\n"
4343 NOT_LOADED_WIZARDS += 'Skip subdir ' + fullPath
4344 continue
4345
4346 if module == '__init__.py' or module[-3:] != '.py':
4347 continue
4348
4349 LoadPluginModule( plugins_dir, module[:-3], module )
4350
4351
4353 def __init__(self):
4354 pass
4355
4356 def register(self):
4357 import inspect
4358 import os
4359
4360 if isinstance(self,FilePlugin):
4361 pass # register to file plugins in C++
4362
4363 if isinstance(self,FootprintWizardPlugin):
4364 PYTHON_FOOTPRINT_WIZARD_LIST.register_wizard(self)
4365 return
4366
4367 if isinstance(self,ActionPlugin):
4368 """
4369 Get path to .py or .pyc that has definition of plugin class.
4370 If path is binary but source also exists, assume definition is in source.
4371 """
4372 self.__plugin_path = inspect.getfile(self.__class__)
4373 if self.__plugin_path.endswith('.pyc') and os.path.isfile(self.__plugin_path[:-1]):
4374 self.__plugin_path = self.__plugin_path[:-1]
4375 self.__plugin_path = self.__plugin_path + '/' + self.__class__.__name__
4376 PYTHON_ACTION_PLUGINS.register_action(self)
4377 return
4378
4379 return
4380
4381 def deregister(self):
4382 if isinstance(self,FilePlugin):
4383 pass # deregister to file plugins in C++
4384
4385 if isinstance(self,FootprintWizardPlugin):
4386 PYTHON_FOOTPRINT_WIZARD_LIST.deregister_wizard(self)
4387 return
4388
4389 if isinstance(self,ActionPlugin):
4390 PYTHON_ACTION_PLUGINS.deregister_action(self)
4391 return
4392
4393 return
4394
4395 def GetPluginPath( self ):
4396 return self.__plugin_path
4397
4398
4400 def __init__(self):
4401 KiCadPlugin.__init__(self)
4402
4403
4404from math import ceil, floor, sqrt
4405
4406uMM = "mm" # Millimetres
4407uMils = "mils" # Mils
4408uFloat = "float" # Natural number units (dimensionless)
4409uInteger = "integer" # Integer (no decimals, numeric, dimensionless)
4410uBool = "bool" # Boolean value
4411uRadians = "radians" # Angular units (radians)
4412uDegrees = "degrees" # Angular units (degrees)
4413uPercent = "%" # Percent (0% -> 100%)
4414uString = "string" # Raw string
4415
4416uNumeric = [uMM, uMils, uFloat, uInteger, uDegrees, uRadians, uPercent] # List of numeric types
4417uUnits = [uMM, uMils, uFloat, uInteger, uBool, uDegrees, uRadians, uPercent, uString] # List of allowable types
4418
4420 _true = ['true','t','y','yes','on','1',1,]
4421 _false = ['false','f','n','no','off','0',0,'',None]
4422
4423 _bools = _true + _false
4424
4425 def __init__(self, page, name, units, default, **kwarg):
4426 self.page = page
4427 self.name = name
4428 self.hint = kwarg.get('hint','') # Parameter hint (shown as mouse-over text)
4429 self.designator = kwarg.get('designator',' ') # Parameter designator such as "e, D, p" (etc)
4430
4431 if units.lower() in uUnits:
4432 self.units = units.lower()
4433 elif units.lower() == 'percent':
4434 self.units = uPercent
4435 elif type(units) in [list, tuple]: # Convert a list of options into a single string
4436 self.units = ",".join([str(el).strip() for el in units])
4437 else:
4438 self.units = units
4439
4440 self.multiple = int(kwarg.get('multiple',1)) # Check integer values are multiples of this number
4441 self.min_value = kwarg.get('min_value',None) # Check numeric values are above or equal to this number
4442 self.max_value = kwarg.get('max_value',None) # Check numeric values are below or equal to this number
4443
4444 self.SetValue(default)
4445 self.default = self.raw_value # Save value as default
4446
4447 def ClearErrors(self):
4448 self.error_list = []
4449
4450 def AddError(self, err, info=None):
4451
4452 if err in self.error_list: # prevent duplicate error messages
4453 return
4454 if info is not None:
4455 err = err + " (" + str(info) + ")"
4456
4457 self.error_list.append(err)
4458
4459 def Check(self, min_value=None, max_value=None, multiple=None, info=None):
4460
4461 if min_value is None:
4462 min_value = self.min_value
4463 if max_value is None:
4464 max_value = self.max_value
4465 if multiple is None:
4466 multiple = self.multiple
4467
4468 if self.units not in uUnits and ',' not in self.units: # Allow either valid units or a list of strings
4469 self.AddError("type '{t}' unknown".format(t=self.units),info)
4470 self.AddError("Allowable types: " + str(self.units),info)
4471
4472 if self.units in uNumeric:
4473 try:
4474 to_num = float(self.raw_value)
4475
4476 if min_value is not None: # Check minimum value if it is present
4477 if to_num < min_value:
4478 self.AddError("value '{v}' is below minimum ({m})".format(v=self.raw_value,m=min_value),info)
4479
4480 if max_value is not None: # Check maximum value if it is present
4481 if to_num > max_value:
4482 self.AddError("value '{v}' is above maximum ({m})".format(v=self.raw_value,m=max_value),info)
4483
4484 except:
4485 self.AddError("value '{v}' is not of type '{t}'".format(v = self.raw_value, t=self.units),info)
4486
4487 if self.units == uInteger: # Perform integer specific checks
4488 try:
4489 to_int = int(self.raw_value)
4490
4491 if multiple is not None and multiple > 1:
4492 if (to_int % multiple) > 0:
4493 self.AddError("value '{v}' is not a multiple of {m}".format(v=self.raw_value,m=multiple),info)
4494 except:
4495 self.AddError("value '{v}' is not an integer".format(v=self.raw_value),info)
4496
4497 if self.units == uBool: # Check that the value is of a correct boolean format
4498 if self.raw_value in [True,False] or str(self.raw_value).lower() in self._bools:
4499 pass
4500 else:
4501 self.AddError("value '{v}' is not a boolean value".format(v = self.raw_value),info)
4502
4503 @property
4504 def value(self): # Return the current value, converted to appropriate units (from string representation) if required
4505 v = str(self.raw_value) # Enforce string type for known starting point
4506
4507 if self.units == uInteger: # Integer values
4508 return int(v)
4509 elif self.units in uNumeric: # Any values that use floating points
4510 v = v.replace(",",".") # Replace "," separators with "."
4511 v = float(v)
4512
4513 if self.units == uMM: # Convert from millimetres to nanometres
4514 return FromMM(v)
4515
4516 elif self.units == uMils: # Convert from mils to nanometres
4517 return FromMils(v)
4518
4519 else: # Any other floating-point values
4520 return v
4521
4522 elif self.units == uBool:
4523 if v.lower() in self._true:
4524 return True
4525 else:
4526 return False
4527 else:
4528 return v
4529
4530 def DefaultValue(self): # Reset the value of the parameter to its default
4531 self.raw_value = str(self.default)
4532
4533 def SetValue(self, new_value): # Update the value
4534 new_value = str(new_value)
4535
4536 if len(new_value.strip()) == 0:
4537 if not self.units in [uString, uBool]:
4538 return # Ignore empty values unless for strings or bools
4539
4540 if self.units == uBool: # Enforce the same boolean representation as is used in KiCad
4541 new_value = "1" if new_value.lower() in self._true else "0"
4542 elif self.units in uNumeric:
4543 new_value = new_value.replace(",", ".") # Enforce decimal point separators
4544 elif ',' in self.units: # Select from a list of values
4545 if new_value not in self.units.split(','):
4546 new_value = self.units.split(',')[0]
4547
4548 self.raw_value = new_value
4549
4550 def __str__(self): # pretty-print the parameter
4551
4552 s = self.name + ": " + str(self.raw_value)
4553
4554 if self.units in [uMM, uMils, uPercent, uRadians, uDegrees]:
4555 s += self.units
4556 elif self.units == uBool: # Special case for Boolean values
4557 s = self.name + ": {b}".format(b = "True" if self.value else "False")
4558 elif self.units == uString:
4559 s = self.name + ": '" + self.raw_value + "'"
4560
4561 return s
4562
4563
4565 def __init__(self):
4566 KiCadPlugin.__init__(self)
4567 self.defaults()
4568
4569 def defaults(self):
4570 self.module = None
4571 self.params = [] # List of added parameters that observes addition order
4572
4573 self.name = "KiCad FP Wizard"
4574 self.description = "Undefined Footprint Wizard plugin"
4575 self.image = ""
4577
4578 def AddParam(self, page, name, unit, default, **kwarg):
4579
4580 if self.GetParam(page,name) is not None: # Param already exists!
4581 return
4582
4583 param = FootprintWizardParameter(page, name, unit, default, **kwarg) # Create a new parameter
4584 self.params.append(param)
4585
4586 @property
4587 def parameters(self): # This is a helper function that returns a nested (unordered) dict of the VALUES of parameters
4588 pages = {} # Page dict
4589 for p in self.params:
4590 if p.page not in pages:
4591 pages[p.page] = {}
4592
4593 pages[p.page][p.name] = p.value # Return the 'converted' value (convert from string to actual useful units)
4594
4595 return pages
4596
4597 @property
4598 def values(self): # Same as above
4599 return self.parameters
4600
4601 def ResetWizard(self): # Reset all parameters to default values
4602 for p in self.params:
4603 p.DefaultValue()
4604
4605 def GetName(self): # Return the name of this wizard
4606 return self.name
4607
4608 def GetImage(self): # Return the filename of the preview image associated with this wizard
4609 return self.image
4610
4611 def GetDescription(self): # Return the description text
4612 return self.description
4613
4614 def GetValue(self):
4615 raise NotImplementedError
4616
4618 return "REF" # Default reference prefix for any footprint
4619
4620 def GetParam(self, page, name): # Grab a parameter
4621 for p in self.params:
4622 if p.page == page and p.name == name:
4623 return p
4624
4625 return None
4626
4627 def CheckParam(self, page, name, **kwarg):
4628 self.GetParam(page,name).Check(**kwarg)
4629
4630 def AnyErrors(self):
4631 return any([len(p.error_list) > 0 for p in self.params])
4632
4633 @property
4634 def pages(self): # Return an (ordered) list of the available page names
4635 page_list = []
4636 for p in self.params:
4637 if p.page not in page_list:
4638 page_list.append(p.page)
4639
4640 return page_list
4641
4642 def GetNumParameterPages(self): # Return the number of parameter pages
4643 return len(self.pages)
4644
4645 def GetParameterPageName(self,page_n): # Return the name of a page at a given index
4646 return self.pages[page_n]
4647
4648 def GetParametersByPageName(self, page_name): # Return a list of parameters on a given page
4649 params = []
4650
4651 for p in self.params:
4652 if p.page == page_name:
4653 params.append(p)
4654
4655 return params
4656
4657 def GetParametersByPageIndex(self, page_index): # Return an ordered list of parameters on a given page
4658 return self.GetParametersByPageName(self.GetParameterPageName(page_index))
4659
4660 def GetParameterDesignators(self, page_index): # Return a list of designators associated with a given page
4661 params = self.GetParametersByPageIndex(page_index)
4662 return [p.designator for p in params]
4663
4664 def GetParameterNames(self,page_index): # Return the list of names associated with a given page
4665 params = self.GetParametersByPageIndex(page_index)
4666 return [p.name for p in params]
4667
4668 def GetParameterValues(self,page_index): # Return the list of values associated with a given page
4669 params = self.GetParametersByPageIndex(page_index)
4670 return [str(p.raw_value) for p in params]
4671
4672 def GetParameterErrors(self,page_index): # Return list of errors associated with a given page
4673 params = self.GetParametersByPageIndex(page_index)
4674 return [str("\n".join(p.error_list)) for p in params]
4675
4676 def GetParameterTypes(self, page_index): # Return list of units associated with a given page
4677 params = self.GetParametersByPageIndex(page_index)
4678 return [str(p.units) for p in params]
4679
4680 def GetParameterHints(self, page_index): # Return a list of units associated with a given page
4681 params = self.GetParametersByPageIndex(page_index)
4682 return [str(p.hint) for p in params]
4683
4684 def GetParameterDesignators(self, page_index): # Return a list of designators associated with a given page
4685 params = self.GetParametersByPageIndex(page_index)
4686 return [str(p.designator) for p in params]
4687
4688 def SetParameterValues(self, page_index, list_of_values): # Update values on a given page
4689
4690 params = self.GetParametersByPageIndex(page_index)
4691
4692 for i, param in enumerate(params):
4693 if i >= len(list_of_values):
4694 break
4695 param.SetValue(list_of_values[i])
4696
4697 def GetFootprint( self ):
4698 self.BuildFootprint()
4699 return self.module
4700
4702 return
4703
4704 def GetBuildMessages( self ):
4705 return self.buildmessages
4706
4707 def Show(self):
4708 text = "Footprint Wizard Name: {name}\n".format(name=self.GetName())
4709 text += "Footprint Wizard Description: {desc}\n".format(desc=self.GetDescription())
4710
4711 n_pages = self.GetNumParameterPages()
4712
4713 text += "Pages: {n}\n".format(n=n_pages)
4714
4715 for i in range(n_pages):
4716 name = self.GetParameterPageName(i)
4717
4718 params = self.GetParametersByPageName(name)
4719
4720 text += "{name}\n".format(name=name)
4721
4722 for j in range(len(params)):
4723 text += ("\t{param}{err}\n".format(
4724 param = str(params[j]),
4725 err = ' *' if len(params[j].error_list) > 0 else ''
4726 ))
4727
4728 if self.AnyErrors():
4729 text += " * Errors exist for these parameters"
4730
4731 return text
4732
4734 def __init__( self ):
4735 KiCadPlugin.__init__( self )
4739 self.defaults()
4740
4741 def defaults( self ):
4742 self.name = "Undefined Action plugin"
4743 self.category = "Undefined"
4744 self.description = ""
4745
4746 def GetClassName(self):
4747 return type(self).__name__
4748
4749 def GetName( self ):
4750 return self.name
4751
4752 def GetCategoryName( self ):
4753 return self.category
4754
4755 def GetDescription( self ):
4756 return self.description
4757
4759 return self.show_toolbar_button
4760
4761 def GetIconFileName( self, dark ):
4762 if dark and self.dark_icon_file_name:
4763 return self.dark_icon_file_name
4764 else:
4765 return self.icon_file_name
4766
4767 def Run(self):
4768 return
4769
4770
4771
4772def BOX2ISafe(*args):
4773 r"""
4774 BOX2ISafe(BOX2D const & aInput) -> BOX2I
4775 BOX2ISafe(VECTOR2D const & aPos, VECTOR2D const & aSize) -> BOX2I
4776 """
4777 return _pcbnew.BOX2ISafe(*args)
4778
4779def KiROUND(*args):
4780 r"""
4781 KiROUND(VECTOR2D const & vec) -> VECTOR2I
4782 KiROUND(BOX2D const & aBoxD) -> BOX2I
4783 """
4784 return _pcbnew.KiROUND(*args)
4786 r"""Proxy of C++ VECTOR2< int > class."""
4787
4788 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
4789 __repr__ = _swig_repr
4790 x = property(_pcbnew.VECTOR2I_x_get, _pcbnew.VECTOR2I_x_set, doc=r"""x : int""")
4791 y = property(_pcbnew.VECTOR2I_y_get, _pcbnew.VECTOR2I_y_set, doc=r"""y : int""")
4792
4793 def __init__(self, *args):
4794 r"""
4795 __init__(VECTOR2I self) -> VECTOR2I
4796 __init__(VECTOR2I self, int x, int y) -> VECTOR2I
4797 __init__(VECTOR2I self, VECTOR2I aVec) -> VECTOR2I
4798 """
4799 _pcbnew.VECTOR2I_swiginit(self, _pcbnew.new_VECTOR2I(*args))
4800
4801 def EuclideanNorm(self):
4802 r"""EuclideanNorm(VECTOR2I self) -> int"""
4803 return _pcbnew.VECTOR2I_EuclideanNorm(self)
4804
4806 r"""SquaredEuclideanNorm(VECTOR2I self) -> VECTOR2< int >::extended_type"""
4807 return _pcbnew.VECTOR2I_SquaredEuclideanNorm(self)
4808
4809 def Perpendicular(self):
4810 r"""Perpendicular(VECTOR2I self) -> VECTOR2I"""
4811 return _pcbnew.VECTOR2I_Perpendicular(self)
4812
4813 def Resize(self, aNewLength):
4814 r"""Resize(VECTOR2I self, int aNewLength) -> VECTOR2I"""
4815 return _pcbnew.VECTOR2I_Resize(self, aNewLength)
4816
4817 def Format(self):
4818 r"""Format(VECTOR2I self) -> string"""
4819 return _pcbnew.VECTOR2I_Format(self)
4820
4821 def Cross(self, aVector):
4822 r"""Cross(VECTOR2I self, VECTOR2I aVector) -> VECTOR2< int >::extended_type"""
4823 return _pcbnew.VECTOR2I_Cross(self, aVector)
4824
4825 def Dot(self, aVector):
4826 r"""Dot(VECTOR2I self, VECTOR2I aVector) -> VECTOR2< int >::extended_type"""
4827 return _pcbnew.VECTOR2I_Dot(self, aVector)
4828
4829 def Distance(self, aVector):
4830 r"""Distance(VECTOR2I self, VECTOR2L aVector) -> double"""
4831 return _pcbnew.VECTOR2I_Distance(self, aVector)
4832
4833 def SquaredDistance(self, aVector):
4834 r"""SquaredDistance(VECTOR2I self, VECTOR2I aVector) -> VECTOR2< int >::extended_type"""
4835 return _pcbnew.VECTOR2I_SquaredDistance(self, aVector)
4836
4837 def __imul__(self, *args):
4838 r"""
4839 __imul__(VECTOR2I self, VECTOR2I aVector) -> VECTOR2I
4840 __imul__(VECTOR2I self, int const & aScalar) -> VECTOR2I
4841 """
4842 return _pcbnew.VECTOR2I___imul__(self, *args)
4843
4844 def __iadd__(self, *args):
4845 r"""
4846 __iadd__(VECTOR2I self, VECTOR2I aVector) -> VECTOR2I
4847 __iadd__(VECTOR2I self, int const & aScalar) -> VECTOR2I
4848 """
4849 return _pcbnew.VECTOR2I___iadd__(self, *args)
4850
4851 def __isub__(self, *args):
4852 r"""
4853 __isub__(VECTOR2I self, VECTOR2I aVector) -> VECTOR2I
4854 __isub__(VECTOR2I self, int const & aScalar) -> VECTOR2I
4855 """
4856 return _pcbnew.VECTOR2I___isub__(self, *args)
4857
4858 def __neg__(self):
4859 r"""__neg__(VECTOR2I self) -> VECTOR2I"""
4860 return _pcbnew.VECTOR2I___neg__(self)
4861
4862 def __truediv__(self, *args):
4863 return _pcbnew.VECTOR2I___truediv__(self, *args)
4864 __div__ = __truediv__
4865
4866
4867
4868 def __eq__(self, aVector):
4869 r"""__eq__(VECTOR2I self, VECTOR2I aVector) -> bool"""
4870 return _pcbnew.VECTOR2I___eq__(self, aVector)
4871
4872 def __ne__(self, aVector):
4873 r"""__ne__(VECTOR2I self, VECTOR2I aVector) -> bool"""
4874 return _pcbnew.VECTOR2I___ne__(self, aVector)
4875
4876 def __lt__(self, aVector):
4877 r"""__lt__(VECTOR2I self, VECTOR2I aVector) -> bool"""
4878 return _pcbnew.VECTOR2I___lt__(self, aVector)
4879
4880 def __le__(self, aVector):
4881 r"""__le__(VECTOR2I self, VECTOR2I aVector) -> bool"""
4882 return _pcbnew.VECTOR2I___le__(self, aVector)
4883
4884 def __gt__(self, aVector):
4885 r"""__gt__(VECTOR2I self, VECTOR2I aVector) -> bool"""
4886 return _pcbnew.VECTOR2I___gt__(self, aVector)
4887
4888 def __ge__(self, aVector):
4889 r"""__ge__(VECTOR2I self, VECTOR2I aVector) -> bool"""
4890 return _pcbnew.VECTOR2I___ge__(self, aVector)
4891
4892 def Set(self, x, y):
4893 r"""Set(VECTOR2I self, long x, long y)"""
4894 return _pcbnew.VECTOR2I_Set(self, x, y)
4895
4896 def Get(self):
4897 r"""Get(VECTOR2I self) -> PyObject *"""
4898 return _pcbnew.VECTOR2I_Get(self)
4899
4900 def __eq__(self,other): return (self.xx==other.x and self.yy==other.y)
4901 def __ne__(self,other): return not (self==other)
4902 def __str__(self): return str(self.Get())
4903 def __repr__(self): return 'VECTOR2I'+str(self.Get())
4904 def __len__(self): return len(self.Get())
4905 def __getitem__(self, index): return self.Get()[index]
4906 def __setitem__(self, index, val):
4907 if index == 0:
4908 self.xx = val
4909 elif index == 1:
4910 self.yy = val
4911 else:
4912 raise IndexError
4913 def __nonzero__(self): return self.Get() != (0,0)
4914 def __add__(self, other): return VECTOR2I(self.xx+other.x, self.yy+other.y)
4915 def __sub__(self, other): return VECTOR2I(self.xx-other.x, self.yy-other.y)
4916
4917
4918 __swig_destroy__ = _pcbnew.delete_VECTOR2I
4919
4920# Register VECTOR2I in _pcbnew:
4921_pcbnew.VECTOR2I_swigregister(VECTOR2I)
4923 r"""Proxy of C++ VECTOR2< long long > class."""
4924
4925 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
4926 __repr__ = _swig_repr
4927 ECOORD_MAX = _pcbnew.VECTOR2L_ECOORD_MAX
4928
4929 ECOORD_MIN = _pcbnew.VECTOR2L_ECOORD_MIN
4930
4931 x = property(_pcbnew.VECTOR2L_x_get, _pcbnew.VECTOR2L_x_set, doc=r"""x : long long""")
4932 y = property(_pcbnew.VECTOR2L_y_get, _pcbnew.VECTOR2L_y_set, doc=r"""y : long long""")
4933
4934 def __init__(self, *args):
4935 r"""
4936 __init__(VECTOR2L self) -> VECTOR2L
4937 __init__(VECTOR2L self, long long x, long long y) -> VECTOR2L
4938 __init__(VECTOR2L self, VECTOR2L aVec) -> VECTOR2L
4939 """
4940 _pcbnew.VECTOR2L_swiginit(self, _pcbnew.new_VECTOR2L(*args))
4941
4942 def EuclideanNorm(self):
4943 r"""EuclideanNorm(VECTOR2L self) -> long long"""
4944 return _pcbnew.VECTOR2L_EuclideanNorm(self)
4945
4947 r"""SquaredEuclideanNorm(VECTOR2L self) -> VECTOR2< long long >::extended_type"""
4948 return _pcbnew.VECTOR2L_SquaredEuclideanNorm(self)
4949
4950 def Perpendicular(self):
4951 r"""Perpendicular(VECTOR2L self) -> VECTOR2L"""
4952 return _pcbnew.VECTOR2L_Perpendicular(self)
4953
4954 def Resize(self, aNewLength):
4955 r"""Resize(VECTOR2L self, long long aNewLength) -> VECTOR2L"""
4956 return _pcbnew.VECTOR2L_Resize(self, aNewLength)
4957
4958 def Format(self):
4959 r"""Format(VECTOR2L self) -> string"""
4960 return _pcbnew.VECTOR2L_Format(self)
4961
4962 def Cross(self, aVector):
4963 r"""Cross(VECTOR2L self, VECTOR2L aVector) -> VECTOR2< long long >::extended_type"""
4964 return _pcbnew.VECTOR2L_Cross(self, aVector)
4965
4966 def Dot(self, aVector):
4967 r"""Dot(VECTOR2L self, VECTOR2L aVector) -> VECTOR2< long long >::extended_type"""
4968 return _pcbnew.VECTOR2L_Dot(self, aVector)
4969
4970 def Distance(self, aVector):
4971 r"""Distance(VECTOR2L self, VECTOR2< VECTOR2< long long >::extended_type > const & aVector) -> double"""
4972 return _pcbnew.VECTOR2L_Distance(self, aVector)
4973
4974 def SquaredDistance(self, aVector):
4975 r"""SquaredDistance(VECTOR2L self, VECTOR2L aVector) -> VECTOR2< long long >::extended_type"""
4976 return _pcbnew.VECTOR2L_SquaredDistance(self, aVector)
4977
4978 def __imul__(self, *args):
4979 r"""
4980 __imul__(VECTOR2L self, VECTOR2L aVector) -> VECTOR2L
4981 __imul__(VECTOR2L self, long long const & aScalar) -> VECTOR2L
4982 """
4983 return _pcbnew.VECTOR2L___imul__(self, *args)
4984
4985 def __iadd__(self, *args):
4986 r"""
4987 __iadd__(VECTOR2L self, VECTOR2L aVector) -> VECTOR2L
4988 __iadd__(VECTOR2L self, long long const & aScalar) -> VECTOR2L
4989 """
4990 return _pcbnew.VECTOR2L___iadd__(self, *args)
4991
4992 def __isub__(self, *args):
4993 r"""
4994 __isub__(VECTOR2L self, VECTOR2L aVector) -> VECTOR2L
4995 __isub__(VECTOR2L self, long long const & aScalar) -> VECTOR2L
4996 """
4997 return _pcbnew.VECTOR2L___isub__(self, *args)
4998
4999 def __neg__(self):
5000 r"""__neg__(VECTOR2L self) -> VECTOR2L"""
5001 return _pcbnew.VECTOR2L___neg__(self)
5002
5003 def __truediv__(self, *args):
5004 return _pcbnew.VECTOR2L___truediv__(self, *args)
5005 __div__ = __truediv__
5006
5007
5008
5009 def __eq__(self, aVector):
5010 r"""__eq__(VECTOR2L self, VECTOR2L aVector) -> bool"""
5011 return _pcbnew.VECTOR2L___eq__(self, aVector)
5012
5013 def __ne__(self, aVector):
5014 r"""__ne__(VECTOR2L self, VECTOR2L aVector) -> bool"""
5015 return _pcbnew.VECTOR2L___ne__(self, aVector)
5016
5017 def __lt__(self, aVector):
5018 r"""__lt__(VECTOR2L self, VECTOR2L aVector) -> bool"""
5019 return _pcbnew.VECTOR2L___lt__(self, aVector)
5020
5021 def __le__(self, aVector):
5022 r"""__le__(VECTOR2L self, VECTOR2L aVector) -> bool"""
5023 return _pcbnew.VECTOR2L___le__(self, aVector)
5024
5025 def __gt__(self, aVector):
5026 r"""__gt__(VECTOR2L self, VECTOR2L aVector) -> bool"""
5027 return _pcbnew.VECTOR2L___gt__(self, aVector)
5028
5029 def __ge__(self, aVector):
5030 r"""__ge__(VECTOR2L self, VECTOR2L aVector) -> bool"""
5031 return _pcbnew.VECTOR2L___ge__(self, aVector)
5032
5033 def Set(self, x, y):
5034 r"""Set(VECTOR2L self, long long x, long long y)"""
5035 return _pcbnew.VECTOR2L_Set(self, x, y)
5036
5037 def Get(self):
5038 r"""Get(VECTOR2L self) -> PyObject *"""
5039 return _pcbnew.VECTOR2L_Get(self)
5040
5041 def __eq__(self,other): return (self.xx==other.x and self.yy==other.y)
5042 def __ne__(self,other): return not (self==other)
5043 def __str__(self): return str(self.Get())
5044 def __repr__(self): return 'VECTOR2L'+str(self.Get())
5045 def __len__(self): return len(self.Get())
5046 def __getitem__(self, index): return self.Get()[index]
5047 def __setitem__(self, index, val):
5048 if index == 0:
5049 self.xx = val
5050 elif index == 1:
5051 self.yy = val
5052 else:
5053 raise IndexError
5054 def __nonzero__(self): return self.Get() != (0,0)
5055 def __add__(self, other): return VECTOR2L(self.xx+other.x, self.yy+other.y)
5056 def __sub__(self, other): return VECTOR2L(self.xx-other.x, self.yy-other.y)
5057
5058
5059 __swig_destroy__ = _pcbnew.delete_VECTOR2L
5060
5061# Register VECTOR2L in _pcbnew:
5062_pcbnew.VECTOR2L_swigregister(VECTOR2L)
5064 r"""Proxy of C++ VECTOR2_TRAITS< int > class."""
5065
5066 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
5067 __repr__ = _swig_repr
5068
5069 def __init__(self):
5070 r"""__init__(VECTOR2I_EXTENDED_TYPE self) -> VECTOR2I_EXTENDED_TYPE"""
5071 _pcbnew.VECTOR2I_EXTENDED_TYPE_swiginit(self, _pcbnew.new_VECTOR2I_EXTENDED_TYPE())
5072 __swig_destroy__ = _pcbnew.delete_VECTOR2I_EXTENDED_TYPE
5073
5074# Register VECTOR2I_EXTENDED_TYPE in _pcbnew:
5075_pcbnew.VECTOR2I_EXTENDED_TYPE_swigregister(VECTOR2I_EXTENDED_TYPE)
5077 r"""Proxy of C++ VECTOR3< double > class."""
5078
5079 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
5080 __repr__ = _swig_repr
5081 ECOORD_MAX = _pcbnew.VECTOR3D_ECOORD_MAX
5082
5083 ECOORD_MIN = _pcbnew.VECTOR3D_ECOORD_MIN
5084
5085 x = property(_pcbnew.VECTOR3D_x_get, _pcbnew.VECTOR3D_x_set, doc=r"""x : double""")
5086 y = property(_pcbnew.VECTOR3D_y_get, _pcbnew.VECTOR3D_y_set, doc=r"""y : double""")
5087 z = property(_pcbnew.VECTOR3D_z_get, _pcbnew.VECTOR3D_z_set, doc=r"""z : double""")
5088
5089 def __init__(self, *args):
5090 r"""
5091 __init__(VECTOR3D self) -> VECTOR3D
5092 __init__(VECTOR3D self, double x, double y, double z) -> VECTOR3D
5093 """
5094 _pcbnew.VECTOR3D_swiginit(self, _pcbnew.new_VECTOR3D(*args))
5095
5096 def Cross(self, aVector):
5097 r"""Cross(VECTOR3D self, VECTOR3D aVector) -> VECTOR3D"""
5098 return _pcbnew.VECTOR3D_Cross(self, aVector)
5099
5100 def Dot(self, aVector):
5101 r"""Dot(VECTOR3D self, VECTOR3D aVector) -> VECTOR3< double >::extended_type"""
5102 return _pcbnew.VECTOR3D_Dot(self, aVector)
5103
5104 def EuclideanNorm(self):