PageRenderTime 47ms CodeModel.GetById 16ms RepoModel.GetById 0ms app.codeStats 0ms

/documentation/skeinforge_application.skeinforge_plugins.craft_plugins.carve.html

https://github.com/jmil/SFACT
HTML | 223 lines | 196 code | 27 blank | 0 comment | 0 complexity | 5252ba1fe332be8df863133de6df319a MD5 | raw file
    

  1. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
    3. 

  3. <html><head><title>Python: module skeinforge_application.skeinforge_plugins.craft_plugins.carve</title>
    4. 

  4. </head><body bgcolor="#f0f0f8">
    5. 

  5. 

  6. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
    7. 

  7. <tr bgcolor="#7799ee">
    8. 

  8. <td valign=bottom>&nbsp;<br>
    9. 

  9. <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="skeinforge_application.html"><font color="#ffffff">skeinforge_application</font></a>.<a href="skeinforge_application.skeinforge_plugins.html"><font color="#ffffff">skeinforge_plugins</font></a>.<a href="skeinforge_application.skeinforge_plugins.craft_plugins.html"><font color="#ffffff">craft_plugins</font></a>.carve</strong></big></big> ($Date: 2008/02/05 $)</font></td
    10. 

  10. ><td align=right valign=bottom
    11. 

  11. ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/enrique/Desktop/backup/babbleold/script/reprap/fabmetheus/skeinforge_application/skeinforge_plugins/craft_plugins/carve.py">/home/enrique/Desktop/backup/babbleold/script/reprap/fabmetheus/skeinforge_application/skeinforge_plugins/craft_plugins/carve.py</a></font></td></tr></table>
    12. 

  12.     <p>
    13. 

  13. <a href="skeinforge_application.skeinforge_plugins.craft_plugins.bottom.html">Previous</a> / <a href="skeinforge_application.skeinforge_plugins.craft_plugins.chamber.html">Next</a> / <a href="contents.html">Contents</a>
    14. 

  14. </p>
    15. 

  15. <p><tt><br>
    16. 

  16. Carve is a script to carve a shape into svg slice layers.<br>
    17. 

  17.  <br>
    18. 

  18. The carve manual page is at:<br>
    19. 

  19. <a href="http://fabmetheus.crsndoo.com/wiki/index.php/Skeinforge_Carve">http://fabmetheus.crsndoo.com/wiki/index.php/Skeinforge_Carve</a><br>
    20. 

  20.  <br>
    21. 

  21. On the Arcol Blog a method of deriving the layer thickness is posted.  That article "Machine Calibrating" is at:<br>
    22. 

  22. <a href="http://blog.arcol.hu/?p=157">http://blog.arcol.hu/?p=157</a><br>
    23. 

  23.  <br>
    24. 

  24. <br />
    25. 

  25. <a href="#Settings">Settings</a><br />
    26. 

  26. &nbsp;&nbsp;<a href="#Add Layer Template to SVG">Add Layer Template to SVG</a><br />
    27. 

  27. &nbsp;&nbsp;<a href="#Extra Decimal Places">Extra Decimal Places</a><br />
    28. 

  28. &nbsp;&nbsp;<a href="#Import Coarseness">Import Coarseness</a><br />
    29. 

  29. &nbsp;&nbsp;<a href="#Infill in Direction of Bridge">Infill in Direction of Bridge</a><br />
    30. 

  30. &nbsp;&nbsp;<a href="#Layer Thickness">Layer Thickness</a><br />
    31. 

  31. &nbsp;&nbsp;<a href="#Layers">Layers</a><br />
    32. 

  32. &nbsp;&nbsp;&nbsp;&nbsp;<a href="#Layers From">Layers From</a><br />
    33. 

  33. &nbsp;&nbsp;&nbsp;&nbsp;<a href="#Layers To">Layers To</a><br />
    34. 

  34. &nbsp;&nbsp;<a href="#Mesh Type">Mesh Type</a><br />
    35. 

  35. &nbsp;&nbsp;&nbsp;&nbsp;<a href="#Correct Mesh">Correct Mesh</a><br />
    36. 

  36. &nbsp;&nbsp;&nbsp;&nbsp;<a href="#Unproven Mesh">Unproven Mesh</a><br />
    37. 

  37. &nbsp;&nbsp;<a href="#Perimeter Width over Thickness">Perimeter Width over Thickness</a><br />
    38. 

  38. &nbsp;&nbsp;<a href="#SVG Viewer">SVG Viewer</a><br />
    39. 

  39. <a href="#Examples">Examples</a><br />
    40. 

  40. <br />
    41. 

  41. <a name="Settings" id="Settings"></a><h2>Settings</h2>
    42. 

  42. <hr>
    43. 

  43. 

  44. <a name="Add Layer Template to SVG" id="Add Layer Template to SVG"></a><h3>Add Layer Template to SVG</h3>
    45. 

  45. 

  46. Default is on.<br>
    47. 

  47.  <br>
    48. 

  48. When selected, the layer template will be added to the svg output, which adds javascript control boxes.  So 'Add Layer Template to SVG' should be selected when the svg will be viewed in a browser.<br>
    49. 

  49.  <br>
    50. 

  50. When off, no controls will be added, the svg output will only include the fabrication paths.  So 'Add Layer Template to SVG' should be deselected when the svg will be used by other software, like Inkscape.<br>
    51. 

  51.  <br>
    52. 

  52. <a name="Extra Decimal Places" id="Extra Decimal Places"></a><h3>Extra Decimal Places</h3>
    53. 

  53. 

  54. Default is two.<br>
    55. 

  55.  <br>
    56. 

  56. Defines the number of extra decimal places export will output compared to the number of decimal places in the layer thickness.  The higher the 'Extra Decimal Places', the more significant figures the output numbers will have.<br>
    57. 

  57.  <br>
    58. 

  58. <a name="Import Coarseness" id="Import Coarseness"></a><h3>Import Coarseness</h3>
    59. 

  59. 

  60. Default is one.<br>
    61. 

  61.  <br>
    62. 

  62. When a triangle mesh has holes in it, the triangle mesh slicer switches over to a slow algorithm that spans gaps in the mesh.  The higher the 'Import Coarseness' setting, the wider the gaps in the mesh it will span.  An import coarseness of one means it will span gaps of the perimeter width.<br>
    63. 

  63.  <br>
    64. 

  64. <a name="Infill in Direction of Bridge" id="Infill in Direction of Bridge"></a><h3>Infill in Direction of Bridge</h3>
    65. 

  65. 

  66. Default is on.<br>
    67. 

  67.  <br>
    68. 

  68. When selected, the infill will be in the direction of any bridge across a gap, so that the fill will be able to span a bridge easier.<br>
    69. 

  69.  <br>
    70. 

  70. <a name="Layer Thickness" id="Layer Thickness"></a><h3>Layer Thickness</h3>
    71. 

  71. 

  72. Default is 0.4 mm.<br>
    73. 

  73.  <br>
    74. 

  74. Defines the thickness of the extrusion layer at default extruder speed, this is the most important carve setting.<br>
    75. 

  75.  <br>
    76. 

  76. <a name="Layers" id="Layers"></a><h3>Layers</h3>
    77. 

  77. 

  78. Carve slices from bottom to top.  To get a single layer, set the "Layers From" to zero and the "Layers To" to one.  The 'Layers From' until 'Layers To' range is a python slice.<br>
    79. 

  79.  <br>
    80. 

  80. <a name="Layers From" id="Layers From"></a><h4>Layers From</h4>
    81. 

  81. 

  82. Default is zero.<br>
    83. 

  83.  <br>
    84. 

  84. Defines the index of the bottom layer that will be carved.  If the 'Layers From' is the default zero, the carving will start from the lowest layer.  If the 'Layers From' index is negative, then the carving will start from the 'Layers From' index below the top layer.<br>
    85. 

  85.  <br>
    86. 

  86. <a name="Layers To" id="Layers To"></a><h4>Layers To</h4>
    87. 

  87. 

  88. Default is a huge number, which will be limited to the highest index layer.<br>
    89. 

  89.  <br>
    90. 

  90. Defines the index of the top layer that will be carved.  If the 'Layers To' index is a huge number like the default, the carving will go to the top of the model.  If the 'Layers To' index is negative, then the carving will go to the 'Layers To' index below the top layer.<br>
    91. 

  91.  <br>
    92. 

  92. <a name="Mesh Type" id="Mesh Type"></a><h3>Mesh Type</h3>
    93. 

  93. 

  94. Default is 'Correct Mesh'.<br>
    95. 

  95.  <br>
    96. 

  96. <a name="Correct Mesh" id="Correct Mesh"></a><h4>Correct Mesh</h4>
    97. 

  97. 

  98. When selected, the mesh will be accurately carved, and if a hole is found, carve will switch over to the algorithm that spans gaps.<br>
    99. 

  99.  <br>
    100. 

  100. <a name="Unproven Mesh" id="Unproven Mesh"></a><h4>Unproven Mesh</h4>
    101. 

  101. 

  102. When selected, carve will use the gap spanning algorithm from the start.  The problem with the gap spanning algothm is that it will span gaps, even if there is not actually a gap in the model.<br>
    103. 

  103.  <br>
    104. 

  104. <a name="Perimeter Width over Thickness" id="Perimeter Width over Thickness"></a><h3>Perimeter Width over Thickness</h3>
    105. 

  105. 

  106. Default is 1.8.<br>
    107. 

  107.  <br>
    108. 

  108. Defines the ratio of the extrusion perimeter width to the layer thickness.  The higher the value the more the perimeter will be inset, the default is 1.8.  A ratio of one means the extrusion is a circle, a typical ratio of 1.8 means the extrusion is a wide oval.  These values should be measured from a test extrusion line.<br>
    109. 

  109.  <br>
    110. 

  110. <a name="SVG Viewer" id="SVG Viewer"></a><h3>SVG Viewer</h3>
    111. 

  111. 

  112. Default is webbrowser.<br>
    113. 

  113.  <br>
    114. 

  114. If the 'SVG Viewer' is set to the default 'webbrowser', the scalable vector graphics file will be sent to the default browser to be opened.  If the 'SVG Viewer' is set to a program name, the scalable vector graphics file will be sent to that program to be opened.<br>
    115. 

  115.  <br>
    116. 

  116. <a name="Examples" id="Examples"></a><h2>Examples</h2>
    117. 

  117. <hr>
    118. 

  118. 

  119. The following examples carve the file Screw Holder Bottom.stl.  The examples are run in a terminal in the folder which contains Screw Holder Bottom.stl and carve.py.<br>
    120. 

  120.  <br>
    121. 

  121. &gt; python carve.py<br>
    122. 

  122. This brings up the carve dialog.<br>
    123. 

  123.  <br>
    124. 

  124. &gt; python carve.py Screw Holder Bottom.stl<br>
    125. 

  125. The carve tool is parsing the file:<br>
    126. 

  126. Screw Holder Bottom.stl<br>
    127. 

  127. ..<br>
    128. 

  128. The carve tool has created the file:<br>
    129. 

  129. .. Screw Holder Bottom_carve.svg</tt>
    130. 

  130. <br />
    131. 

  131. <br />
    132. 

  132. <p>
    133. 

  133. <a href="skeinforge_application.skeinforge_plugins.craft_plugins.bottom.html">Previous</a> / <a href="skeinforge_application.skeinforge_plugins.craft_plugins.chamber.html">Next</a> / <a href="contents.html">Contents</a>
    134. 

  134. </p>
    135. 

  135. <hr>
    136. 

  136. </p>
    137. 

  137. <p>
    138. 

  138. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    139. 

  139. <tr bgcolor="#aa55cc">
    140. 

  140. <td colspan=3 valign=bottom>&nbsp;<br>
    141. 

  141. <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
    142. 

  142.     
    143. 

  143. <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    144. 

  144. <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="__init__.html">__init__</a><br>
    145. 

  145. <a href="fabmetheus_utilities.archive.html">fabmetheus_utilities.archive</a><br>
    146. 

  146. <a href="fabmetheus_utilities.euclidean.html">fabmetheus_utilities.euclidean</a><br>
    147. 

  147. <a href="fabmetheus_utilities.fabmetheus_tools.fabmetheus_interpret.html">fabmetheus_utilities.fabmetheus_tools.fabmetheus_interpret</a><br>
    148. 

  148. </td><td width="25%" valign=top><a href="fabmetheus_utilities.gcodec.html">fabmetheus_utilities.gcodec</a><br>
    149. 

  149. <a href="math.html">math</a><br>
    150. 

  150. <a href="os.html">os</a><br>
    151. 

  151. <a href="fabmetheus_utilities.settings.html">fabmetheus_utilities.settings</a><br>
    152. 

  152. </td><td width="25%" valign=top><a href="skeinforge_application.skeinforge_utilities.skeinforge_polyfile.html">skeinforge_application.skeinforge_utilities.skeinforge_polyfile</a><br>
    153. 

  153. <a href="skeinforge_application.skeinforge_utilities.skeinforge_profile.html">skeinforge_application.skeinforge_utilities.skeinforge_profile</a><br>
    154. 

  154. <a href="fabmetheus_utilities.svg_writer.html">fabmetheus_utilities.svg_writer</a><br>
    155. 

  155. <a href="sys.html">sys</a><br>
    156. 

  156. </td><td width="25%" valign=top><a href="time.html">time</a><br>
    157. 

  157. </td></tr></table></td></tr></table><p>
    158. 

  158. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    159. 

  159. <tr bgcolor="#ee77aa">
    160. 

  160. <td colspan=3 valign=bottom>&nbsp;<br>
    161. 

  161. <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
    162. 

  162.     
    163. 

  163. <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    164. 

  164. <td width="100%"><dl>
    165. 

  165. <dt><font face="helvetica, arial"><a href="skeinforge_application.skeinforge_plugins.craft_plugins.carve.html#CarveRepository">CarveRepository</a>
    166. 

  166. </font></dt><dt><font face="helvetica, arial"><a href="skeinforge_application.skeinforge_plugins.craft_plugins.carve.html#CarveSkein">CarveSkein</a>
    167. 

  167. </font></dt></dl>
    168. 

  168.  <p>
    169. 

  169. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    170. 

  170. <tr bgcolor="#ffc8d8">
    171. 

  171. <td colspan=3 valign=bottom>&nbsp;<br>
    172. 

  172. <font color="#000000" face="helvetica, arial"><a name="CarveRepository">class <strong>CarveRepository</strong></a></font></td></tr>
    173. 

  173.     
    174. 

  174. <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
    175. 

  175. <td colspan=2><tt>A&nbsp;class&nbsp;to&nbsp;handle&nbsp;the&nbsp;carve&nbsp;settings.<br>&nbsp;</tt></td></tr>
    176. 

  176. <tr><td>&nbsp;</td>
    177. 

  177. <td width="100%">Methods defined here:<br>
    178. 

  178. <dl><dt><a name="CarveRepository-__init__"><strong>__init__</strong></a>(self)</dt><dd><tt>Set&nbsp;the&nbsp;default&nbsp;settings,&nbsp;execute&nbsp;title&nbsp;&amp;&nbsp;settings&nbsp;fileName.</tt></dd></dl>
    179. 

  179. 

  180. <dl><dt><a name="CarveRepository-execute"><strong>execute</strong></a>(self)</dt><dd><tt>Carve&nbsp;button&nbsp;has&nbsp;been&nbsp;clicked.</tt></dd></dl>
    181. 

  181. 

  182. </td></tr></table> <p>
    183. 

  183. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    184. 

  184. <tr bgcolor="#ffc8d8">
    185. 

  185. <td colspan=3 valign=bottom>&nbsp;<br>
    186. 

  186. <font color="#000000" face="helvetica, arial"><a name="CarveSkein">class <strong>CarveSkein</strong></a></font></td></tr>
    187. 

  187.     
    188. 

  188. <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
    189. 

  189. <td colspan=2><tt>A&nbsp;class&nbsp;to&nbsp;carve&nbsp;a&nbsp;carving.<br>&nbsp;</tt></td></tr>
    190. 

  190. <tr><td>&nbsp;</td>
    191. 

  191. <td width="100%">Methods defined here:<br>
    192. 

  192. <dl><dt><a name="CarveSkein-getCarvedSVG"><strong>getCarvedSVG</strong></a>(self, carving, fileName, repository)</dt><dd><tt>Parse&nbsp;gnu&nbsp;triangulated&nbsp;surface&nbsp;text&nbsp;and&nbsp;store&nbsp;the&nbsp;carved&nbsp;gcode.</tt></dd></dl>
    193. 

  193. 

  194. </td></tr></table></td></tr></table><p>
    195. 

  195. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    196. 

  196. <tr bgcolor="#eeaa77">
    197. 

  197. <td colspan=3 valign=bottom>&nbsp;<br>
    198. 

  198. <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
    199. 

  199.     
    200. 

  200. <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    201. 

  201. <td width="100%"><dl><dt><a name="-getCraftedText"><strong>getCraftedText</strong></a>(fileName, gcodeText<font color="#909090">=''</font>, repository<font color="#909090">=None</font>)</dt><dd><tt>Get&nbsp;carved&nbsp;text.</tt></dd></dl>
    202. 

  202.  <dl><dt><a name="-getNewRepository"><strong>getNewRepository</strong></a>()</dt><dd><tt>Get&nbsp;new&nbsp;repository.</tt></dd></dl>
    203. 

  203.  <dl><dt><a name="-main"><strong>main</strong></a>()</dt><dd><tt>Display&nbsp;the&nbsp;carve&nbsp;dialog.</tt></dd></dl>
    204. 

  204.  <dl><dt><a name="-writeOutput"><strong>writeOutput</strong></a>(fileName, shouldAnalyze<font color="#909090">=True</font>)</dt><dd><tt>Carve&nbsp;a&nbsp;GNU&nbsp;Triangulated&nbsp;Surface&nbsp;file.</tt></dd></dl>
    205. 

  205. </td></tr></table><p>
    206. 

  206. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    207. 

  207. <tr bgcolor="#55aa55">
    208. 

  208. <td colspan=3 valign=bottom>&nbsp;<br>
    209. 

  209. <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
    210. 

  210.     
    211. 

  211. <tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    212. 

  212. <td width="100%"><strong>__author__</strong> = 'Enrique Perez (perez_enrique@yahoo.com)'<br>
    213. 

  213. <strong>__date__</strong> = '$Date: 2008/02/05 $'<br>
    214. 

  214. <strong>__license__</strong> = 'GNU Affero General Public License http://www.gnu.org/licenses/agpl.html'<br>
    215. 

  215. <strong>absolute_import</strong> = _Feature((2, 5, 0, 'alpha', 1), (2, 7, 0, 'alpha', 0), 16384)</td></tr></table><p>
    216. 

  216. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    217. 

  217. <tr bgcolor="#7799ee">
    218. 

  218. <td colspan=3 valign=bottom>&nbsp;<br>
    219. 

  219. <font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
    220. 

  220.     
    221. 

  221. <tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    222. 

  222. <td width="100%">Enrique&nbsp;Perez&nbsp;(perez_enrique@yahoo.com)</td></tr></table>
    223. 

  223. </body></html>
    224.