kindred/create
1
1
Fork 0
Code Issues 30 Pull Requests Actions 1 Packages Projects 9 Releases 2 Wiki Activity

Improve Part.Shape methods documentation

Browse Source 
Formats UserDocu to follow the template:
 Description
 method(args) -> return
 --
 More infos
This commit is contained in:
flachyjoe
2021-03-21 21:43:06 +01:00
committed by wwmayer
parent bc51f50720
commit 5389eeccb3
1 changed files with 267 additions and 187 deletions
Download Patch File Download Diff File Expand all files Collapse all files

454
src/Mod/Part/App/TopoShapePy.xml
View File

@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
<PythonExport
Father="ComplexGeoDataPy"
Name="TopoShapePy"
Twin="TopoShape"
TwinPointer="TopoShape"
Include="Mod/Part/App/TopoShape.h"
Namespace="Part"
FatherInclude="App/ComplexGeoDataPy.h"
<PythonExport
Father="ComplexGeoDataPy"
Name="TopoShapePy"
Twin="TopoShape"
TwinPointer="TopoShape"
Include="Mod/Part/App/TopoShape.h"
Namespace="Part"
FatherInclude="App/ComplexGeoDataPy.h"
FatherNamespace="Data"
Constructor="true">
<Documentation>
@@ -30,74 +30,98 @@ Sub-elements such as vertices, edges or faces are accessible as:
</Methode>
<Methode Name="read">
<Documentation>
<UserDocu>Read in an IGES, STEP or BREP file.</UserDocu>
<UserDocu>Read in an IGES, STEP or BREP file.
read(filename)
</UserDocu>
</Documentation>
</Methode>
<Methode Name="writeInventor" Const="true" Keyword="true">
<Documentation>
<UserDocu>Write the mesh in OpenInventor format to a string.</UserDocu>
<UserDocu>Write the mesh in OpenInventor format to a string.
writeInventor() -> string
</UserDocu>
</Documentation>
</Methode>
<Methode Name="exportIges" Const="true">
<Documentation>
<UserDocu>Export the content of this shape to an IGES file.</UserDocu>
<UserDocu>Export the content of this shape to an IGES file.
exportIges(filename)
</UserDocu>
</Documentation>
</Methode>
<Methode Name="exportStep" Const="true">
<Documentation>
<UserDocu>Export the content of this shape to an STEP file.</UserDocu>
<UserDocu>Export the content of this shape to an STEP file.
exportStep(filename)
</UserDocu>
</Documentation>
</Methode>
<Methode Name="exportBrep" Const="true">
<Documentation>
<UserDocu>Export the content of this shape to an BREP file. BREP is a CasCade native format.</UserDocu>
<UserDocu>Export the content of this shape to an BREP file. BREP is a CasCade native format.
exportBrep(filename)
</UserDocu>
</Documentation>
</Methode>
<Methode Name="exportBinary" Const="true">
<Documentation>
<UserDocu>Export the content of this shape in binary format to a file.</UserDocu>
<UserDocu>Export the content of this shape in binary format to a file.
exportBinary(filename)
</UserDocu>
</Documentation>
</Methode>
<Methode Name="exportBrepToString" Const="true">
<Documentation>
<UserDocu>Export the content of this shape to a string in BREP format. BREP is a CasCade native format.</UserDocu>
<UserDocu>Export the content of this shape to a string in BREP format.
exportBrepToString() -> string
--
BREP is a CasCade native format.</UserDocu>
</Documentation>
</Methode>
<Methode Name="dumpToString" Const="true">
<Documentation>
<UserDocu>Dump information about the shape to a string.</UserDocu>
<UserDocu>Dump information about the shape to a string.
dumpToString() -> string</UserDocu>
</Documentation>
</Methode>
<Methode Name="exportStl" Const="true">
<Documentation>
<UserDocu>Export the content of this shape to an STL mesh file.</UserDocu>
<UserDocu>Export the content of this shape to an STL mesh file.
exportStl(filename)</UserDocu>
</Documentation>
</Methode>
<Methode Name="importBrep">
<Documentation>
<UserDocu>Load the shape from a file in BREP format.</UserDocu>
<UserDocu>Load the shape from a file in BREP format.
importBrep(filename)</UserDocu>
</Documentation>
</Methode>
<Methode Name="importBinary">
<Documentation>
<UserDocu>Import the content to this shape of a string in BREP format.</UserDocu>
<UserDocu>Import the content to this shape of a string in BREP format.
importBinary(filename)</UserDocu>
</Documentation>
</Methode>
<Methode Name="importBrepFromString">
<Documentation>
<UserDocu>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.
</UserDocu>
</Documentation>
</Methode>
<Methode Name="extrude" Const="true">
<Documentation>
<UserDocu>Extrude the shape along a direction.</UserDocu>
<UserDocu>Extrude the shape along a direction.
extrude(direction, length)</UserDocu>
</Documentation>
</Methode>
<Methode Name="revolve" Const="true">
<Documentation>
<UserDocu>Revolve the shape around an Axis to a given degree.
revolve(base, direction, angle)
--
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.
@@ -137,8 +161,9 @@ Part.show(r)
<Methode Name="check" Const="true">
<Documentation>
<UserDocu>Checks the shape and report errors in the shape structure.
check([runBopCheck = False])
--
This is a more detailed check as done in isValid().
myShape.check(runBopCheck = False)
if runBopCheck is True, a BOPCheck analysis is also performed.</UserDocu>
</Documentation>
</Methode>
@@ -148,7 +173,7 @@ if runBopCheck is True, a BOPCheck analysis is also performed.</UserDocu>
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):
@@ -161,10 +186,9 @@ Beginning from OCCT 6.8.1 a tolerance value can be specified.</UserDocu>
</Methode>
<Methode Name="multiFuse" Const="true">
<Documentation>
<UserDocu>multiFuse((tool1,tool2,...),[tolerance=0.0]) -> Shape
Union of this and a given list of topo shapes.
<UserDocu>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
@@ -176,7 +200,9 @@ Deprecated: use fuse() instead.</UserDocu>
</Methode>
<Methode Name="oldFuse" Const="true">
<Documentation>
<UserDocu>Union of this and a given topo shape (old algorithm).</UserDocu>
<UserDocu>Union of this and a given topo shape (old algorithm).
oldFuse(tool) -> Shape
</UserDocu>
</Documentation>
</Methode>
<Methode Name="common" Const="true">
@@ -185,9 +211,7 @@ Deprecated: use fuse() instead.</UserDocu>
common(tool) -> Shape
or
common((tool1,tool2,...),[tolerance=0.0]) -> Shape
Intersection of this and a given list of topo shapes.
--
Supports:
- Fuzzy Boolean operations (global tolerance for a Boolean operation)
- Support of multiple arguments for a single Boolean operation (s1 AND (s2 OR s3))
@@ -202,11 +226,9 @@ OCC 6.9.0 or later is required.</UserDocu>
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.
Section of this and a given list of topo shapes.
Supports:
- Fuzzy Boolean operations (global tolerance for a Boolean operation)
- Support of multiple arguments for a single Boolean operation (s1 AND (s2 OR s3))
@@ -217,12 +239,15 @@ OCC 6.9.0 or later is required.</UserDocu>
</Methode>
<Methode Name="slices" Const="true">
<Documentation>
<UserDocu>Make slices of this shape.</UserDocu>
<UserDocu>Make slices of this shape.
slices(direction, distancesList) --> Wires
</UserDocu>
</Documentation>
</Methode>
<Methode Name="slice" Const="true">
<Documentation>
<UserDocu>Make single slice of this shape.</UserDocu>
<UserDocu>Make single slice of this shape.
slice(direction, distance) --> Wires</UserDocu>
</Documentation>
</Methode>
<Methode Name="cut" Const="true">
@@ -231,9 +256,7 @@ OCC 6.9.0 or later is required.</UserDocu>
cut(tool) -> Shape
or
cut((tool1,tool2,...),[tolerance=0.0]) -> Shape
Substraction of this and a given list of topo shapes.
--
Supports:
- Fuzzy Boolean operations (global tolerance for a Boolean operation)
- Support of multiple arguments for a single Boolean operation
@@ -244,8 +267,9 @@ OCC 6.9.0 or later is required.</UserDocu>
</Methode>
<Methode Name="generalFuse" Const="true">
<Documentation>
<UserDocu>generalFuse(list_of_other_shapes, fuzzy_value = 0.0): Run general fuse algorithm (GFA) between this and given shapes.
<UserDocu>Run general fuse algorithm (GFA) between this and given shapes.
generalFuse(list_of_other_shapes, fuzzy_value = 0.0)
--
list_of_other_shapes: shapes to run the algorithm against (the list is
effectively prepended by 'self').
@@ -273,14 +297,16 @@ OCC 6.9.0 or later is required.
</Methode>
<Methode Name="sewShape">
<Documentation>
<UserDocu>Sew the shape if there is a gap.</UserDocu>
<UserDocu>Sew the shape if there is a gap.
sewShape()
</UserDocu>
</Documentation>
</Methode>
<Methode Name="childShapes" Const="true">
<Documentation>
<UserDocu>
<UserDocu>Return a list of sub-shapes that are direct children of this shape.
childShapes([cumOri=True, cumLoc=True]) -> list
Return a list of sub-shapes that are direct children of this shape.
--
* If cumOri is true, the function composes all
sub-shapes with the orientation of this shape.
* If cumLoc is true, the function multiplies all
@@ -291,25 +317,30 @@ Return a list of sub-shapes that are direct children of this shape.
</Methode>
<Methode Name="ancestorsOfType" Const="true">
<Documentation>
<UserDocu>ancestorsOfType(shape, shape type) -> list
For a sub-shape of this shape get its ancestors of a type.
<UserDocu>For a sub-shape of this shape get its ancestors of a type.
ancestorsOfType(shape, shape type) -> list
</UserDocu>
</Documentation>
</Methode>
<Methode Name="removeInternalWires">
<Documentation>
<UserDocu>Removes internal wires (also holes) from the shape.</UserDocu>
<UserDocu>Removes internal wires (also holes) from the shape.
removeInternalWires(minimalArea) -> bool
</UserDocu>
</Documentation>
</Methode>
<Methode Name="mirror" Const="true">
<Documentation>
<UserDocu>Mirror this shape on a given plane.
mirror(base, norm) -> Shape
The plane is given with its base point and its normal direction.</UserDocu>
</Documentation>
</Methode>
<Methode Name="transformGeometry" Const="true">
<Documentation>
<UserDocu>Apply geometric transformation on this or a copy the shape.
transformGeometry(matrix) -> Shape
--
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:
@@ -333,20 +364,17 @@ transformGeometry(Matrix) -> Shape
</Methode>
<Methode Name="transformShape">
<Documentation>
<UserDocu>Apply transformation on a shape without changing
the underlying geometry.
<UserDocu>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.</UserDocu>
</Documentation>
</Methode>
<Methode Name="transformed" Const="true" Keyword="true">
<Documentation>
<UserDocu>
<UserDocu>Create a new transformed shape
transformed(Matrix,copy=False,checkScale=False,op=None) -> shape
Create a new transformed shape
</UserDocu>
</Documentation>
</Methode>
@@ -357,66 +385,74 @@ Create a new transformed shape
</Methode>
<Methode Name="translated">
<Documentation>
<UserDocu>
<UserDocu>Create a new shape with translation
translated(vector) -> shape
Create a new shape with translation
</UserDocu>
</Documentation>
</Methode>
<Methode Name="rotate">
<Documentation>
<UserDocu>
Apply the rotation (base,dir,degree) to the current location of this shape
<UserDocu>Apply the rotation (base,dir,degree) to the current location of this shape
rotate(base,dir,degree)
--
Shp.rotate(Vector(0,0,0),Vector(0,0,1),180) - rotate the shape around the Z Axis 180 degrees.
</UserDocu>
</Documentation>
</Methode>
<Methode Name="rotated">
<Documentation>
<UserDocu>
<UserDocu>Create a new shape with rotation.
rotated(base,dir,degree) -> shape
Create a new shape with rotation.
</UserDocu>
</Documentation>
</Methode>
<Methode Name="scale">
<Documentation>
<UserDocu>Apply scaling with point and factor to this shape.</UserDocu>
<UserDocu>Apply scaling with point and factor to this shape.
scale(factor,[base=Vector(0,0,0)])
</UserDocu>
</Documentation>
</Methode>
<Methode Name="scaled">
<Documentation>
<UserDocu>
scaled(factor,base=Vector(0,0,0)) -> shape
Create a new shape with scale.
<UserDocu>Create a new shape with scale.
scaled(factor,[base=Vector(0,0,0)]) -> shape
</UserDocu>
</Documentation>
</Methode>
<Methode Name="makeFillet" Const="true">
<Documentation>
<UserDocu>Make fillet.</UserDocu>
<UserDocu>Make fillet.
makeFillet(radius,edgeList) -> Shape
or
makeFillet(radius1,radius2,edgeList) -> Shape
</UserDocu>
</Documentation>
</Methode>
<Methode Name="makeChamfer" Const="true">
<Documentation>
<UserDocu>Make chamfer.</UserDocu>
<UserDocu>Make chamfer.
makeChamfer(radius,edgeList) -> Shape
or
makeChamfer(radius1,radius2,edgeList) -> Shape</UserDocu>
</Documentation>
</Methode>
<Methode Name="makeThickness" Const="true">
<Documentation>
<UserDocu>makeThickness(List of shapes, Offset (Float), Tolerance (Float)) -> Shape
<Documentation>
<UserDocu>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.</UserDocu>
</Documentation>
</Methode>
<Methode Name="makeOffsetShape" Const="true" Keyword="true">
<Documentation>
<UserDocu>makeOffsetShape(offset, tolerance, inter = False, self_inter = False,
offsetMode = 0, join = 0, fill = False): makes an offset shape (3d offsetting).
<Documentation>
<UserDocu>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
@@ -440,8 +476,11 @@ Returns: result of offsetting.</UserDocu>
</Methode>
<Methode Name="makeOffset2D" Const="true" Keyword="true">
<Documentation>
<UserDocu>makeOffset2D(offset, join = 0, fill = False, openResult = false, intersection =
false): makes an offset shape (2d offsetting). The function supports keyword
<UserDocu>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
@@ -469,9 +508,9 @@ structure follows that of source shape.</UserDocu>
</Methode>
<Methode Name="makeWires">
<Documentation>
<UserDocu>
makeWires(op=None): make wire(s) using the edges of this shape
<UserDocu>make wire(s) using the edges of this shape
makeWires(op=None)
--
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.
@@ -486,29 +525,39 @@ op: an optional string to be appended when auto generates element mapping.
</Methode>
<Methode Name="reverse">
<Documentation>
<UserDocu>Reverses the orientation of this shape.</UserDocu>
<UserDocu>Reverses the orientation of this shape.
reverse()
</UserDocu>
</Documentation>
</Methode>
<Methode Name="reversed">
<Documentation>
<UserDocu>Reverses the orientation of a copy of this shape.</UserDocu>
<UserDocu>Reverses the orientation of a copy of this shape.
reversed() -> Shape
</UserDocu>
</Documentation>
</Methode>
<Methode Name="complement">
<Documentation>
<UserDocu>Computes the complement of the orientation of this shape,
i.e. reverses the interior/exterior status of boundaries of this shape.</UserDocu>
i.e. reverses the interior/exterior status of boundaries of this shape.
complement()
</UserDocu>
</Documentation>
</Methode>
<Methode Name="nullify">
<Documentation>
<UserDocu>Destroys the reference to the underlying shape stored in this shape.
As a result, this shape becomes null.</UserDocu>
As a result, this shape becomes null.
nullify()
</UserDocu>
</Documentation>
</Methode>
<Methode Name="isClosed" Const="true">
<Documentation>
<UserDocu>Checks if the shape is closed
<UserDocu>Checks if the shape is closed.
isClosed() -> bool
--
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)
@@ -519,7 +568,8 @@ If the shape is an edge it returns True if its vertices are the same.
<Methode Name="isPartner" Const="true">
<Documentation>
<UserDocu>Checks if both shapes share the same geometry.
Placement and orientation may differ.
Placement and orientation may differ.
isPartner(shape) -> bool
</UserDocu>
</Documentation>
</Methode>
@@ -527,6 +577,7 @@ If the shape is an edge it returns True if its vertices are the same.
<Documentation>
<UserDocu>Checks if both shapes share the same geometry
and placement. Orientation may differ.
isSame(shape) -> bool
</UserDocu>
</Documentation>
</Methode>
@@ -534,68 +585,86 @@ If the shape is an edge it returns True if its vertices are the same.
<Documentation>
<UserDocu>Checks if both shapes are equal.
This means geometry, placement and orientation are equal.
isEqual(shape) -> bool
</UserDocu>
</Documentation>
</Methode>
<Methode Name="isNull" Const="true">
<Documentation>
<UserDocu>Checks if the shape is null.</UserDocu>
<UserDocu>Checks if the shape is null.
isNull() -> bool</UserDocu>
</Documentation>
</Methode>
<Methode Name="isValid" Const="true">
<Documentation>
<UserDocu>Checks if the shape is valid, i.e. neither null, nor empty nor corrupted.</UserDocu>
<UserDocu>Checks if the shape is valid, i.e. neither null, nor empty nor corrupted.
isValid() -> bool
</UserDocu>
</Documentation>
</Methode>
<Methode Name="isCoplanar" Const="true">
<Documentation>
<UserDocu>isCoplanar(shape,tol=None) -- Checks if this shape is coplanar with the given shape.</UserDocu>
<UserDocu>Checks if this shape is coplanar with the given shape.
isCoplanar(shape,tol=None) -> bool
</UserDocu>
</Documentation>
</Methode>
<Methode Name="isInfinite" Const="true">
<Documentation>
<UserDocu>isInfinite() -- Checks if this shape has an infinite expansion.</UserDocu>
<UserDocu>Checks if this shape has an infinite expansion.
isInfinite() -> bool
</UserDocu>
</Documentation>
</Methode>
<Methode Name="findPlane" Const="true">
<Documentation>
<UserDocu>findPlane(tol=None) -- return a plane if the shape is planar</UserDocu>
<UserDocu>return a plane if the shape is planar
findPlane(tol=None) -> Shape
</UserDocu>
</Documentation>
</Methode>
<Methode Name="fix">
<Documentation>
<UserDocu>Tries to fix a broken shape. True is returned if the operation succeeded, False otherwise.
fix(working precision, minimum precision, maximum precision)
<UserDocu>Tries to fix a broken shape.
fix(working precision, minimum precision, maximum precision) -> bool
--
True is returned if the operation succeeded, False otherwise.
</UserDocu>
</Documentation>
</Methode>
<Methode Name="hashCode" Const="true">
<Documentation>
<UserDocu>This value is computed from the value of the underlying shape reference and the location.
hashCode() -> int
--
Orientation is not taken into account.</UserDocu>
</Documentation>
</Methode>
<Methode Name="tessellate" Const="true">
<Documentation>
<UserDocu>Tessellate the shape and return a list of vertices and face indices</UserDocu>
<UserDocu>Tessellate the shape and return a list of vertices and face indices
tessellate() -> (vertex,facets)
</UserDocu>
</Documentation>
</Methode>
<Methode Name="project" Const="true">
<Documentation>
<UserDocu>Project a list of shapes on this shape</UserDocu>
<UserDocu>Project a list of shapes on this shape
project(shapeList) -> Shape
</UserDocu>
</Documentation>
</Methode>
<Methode Name="makeParallelProjection" Const="true">
<Documentation>
<UserDocu>Parallel projection of an edge or wire on this shape
makeParallelProjection(shape, dir)
makeParallelProjection(shape, dir) -> Shape
</UserDocu>
</Documentation>
</Methode>
<Methode Name="makePerspectiveProjection" Const="true">
<Documentation>
<UserDocu>Perspective projection of an edge or wire on this shape
makePerspectiveProjection(shape, pnt)
makePerspectiveProjection(shape, pnt) -> Shape
</UserDocu>
</Documentation>
</Methode>
@@ -610,12 +679,16 @@ reflectLines(ViewDir, ViewPos, UpDir) -> Shape
<Methode Name="makeShapeFromMesh">
<Documentation>
<UserDocu>Make a compound shape out of mesh data.
makeShapeFromMesh((vertex,facets),tolerance) -> Shape
--
Note: This should be used for rather small meshes only.</UserDocu>
</Documentation>
</Methode>
<Methode Name="toNurbs" Const="true">
<Documentation>
<UserDocu>Conversion of the complete geometry of a shape into NURBS geometry.
toNurbs() -> Shape
--
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.</UserDocu>
@@ -625,6 +698,7 @@ into B-spline surfaces.</UserDocu>
<Documentation>
<UserDocu>Create a copy of this shape
copy(copyGeom=True, copyMesh=False) -> Shape
--
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
@@ -635,6 +709,8 @@ geometry and triangulation will be shared with original shape.
<Methode Name="cleaned" Const="true">
<Documentation>
<UserDocu>This creates a cleaned copy of the shape with the triangulation removed.
clean()
--
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.
@@ -644,48 +720,55 @@ if the shape has no internal triangulation any more.
<Methode Name="replaceShape" Const="true">
<Documentation>
<UserDocu>Replace a sub-shape with a new shape and return a new shape.
replaceShape(tupleList) -> Shape
--
The parameter is in the form list of tuples with the two shapes.</UserDocu>
</Documentation>
</Methode>
<Methode Name="removeShape" Const="true">
<Documentation>
<UserDocu>Remove a sub-shape and return a new shape.
removeShape(shapeList) -> Shape
--
The parameter is a list of shapes.</UserDocu>
</Documentation>
</Methode>
<Methode Name="defeaturing" Const="true">
<Documentation>
<UserDocu>Remove a feature defined by supplied faces and return a new shape.
defeaturing(shapeList) -> Shape
--
The parameter is a list of faces.</UserDocu>
</Documentation>
</Methode>
<Methode Name="isInside" Const="true">
<Documentation>
<UserDocu>Checks whether a point is inside or outside the shape.
isInside(App.Vector, float, Boolean) => Boolean
The App.Vector is the point you want to check if it's inside or not
float gives the tolerance
Boolean indicates if the point lying directly on a face is considered to be inside or not
isInside(point, tolerance, checkFace) => Boolean
--
checkFace indicates if the point lying directly on a face is considered to be inside or not
</UserDocu>
</Documentation>
</Methode>
<Methode Name="removeSplitter" Const="true">
<Documentation>
<UserDocu>Removes redundant edges from the B-REP model</UserDocu>
<UserDocu>Removes redundant edges from the B-REP model
removeSplitter() -> Shape
</UserDocu>
</Documentation>
</Methode>
<Methode Name="proximity" Const="true">
<Documentation>
<UserDocu>proximity(Shape s): Returns two lists of Face indexes for the Faces involved in the intersection.</UserDocu>
<UserDocu>Returns two lists of Face indexes for the Faces involved in the intersection.
proximity(shape,[tolerance]) -> (selfFaces, shapeFaces)
</UserDocu>
</Documentation>
</Methode>
<Methode Name="distToShape" Const="true">
<Methode Name="distToShape" Const="true">
<Documentation>
<UserDocu>Find the minimum distance to another shape.
distToShape(Shape s): Returns a list of minimum distance and solution point pairs.
Returned is a tuple of three: (dist, vectors, infos).
<UserDocu>Find the minimum distance to another shape.
distToShape(shape) -> (dist, vectors, infos)
--
dist is the minimum distance, in mm (float value).
vectors is a list of pairs of App.Vector. Each pair corresponds to solution.
@@ -704,108 +787,105 @@ infos contains additional info on the solutions. It is a list of tuples:
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). </UserDocu>
</Documentation>
</Methode>
</Documentation>
</Methode>
<Methode Name="getElement" Const="true">
<Documentation>
<UserDocu>Returns a SubElement</UserDocu>
<UserDocu>Returns a SubElement
getElement(elementName) -> Face | Edge | Vertex
</UserDocu>
</Documentation>
</Methode>
<Methode Name="countElement" Const="true">
<Documentation>
<UserDocu>Returns the count of a type of element</UserDocu>
<UserDocu>Returns the count of a type of element
countElement(type) -> int
</UserDocu>
</Documentation>
</Methode>
<Methode Name="getTolerance" Const="true">
<Documentation>
<UserDocu>
getTolerance(mode, ShapeType=Shape) -> float
Determines a tolerance from the ones stored in a shape
mode = 0 : returns the average value between sub-shapes,
mode &gt; 0 : returns the maximal found,
mode &lt; 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
<UserDocu>Determines a tolerance from the ones stored in a shape
getTolerance(mode, ShapeType=Shape) -> float
--
mode = 0 : returns the average value between sub-shapes,
mode &gt; 0 : returns the maximal found,
mode &lt; 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
</UserDocu>
</Documentation>
</Methode>
<Methode Name="overTolerance" Const="true">
<Documentation>
<UserDocu>
overTolerance(value, ShapeType=Shape) -> float
Determines which shapes have a tolerance over the given value
ShapeType is interpreted as in the method getTolerance
<UserDocu>Determines which shapes have a tolerance over the given value
overTolerance(value, [ShapeType=Shape]) -> ShapeList
--
ShapeType is interpreted as in the method getTolerance
</UserDocu>
</Documentation>
</Methode>
<Methode Name="inTolerance" Const="true">
<Documentation>
<UserDocu>
inTolerance(value, ShapeType=Shape) -> float
Determines which shapes have a tolerance within a given interval
ShapeType is interpreted as in the method getTolerance
<UserDocu>Determines which shapes have a tolerance within a given interval
inTolerance(value, [ShapeType=Shape]) -> ShapeList
--
ShapeType is interpreted as in the method getTolerance
</UserDocu>
</Documentation>
</Methode>
<Methode Name="globalTolerance" Const="true">
<Documentation>
<UserDocu>
globalTolerance(mode) -> float
Returns the computed tolerance according to the mode
mode = 0 : average
mode &gt; 0 : maximal
mode &lt; 0 : minimal
<UserDocu>Returns the computed tolerance according to the mode
globalTolerance(mode) -> float
--
mode = 0 : average
mode &gt; 0 : maximal
mode &lt; 0 : minimal
</UserDocu>
</Documentation>
</Methode>
<Methode Name="fixTolerance" Const="true">
<Documentation>
<UserDocu>
fixTolerance(value, ShapeType=Shape)
Sets (enforces) tolerances in a shape to the given value
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
<UserDocu>Sets (enforces) tolerances in a shape to the given value
fixTolerance(value, [ShapeType=Shape])
--
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
</UserDocu>
</Documentation>
</Methode>
<Methode Name="limitTolerance" Const="true">
<Documentation>
<UserDocu>
limitTolerance(tmin, tmax=0, ShapeType=Shape)
Limits tolerances in a shape as follows :
tmin = tmax -> as fixTolerance (forces)
tmin = 0 -> maximum tolerance will be tmax
tmax = 0 or not given (more generally, tmax &lt; 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
<UserDocu>Limits tolerances in a shape
limitTolerance(tmin, [tmax=0, ShapeType=Shape]) -> bool
--
tmin = tmax -> as fixTolerance (forces)
tmin = 0 -> maximum tolerance will be tmax
tmax = 0 or not given (more generally, tmax &lt; 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
</UserDocu>
</Documentation>
</Methode>
<Methode Name="optimalBoundingBox" Const="true">
<Documentation>
<UserDocu>
optimalBoundingBox(useTriangulation = True, useShapeTolerance = False) -> bound box
<UserDocu>Get the optimal bounding box
optimalBoundingBox([useTriangulation = True, useShapeTolerance = False]) -> bound box
</UserDocu>
</Documentation>
</Methode>
@@ -841,25 +921,25 @@ infos contains additional info on the solutions. It is a list of tuples:
</Documentation>
<Parameter Name="Vertexes" Type="List"/>
</Attribute>
<Attribute Name="Shells" ReadOnly="true">
<Documentation>
<UserDocu>List of subsequent shapes in this shape.</UserDocu>
</Documentation>
<Parameter Name="Shells" Type="List"/>
</Attribute>
<Attribute Name="Solids" ReadOnly="true">
<Documentation>
<UserDocu>List of subsequent shapes in this shape.</UserDocu>
</Documentation>
<Parameter Name="Solids" Type="List"/>
</Attribute>
<Attribute Name="CompSolids" ReadOnly="true">
<Documentation>
<UserDocu>List of subsequent shapes in this shape.</UserDocu>
</Documentation>
<Parameter Name="CompSolids" Type="List"/>
</Attribute>
<Attribute Name="Edges" ReadOnly="true">
<Attribute Name="Shells" ReadOnly="true">
<Documentation>
<UserDocu>List of subsequent shapes in this shape.</UserDocu>
</Documentation>
<Parameter Name="Shells" Type="List"/>
</Attribute>
<Attribute Name="Solids" ReadOnly="true">
<Documentation>
<UserDocu>List of subsequent shapes in this shape.</UserDocu>
</Documentation>
<Parameter Name="Solids" Type="List"/>
</Attribute>
<Attribute Name="CompSolids" ReadOnly="true">
<Documentation>
<UserDocu>List of subsequent shapes in this shape.</UserDocu>
</Documentation>
<Parameter Name="CompSolids" Type="List"/>
</Attribute>
<Attribute Name="Edges" ReadOnly="true">
<Documentation>
<UserDocu>List of Edges in this shape.</UserDocu>
</Documentation>