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