summaryrefslogtreecommitdiff
path: root/trunk/users/stef/pyRepRap/docs/reprap.baseplotters.html
blob: 14790cfc9ea0701c908ab4ecf08989a2ab660ab2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195

<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module reprap.baseplotters</title>
</head><body bgcolor="#f0f0f8">

<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="reprap.html"><font color="#ffffff">reprap</font></a>.baseplotters</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/lib/python2.5/site-packages/reprap/baseplotters.py">/usr/lib/python2.5/site-packages/reprap/baseplotters.py</a></font></td></tr></table>
    <p><tt>Base&nbsp;classes&nbsp;for&nbsp;import,&nbsp;export&nbsp;and&nbsp;toolhead&nbsp;plugins</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
    
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="reprap.reprap.html">reprap.reprap</a><br>
</td><td width="25%" valign=top><a href="threading.html">threading</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
    
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="reprap.baseplotters.html#Tool">Tool</a>
</font></dt><dt><font face="helvetica, arial"><a href="threading.html#Thread">threading.Thread</a>(<a href="threading.html#_Verbose">threading._Verbose</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="reprap.baseplotters.html#ExportPlotter">ExportPlotter</a>
</font></dt><dt><font face="helvetica, arial"><a href="reprap.baseplotters.html#ImportPlotter">ImportPlotter</a>
</font></dt></dl>
</dd>
</dl>
 <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="ExportPlotter">class <strong>ExportPlotter</strong></a>(<a href="threading.html#Thread">threading.Thread</a>)</font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>Base&nbsp;class&nbsp;for&nbsp;export&nbsp;plotter&nbsp;plugins<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="reprap.baseplotters.html#ExportPlotter">ExportPlotter</a></dd>
<dd><a href="threading.html#Thread">threading.Thread</a></dd>
<dd><a href="threading.html#_Verbose">threading._Verbose</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="ExportPlotter-__init__"><strong>__init__</strong></a>(self, toolpath, toolhead, feedbackHandler<font color="#909090">=False</font>, outputFilename<font color="#909090">=False</font>)</dt><dd><tt>Create&nbsp;output&nbsp;plotter&nbsp;plugin&nbsp;with&nbsp;toolpath&nbsp;(reprap.toolpath.Object&nbsp;object),&nbsp;toolhead&nbsp;(toolhead&nbsp;plugin&nbsp;object),&nbsp;feedback&nbsp;handler&nbsp;(feedback&nbsp;handler&nbsp;object)&nbsp;and&nbsp;output&nbsp;file&nbsp;name</tt></dd></dl>

<dl><dt><a name="ExportPlotter-cartesianMove"><strong>cartesianMove</strong></a>(self, x, y, z, units<font color="#909090">=1</font>)</dt><dd><tt>Perform&nbsp;cartesian&nbsp;movement<br>
This&nbsp;should&nbsp;be&nbsp;defined&nbsp;in&nbsp;derived&nbsp;plugin&nbsp;class</tt></dd></dl>

<dl><dt><a name="ExportPlotter-loadPreferences"><strong>loadPreferences</strong></a>(self)</dt><dd><tt>Load&nbsp;preferences&nbsp;from&nbsp;file<br>
This&nbsp;should&nbsp;be&nbsp;defined&nbsp;in&nbsp;derived&nbsp;plugin&nbsp;class</tt></dd></dl>

<dl><dt><a name="ExportPlotter-run"><strong>run</strong></a>(self)</dt><dd><tt>Run&nbsp;is&nbsp;executed&nbsp;when&nbsp;thread&nbsp;is&nbsp;started&nbsp;(in&nbsp;new&nbsp;thread)<br>
This&nbsp;should&nbsp;be&nbsp;defined&nbsp;in&nbsp;derived&nbsp;plugin&nbsp;class</tt></dd></dl>

<dl><dt><a name="ExportPlotter-terminate"><strong>terminate</strong></a>(self)</dt><dd><tt>Tell&nbsp;thread&nbsp;to&nbsp;terminate&nbsp;ASAP&nbsp;(result&nbsp;of&nbsp;GUI&nbsp;'Stop'&nbsp;button)</tt></dd></dl>

<hr>
Methods inherited from <a href="threading.html#Thread">threading.Thread</a>:<br>
<dl><dt><a name="ExportPlotter-__repr__"><strong>__repr__</strong></a>(self)</dt></dl>

<dl><dt><a name="ExportPlotter-getName"><strong>getName</strong></a>(self)</dt></dl>

<dl><dt><a name="ExportPlotter-isAlive"><strong>isAlive</strong></a>(self)</dt></dl>

<dl><dt><a name="ExportPlotter-isDaemon"><strong>isDaemon</strong></a>(self)</dt></dl>

<dl><dt><a name="ExportPlotter-join"><strong>join</strong></a>(self, timeout<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="ExportPlotter-setDaemon"><strong>setDaemon</strong></a>(self, daemonic)</dt></dl>

<dl><dt><a name="ExportPlotter-setName"><strong>setName</strong></a>(self, name)</dt></dl>

<dl><dt><a name="ExportPlotter-start"><strong>start</strong></a>(self)</dt></dl>

<hr>
Data descriptors inherited from <a href="threading.html#_Verbose">threading._Verbose</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="ImportPlotter">class <strong>ImportPlotter</strong></a>(<a href="threading.html#Thread">threading.Thread</a>)</font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>Base&nbsp;class&nbsp;for&nbsp;import&nbsp;plotter&nbsp;plugins<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="reprap.baseplotters.html#ImportPlotter">ImportPlotter</a></dd>
<dd><a href="threading.html#Thread">threading.Thread</a></dd>
<dd><a href="threading.html#_Verbose">threading._Verbose</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="ImportPlotter-__init__"><strong>__init__</strong></a>(self, fileName, toolpath, feedbackHandler<font color="#909090">=False</font>, arcResolution<font color="#909090">=False</font>, fillDensity<font color="#909090">=4</font>, debug<font color="#909090">=False</font>)</dt><dd><tt>Create&nbsp;plotter&nbsp;plugin&nbsp;with&nbsp;filename,&nbsp;toolpath&nbsp;(reprap.toolpath.Object&nbsp;object),&nbsp;feedback&nbsp;handler&nbsp;(feedback&nbsp;handler&nbsp;object),&nbsp;fill&nbsp;density&nbsp;(lines&nbsp;/&nbsp;mm)&nbsp;and&nbsp;debug</tt></dd></dl>

<dl><dt><a name="ImportPlotter-getFileLimitsXY"><strong>getFileLimitsXY</strong></a>(self)</dt><dd><tt>Return&nbsp;bounding&nbsp;limits&nbsp;of&nbsp;file&nbsp;(used&nbsp;for&nbsp;zeroing&nbsp;position)<br>
This&nbsp;should&nbsp;be&nbsp;defined&nbsp;in&nbsp;derived&nbsp;plugin&nbsp;class</tt></dd></dl>

<dl><dt><a name="ImportPlotter-loadPreferences"><strong>loadPreferences</strong></a>(self)</dt><dd><tt>Load&nbsp;preferences&nbsp;from&nbsp;file<br>
This&nbsp;should&nbsp;be&nbsp;defined&nbsp;in&nbsp;derived&nbsp;plugin&nbsp;class</tt></dd></dl>

<dl><dt><a name="ImportPlotter-run"><strong>run</strong></a>(self)</dt><dd><tt>Run&nbsp;is&nbsp;executed&nbsp;when&nbsp;thread&nbsp;is&nbsp;started&nbsp;(in&nbsp;new&nbsp;thread)<br>
This&nbsp;should&nbsp;be&nbsp;defined&nbsp;in&nbsp;derived&nbsp;plugin&nbsp;class</tt></dd></dl>

<dl><dt><a name="ImportPlotter-terminate"><strong>terminate</strong></a>(self)</dt><dd><tt>Tell&nbsp;thread&nbsp;to&nbsp;terminate&nbsp;ASAP&nbsp;(result&nbsp;of&nbsp;GUI&nbsp;'Stop'&nbsp;button)</tt></dd></dl>

<hr>
Methods inherited from <a href="threading.html#Thread">threading.Thread</a>:<br>
<dl><dt><a name="ImportPlotter-__repr__"><strong>__repr__</strong></a>(self)</dt></dl>

<dl><dt><a name="ImportPlotter-getName"><strong>getName</strong></a>(self)</dt></dl>

<dl><dt><a name="ImportPlotter-isAlive"><strong>isAlive</strong></a>(self)</dt></dl>

<dl><dt><a name="ImportPlotter-isDaemon"><strong>isDaemon</strong></a>(self)</dt></dl>

<dl><dt><a name="ImportPlotter-join"><strong>join</strong></a>(self, timeout<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="ImportPlotter-setDaemon"><strong>setDaemon</strong></a>(self, daemonic)</dt></dl>

<dl><dt><a name="ImportPlotter-setName"><strong>setName</strong></a>(self, name)</dt></dl>

<dl><dt><a name="ImportPlotter-start"><strong>start</strong></a>(self)</dt></dl>

<hr>
Data descriptors inherited from <a href="threading.html#_Verbose">threading._Verbose</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="Tool">class <strong>Tool</strong></a></font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>Base&nbsp;class&nbsp;for&nbsp;tool&nbsp;plugins<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="Tool-__init__"><strong>__init__</strong></a>(self)</dt><dd><tt>Create&nbsp;tool&nbsp;object</tt></dd></dl>

<dl><dt><a name="Tool-idle"><strong>idle</strong></a>(self)</dt><dd><tt>Switch&nbsp;off&nbsp;tool&nbsp;(e.g.&nbsp;switch&nbsp;off&nbsp;cutter)<br>
This&nbsp;should&nbsp;be&nbsp;defined&nbsp;in&nbsp;derived&nbsp;plugin&nbsp;class</tt></dd></dl>

<dl><dt><a name="Tool-prepare"><strong>prepare</strong></a>(self)</dt><dd><tt>Switch&nbsp;on&nbsp;tool&nbsp;/&nbsp;prepare&nbsp;for&nbsp;use&nbsp;(e.g.&nbsp;switch&nbsp;on&nbsp;cutter)<br>
This&nbsp;should&nbsp;be&nbsp;defined&nbsp;in&nbsp;derived&nbsp;plugin&nbsp;class</tt></dd></dl>

<dl><dt><a name="Tool-ready"><strong>ready</strong></a>(self)</dt><dd><tt><a href="#Tool">Tool</a>&nbsp;use&nbsp;about&nbsp;to&nbsp;start,&nbsp;make&nbsp;sure&nbsp;it&nbsp;is&nbsp;ready&nbsp;(e.g.&nbsp;dip&nbsp;paintbrush)<br>
This&nbsp;should&nbsp;be&nbsp;defined&nbsp;in&nbsp;derived&nbsp;plugin&nbsp;class</tt></dd></dl>

<dl><dt><a name="Tool-start"><strong>start</strong></a>(self)</dt><dd><tt>Start&nbsp;tool&nbsp;use&nbsp;(e.g.&nbsp;lower&nbsp;cutter)<br>
This&nbsp;should&nbsp;be&nbsp;defined&nbsp;in&nbsp;derived&nbsp;plugin&nbsp;class</tt></dd></dl>

<dl><dt><a name="Tool-stop"><strong>stop</strong></a>(self)</dt><dd><tt>End&nbsp;tool&nbsp;use&nbsp;(e.g.&nbsp;raise&nbsp;cutter)<br>
This&nbsp;should&nbsp;be&nbsp;defined&nbsp;in&nbsp;derived&nbsp;plugin&nbsp;class</tt></dd></dl>

</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
    
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>__author__</strong> = 'Stefan Blanke (greenarrow) (greenarrow@users.sourceforge.net)'<br>
<strong>__licence__</strong> = '<font color="#c040c0">\n</font>pyRepRap is free software: you can redistribute...ap.  If not, see &lt;http://www.gnu.org/licenses/&gt;.<font color="#c040c0">\n</font>'<br>
<strong>__license__</strong> = 'GPL 3.0'</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#7799ee">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
    
<tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%">Stefan&nbsp;Blanke&nbsp;(greenarrow)&nbsp;(greenarrow@users.sourceforge.net)</td></tr></table>
</body></html>