293 lines
15 KiB
HTML
293 lines
15 KiB
HTML
<html><head><title>Part API/en</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><link type='text/css' href='wiki.css' rel='stylesheet'></head><body><h1>Part API/en</h1></div>
|
|
|
|
<div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr"><hr/><div class="mw-parser-output"><p>The Part module is the direct connection between FreeCAD and the OpenCasCade kernel. It provides mainly <a href="TopoShape_API.html" title="TopoShape API">TopoShapes</a> which is the main object type used by OpenCascade. The Part module also contains a variety of convenience functions to create and manipulate topoShapes. Example:
|
|
</p>
|
|
<pre>import Part
|
|
mycube = Part.makeBox(2,2,2)
|
|
Part.show(mycube) </pre>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>__fromPythonOCC__</b></big> ( <i>OCC.Object</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Helper method to convert a pythonocc shape to an internal shape
|
|
</p><p><small><b>Returns</b>:</small> A Part.Shape
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>__sortEdges__</b></big> ( <i>list of edges</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Helper method to sort an unsorted list of edges so that afterwards two adjacent edges share a common vertex
|
|
</p><p><small><b>Returns</b>:</small> a list of edges
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>__toPythonOCC__</b></big> ( <i>Part.Shape</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Helper method to convert an internal shape to pythonocc shape
|
|
</p><p><small><b>Returns</b>:</small> an OCC.Shape
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>cast_to_shape</b></big> ( <i>Part.Shape</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Cast to the actual shape type
|
|
</p><p><small><b>Returns</b>:</small>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>export</b></big> ( <i>list,string</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Export a list of objects into a single file.
|
|
</p><p><small><b>Returns</b>:</small>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>getSortedClusters</b></big> ( <i>list of edges</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Helper method to sort and cluster a variety of edges
|
|
</p><p><small><b>Returns</b>:</small>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>insert</b></big> ( <i>string,string</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Insert the file (path given as first argument) into the given document (second argument).
|
|
</p><p><small><b>Returns</b>:</small>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>makeBox</b></big> ( <i>length,width,height,[pnt,dir]</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Makes a box located at pnt with the dimensions (length,width,height). By default pnt is Vector(0,0,0) and dir is Vector(0,0,1)
|
|
</p><p><small><b>Returns</b>:</small> the created shape
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>makeCircle</b></big> ( <i>radius,[pnt,dir,angle1,angle2]</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Makes a circle with a given radius. By default pnt is Vector(0,0,0), dir is Vector(0,0,1), angle1 is 0 and angle2 is 360
|
|
</p><p><small><b>Returns</b>:</small> the created shape
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>makeCompound</b></big> ( <i>list</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Creates a compound out of a list of shapes.
|
|
</p><p><small><b>Returns</b>:</small> the created shape
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>makeCone</b></big> ( <i>radius1,radius2,height,[pnt,dir,angle]</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Makes a cone with given radii and height. By default pnt is Vector(0,0,0), dir is Vector(0,0,1) and angle is 360
|
|
</p><p><small><b>Returns</b>:</small> the created shape
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>makeCylinder</b></big> ( <i>radius,height,[pnt,dir,angle]</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Makes a cylinder with a given radius and height. By default pnt is Vector(0,0,0),dir is Vector(0,0,1) and angle is 360
|
|
</p><p><small><b>Returns</b>:</small> the created shape
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>makeHelix</b></big> ( <i>pitch,height,radius,[angle,lefthand,heightstyle]</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Makes a helix shape with a given pitch, height and radius. Defaults to right-handed cylindrical helix. Non-zero angle parameter produces a conical helix. Lefthand True produces left handed helix. Heightstyle applies only to conical helices. Heightstyle False (default) will cause the height parameter to be interpreted as the length of the side of the underlying frustum. Heightstyle True will cause the height parameter to be interpreted as the vertical height of the helix. Pitch is "metric pitch" (advance/revolution). For conical helix, radius is the minor radius.
|
|
</p><p><small><b>Returns</b>:</small> the created shape
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>makeLine</b></big> ( <i>(x1,y1,z1),(x2,y2,z2)</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Makes a line of two points
|
|
</p><p><small><b>Returns</b>:</small> the created shape
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>makeLoft</b></big> ( <i>shapelist<profiles>,[boolean<solid>,boolean<ruled>]</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Creates a loft shape using the list of profiles. Optionally make result a solid (vs surface/shell) or make result a ruled surface.
|
|
</p><p><small><b>Returns</b>:</small> the created shape
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>makePlane</b></big> ( <i>length,width,[pnt,dir]</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Makes a plane. By default pnt is Vector(0,0,0) and dir is Vector(0,0,1)
|
|
</p><p><small><b>Returns</b>:</small> the created shape
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>makePolygon</b></big> ( <i>list</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Makes a polygon of a list of Vectors
|
|
</p><p><small><b>Returns</b>:</small> the created shape
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>makeRevolution</b></big> ( <i>Curve,[vmin,vmax,angle,pnt,dir]</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Makes a revolved shape by rotating the curve or a portion of it around an axis given by (pnt,dir). By default vmin/vmax are set to bounds of the curve,angle is 360,pnt is Vector(0,0,0) and dir is Vector(0,0,1)
|
|
</p><p><small><b>Returns</b>:</small> the created shape
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>makeRuledSurface</b></big> ( <i>Edge or Wire,Edge or Wire</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Creates a ruled surface out of two edges or wires. If wires are used then these must have the same number of edges.
|
|
</p><p><small><b>Returns</b>:</small> the created shape
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>makeShell</b></big> ( <i>list</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Creates a shell out of a list of faces. Note: Resulting shell should be manifold. Non-manifold shells are not well supported.
|
|
</p><p><small><b>Returns</b>:</small> the created shape
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>makeSolid</b></big> ( <i>Part.Shape</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Creates a solid out of the shells inside a shape.
|
|
</p><p><small><b>Returns</b>:</small> the created shape
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>makeSphere</b></big> ( <i>radius,[center_pnt, axis_dir, V_startAngle, V_endAngle, U_angle]</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Makes a sphere (or partial sphere) with a given radius. By default center_pnt is Vector(0,0,0), axis_dir is Vector(0,0,1), V_startAngle is 0, V_endAngle is 90 and U_angle is 360
|
|
</p><p><small><b>Returns</b>:</small> the created shape
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>makeTorus</b></big> ( <i>radius1,radius2,[pnt,dir,angle1,angle2,angle]</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Makes a torus with a given radii and angles. By default pnt is Vector(0,0,0),dir is Vector(0,0,1),angle1 is 0,angle2 is 360 and angle is 360
|
|
</p><p><small><b>Returns</b>:</small> the created shape
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>makeTube</b></big> ( <i>edge,float</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Creates a tube.
|
|
</p><p><small><b>Returns</b>:</small> the created shape
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>open</b></big> ( <i>string</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Creates a new document and load the file into the document.
|
|
</p><p><small><b>Returns</b>:</small>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>read</b></big> ( <i>string</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Loads the file and return the shape.
|
|
</p><p><small><b>Returns</b>:</small> a shape
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>show</b></big> ( <i>shape</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Adds the shape to the active document or create one if no document exists.
|
|
</p><p><small><b>Returns</b>:</small>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div style="clear:both"></div>
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div><div class="printfooter">
|
|
Online version: "<a dir="ltr" href="https://www.freecadweb.org/wiki/index.php?title=Part_API/en&oldid=289294">http://www.freecadweb.org/wiki/index.php?title=Part_API/en&oldid=289294</a>"</div>
|
|
<div id="catlinks" class="catlinks" data-mw="interface"></div><div class="visualClear"></div>
|
|
</div>
|
|
</div>
|
|
<div id="mw-navigation">
|
|
<h2>Navigation menu</h2>
|
|
|
|
</body></html> |