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