805d532ecebf4b2ca3d01b659caad54165f936f3
[blender.git] / doc / python_api / rst / include__bmesh.rst
1 ..
2    This document is appended to the auto generated bmesh api doc to avoid clogging up the C files with details.
3    to test this run:
4    ./blender.bin -b -noaudio -P doc/python_api/sphinx_doc_gen.py -- \
5                  --partial bmesh* ; cd doc/python_api ; sphinx-build sphinx-in sphinx-out ; cd ../../
6
7
8 Submodules:
9
10 * :mod:`bmesh.ops`
11 * :mod:`bmesh.types`
12 * :mod:`bmesh.utils`
13 * :mod:`bmesh.geometry`
14
15
16 Intro
17 -----
18
19 This API gives access the blenders internal mesh editing api, featuring geometry connectivity data and
20 access to editing operations such as split, separate, collapse and dissolve.
21
22 The features exposed closely follow the C API,
23 giving python access to the functions used by blenders own mesh editing tools.
24
25 For an overview of BMesh data types and how they reference each other see:
26 `BMesh Design Document <http://wiki.blender.org/index.php/Dev:2.6/Source/Modeling/BMesh/Design>`_ .
27
28
29 .. note::
30
31    **Disk** and **Radial** data is not exposed by the python api since this is for internal use only.
32
33
34 .. warning::
35
36    TODO items are...
37
38    * add access to BMesh **walkers**
39    * add custom-data manipulation functions add/remove/rename.
40
41 Example Script
42 --------------
43
44 .. literalinclude:: ../../../release/scripts/templates_py/bmesh_simple.py
45
46
47 Stand-Alone Module
48 ^^^^^^^^^^^^^^^^^^
49
50 The bmesh module is written to be standalone except for :mod:`mathutils`
51 which is used for vertex locations and normals.
52
53 The only other exception to this are when converting mesh data to and from :class:`bpy.types.Mesh`.
54
55
56 Mesh Access
57 -----------
58
59 There are 2 ways to access BMesh data, you can create a new BMesh by converting a mesh from
60 :class:`bpy.types.BlendData.meshes` or by accessing the current edit mode mesh.
61 see: :class:`bmesh.types.BMesh.from_mesh` and :mod:`bmesh.from_edit_mesh` respectively.
62
63 When explicitly converting from mesh data python **owns** the data, that is to say -
64 that the mesh only exists while python holds a reference to it,
65 and the script is responsible for putting it back into a mesh data-block when the edits are done.
66
67 Note that unlike :mod:`bpy`, a BMesh does not necessarily correspond to data in the currently open blend file,
68 a BMesh can be created, edited and freed without the user ever seeing or having access to it.
69 Unlike edit mode, the bmesh module can use multiple BMesh instances at once.
70
71 Take care when dealing with multiple BMesh instances since the mesh data can use a lot of memory, while a mesh that
72 python owns will be freed in when the script holds no references to it,
73 its good practice to call :class:`bmesh.types.BMesh.free` which will remove all the mesh data immediately and disable
74 further access.
75
76
77 EditMode Tessellation
78 ^^^^^^^^^^^^^^^^^^^^^
79
80 When writing scripts that operate on editmode data you will normally want to re-calculate the tessellation after
81 running the  script, this needs to be called explicitly.
82
83 The BMesh its self does not store the triangulated faces, they are stored in the :class:`bpy.types.Mesh`,
84 to refresh tessellation faces call :class:`bpy.types.Mesh.calc_tessface`.
85
86
87 CustomData Access
88 -----------------
89
90 BMesh has a unified way to access mesh attributes such as UV's vertex colors, shape keys, edge crease etc.
91
92 This works by having a **layers** property on bmesh data sequences to access the custom data layers which can then be
93 used to access the actual data on each vert/edge/face/loop.
94
95 Here are some examples ...
96
97 .. code-block:: python
98
99    uv_lay = bm.loops.layers.uv.active
100
101    for face in bm.faces:
102        for loop in face.loops:
103            uv = loop[uv_lay].uv
104            print("Loop UV: %f, %f" % uv[:])
105            vert = loop.vert
106            print("Loop Vert: (%f,%f,%f)" % vert.co[:])
107
108
109 .. code-block:: python
110
111    shape_lay = bm.verts.layers.shape["Key.001"]
112
113    for vert in bm.verts:
114        shape = vert[shape_lay]
115        print("Vert Shape: %f, %f, %f" % (shape.x, shape.y, shape.z))
116
117
118 .. code-block:: python
119
120    # in this example the active vertex group index is used,
121    # this is stored in the object, not the BMesh
122    group_index = obj.vertex_groups.active_index
123
124    # only ever one deform weight layer
125    dvert_lay = bm.verts.layers.deform.active
126
127    for vert in bm.verts:
128        dvert = vert[dvert_lay]
129
130        if group_index in dvert:
131            print("Weight %f" % dvert[group_index])
132        else:
133            print("Setting Weight")
134            dvert[group_index] = 0.5
135
136
137 Keeping a Correct State
138 -----------------------
139
140 When modeling in blender there are certain assumptions made about the state of the mesh.
141
142 * hidden geometry isn't selected.
143 * when an edge is selected, its vertices are selected too.
144 * when a face is selected, its edges and vertices are selected.
145 * duplicate edges / faces don't exist.
146 * faces have at least 3 vertices.
147
148 To give developers flexibility these conventions are not enforced,
149 however tools must leave the mesh in a valid state else other tools may behave incorrectly.
150
151 Any errors that arise from not following these conventions is considered a bug in the script,
152 not a bug in blender.
153
154
155 Selection / Flushing
156 ^^^^^^^^^^^^^^^^^^^^
157
158 As mentioned above, it is possible to create an invalid selection state
159 (by selecting a state and then de-selecting one of its vertices's for example), mostly the best way to solve this is to
160 flush the selection after performing a series of edits. this validates the selection state.
161
162
163 Module Functions
164 ----------------