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