719 lines
33 KiB
HTML
719 lines
33 KiB
HTML
<html><head><title>TopoShape API/it</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><link type='text/css' href='wiki.css' rel='stylesheet'></head><body><h1>TopoShape API/it</h1></div>
|
|
|
|
<div id="mw-content-text" lang="it" dir="ltr" class="mw-content-ltr"><hr/><div class="mw-parser-output"><p>The TopoShape is the mother object of the Part Module. All shape types (wire, face, solid, etc...) of the Part module are TopoShapes, and share the following attributes and methods. Example:
|
|
</p>
|
|
<pre>import Part
|
|
sh = Part.makeBox(10,10,10)
|
|
print sh.Faces
|
|
for f in sh.Faces:
|
|
print f.Edges </pre>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>Area</b></big></div>
|
|
<div class="description">
|
|
<p><small><b>Returns</b>:</small> The total area of the faces of the shape.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>BoundBox</b></big></div>
|
|
<div class="description">
|
|
<p><small><b>Returns</b>:</small> The BoundBox of the object
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>CenterOfMass</b></big></div>
|
|
<div class="description">
|
|
<p><small><b>Returns</b>:</small> The center of mass of the current system. If the gravitational field is uniform, it is the center of gravity. The coordinates returned for the center of mass are expressed in the absolute Cartesian coordinate system.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>CompSolids</b></big></div>
|
|
<div class="description">
|
|
<p><small><b>Returns</b>:</small> Lists the subsequent shapes in this shape.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>Compounds</b></big></div>
|
|
<div class="description">
|
|
<p><small><b>Returns</b>:</small> Lists the coumpounds in this shape.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>Edges</b></big></div>
|
|
<div class="description">
|
|
<p><small><b>Returns</b>:</small> Lists the Edges in this shape.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>Faces</b></big></div>
|
|
<div class="description">
|
|
<p><small><b>Returns</b>:</small> Lists the faces in this shape.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>Length</b></big></div>
|
|
<div class="description">
|
|
<p><small><b>Returns</b>:</small> Total length of the edges of the shape.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>Matrix</b></big></div>
|
|
<div class="description">
|
|
<p><small><b>Returns</b>:</small> The current transformation of the object as matrix
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>Orientation</b></big></div>
|
|
<div class="description">
|
|
<p><small><b>Returns</b>:</small> the orientation of the shape.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>Placement</b></big></div>
|
|
<div class="description">
|
|
<p><small><b>Returns</b>:</small> The current transformation of the object as placement
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>ShapeType</b></big></div>
|
|
<div class="description">
|
|
<p><small><b>Returns</b>:</small> The type of the shape.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>Shells</b></big></div>
|
|
<div class="description">
|
|
<p><small><b>Returns</b>:</small> Lists the subsequent shapes in this shape.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>Solids</b></big></div>
|
|
<div class="description">
|
|
<p><small><b>Returns</b>:</small> List of subsequent shapes in this shape.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>Vertexes</b></big></div>
|
|
<div class="description">
|
|
<p><small><b>Returns</b>:</small> List of vertexes in this shape.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>Volume</b></big></div>
|
|
<div class="description">
|
|
<p><small><b>Returns</b>:</small> Total volume of the solids of the shape.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>Wires</b></big></div>
|
|
<div class="description">
|
|
<p><small><b>Returns</b>:</small> List of wires in this 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>approximate</b></big> ( <i> </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Approximates a B-Spline-curve from this wire
|
|
</p><p><small><b>Returns</b>:</small> a BSplineCurve object
|
|
</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>check</b></big> ( <i> </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Checks the shape and report errors in the shape structure. This is a more detailed check as done in isValid().
|
|
</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>common</b></big> ( <i>TopoShape</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Intersection of this and a given topo shape.
|
|
</p><p><small><b>Returns</b>:</small> a TopoShape
|
|
</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>complement</b></big> ( <i> </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Computes the complement of the orientation of this shape, i.e. reverses the interior/exterior status of boundaries of this shape.
|
|
</p><p><small><b>Returns</b>:</small> a TopoShape
|
|
</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>copy</b></big> ( <i> </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Creates a copy of this shape
|
|
</p><p><small><b>Returns</b>:</small> a TopoShape
|
|
</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>cut</b></big> ( <i>TopoShape</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Difference of this and a given topo shape.
|
|
</p><p><small><b>Returns</b>:</small> a TopoShape
|
|
</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>distToShape</b></big> ( <i> TopoShape </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Calculates the minimum distance between this and a given TopoShape.
|
|
</p><p><small><b>Returns</b>:</small> float<minimum distance>,list<nearest points>,list<nearest subshapes & parameters>
|
|
</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>exportBrep</b></big> ( <i> string </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Exports the content of this shape to an BREP file. BREP is a CasCade native format.
|
|
</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>exportIges</b></big> ( <i> string </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Exports the content of this shape to an IGES 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>exportStep</b></big> ( <i> string </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Exports the content of this shape to an STEP 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>exportStl</b></big> ( <i> string </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Exports the content of this shape to an STL mesh 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>extrude</b></big> ( <i>Vector</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Extrudes the shape along a direction.
|
|
</p><p><small><b>Returns</b>:</small> a TopoShape
|
|
</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>fuse</b></big> ( <i>TopoShape</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Union of this and a given topo shape.
|
|
</p><p><small><b>Returns</b>:</small> a TopoShape
|
|
</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>getAllDerivedFrom</b></big> ( <i> </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Returns all descentences of this object type
|
|
</p><p><small><b>Returns</b>:</small> a list
|
|
</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>hashCode</b></big> ( <i> </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> This value is computed from the value of the underlying shape reference and the location. Orientation is not taken into account.
|
|
</p><p><small><b>Returns</b>:</small> a string
|
|
</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>isClosed</b></big> ( <i> </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Checks if the shape is closed.
|
|
</p><p><small><b>Returns</b>:</small> a boolean
|
|
</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>isDerivedFrom</b></big> ( <i>string</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Returns true if given type is a father
|
|
</p><p><small><b>Returns</b>:</small> boolean
|
|
</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>isEqual</b></big> ( <i>TopoShape</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Returns true if both shapes share the same TShape, have the same Location and have the same Orientation.
|
|
</p><p><small><b>Returns</b>:</small> a boolean
|
|
</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>isInside</b></big> ( <i>Vector,float,Boolean</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Checks if a point is inside a solid with a certain tolerance. If the 3rd parameter is True a point on a face is considered as inside
|
|
</p><p><small><b>Returns</b>:</small> a boolean
|
|
</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>isNull</b></big> ( <i> </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Checks if the shape is null.
|
|
</p><p><small><b>Returns</b>:</small> a boolean
|
|
</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>isPartner</b></big> ( <i>TopoShape</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Returns true if both shapes share the same TShape, but may have a different Location and may have a different Orientation.
|
|
</p><p><small><b>Returns</b>:</small> a boolean
|
|
</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>isSame</b></big> ( <i>TopoShape</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Checks if both shapes share the same geometry, true if both shapes share the same TShape, have the same Location but may have a different Orientation.
|
|
</p><p><small><b>Returns</b>:</small> a boolean
|
|
</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>isValid</b></big> ( <i> </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Checks if the shape is valid, i.e. neither null, nor empty nor corrupted.
|
|
</p><p><small><b>Returns</b>:</small> a boolean
|
|
</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>makeFillet</b></big> ( <i>float,TopoShape</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Returns a new object based on TopoShape, but with a fillet of radius 'float' applied to each edge.
|
|
</p><p><small><b>Returns</b>:</small> a TopoShape
|
|
</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>makeHomogenousWires</b></big> ( <i>wire</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Makes this and the given wire homogenous to have the same number of edges
|
|
</p><p><small><b>Returns</b>:</small> a wire
|
|
</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>makeOffset</b></big> ( <i>float</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Offsets the shape by a given ammount
|
|
</p><p><small><b>Returns</b>:</small> a TopoShape
|
|
</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>makePipe</b></big> ( <i>wire</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Makes a pipe by sweeping along a wire.
|
|
</p><p><small><b>Returns</b>:</small> a TopoShape
|
|
</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>makePipeShell</b></big> ( <i>wire</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Makes a loft defined by profiles along a wire.
|
|
</p><p><small><b>Returns</b>:</small> a TopoShape
|
|
</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>makeShapeFromMesh</b></big> ( <i>mesh</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Makes a compound shape out of mesh data. Note: This should be used for rather small meshes only.
|
|
</p><p><small><b>Returns</b>:</small> a TopoShape
|
|
</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>makeThickness</b></big> ( <i>list,float,float</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> A hollowed solid is built from an initial solid and a set of faces on this solid, which are to be removed. The remaining faces of the solid become the walls of the hollowed solid, their thickness defined at the time of construction. The arguments to be passed are a list of faces to be skipped, the thickness of the walls and a tolerance value.
|
|
</p><p><small><b>Returns</b>:</small> a TopoShape
|
|
</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>nullify</b></big> ( <i> </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Destroys the reference to the underlying shape stored in this shape. As a result, this shape becomes null.
|
|
</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>project</b></big> ( <i>TopoShape</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Project a shape on this shape
|
|
</p><p><small><b>Returns</b>:</small> a TopoShape
|
|
</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> Reads in an IGES, STEP or BREP file.
|
|
</p><p><small><b>Returns</b>:</small> a TopoShape
|
|
</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>reverse</b></big> ( <i> </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Reverses the orientation of this shape.
|
|
</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>revolve</b></big> ( <i>Vector, Vector, float</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Revolves the shape around a Axis to a given degree. ex: Part.revolve(Vector(0,0,0),Vector(0,0,1),360) revolves the shape around the Z Axis 360 degree.
|
|
</p><p><small><b>Returns</b>:</small> a TopoShape
|
|
</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>rotate</b></big> ( <i>Vector<position>, Vector<direction>, float<angle></i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Rotates this shape by angle degrees around an axis specified by position and direction. ex: Shp.rotate(Vector(0,0,0),Vector(0,0,1),180) rotate the shape around the Z Axis 180 degrees.
|
|
</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>scale</b></big> ( <i>float<factor>, [Vector<centre>]</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Uniformly scales this shape by factor. Optionally specify centre of scaling transformation.
|
|
</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>section</b></big> ( <i>TopoShape</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Section of this with a given topo shape.
|
|
</p><p><small><b>Returns</b>:</small> a TopoShape
|
|
</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>sewShape</b></big> ( <i> </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Sews the shape if there is a gap.
|
|
</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>tessellate</b></big> ( <i>float</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Tessellate the the shape and return a list of vertices and face indices. The given float is the tolerance.
|
|
</p><p><small><b>Returns</b>:</small> a list
|
|
</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>toNurbs</b></big> ( <i> </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Conversion of the complete geometry of a shape into NURBS geometry. For example, all curves supporting edges of the basis shape are converted into BSpline curves, and all surfaces supporting its faces are converted into BSpline surfaces.
|
|
</p><p><small><b>Returns</b>:</small> a NURBS curve
|
|
</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>transformGeometry</b></big> ( <i>matrix</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Applies geometric transformation on a copy of the shape. The transformation to be applied is defined as a 4x4 matrix. The underlying geometry of the following shapes may change to a curve which supports an edge of the shape, or a surface which supports a face of the shape. For example, a circle may be transformed into an ellipse when applying an affinity transformation. It may also happen that the circle then is represented as a b-spline curve. The transformation is applied to all the curves which support edges of the shape, and all the surfaces which support faces of the shape. Note: If you want to transform a shape without changing the underlying geometry then use the methods translate or rotate.
|
|
</p><p><small><b>Returns</b>:</small> a TopoShape
|
|
</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>transformShape</b></big> ( <i>matrix</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Applies transformation on a shape without changing the underlying geometry.
|
|
</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>translate</b></big> ( <i>Vector</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Applies the translation to the current location of this shape.
|
|
</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>writeInventor</b></big> ( <i> </i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Writes the mesh in OpenInventor format to a string.
|
|
</p><p><small><b>Returns</b>:</small> a string
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p><p><br />
|
|
Some attributes and methods apply only to certain TopoShapes. These items apply to Edges (TopoShapeEdge).
|
|
</p><p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>FirstParameter</b></big></div>
|
|
<div class="description">
|
|
<p><small><b>Returns</b>:</small> The parameter value at one end of the Edge. Not necessarily at Vertex[0]. <a rel="nofollow" class="external text" href="http://en.wikipedia.org/wiki/Parametric_equations">See Parametric Equations</a>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<p><br />
|
|
</p>
|
|
<div class="api">
|
|
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>LastParameter</b></big></div>
|
|
<div class="description">
|
|
<p><small><b>Returns</b>:</small> The parameter value at the other end of the Edge. Not necessarily at Vertex[1].
|
|
</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>getParameterByLength</b></big> ( <i>Float</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Maps the interval [0,Length] to the interval [FirstParameter,LastParameter]
|
|
</p><p><small><b>Returns</b>:</small> Float
|
|
</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>valueAt</b></big> ( <i>Float</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Returns the 3D vector corresponding to a parameter value.
|
|
</p><p><small><b>Returns</b>:</small> Vector
|
|
</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>parameterAt</b></big> ( <i>Vertex,[Face]</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Returns the parameter value corresponding to a Vertex (3D point).
|
|
</p><p><small><b>Returns</b>:</small> Float
|
|
</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>tangentAt</b></big> ( <i>Float</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Returns the direction vector of the tangent to the edge at a parameter value (if it exists).
|
|
</p><p><small><b>Returns</b>:</small> Vector
|
|
</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>normalAt</b></big> ( <i>Float</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Returns the direction vector of the normal to the edge at a parameter value (if it exists uniquely).
|
|
</p><p><small><b>Returns</b>:</small> Vector
|
|
</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>curvatureAt</b></big> ( <i>Float</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Returns the curvature of the edge at a parameter value.
|
|
</p><p><small><b>Returns</b>:</small> Float
|
|
</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>centerOfCurvatureAt</b></big> ( <i>Float</i> )</div>
|
|
<div class="description">
|
|
<p><small><b>Description</b>:</small> Returns the center (3D point) of the osculating circle at a parameter value.
|
|
</p><p><small><b>Returns</b>:</small> Vector
|
|
</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=TopoShape_API/it&oldid=174292">http://www.freecadweb.org/wiki/index.php?title=TopoShape_API/it&oldid=174292</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> |