bmesh py api: more comprehensive intro page, also fix some spelling errors.
[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 Intro
8 -----
9
10 This API gives access the blenders internal mesh editing api, featuring geometry connectivity data and
11 access to editing operations such as split, separate, collapse and dissolve.
12
13 The features exposed closely follow the C API,
14 giving python access to the functions used by blenders own mesh editing tools.
15
16 For an overview of BMesh data types and how they reference each other see:
17 `BMesh Design Document <http://wiki.blender.org/index.php/Dev:2.6/Source/Modeling/BMesh/Design>`_ .
18
19
20 .. note::
21
22    **Disk** and **Radial** data is not exposed by the python api since this is for internal use only.
23
24
25 .. warning::
26
27    This API is still in development and experimental, while we don't expect to see large changes,
28    many areas are not well tested yet and so its possible changes will be made that break scripts.
29
30    *Campbell Barton, 13, March 2012*
31
32
33 .. todo::
34
35    * add access to BMesh **walkers**
36    * add access selection history (readonly access done)
37    * add a way to re-tessellate an editmode bmesh.
38
39
40 Stand-Alone Module
41 ^^^^^^^^^^^^^^^^^^
42
43 The bmesh module is written to be standalone except for :mod:`mathutils`
44 which is used for vertex locations and normals.
45
46 The only other exception to this are when converting mesh data to and from :class:`bpy.types.Mesh`.
47
48
49 Mesh Access
50 -----------
51
52 There are 2 ways to access BMesh data, you can create a new BMesh by converting a mesh from
53 :class:`bpy.types.BlendData.meshes` or by accessing the current edit mode mesh.
54 see: :class:`bmesh.types.BMesh.from_mesh` and :mod:`bmesh.from_edit_mesh` respectively.
55
56 When explicitly converting from mesh data python **owns** the data, that is to say - that the mesh only exists while
57 python holds a reference to it, and the script is responsible for putting it back into a mesh data-block when the edits
58 are done.
59
60 Note that unlike :mod:`bpy`, a BMesh does not necessarily correspond to data in the currently open blend file,
61 a BMesh can be created, edited and freed without the user ever seeing or having access to it.
62 Unlike edit mode, the bmesh module can use multiple BMesh instances at once.
63
64 Take care when dealing with multiple BMesh instances since the mesh data can use a lot of memory, while a mesh that
65 python owns will be freed in when the script holds no references to it,
66 its good practice to call :class:`bmesh.types.BMesh.free` which will remove all the mesh data immediately and disable
67 further access.
68
69
70 Keeping a Correct State
71 -----------------------
72
73 When modeling in blender there are certain assumptions made about the state of the mesh.
74
75 * hidden geometry isn't selected.
76 * when an edge is selected, its vertices's are selected too.
77 * when a face is selected, its edges and vertices's are selected.
78 * duplicate edges / faces don't exist.
79 * faces have at least 3 vertices's.
80
81 To give developers flexibility these conventions are not enforced,
82 however tools must leave the mesh in a valid state else other tools may behave incorrectly.
83
84 Any errors that arise from not following these conventions is considered a bug in the script,
85 not a bug in blender.
86
87
88 Selection / Flushing
89 ^^^^^^^^^^^^^^^^^^^^
90
91 As mentioned above, it is possible to create an invalid selection state
92 (by selecting a state and then de-selecting one of its vertices's for example), mostly the best way to solve this is to
93 flush the selection after performing a series of edits. this validates the selection state.
94
95
96 Example Script
97 --------------
98
99 .. literalinclude:: ../../../release/scripts/templates/bmesh_simple.py
100
101
102 Module Functions
103 ----------------