TopoShapeWire is the OpenCasCade topological wire wrapper
Total area of the faces of the shape.
Get the BoundBox of the object
Get the center of gravity
Returns 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.
List of subsequent shapes in this shape.
List of compounds in this shape.
Content of the object in XML representation
Returns the continuity
List of Edges in this shape.
List of faces in this shape.
Total length of the edges of the shape.
Returns the mass of the current system.
Returns the matrix of inertia. It is a symmetrical matrix. The coefficients of the matrix are the quadratic moments of inertia.
| Ixx Ixy Ixz 0 | | Ixy Iyy Iyz 0 | | Ixz Iyz Izz 0 | | 0 0 0 1 |
The moments of inertia are denoted by Ixx, Iyy, Izz. The products of inertia are denoted by Ixy, Ixz, Iyz. The matrix of inertia is returned in the central coordinate system (G, Gx, Gy, Gz) where G is the centre of mass of the system and Gx, Gy, Gz the directions parallel to the X(1,0,0) Y(0,1,0) Z(0,0,1) directions of the absolute cartesian coordinate system.
Memory size of the object in byte
Module in which this class is defined
List of ordered edges in this shape.
List of ordered vertexes in this shape.
Returns the orientation of the shape.
Get the current transformation of the object as placement
Computes the principal properties of inertia of the current system. There is always a set of axes for which the products of inertia of a geometric system are equal to 0; i.e. the matrix of inertia of the system is diagonal. These axes are the principal axes of inertia. Their origin is coincident with the center of mass of the system. The associated moments are called the principal moments of inertia. This function computes the eigen values and the eigen vectors of the matrix of inertia of the system.
Returns the type of the shape.
List of subsequent shapes in this shape.
List of subsequent shapes in this shape.
Returns Ix, Iy, Iz, the static moments of inertia of the current system; i.e. the moments of inertia about the three axes of the Cartesian coordinate system.
List of sub-shapes in this shape.
Geometry Tag
Is the type of the FreeCAD object with module domain
List of vertexes in this shape.
Total volume of the solids of the shape.
List of wires in this shape.
Add an edge to the wire add(edge)
For a sub-shape of this shape get its ancestors of a type. ancestorsOfType(shape, shape type) -> list
Apply an additional rotation to the placement
Apply an additional translation to the placement
Approximate B-Spline-curve from this wire approximate([Tol2d,Tol3d=1e-4,MaxSegments=10,MaxDegree=3]) -> BSpline
This is a more detailed check as done in isValid(). if runBopCheck is True, a BOPCheck analysis is also performed.
Return a list of sub-shapes that are direct children of this shape. childShapes([cumOri=True, cumLoc=True]) -> list
- If cumOri is true, the function composes all sub-shapes with the orientation of this shape.
- If cumLoc is true, the function multiplies all sub-shapes by the location of this shape, i.e. it applies to each sub-shape the transformation that is associated with this shape.
This can be useful to reduce file size when exporting as a BREP file. Warning: Use the cleaned shape with care because certain algorithms may work incorrectly if the shape has no internal triangulation any more.
Intersection of this and a given (list of) topo shape. common(tool) -> Shape or common((tool1,tool2,...),[tolerance=0.0]) -> Shape
Supports:
- Fuzzy Boolean operations (global tolerance for a Boolean operation)
- Support of multiple arguments for a single Boolean operation (s1 AND (s2 OR s3))
- Parallelization of Boolean Operations algorithm
OCC 6.9.0 or later is required.
Computes the complement of the orientation of this shape, i.e. reverses the interior/exterior status of boundaries of this shape. complement()
If copyMesh is True, triangulation contained in original shape will be copied along with geometry. If copyGeom is False, only topological objects will be copied, while geometry and triangulation will be shared with original shape.
Returns the count of a type of element countElement(type) -> int
Return the number of elements of a type
Difference of this and a given (list of) topo shape cut(tool) -> Shape or cut((tool1,tool2,...),[tolerance=0.0]) -> Shape
Supports:
- Fuzzy Boolean operations (global tolerance for a Boolean operation)
- Support of multiple arguments for a single Boolean operation
- Parallelization of Boolean Operations algorithm
OCC 6.9.0 or later is required.
The parameter is a list of faces.
The function accepts keywords as argument: discretize(Number=n) => gives a list of 'n' equidistant points discretize(QuasiNumber=n) => gives a list of 'n' quasi equidistant points (is faster than the method above) discretize(Distance=d) => gives a list of equidistant points with distance 'd' discretize(Deflection=d) => gives a list of points with a maximum deflection 'd' to the wire discretize(QuasiDeflection=d) => gives a list of points with a maximum deflection 'd' to the wire (faster) discretize(Angular=a,Curvature=c,[Minimum=m]) => gives a list of points with an angular deflection of 'a' and a curvature deflection of 'c'. Optionally a minimum number of points can be set which by default is set to 2.
Optionally you can set the keywords 'First' and 'Last' to define a sub-range of the parameter range of the wire.
If no keyword is given then it depends on whether the argument is an int or float. If it's an int then the behaviour is as if using the keyword 'Number', if it's float then the behaviour is as if using the keyword 'Distance'.
Example:
import Part V=App.Vector
e1=Part.makeCircle(5,V(0,0,0),V(0,0,1),0,180) e2=Part.makeCircle(5,V(10,0,0),V(0,0,1),180,360) w=Part.Wire([e1,e2])
p=w.discretize(Number=50) s=Part.Compound([Part.Vertex(i) for i in p]) Part.show(s)
p=w.discretize(Angular=0.09,Curvature=0.01,Minimum=100) s=Part.Compound([Part.Vertex(i) for i in p]) Part.show(s)
dist is the minimum distance, in mm (float value).
vectors is a list of pairs of App.Vector. Each pair corresponds to solution. Example: [(Vector (2.0, -1.0, 2.0), Vector (2.0, 0.0, 2.0)), (Vector (2.0, -1.0, 2.0), Vector (2.0, -1.0, 3.0))] First vector is a point on self, second vector is a point on s.
infos contains additional info on the solutions. It is a list of tuples: (topo1, index1, params1, topo2, index2, params2)
topo1, topo2 are strings identifying type of BREP element: 'Vertex',
'Edge', or 'Face'.
index1, index2 are indexes of the elements (zero-based).
params1, params2 are parameters of internal space of the elements. For
vertices, params is None. For edges, params is one float, u. For faces,
params is a tuple (u,v).
Dumps the content of the object, both the XML representation as well as the additional datafiles
required, into a byte representation. It will be returned as byte array.
dumpContent() -- returns a byte array with full content
dumpContent(Compression=1-9) -- Sets the data compression from 0 (no) to 9 (max)
Dump information about the shape to a string. dumpToString() -> string
Export the content of this shape in binary format to a file. exportBinary(filename)
BREP is an OpenCasCade native format.
BREP is an OpenCasCade native format.
Export the content of this shape to an IGES file. exportIges(filename)
Export the content of this shape to an STEP file. exportStep(filename)
Export the content of this shape to an STL mesh file. exportStl(filename)
Extrude the shape along a direction. extrude(direction, length)
return a plane if the shape is planar findPlane(tol=None) -> Shape
True is returned if the operation succeeded, False otherwise.
ShapeType = Vertex : only vertices are set ShapeType = Edge : only edges are set ShapeType = Face : only faces are set ShapeType = Wire : to have edges and their vertices set ShapeType = other value : all (vertices,edges,faces) are set
A face and a tolerance can optionally be supplied to the algorithm:
Union of this and a given (list of) topo shape. fuse(tool) -> Shape or fuse((tool1,tool2,...),[tolerance=0.0]) -> Shape
Union of this and a given list of topo shapes.
Supports (OCCT 6.9.0 and above):
- Fuzzy Boolean operations (global tolerance for a Boolean operation)
- Support of multiple arguments for a single Boolean operation
- Parallelization of Boolean Operations algorithm
Beginning from OCCT 6.8.1 a tolerance value can be specified.
Run general fuse algorithm (GFA) between this and given shapes. generalFuse(list_of_other_shapes, [fuzzy_value = 0.0]) -> (result, map)
list_of_other_shapes: shapes to run the algorithm against (the list is effectively prepended by 'self').
fuzzy_value: extra tolerance to apply when searching for interferences, in addition to tolerances of the input shapes.
Returns a tuple of 2: (result, map).
result is a compound containing all the pieces generated by the algorithm (e.g., for two spheres, the pieces are three touching solids). Pieces that touch share elements.
map is a list of lists of shapes, providing the info on which children of result came from which argument. The length of list is equal to length of list_of_other_shapes + 1. First element is a list of pieces that came from shape of this, and the rest are those that come from corresponding shapes in list_of_other_shapes. hint: use isSame method to test shape equality
Parallelization of Boolean Operations algorithm
OCC 6.9.0 or later is required.
Returns all descendants
Returns a SubElement getElement(elementName) -> Face | Edge | Vertex
Return a list of element types
Return a tuple of points and triangles with a given accuracy
Return vertexes and faces from a sub-element
Return a tuple of points and lines with a given accuracy
Return vertexes and lines from a sub-element
Return a tuple of points and normals with a given accuracy
mode = 0 : returns the average value between sub-shapes, mode > 0 : returns the maximal found, mode < 0 : returns the minimal found. ShapeType defines what kinds of sub-shapes to consider: Shape (default) : all : Vertex, Edge, Face, Vertex : only vertices, Edge : only edges, Face : only faces, Shell : combined Shell + Face, for each face (and containing shell), also checks edge and Vertex
mode = 0 : average mode > 0 : maximal mode < 0 : minimal
This value is computed from the value of the underlying shape reference and the location. hashCode() -> int
Orientation is not taken into account.
Import the content to this shape of a string in BREP format. importBinary(filename)
Load the shape from a file in BREP format. importBrep(filename)
Load the shape from a string that keeps the content in BREP format. importBrepFromString(string, [displayProgressBar=True])
importBrepFromString(str,False) to not display a progress bar.
Determines which shapes have a tolerance within a given interval inTolerance(value, [ShapeType=Shape]) -> ShapeList
ShapeType is interpreted as in the method getTolerance
If the shape is a shell it returns True if it has no free boundaries (edges). If the shape is a wire it returns True if it has no free ends (vertices). (Internal and External sub-shepes are ignored in these checks) If the shape is an edge it returns True if its vertices are the same.
Checks if this shape is coplanar with the given shape. isCoplanar(shape,tol=None) -> bool
Returns true if given type is a father
Checks if both shapes are equal. This means geometry, placement and orientation are equal. isEqual(shape) -> bool
Checks if this shape has an infinite expansion. isInfinite() -> bool
Checks whether a point is inside or outside the shape. isInside(point, tolerance, checkFace) => Boolean
checkFace indicates if the point lying directly on a face is considered to be inside or not
Checks if the shape is null. isNull() -> bool
Checks if both shapes share the same geometry. Placement and orientation may differ. isPartner(shape) -> bool
Checks if both shapes share the same geometry and placement. Orientation may differ. isSame(shape) -> bool
Checks if the shape is valid, i.e. neither null, nor empty nor corrupted. isValid() -> bool
tmin = tmax -> as fixTolerance (forces) tmin = 0 -> maximum tolerance will be tmax tmax = 0 or not given (more generally, tmax < tmin) -> tmax ignored, minimum will be tmin else, maximum will be max and minimum will be min ShapeType = Vertex : only vertices are set ShapeType = Edge : only edges are set ShapeType = Face : only faces are set ShapeType = Wire : to have edges and their vertices set ShapeType = other value : all (vertices,edges,faces) are set Returns True if at least one tolerance of the sub-shape has been modified
Make chamfer. makeChamfer(radius,edgeList) -> Shape or makeChamfer(radius1,radius2,edgeList) -> Shape
Profile along the spine
Make fillet. makeFillet(radius,edgeList) -> Shape or makeFillet(radius1,radius2,edgeList) -> Shape
Make this and the given wire homogeneous to have the same number of edges makeHomogenousWires(wire) -> Wire
Offset the shape by a given amount. DEPRECATED - use makeOffset2D instead.
makes an offset shape (2d offsetting). makeOffset2D(offset, [join = 0, fill = False, openResult = false, intersection = false]) -> Shape
The function supports keyword arguments. Input shape (self) can be edge, wire, face, or a compound of those.
-
offset: distance to expand the shape by. Negative value will shrink the shape.
-
join: method of offsetting non-tangent joints. 0 = arcs, 1 = tangent, 2 = intersection
-
fill: if true, the output is a face filling the space covered by offset. If false, the output is a wire.
-
openResult: affects the way open wires are processed. If False, an open wire is made. If True, a closed wire is made from a double-sided offset, with rounds around open vertices.
-
intersection: affects the way compounds are processed. If False, all children are offset independently. If True, and children are edges/wires, the children are offset in a collective manner. If compounding is nested, collectiveness does not spread across compounds (only direct children of a compound are taken collectively).
Returns: result of offsetting (wire or face or compound of those). Compounding structure follows that of source shape.
makes an offset shape (3d offsetting). makeOffsetShape(offset, tolerance, [inter = False, self_inter = False, offsetMode = 0, join = 0, fill = False]) -> Shape
The function supports keyword arguments.
-
offset: distance to expand the shape by. Negative value will shrink the shape.
-
tolerance: precision of approximation.
-
inter: (parameter to OCC routine; not implemented)
-
self_inter: (parameter to OCC routine; not implemented)
-
offsetMode: 0 = skin; 1 = pipe; 2 = recto-verso
-
join: method of offsetting non-tangent joints. 0 = arcs, 1 = tangent, 2 = intersection
-
fill: if true, offsetting a shell is to yield a solid
Returns: result of offsetting.
Parallel projection of an edge or wire on this shape makeParallelProjection(shape, dir) -> Shape
Perspective projection of an edge or wire on this shape makePerspectiveProjection(shape, pnt) -> Shape
Make a pipe by sweeping along a wire. makePipe(profile) -> Shape
Make a loft defined by a list of profiles along a wire. makePipeShell(shapeList,[isSolid=False,isFrenet=False,transition=0]) -> Shape
Transition can be 0 (default), 1 (right corners) or 2 (rounded corners).
Note: This should be used for rather small meshes only.
Hollow a solid according to given thickness and faces. makeThickness(List of faces, Offset (Float), Tolerance (Float)) -> Shape
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 function will sort any edges inside the current shape, and connect them into wire. If more than one wire is found, then it will make a compound out of all found wires.
This function is element mapping aware. If the input shape has non-zero Tag, it will map any edge and vertex element name inside the input shape into the itself.
op: an optional string to be appended when auto generates element mapping.
The plane is given with its base point and its normal direction.
Union of this and a given list of topo shapes. multiFuse((tool1,tool2,...),[tolerance=0.0]) -> Shape
Supports (OCCT 6.9.0 and above):
- Fuzzy Boolean operations (global tolerance for a Boolean operation)
- Support of multiple arguments for a single Boolean operation
- Parallelization of Boolean Operations algorithm
Beginning from OCCT 6.8.1 a tolerance value can be specified. Deprecated: use fuse() instead.
Destroys the reference to the underlying shape stored in this shape. As a result, this shape becomes null. nullify()
Union of this and a given topo shape (old algorithm). oldFuse(tool) -> Shape
Get the optimal bounding box optimalBoundingBox([useTriangulation = True, useShapeTolerance = False]) -> bound box
Determines which shapes have a tolerance over the given value overTolerance(value, [ShapeType=Shape]) -> ShapeList
ShapeType is interpreted as in the method getTolerance
Project a list of shapes on this shape project(shapeList) -> Shape
Returns two lists of Face indexes for the Faces involved in the intersection. proximity(shape,[tolerance]) -> (selfFaces, shapeFaces)
Read in an IGES, STEP or BREP file. read(filename)
Build projection or reflect lines of a shape according to a view direction. reflectLines(ViewDir, [ViewPos, UpDir, EdgeType, Visible, OnShape]) -> Shape (Compound of edges)
This algorithm computes the projection of the shape in the ViewDir direction. If OnShape is False(default), the returned edges are flat on the XY plane defined by ViewPos(origin) and UpDir(up direction). If OnShape is True, the returned edges are the corresponding 3D reflect lines located on the shape. EdgeType is a string defining the type of result edges :
- IsoLine : isoparametric line
- OutLine : outline (silhouette) edge
- Rg1Line : smooth edge of G1-continuity between two surfaces
- RgNLine : sewn edge of CN-continuity on one surface
- Sharp : sharp edge (of C0-continuity) If Visible is True (default), only visible edges are returned. If Visible is False, only invisible edges are returned.
Removes internal wires (also holes) from the shape. removeInternalWires(minimalArea) -> bool
The parameter is a list of shapes.
Removes redundant edges from the B-REP model removeSplitter() -> Shape
The parameter is in the form list of tuples with the two shapes.
Restore the content of the object from a byte representation as stored by "dumpContent". It could be restored from any python object implementing the buffer protocol. restoreContent(buffer) -- restores from the given byte array
Reverses the orientation of this shape. reverse()
Reverses the orientation of a copy of this shape. reversed() -> Shape
Part.revolve(Vector(0,0,0),Vector(0,0,1),360) - revolves the shape around the Z Axis 360 degree.
Hints: Sometimes you want to create a rotation body out of a closed edge or wire. Example: from FreeCAD import Base import Part V=Base.Vector
e=Part.Ellipse() s=e.toShape() r=s.revolve(V(0,0,0),V(0,1,0), 360) Part.show(r)
However, you may possibly realize some rendering artifacts or that the mesh creation seems to hang. This is because this way the surface is created twice. Since the curve is a full ellipse it is sufficient to do a rotation of 180 degree only, i.e. r=s.revolve(V(0,0,0),V(0,1,0), 180)
Now when rendering this object you may still see some artifacts at the poles. Now the problem seems to be that the meshing algorithm doesn't like to rotate around a point where there is no vertex.
The idea to fix this issue is that you create only half of the ellipse so that its shape representation has vertexes at its start and end point.
from FreeCAD import Base import Part V=Base.Vector
e=Part.Ellipse() s=e.toShape(e.LastParameter/4,3*e.LastParameter/4) r=s.revolve(V(0,0,0),V(0,1,0), 360) Part.show(r)
Shp.rotate(Vector(0,0,0),Vector(0,0,1),180) - rotate the shape around the Z Axis 180 degrees.
Create a new shape with rotation. rotated(base,dir,degree) -> shape
Apply scaling with point and factor to this shape. scale(factor,[base=Vector(0,0,0)])
Create a new shape with scale. scaled(factor,[base=Vector(0,0,0)]) -> shape
Section of this with a given (list of) topo shape. section(tool,[approximation=False]) -> Shape or section((tool1,tool2,...),[tolerance=0.0, approximation=False]) -> Shape
If approximation is True, section edges are approximated to a C1-continuous BSpline curve.
Supports:
- Fuzzy Boolean operations (global tolerance for a Boolean operation)
- Support of multiple arguments for a single Boolean operation (s1 AND (s2 OR s3))
- Parallelization of Boolean Operations algorithm
OCC 6.9.0 or later is required.
Sew the shape if there is a gap. sewShape()
Make single slice of this shape. slice(direction, distance) --> Wires
Make slices of this shape. slices(direction, distancesList) --> Wires
Tessellate the shape and return a list of vertices and face indices tessellate() -> (vertex,facets)
For example, all curves supporting edges of the basis shape are converted into B-spline curves, and all surfaces supporting its faces are converted into B-spline surfaces.
This method returns a new shape. The transformation to be applied is defined as a 4x4 matrix. The underlying geometry of the following shapes may change:
- 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.
Apply transformation on a shape without changing the underlying geometry. transformShape(Matrix,[boolean copy=False, checkScale=False]) -> None
If checkScale is True, it will use transformGeometry if non-uniform scaling is detected.
Create a new transformed shape transformed(Matrix,copy=False,checkScale=False,op=None) -> shape
Apply the translation to the current location of this shape. translate(vector)
Create a new shape with translation translated(vector) -> shape
Write the mesh in OpenInventor format to a string. writeInventor() -> string
documentation index > API > Wire API