Mesh Scripting: Difference between revisions

From FreeCAD Documentation
(Changed Docnav order.)
(Apply new top tag)
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>
<!--T:21-->
{{Docnav
|[[Topological_data_scripting|Topological data scripting]]
|[[Mesh_to_Part|Mesh to Part]]
}}


</translate>
</translate>
Line 22: Line 17:
<translate>
<translate>


==Creation and loading== <!--T:3-->
==Creation== <!--T:3-->

<!--T:32-->
To create an empty mesh object just use the standard constructor:
To create an empty mesh object just use the standard constructor:


Line 59: Line 56:
The Mesh-Kernel takes care of creating a topologically correct data structure by sorting coincident points and edges.
The Mesh-Kernel takes care of creating a topologically correct data structure by sorting coincident points and edges.


</translate>{{Top}}<translate>
<!--T:28-->
[[#top|top]]


==Modeling== <!--T:9-->
==Modeling== <!--T:9-->


<!--T:26-->
<!--T:26-->
To create regular geometries you can use the Python module {{incode|BuildRegularGeoms}}:
To create regular geometries you can use one of the {{incode|create*()}} methods. A torus, for instance, can be created as follows:


</translate>
</translate>
{{Code|code=
{{Code|code=
m = Mesh.createTorus(8.0, 2.0, 50)
import BuildRegularGeoms
}}
<translate>

<!--T:10-->
This module provides methods to define simple rotation bodies like spheres, ellipsoids, cylinders, toroids and cones. And it also has a method to create a simple cube.
A toroid, for instance, can be created as follows:

</translate>
{{Code|code=
t = BuildRegularGeoms.Toroid(8.0, 2.0, 50) # list with several thousands triangles
m = Mesh.Mesh(t)
Mesh.show(m)
Mesh.show(m)
}}
}}
Line 86: Line 71:


<!--T:11-->
<!--T:11-->
The first two parameters define the radii of the toroid and the third parameter is a sub-sampling factor for how many triangles are created. The higher this value the smoother the mesh.
The first two parameters define the radii of the torus and the third parameter is a sub-sampling factor for how many triangles are created. The higher this value the smoother the mesh.


<!--T:33-->
The {{incode|Mesh}} module also provides three Boolean methods: {{incode|union()}}, {{incode|intersection()}} and {{incode|difference()}}:
The {{incode|Mesh}} module also provides three Boolean methods: {{incode|union()}}, {{incode|intersection()}} and {{incode|difference()}}:


Line 109: Line 95:
</translate>
</translate>
{{Code|code=
{{Code|code=
import FreeCAD, Mesh, BuildRegularGeoms
import FreeCAD, Mesh
cylA = Mesh.Mesh(BuildRegularGeoms.Cylinder(2.0, 10.0, True, 1.0, 36))
cylA = Mesh.createCylinder(2.0, 10.0, True, 1.0, 36)
cylB = Mesh.Mesh(BuildRegularGeoms.Cylinder(1.0, 12.0, True, 1.0, 36))
cylB = Mesh.createCylinder(1.0, 12.0, True, 1.0, 36)
cylB.Placement.Base = (FreeCAD.Vector(-1, 0, 0)) # move cylB to avoid co-planar faces
cylB.Placement.Base = (FreeCAD.Vector(-1, 0, 0)) # move cylB to avoid co-planar faces
pipe = cylA
pipe = cylA
pipe = pipe.difference(cylB)
pipe = pipe.difference(cylB)
pipe.flipNormals() # somehow required
pipe.flipNormals() # somehow required
d = FreeCAD.ActiveDocument
doc = FreeCAD.ActiveDocument
d.addObject("Mesh::Feature", "Pipe").Mesh = pipe
obj = d.addObject("Mesh::Feature", "Pipe")
obj.Mesh = pipe
d.recompute()
doc.recompute()
}}
}}
<translate>
<translate>


</translate>{{Top}}<translate>
<!--T:29-->
[[#top|top]]

==Exporting== <!--T:15-->
You can even write a mesh to a python module:

</translate>
{{Code|code=
import os
path = os.environ.get("APPDATA") + "/FreeCAD/Macro/SavedMesh.py"
m.write(path)
import SavedMesh
m2 = Mesh.Mesh(SavedMesh.faces)
}}
<translate>

<!--T:30-->
[[#top|top]]


==Notes== <!--T:17-->
==Notes== <!--T:17-->
Line 149: Line 119:


<!--T:20-->
<!--T:20-->
See also [[Mesh_API|Mesh API]]
See also: [[Mesh_API|Mesh API]].


</translate>{{Top}}<translate>
<!--T:31-->
[[#top|top]]

<!--T:18-->
{{Docnav
|[[Topological_data_scripting|Topological data scripting]]
|[[Mesh_to_Part|Mesh to Part]]
}}


</translate>
</translate>
{{Mesh Tools navi{{#translation:}}}}
{{Powerdocnavi{{#translation:}}}}
{{Powerdocnavi{{#translation:}}}}
[[Category:Developer Documentation{{#translation:}}]]
[[Category:Python Code{{#translation:}}]]
[[Category:Python Code{{#translation:}}]]
{{Mesh Tools navi{{#translation:}}}}
{{clear}}
{{clear}}

Latest revision as of 18:39, 4 September 2021

Introduction

To get access to the Mesh module you have to import it first:

import Mesh

Creation

To create an empty mesh object just use the standard constructor:

mesh = Mesh.Mesh()

You can also create an object from a file:

mesh = Mesh.Mesh("D:/temp/Something.stl")

Or create it out of a set of triangles described by their corner points:

triangles = [
# triangle 1
[-0.5000, -0.5000, 0.0000], [0.5000, 0.5000, 0.0000], [-0.5000, 0.5000, 0.0000],
#triangle 2
[-0.5000, -0.5000, 0.0000], [0.5000, -0.5000, 0.0000], [0.5000, 0.5000, 0.0000],
]
meshObject = Mesh.Mesh(triangles)
Mesh.show(meshObject)

The Mesh-Kernel takes care of creating a topologically correct data structure by sorting coincident points and edges.

Top

Modeling

To create regular geometries you can use one of the create*() methods. A torus, for instance, can be created as follows:

m = Mesh.createTorus(8.0, 2.0, 50)
Mesh.show(m)

The first two parameters define the radii of the torus and the third parameter is a sub-sampling factor for how many triangles are created. The higher this value the smoother the mesh.

The Mesh module also provides three Boolean methods: union(), intersection() and difference():

m1, m2              # are the input mesh objects
m3 = Mesh.Mesh(m1)  # create a copy of m1
m3.unite(m2)        # union of m1 and m2, the result is stored in m3
m4 = Mesh.Mesh(m1)
m4.intersect(m2)    # intersection of m1 and m2
m5 = Mesh.Mesh(m1)
m5.difference(m2)   # the difference of m1 and m2
m6 = Mesh.Mesh(m2)
m6.difference(m1)   # the difference of m2 and m1, usually the result is different to m5

Here is an example that creates a pipe using the difference() method:

import FreeCAD, Mesh
cylA = Mesh.createCylinder(2.0, 10.0, True, 1.0, 36)
cylB = Mesh.createCylinder(1.0, 12.0, True, 1.0, 36)
cylB.Placement.Base = (FreeCAD.Vector(-1, 0, 0)) # move cylB to avoid co-planar faces
pipe = cylA
pipe = pipe.difference(cylB)
pipe.flipNormals() # somehow required
doc = FreeCAD.ActiveDocument
obj = d.addObject("Mesh::Feature", "Pipe")
obj.Mesh = pipe
doc.recompute()

Top

Notes

An extensive, though hard to use, source of mesh related scripting are the unit test scripts of the Mesh module. In these unit tests literally all methods are called and all properties/attributes are tweaked. So if you are bold enough, take a look at the Unit Test module.

See also: Mesh API.

Top