Type header_seq.c - Reassing Inputs -> Reassign Inputs
[blender.git] / source / blender / python / api2_2x / doc / Mesh.py
1 # Blender.Mesh module and the Mesh PyType object
2
3 """
4 The Blender.Mesh submodule.
5
6 B{New}:
7
8 Mesh Data
9 =========
10
11 This module provides access to B{Mesh Data} objects in Blender.  It differs
12 from the NMesh module by allowing direct access to the actual Blender data, 
13 so that changes are done immediately without need to update or put the data
14 back into the original mesh.  The result is faster operations with less memory
15 usage.  The example below creates a simple pyramid, and sets some of the
16 face's attributes (the vertex color):
17
18 Example::
19         from Blender import *
20
21         editmode = Window.EditMode()    # are we in edit mode?  If so ...
22         if editmode: Window.EditMode(0) # leave edit mode before getting the mesh
23
24         # define vertices and faces for a pyramid
25         coords=[ [-1,-1,-1], [1,-1,-1], [1,1,-1], [-1,1,-1], [0,0,1] ]  
26         faces= [ [3,2,1,0], [0,1,4], [1,2,4], [2,3,4], [3,0,4] ]
27
28         me = Mesh.New('myMesh')          # create a new mesh
29
30         me.verts.extend(coords)          # add vertices to mesh
31         me.faces.extend(faces)           # add faces to the mesh (also adds edges)
32
33         me.vertexColors = 1              # enable vertex colors 
34         me.faces[1].col[0].r = 255       # make each vertex a different color
35         me.faces[1].col[1].g = 255
36         me.faces[1].col[2].b = 255
37
38         scn = Scene.GetCurrent()          # link object to current scene
39         ob = scn.objects.new(me, 'myObj')
40
41         if editmode: Window.EditMode(1)  # optional, just being nice
42
43 Vertices, edges and faces are added to a mesh using the .extend() methods.
44 For best speed and efficiency, gather all vertices, edges or faces into a
45 list and call .extend() once as in the above example.  Similarly, deleting
46 from the mesh is done with the .delete() methods and are most efficient when
47 done once.
48
49 @type Modes: readonly dictionary
50 @type FaceFlags: readonly dictionary
51 @type FaceModes: readonly dictionary
52 @type FaceTranspModes: readonly dictionary
53 @var Modes: The available mesh modes.
54                 - NOVNORMALSFLIP - no flipping of vertex normals during render.
55                 - TWOSIDED - double sided mesh.
56                 - AUTOSMOOTH - turn auto smoothing of faces "on".
57                 - note: SUBSURF and OPTIMAL have been removed, use Modifiers to apply subsurf.
58 @var FaceFlags: The available *texture face* (uv face select mode) selection
59         flags.  Note: these refer to TexFace faces, available if mesh.faceUV
60         returns true.
61                 - SELECT - selected.
62                 - HIDE - hidden.
63                 - ACTIVE - the active face, read only - Use L{mesh.activeFace<Mesh.Mesh.activeFace>} to set.
64 @var FaceModes: The available *texture face* modes. Note: these are only
65         meaningful if mesh.faceUV returns true, since in Blender this info is
66         stored at the TexFace (TexFace button in Edit Mesh buttons) structure.
67                 - ALL - set all modes at once.
68                 - BILLBOARD - always orient after camera.
69                 - HALO - halo face, always point to camera.
70                 - DYNAMIC - respond to collisions.
71                 - INVISIBLE - invisible face.
72                 - LIGHT - dynamic lighting.
73                 - OBCOL - use object color instead of vertex colors.
74                 - SHADOW - shadow type.
75                 - SHAREDVERT - apparently unused in Blender.
76                 - SHAREDCOL - shared vertex colors (per vertex).
77                 - TEX - has texture image.
78                 - TILES - uses tiled image.
79                 - TWOSIDE - two-sided face.
80 @var FaceTranspModes: The available face transparency modes. Note: these are
81         enumerated values (enums), they can't be combined (ANDed, ORed, etc) like a bit vector.
82                 - SOLID - draw solid.
83                 - ADD - add to background (halo).
84                 - ALPHA - draw with transparency.
85                 - SUB - subtract from background.
86 @var EdgeFlags: The available edge flags.
87                 - SELECT - selected (B{deprecated}).  Use edge.sel attribute instead.
88                 - EDGEDRAW - edge is drawn out of edition mode.
89                 - EDGERENDER - edge is drawn out of edition mode.
90                 - SEAM - edge is a seam for UV unwrapping
91                 - FGON - edge is part of a F-Gon.
92                 - LOOSE - Edge is not a part of a face (only set on leaving editmode)
93                 - SHARP - Edge will be rendered sharp when used with the "Edge Split" modifier.
94 @type AssignModes: readonly dictionary.
95 @var AssignModes: The available vertex group assignment modes, used by 
96         L{mesh.assignVertsToGroup()<Mesh.Mesh.assignVertsToGroup>}.
97                 - ADD: if the vertex in the list is not assigned to the group
98                         already, this creates a new association between this vertex and the
99                         group with the weight specified, otherwise the weight given is added to
100                         the current weight of an existing association between the vertex and
101                         group.
102                 - SUBTRACT: will attempt to subtract the weight passed from a vertex
103                         already associated with a group, else it does nothing.\n
104                 - REPLACE: attempts to replace a weight with the new weight value
105                         for an already associated vertex/group, else it does nothing. 
106 @type SelectModes: readonly dictionary.
107 @var SelectModes: The available edit select modes.
108         - VERTEX: vertex select mode.
109         - EDGE: edge select mode.
110         - FACE: face select mode.
111 """
112
113 AssignModes = {'REPLACE':1}
114
115 def Get(name=None):
116         """
117         Get the mesh data object called I{name} from Blender.
118         @type name: string
119         @param name: The name of the mesh data object.
120         @rtype: Mesh
121         @return: If a name is given, it returns either the requested mesh or None.
122                 If no parameter is given, it returns all the meshes in the current scene.
123         """
124
125 def New(name='Mesh'):
126         """
127         Create a new mesh data object called I{name}.
128         @type name: string
129         @param name: The name of the mesh data object.
130         @rtype: Mesh
131         @return: a new Blender mesh.
132         @note: if the mesh is not linked to an object, its datablock will be deleted
133         when the object is deallocated.
134         """
135
136 def Mode(mode=0):
137         """
138         Get and/or set the selection modes for mesh editing.  These are the modes
139         visible in the 3D window when a mesh is in Edit Mode.
140         @type mode: int
141         @param mode: The desired selection mode.  See L{SelectModes} for values.
142         Modes can be combined.  If omitted, the selection mode is not changed.
143         @rtype: int
144         @return: the current selection mode.
145         @note: The selection mode is an attribute of the current scene.  If the
146         scene is changed, the selection mode may not be the same.
147         """
148
149 def Unlink(name):
150         """
151         Delete an unused mesh from Blender's database.  The mesh must not have
152         any users (i.e., it must not be linked to any object).  
153         @type name: string
154         @param name: The name of the mesh data object.  
155         @rtype: None
156         @note: This function may be a temporary solution; it may be replaced
157         in the future by a more general unlink function for many datablock types.
158         Hopefully this will be decided prior to the 2.42 release of Blender.
159         """
160
161 class MCol:
162         """
163         The MCol object
164         ===============
165                 This object is four ints representing an RGBA color.
166         @ivar r: The Red component in [0, 255].
167         @type r: int
168         @ivar g: The Green component in [0, 255].
169         @type g: int
170         @ivar b: The Blue component in [0, 255].
171         @type b: int
172         @ivar a: The Alpha (transparency) component in [0, 255].
173         @type a: int
174         """
175
176 class MVert:
177         """
178         The MVert object
179         ================
180                 This object holds mesh vertex data.
181         @ivar co: The vertex coordinates (x, y, z).
182         @type co: vector (WRAPPED DATA)
183         @ivar no: The vertex's unit normal vector (x, y, z).
184                 B{Note}: if vertex coordinates are changed, it may be necessary to use
185                 L{Mesh.calcNormals()} to update the vertex normals.
186                 B{Note}: Vertex normals can be set, but are not wrapped so modifying a normal
187                 vector will not effect the verts normal. The result is only visible
188                 when faces have the smooth option enabled.
189                 Example::
190                         # This won't work.
191                         for v in me.verts:
192                                 v.no.x= 0
193                                 v.no.y= 0
194                                 v.no.z= 1
195                         # This will work
196                         no= Blender.Mathutils.Vector(0,0,1)
197                         for v in me.verts:
198                                 v.no= no
199         @type no: vector
200         @ivar uvco: The vertex texture "sticky" coordinates (x, y),
201                 if present. Available for MVerts only. 
202                 Use L{Mesh.vertexUV} to test for presence before trying to access;
203                 otherwise an exception will may be thrown.
204                 (Sticky coordinates can be set when the object is in the Edit mode;
205                 from the Editing Panel (F9), look under the "Mesh" properties for the 
206                 "Sticky" button).  
207         @type uvco: vector (WRAPPED DATA)
208         @ivar index: The vertex's index within the mesh (MVerts only). Read-only.
209         @type index: int
210         @ivar sel: The vertex's selection state (selected=1).
211                 B{Note}: a Mesh will return the selection state of the mesh when EditMode 
212                 was last exited. A Python script operating in EditMode must exit EditMode 
213                 before getting the current selection state of the mesh.
214         @type sel: int
215         @ivar hide: The face's B{edit mode} visibility state (hidden=1).
216         @type hide: int
217         @warn:  There are two kinds of UV texture coordinates in Blender: per vertex
218                 ("sticky") and per face vertex (UV in L{MFace}).  In the first, there's
219                 only one UV pair of coordinates for each vertex in the mesh.  In the
220                 second, for each face it belongs to, a vertex can have different UV
221                 coordinates.  This makes the per face option more flexible, since two
222                 adjacent faces won't have to be mapped to a continuous region in an image:
223                 each face can be independently mapped to any part of its texture.
224         """
225
226         def __init__(coord):
227                 """
228                 Create a new PVert object.  
229
230                 @note: PVert-type objects are designed to be used for creating and
231                 modifying a mesh's vertex list, but since they do not "wrap" any Blender
232                 data there are some differences.  The B{index} and B{uvco} attributes 
233                 are not defined for PVerts, and the B{no} attribute contains valid
234                 data only if the PVert was created from an MVert (using a slice
235                 operation on the mesh's vertex list.)  PVerts also cannot be used as an
236                 argument to any method which expects data wrapping a Blender mesh, such
237                 as L{MVertSeq.delete()}.
238
239                 Example::
240                         v = Blender.Mesh.MVert(1,0,0)
241                         v = Blender.Mesh.MVert(Blender.Mathutils.Vector([1,0,0]))
242
243                         m = Blender.Mesh.Get('Mesh')
244                         vlist = m.verts[:]   # slice operation also returns PVerts
245
246                 @type coord: three floats or a Vector object
247                 @param coord: the coordinate values for the new vertex
248                 @rtype: PVert
249                 @return: a new PVert object
250
251                 """
252
253 class MVertSeq:
254         """
255         The MVertSeq object
256         ===================
257                 This object provides sequence and iterator access to the mesh's vertices.
258                 Access and assignment of single items and slices are also supported.
259                 When a single item in the vertex list is accessed, the operator[] returns
260                 a MVert object which "wraps" the actual vertex in the mesh; changing any
261                 of the vertex's attributes will immediately change the data in the mesh.
262                 When a slice of the vertex list is accessed, however, the operator[]
263                 returns a list of PVert objects which are copies of the mesh's vertex
264                 data.  Changes to these objects have no effect on the mesh; they must be
265                 assigned back to the mesh's vertex list.
266
267                 Slice assignments cannot change the vertex list size.  The size of the
268                 list being assigned must be the same as the specified slice; otherwise an
269                 exception is thrown.
270
271                 Example::
272                         import Blender
273                         from Blender import Mesh
274
275                         me = Mesh.Get("Plane")          # get the mesh data called "Plane"
276                         vert = me.verts[0]              # vert accesses actual mesh data
277                         vert.co[0] += 2                 # change the vertex's X location
278                         pvert = me.verts[-2:]           # pvert is COPY of mesh's last two verts
279                         pvert[0].co[0] += 2             # change the vertex's X location
280                         pvert[1].co[0] += 2             # change the vertex's X location
281                         me.verts[-1] = pvert[1]         # put change to second vertex into mesh
282
283                 @note: The mesh can be "cleared" by assigning B{None} to the mesh's vertex
284                 list.  This does not delete the Blender mesh object, it only deletes all
285                 the memory allocated to the mesh.  The result is equivalent to calling 
286                 Mesh.New().  The intent is to allow users writing exporters to free memory
287                 after it is used in a quick and simple way.
288
289                 Example::
290                         import Blender
291                         from Blender import Mesh
292
293                         me = Mesh.Get("Plane")          # get the mesh data called "Plane"
294                         me.verts = None                 # delete all the mesh's attributes
295
296         """
297
298         def extend(coords):
299                 """
300                 Append zero or more vertices to the mesh.  Unlike L{MEdgeSeq.extend()} and
301                 L{MFaceSeq.extend()} no attempt is made to check for duplicate vertices in
302                 the parameter list, or for vertices already in the mesh.
303
304                 Example::
305                         import Blender
306                         from Blender import Mesh
307                         from Blender.Mathutils import Vector
308
309                         me = Mesh.Get("Plane")          # get the mesh data called "Plane"
310                         me.verts.extend(1,1,1)          # add one vertex
311                         l=[(.1,.1,.1),Vector([2,2,.5])]
312                         me.verts.extend(l)              # add multiple vertices
313
314                 @type coords: sequences(s) of floats or vectors
315                 @param coords: coords can be
316                         - a sequence of three floats,
317                         - a 3D vector, or
318                         - a sequence (list or tuple) of either of the above.
319                 """
320
321         def delete(verts):
322                 """
323                 Deletes one or more vertices from the mesh.  Any edge or face which
324                 uses the specified vertices are also deleted.
325
326                 @type verts: multiple ints or MVerts
327                 @param verts: can be
328                         - a single MVert belonging to the mesh (B{note:} will not work with
329                                 PVerts)
330                         - a single integer, specifying an index into the mesh's vertex list
331                         - a sequence (list or tuple) containing two or more of either of
332                                 the above.
333                 """
334
335         def selected():
336                 """
337                 Get selected vertices.
338                 @return: a list of the indices for all vertices selected in edit mode.
339                 @rtype: list of ints
340                 """
341
342 class MEdge:
343         """
344         The MEdge object
345         ================
346                 This object holds mesh edge data.
347         @ivar v1: The first vertex of the edge.
348         @type v1: MVert
349         @ivar v2: The second vertex of the edge.
350         @type v2: MVert
351         @ivar length: The length of the edge, same as (ed.v1.co-ed.v2.co).length where "ed" is an MEdge.
352         @type length: float
353         @ivar crease: The crease value of the edge. It is in the range [0,255].
354         @type crease: int
355         @ivar flag: The bitfield describing edge properties. See L{EdgeFlags}.
356                 Example::
357                         # This script counts fgon and non fgon edges
358                         from Blender import Scene, Mesh
359                         scn= Scene.GetCurrent() # Current scene, important to be scene aware
360                         ob= scn.objects.active # last selected object
361                         me= ob.getData(mesh=1) # thin wrapper doesn't copy mesh data like nmesh
362                 
363                         total_fgon_eds= total_nor_eds= 0
364                         
365                         # Look through the edges and find any fgon edges, then print the findings to the console
366                         for ed in me.edges: # all meshes have edge data now
367                                 if ed.flag & Mesh.EdgeFlags.FGON:
368                                         total_fgon_eds+=1
369                                 else:
370                                         total_nor_eds+=1
371                         
372                         print 'Blender has', total_fgon_eds, 'fgon edges and', total_nor_eds, 'non fgon edges'
373         @type flag: int
374         @ivar index: The edge's index within the mesh.  Read-only.
375         @type index: int
376         @ivar sel: The edge's B{edit mode} selection state (selected=1).  B{Note}:
377         changing the select state of an edge changes the select state of the edge's
378         vertices.
379         @type sel: int
380         @ivar key: The edge's vert indices in an ordered tuple, which can be used
381         as a dictionary key. Read-only.
382         This is the same as (min(ed.v1.index, ed.v2.index), max(ed.v1.index, ed.v2.index))
383         @type key: tuple
384         """
385
386         def __iter__():
387                 """
388                 Iterator for MEdge.  It iterates over the MVerts of the edge, returning
389                 v1 then v2.
390                 @return: one of the edge's vertices
391                 @rtype: MVert
392                 """
393
394 class MEdgeSeq:
395         """
396         The MEdgeSeq object
397         ===================
398                 This object provides sequence and iterator access to the mesh's edges.
399         """
400
401         def extend(vertseq):
402                 """
403                 Add zero or more edges to the mesh.  Edges which already exist in the 
404                 mesh or with both vertices the same are ignored.  If three or four verts
405                 are specified in any sequence, an edge is also created between the first
406                 and last vertices (this is useful when adding faces).  
407
408                 Example::
409                         import Blender
410                         from Blender import Mesh
411
412                         me = Mesh.Get("Plane")          # get the mesh data called "Plane"
413                         v = me.verts                    # get vertices
414                         if len(v) >= 6:                 # if there are enough vertices...
415                                 me.edges.extend(v[0],v[1])    #   add a single edge
416                                 l=[(v[1],v[2],v[3]),[0,2,4,5]]
417                                 me.edges.extend(l)            #   add multiple edges
418
419                 @type vertseq: sequence(s) of ints or MVerts
420                 @param vertseq: either two to four ints or MVerts, or sequence
421                 (list or tuple) of sequences each containing two to four ints or MVerts.
422                 """
423
424         def delete(edges):
425                 """
426                 Deletes one or more edges from the mesh.  In addition, also delete:
427                         - any faces which uses the specified edge(s)
428                         - any "orphan" vertices (belonging only to specified edge(s))
429
430                 @type edges: multiple ints or MEdges
431                 @param edges: can be
432                         - a single MEdge belonging to the mesh
433                         - a single integer, specifying an index into the mesh's edge list
434                         - a sequence (list or tuple) containing two or more of either of
435                                 the above.
436                 """
437
438         def selected():
439                 """
440                 Get selected edges.
441                 Selected edges are those for which both vertices are selected.
442                 @return: a list of the indices for all edges selected in edit mode.
443                 @rtype: list of ints
444                 """
445
446 class MFace:
447         """
448         The MFace object
449         ================
450         This object holds mesh face data.
451
452         Example::
453                 import Blender
454                 from Blender import Mesh, Window
455
456                 in_emode = Window.EditMode()
457                 if in_emode: Window.EditMode(0)
458
459                 me = Mesh.Get("Mesh")
460                 faces = me.faces
461
462                 ## Example for editmode faces selection:
463                 selected_faces = []
464                 for f in faces:
465                         if f.sel:
466                                 selected_faces.append(f)
467                 # ... unselect selected and select all the others:
468                 for f in faces:
469                         f.sel = not f.sel # 1 becomes 0, 0 becomes 1
470
471                 ## Example for UV textured faces selection:
472                 selected_faces = []
473                 SEL = Mesh.FaceFlags['SELECT']
474                 # get selected faces:
475                 for f in faces:
476                         if f.flag & SEL:
477                                 selected_faces.append(f)
478                 # ... unselect selected and select all the others:
479                 for f in faces:
480                         if f.flag & SEL:
481                                 f.flag &= ~SEL # unselect these
482                         else:
483                                 f.flag |= SEL # and select these
484
485                 if in_emode: Window.EditMode(1)
486                 Blender.Redraw()
487
488         @ivar verts: The face's vertices.  Each face has 3 or 4 vertices.
489         @type verts: list of MVerts
490         @ivar v: Same as L{verts}.  This attribute is only for compatibility with
491                 NMesh scripts and will probably be deprecated in the future.
492         @ivar sel: The face's B{edit mode} selection state (selected=1).
493                 This is not the same as the selection state of the textured faces
494                 (see L{flag}). B{Note}: changing the select state of a face changes
495                 the select state of the face's vertices.
496         @type sel: int
497         @ivar hide: The face's B{edit mode} visibility state (hidden=1).
498                 This is not the same as the visibility state of
499                 the textured faces (see L{flag}).
500         @type hide: int
501         @ivar smooth: If set, the vertex normals are averaged to make this
502                 face look smooth.  (This is the same as choosing "Set Smooth" in the 
503                 Editing Panel (F9) under "Link and Material" properties).
504         @type smooth: int
505         @ivar col: The face's vertex colors, if defined.  Each vertex has its own
506                 color.
507                 Will throw an exception if the mesh does not have UV faces or vertex
508                 colors; use L{Mesh.faceUV} and L{Mesh.vertexColors} to test.  B{Note}:
509                 if a mesh has i{both} UV faces and vertex colors, the colors stored in
510                 the UV faces will be used here.
511
512                 Example::
513                         # This example uses vertex normals to apply normal colors to each face.
514                         from Blender import Scene, Mesh, Window
515                         scn= Scene.GetCurrent() # Current scene, important to be scene aware
516                         ob= scn.getActiveObject() # last selected object
517                         me= ob.getData(mesh=1) # thin wrapper doesn't copy mesh data like nmesh
518                         me.faceUV=1                             # Enable face, vertex colors
519                         for f in me.faces:
520                                 for i, v in enumerate(f.v):
521                                         no= v.no
522                                         col= f.col[i]
523                                         col.r= int((no.x+1)*128)
524                                         col.g= int((no.y+1)*128)
525                                         col.b= int((no.z+1)*128)
526                         Window.RedrawAll()
527         @type col: sequence of MCols
528         @ivar mat: The face's index into the mesh's materials
529                         list.  It is in the range [0,15].
530         @type mat: int
531         @ivar image: The Image used as a texture for this face.
532                         Setting this attribute will create UV faces if they do not exist.
533                         Getting this attribute throw an exception if the mesh does not have 
534                         UV faces; use L{Mesh.faceUV} to test.  
535                         Assigning an image will automatically set the TEX attribute of the
536                         L{mode} bitfield.  Use "del f.image" or "f.image = None" to clear the
537                         image assigned to the face.
538         @type image: Image
539         @ivar mode: The texture mode bitfield (see L{FaceModes}).
540                         Will throw an exception if the mesh does not have UV faces; use
541                         L{Mesh.faceUV} to test.
542         @type mode: int
543         @ivar index: The face's index within the mesh.  Read-only.
544         @type index: int
545
546         @ivar flag: The face's B{texture mode} flags; indicates the selection, 
547                         active , and visibility states of a textured face (see
548                         L{FaceFlags} for values).
549                         This is not the same as the selection or visibility states of
550                         the faces in edit mode (see L{sel} and L{hide}).
551                         To set the active face, use
552                         the L{Mesh.activeFace} attribute instead.
553                         Will throw an exception if the mesh does not have UV faces; use
554                         L{Mesh.faceUV} to test.
555
556         @ivar transp: Transparency mode.  It is one of the values in 
557                         L{FaceTranspModes}).
558                         Will throw an exception if the mesh does not have UV faces; use
559                         L{Mesh.faceUV} to test.
560         @type transp: int
561
562         @ivar uv: The face's UV coordinates.  Each vertex has its own UV coordinate.
563                         Setting this attribute will create UV faces if they do not exist.
564                         Getting this attribute throw an exception if the mesh does not have 
565                         UV faces; use L{Mesh.faceUV} to test.  
566         @type uv: tuple of vectors (WRAPPED DATA)
567         @ivar uvSel: The face's UV coordinates selection state; a 1 indicates the
568                         vertex is selected.  Each vertex has its own UV coordinate select state
569                         (this is not the same as the vertex's edit mode selection state).
570                         Setting this attribute will create UV faces if they do not exist.
571                         Getting this attribute throw an exception if the mesh does not have 
572                         UV faces; use L{Mesh.faceUV} to test.  
573         @type uvSel: tuple of ints
574         @ivar no: The face's normal vector (x, y, z).  Read-only.
575         @type no: vector
576         @ivar cent: The center of the face. Read-only.
577         @type cent: vector
578         @ivar area: The area of the face. Read-only.
579         @type area: float
580         @ivar edge_keys: A tuple, each item a key that can reference an edge by its
581         ordered indices. Read-only.  This is useful for building connectivity data.
582         Example::
583                         from Blender import Mesh
584                         me = Mesh.Get('Cube')
585                         # a dictionary where the edge is the key, and a list of faces that use it are the value
586                         edge_faces = dict([(ed.key, []) for ed in me.edges])
587
588                         # Add the faces to the dict
589                         for f in me.faces:
590                                 for key in f.edge_keys:
591                                         edge_faces[key].append(f) # add this face to the edge as a user
592
593                         # Print the edges and the number of face users
594                         for key, face_users in edge_faces.iteritems():
595                                 print 'Edge:', key, 'uses:', len(face_users),'faces'
596
597         @type edge_keys: tuple
598         @note: there are regular faces and textured faces in Blender, both currently
599                 with their own selection and visibility states, due to a mix of old and new
600                 code.  To (un)select or (un)hide regular faces (visible in EditMode), use
601                 L{MFace.sel} and L{MFace.hide} attributes.  For textured faces (UV Face 
602                 Select and Paint modes in Blender) use the L{MFace.flag} attribute.
603                 Check the example above and note L{Window.EditMode}.
604         @note: Assigning UV textures to mesh faces in Blender works like this:
605                 1. Select your mesh.
606                 2. Enter face select mode (press f) and select at least some face(s).
607                 3. In the UV/Image Editor window, load / select an image.
608                 4. Play in both windows (better split the screen to see both at the same
609                         time) until the UV coordinates are where you want them.  Hint: in the
610                         3D window, the 'u' key opens a menu of default UV choices and the 'r'
611                         key lets you rotate the UV coords.
612                 5. Leave face select mode (press f).
613         """
614
615         def __iter__():
616                 """
617                 Iterator for MVert.  It iterates over the MVerts of the face, returning
618                 v1, v2, v3 (and optionally v4);
619                 @return: one of the face's vertices
620                 @rtype: MVert
621                 """
622
623         def __len__():
624                 """
625                 len for MVert.  It returns the number of vertices in the face.
626                 @rtype: int
627                 """
628
629 class MFaceSeq:
630         """
631         The MFaceSeq object
632         ===================
633                 This object provides sequence and iterator access to the mesh's faces.
634         """
635
636         def extend(vertseq,ignoreDups=True,indexList=True):
637                 """
638                 Add zero or more faces and edges to the mesh.  Faces which already exist
639                 in the mesh, or faces which contain the same vertex multiple times are
640                 ignored.  Sequences of two vertices are accepted, but no face will be
641                 created.
642
643                 Example::
644                         import Blender
645                         from Blender import Mesh
646
647                         me = Mesh.Get("Plane")          # get the mesh data called "Plane"
648                         v = me.verts                    # get vertices
649                         if len(v) >= 6:                 # if there are enough vertices...
650                                 me.faces.extend(v[1],v[2],v[3]) #   add a single edge
651                                 l=[(v[0],v[1]),[0,2,4,5]]
652                                 me.faces.extend(l)            #   add another face
653
654                 @type vertseq: sequence(s) of MVerts
655                 @param vertseq: either two to four ints or MVerts, or sequence (list or
656                 tuple) of sequences each containing two to four ints or MVerts.
657                 @type ignoreDups: boolean
658                 @param ignoreDups: keyword parameter (default is False).  If supplied and
659                 True, do not check the input list or mesh for duplicate faces.  This can
660                 speed up scripts but can prossibly produce undesirable effects.  Only
661                 use if you know what you're doing.
662                 @type indexList: boolean
663                 @param indexList: keyword parameter (default is False).  If supplied and
664                 True, the method will return a list representing the new index for each
665                 face in the input list.  If faces are removed as duplicates, None is
666                 inserted in place of the index.
667                 @warning: Faces using the first vertex at the 3rd or 4th location in the
668                 face's vertex list will have their order rotated so that the zero index
669                 on in the first or second location in the face. When creating face data
670                 with UVs or vertex colors, you may need to work around this, either by
671                 checking for zero indices yourself or by adding a dummy first vertex to
672                 the mesh that can be removed when your script has finished.
673                 """
674
675         def delete(deledges, faces):
676                 """
677                 Deletes one or more faces (and optionally the edges associated with
678                 the face(s)) from the mesh.  
679
680                 @type deledges: int
681                 @param deledges: controls whether just the faces (deledges=0)
682                 or the faces and edges (deledges=1) are deleted.  These correspond to the
683                 "Only Faces" and "Edges & Faces" options in the Edit Mode pop-up menu
684                 @type faces: multiple ints or MFaces
685                 @param faces: a sequence (list or tuple) containing one or more of:
686                         - an MEdge belonging to the mesh
687                         - a integer, specifying an index into the mesh's face list
688                 """
689
690         def selected():
691                 """
692                 Get selected faces.
693                 @return: a list of the indices for all faces selected in edit mode.
694                 @rtype: list of ints
695                 """
696
697 from IDProp import IDGroup, IDArray
698 class Mesh:
699         """
700         The Mesh Data object
701         ====================
702                 This object gives access to mesh data in Blender.
703
704         @note: the verts, edges and faces attributes are implemented as sequences.
705         The operator[] and len() are defined for these sequences.  You cannot
706         assign to an item in the sequence, but you can assign to most of the
707         attributes of individual items.
708         @ivar edges: The mesh's edges.
709         @type edges: sequence of MEdges
710         @ivar faces: The mesh's faces.
711         @type faces: sequence of MFaces
712         @ivar verts: The mesh's vertices.
713         @type verts: sequence of MVerts
714
715         @ivar materials: The mesh's materials.  Each mesh can reference up to
716                 16 materials.  Empty slots in the mesh's list are represented by B{None}.
717                 B{Note}: L{Object.colbits<Object.Object.colbits>} needs to be set correctly
718                 for each object in order for these materials to be used instead of
719                 the object's materials.
720                 B{Note}: Making the material list shorter does not change the face's material indices.
721                 Take care when using the face's material indices to reference a material in this list.
722                 B{Note}: The list that's returned is I{not} linked to the original mesh.
723                 mesh.materials.append(material) won't do anything.
724                 Use mesh.materials += [material] instead.
725         @type materials: list of L{Material}s
726         @ivar degr: The max angle for auto smoothing in [1,80].  
727         @type degr: int
728         @ivar maxSmoothAngle: Same as L{degr}.  This attribute is only for
729                 compatibility with NMesh scripts and will probably be deprecated in 
730                 the future.
731         @ivar mode: The mesh's mode bitfield.  See L{Modes}.
732         @type mode: int
733         @ivar sel: Sets selection status for all vertices, edges and faces in the
734                 mesh (write only).
735         @type sel: boolean
736         @ivar hide: Sets hidden status for all vertices, edges and faces in the
737                 mesh (write only).
738         @type hide: boolean
739         @ivar subDivLevels: The [display, rendering] subdivision levels in [1, 6].
740         @type subDivLevels: list of 2 ints
741
742         @ivar faceUV: The mesh contains UV-mapped textured faces.  Enabling faceUV
743                 does not initialize the face colors like the Blender UI does; this must
744                 be done in the script.  B{Note}: if faceUV is set, L{vertexColors} cannot
745                 be set.  Furthermore, if vertexColors is already set when faceUV is set,
746                 vertexColors is cleared.  This is because the vertex color information
747                 is stored with UV faces, so enabling faceUV implies enabling vertexColors.
748                 In addition, faceUV cannot be set when the mesh has no faces defined
749                 (this is the same behavior as the UI).  Attempting to do so will throw
750                 a RuntimeError exception.
751         @type faceUV: bool
752         @ivar vertexColors: The mesh contains vertex colors.  See L{faceUV} for the
753                 use of vertex colors when UV-mapped texture faces are enabled.
754         @type vertexColors: bool
755         @ivar vertexUV: The mesh contains "sticky" per-vertex UV coordinates.
756         @type vertexUV: bool
757         @ivar activeFace: Index of the mesh's active face in UV Face Select and
758                 Paint modes.  Only one face can be active at a time.  Note that this is
759                 independent of the selected faces in Face Select and Edit modes.
760                 Will throw an exception if the mesh does not have UV faces; use
761                 L{faceUV} to test.
762         @type activeFace: int
763         @ivar activeGroup: The mesh's active vertex group.  The mesh must be
764                 linked to an object (read the comment in L{addVertGroup} for more info).
765         @type activeGroup: string or None
766         @ivar texMesh: The mesh's texMesh setting, used so coordinates from another
767                 mesh can be used for rendering textures.
768         @type texMesh: Mesh or None
769         @ivar key: The L{Key<Key.Key>} object containing the keyframes for this mesh, if any.
770         @type key: Key or None
771
772         @ivar activeUVLayer: The mesh's active UV/Image layer. None if there is no UV/Image layers.
773         @type activeUVLayer: string
774         @ivar activeColorLayer: The mesh's active Vertex Color layer. None if there is no UV/Image layers.
775         @type activeColorLayer: string
776
777         @ivar multires: The mesh has multires data, set True to add multires data.
778                 Will throw an exception if the mesh has shape keys; use L{key} to test.
779         @type multires: bool
780         @ivar multiresLevelCount: The mesh has multires data. (read only)
781         @type multiresLevelCount: int
782         @ivar multiresDrawLevel: The multires level to display in the 3dview in [1 - multiresLevelCount].
783         @type multiresDrawLevel: int
784         @ivar multiresEdgeLevel: The multires level edge display in the 3dview [1 - multiresLevelCount].
785         @type multiresEdgeLevel: int
786         @ivar multiresPinLevel: The multires pin level, used for applying modifiers [1 - multiresLevelCount].
787         @type multiresPinLevel: int
788         @ivar multiresRenderLevel: The multires level to render [1 - multiresLevelCount].
789         @type multiresRenderLevel: int
790         
791         
792         """
793
794         def getFromObject(object, cage=0, render=0):
795                 """
796                 Replace the mesh's existing data with the raw mesh data from a Blender
797                 Object.  This method supports all the geometry based objects (mesh, text,
798                 curve, surface, and meta).  If the object has modifiers, they will be
799                 applied before to the object before extracting the vertex data unless
800                 the B{cage} parameter is 1.
801                 @note: The mesh coordinates are in I{local space}, not the world space of
802                 its object.  For world space vertex coordinates, each vertex location must
803                 be multiplied by the object's 4x4 transform matrix (see L{transform}).
804                 @note: The objects materials will not be copied into the existing mesh,
805                 however the face material indices will match the material list of the original data.
806                 @type object: blender object or string
807                 @param object: The Blender object or its name, which contains the geometry data.
808                 @type cage: int
809                 @param cage: determines whether the original vertices or derived vertices
810                 @type render: int
811                 @param render: determines whether the render setting for modifiers will be used or not.
812                 (for objects with modifiers) are used.  The default is derived vertices.
813                 """
814
815         def calcNormals():
816                 """
817                 Recalculates the vertex normals using face data.
818                 """
819         
820         def pointInside(vector):
821                 """
822                 Returns true if vector is inside the mesh.
823                 @note: Only returns a valid result for mesh data that has no holes.
824                 """
825         
826         def transform(matrix, recalc_normals = False):
827                 """
828                 Transforms the mesh by the specified 4x4 matrix (such as returned by
829                 L{Object.Object.getMatrix}).  The matrix should be invertible.
830                 Ideal usage for this is exporting to an external file where
831                 global vertex locations are required for each object.
832                 Sometimes external renderers or file formats do not use vertex normals.
833                 In this case, you can skip transforming the vertex normals by leaving
834                 the optional parameter recalc_normals as False or 0 (the default value).
835
836                 Example::
837                         # This script outputs deformed meshes worldspace vertex locations
838                         # for a selected object without changing the object
839                         import Blender
840                         from Blender import Mesh, Object
841                         
842                         ob = Object.GetSelected()[0] # Get the first selected object
843                         me = Mesh.New()              # Create a new mesh
844                         me.getFromObject(ob.name)    # Get the object's mesh data
845                         verts = me.verts[:]          # Save a copy of the vertices
846                         me.transform(ob.matrix)      # Convert verts to world space
847                         for v in me.verts:
848                                 print 'worldspace vert', v.co
849                         me.verts = verts             # Restore the original verts
850                 
851                 @type matrix: Py_Matrix
852                 @param matrix: 4x4 Matrix which can contain location, scale and rotation. 
853                 @type recalc_normals: int
854                 @param recalc_normals: if True or 1, also transform vertex normals.
855                 @warn: unlike L{NMesh.transform()<NMesh.NMesh.transform>}, this method
856                 I{will immediately modify the mesh data} when it is used.  If you
857                 transform the mesh using the object's matrix to get the vertices'
858                 world positions, the result will be a "double transform".  To avoid
859                 this you either need to set the object's matrix to the identity
860                 matrix, perform the inverse transform after outputting the transformed
861                 vertices, or make a copy of the vertices prior to using this method
862                 and restore them after outputting the transformed vertices (as shown
863                 in the example).
864                 """
865
866         def vertexShade(object):
867                 """
868                 Colors vertices based on the current lighting setup, like when there
869                 are no vertex colors and no textured faces and a user enters Vertex Paint
870                 Mode in Blender (only lamps in visible layers account).  An exception is
871                 thrown if called while in EditMode.
872                 @type object: Object
873                 @param object: The Blender Object linked to the mesh.
874                 """
875
876         def update():
877                 """
878                 Update display lists after changes to mesh.  B{Note}: with changes taking
879                 place for using a directed acyclic graph (DAG) for scene and object
880                 updating, this method may be only temporary and may be removed in future
881                 releases.
882                 @warn: Since Blender 2.42 this function has changed; now it won't recalculate
883                 vertex normals (seen when faces are smooth). See L{Mesh.calcNormals()}.
884                 """
885
886         def findEdges(edges):
887                 """
888                 Quickly search for the location of an edges.  
889                 @type edges: sequence(s) of ints or MVerts
890                 @param edges: can be tuples of MVerts or integer indexes (B{note:} will
891                         not work with PVerts) or a sequence (list or tuple) containing two or
892                         more sequences.
893                 @rtype: int, None or list
894                 @return: if an edge is found, its index is returned; otherwise None is
895                 returned.  If a sequence of edges is passed, a list is returned.
896                 """
897
898         def addVertGroup(group):
899                 """
900                 Add a named and empty vertex (deform) group to the object this mesh is
901                 linked to.  The mesh must first be linked to an object (with object.link()
902                 or object.getData() ) so the method knows which object to update.  
903                 This is because vertex groups in Blender are stored in I{the object} --
904                 not in the mesh, which may be linked to more than one object. 
905                 @type group: string
906                 @param group: the name for the new group.
907                 """
908
909         def removeVertGroup(group):
910                 """
911                 Remove a named vertex (deform) group from the object linked to this mesh.
912                 All vertices assigned to the group will be removed (just from the group,
913                 not deleted from the mesh), if any. If this mesh was newly created, it
914                 must first be linked to an object (read the comment in L{addVertGroup} for
915                 more info).
916                 @type group: string
917                 @param group: the name of a vertex group.
918                 """
919
920         def assignVertsToGroup(group, vertList, weight, assignmode = AssignModes['REPLACE']):
921                 """
922                 Adds an array (a Python list) of vertex points to a named vertex group
923                 associated with a mesh. The vertex list is a list of vertex indices from
924                 the mesh. You should assign vertex points to groups only when the mesh has
925                 all its vertex points added to it and is already linked to an object.
926
927                 I{B{Example:}}
928                 The example here adds a new set of vertex indices to a sphere primitive::
929                         import Blender
930                         sphere = Blender.Object.Get('Sphere')
931                         replace = Blender.Mesh.AssignModes.REPLACE
932                         mesh = sphere.getData(mesh=True)
933                         mesh.addVertGroup('firstGroup')
934                         vertList = []
935                         for x in range(300):
936                                 if x % 3 == 0:
937                                         vertList.append(x)
938                         mesh.assignVertsToGroup('firstGroup', vertList, 0.5, replace)
939
940                 @type group: string
941                 @param group: the name of the group.
942                 @type vertList: list of ints
943                 @param vertList: a list of vertex indices.
944                 @type weight: float
945                 @param weight: the deform weight for (which means: the amount of influence
946                                 the group has over) the given vertices. It should be in the range
947                                 [0.0, 1.0]. If weight <= 0, the given vertices are removed from the
948                                 group.  If weight > 1, it is clamped.
949                 @type assignmode: module constant
950                 @param assignmode: Three choices: REPLACE, ADD or SUBTRACT. 
951                         See L{AssignModes} for a complete description.
952                 """
953
954         def removeVertsFromGroup(group, vertList = None):
955                 """
956                 Remove a list of vertices from the given group.  If this mesh was newly
957                 created, it must first be linked to an object (check L{addVertGroup}).
958                 @type group: string
959                 @param group: the name of a vertex group
960                 @type vertList: list of ints
961                 @param vertList: a list of vertex indices to be removed from I{group}.
962                                 If None, all vertices are removed -- the group is emptied.
963                 """
964
965         def getVertsFromGroup(group, weightsFlag = 0, vertList = None):
966                 """
967                 Return a list of vertex indices associated with the passed group. This
968                 method can be used to test whether a vertex index is part of a group and
969                 if so, what its weight is. 
970
971                 I{B{Example:}}
972                 Append this to the example from L{assignVertsToGroup}::
973                         # ...
974                         print "Vertex indices from group %s :" % groupName
975                         print mesh.getVertsFromGroup('firstGroup')
976                         print "Again, with weights:"
977                         print mesh.getVertsFromGroup('firstGroup',1)
978                         print "Again, with weights and restricted to the given indices:"
979                         print mesh.getVertsFromGroup('firstGroup',1,[1,2,3,4,5,6])     
980
981                 @type group: string
982                 @param group: the group name.
983                 @type weightsFlag: bool
984                 @param weightsFlag: if 1, the weight is returned along with the index. 
985                 @type vertList: list of ints
986                 @param vertList: if given, only those vertex points that are both in the
987                                 list and group passed in are returned.
988                 """
989
990         def renameVertGroup(groupName, newName):
991                 """
992                 Renames a vertex group.
993                 @type groupName: string
994                 @param groupName: the vertex group name to be renamed.
995                 @type newName: string
996                 @param newName: the name to replace the old name.
997                 """
998
999         def getVertGroupNames():
1000                 """
1001                 Return a list of all vertex group names.
1002                 @rtype: list of strings
1003                 @return: returns a list of strings representing all vertex group
1004                 associated with the mesh's object
1005                 """
1006
1007         def getUVLayerNames():
1008                 """
1009                 Return a list of all UV layer names
1010                 @rtype: list of strings
1011                 @return: returns a list of strings representing all UV layers
1012                 associated with the mesh's object
1013                 """
1014
1015         def getColorLayerNames():
1016                 """
1017                 Return a list of all color layer names
1018                 @rtype: list of strings
1019                 @return: returns a list of strings representing all color layers
1020                 associated with the mesh's object
1021                 """
1022
1023         def getVertexInfluences(index):
1024                 """
1025                 Get the bone influences for a specific vertex.
1026                 @type index: int
1027                 @param index: The index of a vertex.
1028                 @rtype: list of lists
1029                 @return: List of pairs [name, weight], where name is the bone name (string)
1030                                 and weight is a float value.
1031                 """
1032
1033         def removeAllKeys():
1034                 """
1035                 Remove all mesh keys stored in this mesh.
1036                 @rtype: bool
1037                 @return: True if successful or False if the Mesh has no keys.
1038                 """
1039
1040         def insertKey(frame = None, type = 'relative'):
1041                 """
1042                 Insert a mesh key at the given frame. 
1043                 @type frame: int
1044                 @type type: string
1045                 @param frame: The Scene frame where the mesh key should be inserted.  If
1046                                 None or the arg is not given, the current frame is used.
1047                 @param type: The mesh key type: 'relative' or 'absolute'.  This is only
1048                                 relevant on meshes with no keys.
1049                 @warn: This and L{removeAllKeys} were included in this release only to
1050                                 make accessing vertex keys possible, but may not be a proper solution
1051                                 and may be substituted by something better later.  For example, it
1052                                 seems that 'frame' should be kept in the range [1, 100]
1053                                 (the curves can be manually tweaked in the Ipo Curve Editor window in
1054                                 Blender itself later).
1055                 @warn: Will throw an error if the mesh has multires. use L{multires} to check.
1056                 """
1057
1058         def addUVLayer(name):
1059                 """
1060                 Adds a new UV/Image layer to this mesh, it will always be the last layer but not made active.
1061                 @type name: string
1062                 @param name: The name of the new UV layer, 31 characters max.
1063                 """
1064
1065         def addColorLayer(name):
1066                 """
1067                 Adds a new Vertex Color layer to this mesh, it will always be the last layer but not made active.
1068                 @type name: string
1069                 @param name: The name of the new Color layer, 31 characters max.
1070                 """
1071
1072         def removeUVLayer(name):
1073                 """
1074                 Removes the active UV/Image layer.
1075                 @type name: string
1076                 @param name: The name of the UV layer to remove.
1077                 """
1078
1079         def removeColorLayer(name):
1080                 """
1081                 Removes the active Vertex Color layer.
1082                 @type name: string
1083                 @param name: The name of the Color layer to remove.
1084                 """
1085
1086         def renameUVLayer(name, newname):
1087                 """
1088                 Removes the active UV/Image layer.
1089                 @type name: string
1090                 @param name: The UV layer to rename.
1091                 @type newname: string
1092                 @param newname: The new name of the UV layer, will be made unique.
1093                 """
1094
1095         def renameColorLayer(name, newname):
1096                 """
1097                 Removes the active Vertex Color layer.
1098                 @type name: string
1099                 @param name: The Color layer to rename.
1100                 @type newname: string
1101                 @param newname: The new name of the Color layer, will be made unique.
1102                 """
1103
1104         def smooth():
1105                 """
1106                 Flattens angle of selected faces. Experimental mesh tool.
1107                 An exception is thrown if called while in EditMode.
1108                 """
1109
1110         def flipNormals():
1111                 """
1112                 Toggles the direction of selected face's normals. Experimental mesh tool.
1113                 An exception is thrown if called while in EditMode.
1114                 """
1115
1116         def toSphere():
1117                 """
1118                 Moves selected vertices outward in a spherical shape. Experimental mesh
1119                 tool.
1120                 An exception is thrown if called while in EditMode.
1121                 """
1122
1123         def fill():
1124                 """
1125                 Scan fill a closed selected edge loop. Experimental mesh tool.
1126                 An exception is thrown if called while in EditMode.
1127                 """
1128
1129         def triangleToQuad():
1130                 """
1131                 Convert selected triangles to quads. Experimental mesh tool.
1132                 An exception is thrown if called while in EditMode.
1133                 """
1134
1135         def quadToTriangle(mode=0):
1136                 """
1137                 Convert selected quads to triangles. Experimental mesh tool.
1138                 An exception is thrown if called while in EditMode.
1139                 @type mode: int
1140                 @param mode: specifies whether a to add the new edge between the
1141                 closest (=0) or farthest(=1) vertices.
1142                 """
1143
1144         def subdivide(beauty=0):
1145                 """
1146                 Subdivide selected edges in a mesh. Experimental mesh tool.
1147                 An exception is thrown if called while in EditMode.
1148                 @type beauty: int
1149                 @param beauty: specifies whether a "beauty" subdivide should be
1150                 enabled (disabled is default).  Value must be in the range [0,1].
1151                 """
1152
1153         def remDoubles(limit):
1154                 """
1155                 Removes duplicates from selected vertices. Experimental mesh tool.
1156                 An exception is thrown if called while in EditMode.
1157                 @type limit: float
1158                 @param limit: specifies the maximum distance considered for vertices
1159                 to be "doubles".  Value is clamped to the range [0.0,1.0].
1160                 @rtype: int
1161                 @return: the number of vertices deleted
1162                 """
1163
1164         def recalcNormals(direction=0):
1165                 """
1166                 Recalculates inside or outside normals for selected faces. Experimental
1167                 mesh tool.
1168                 An exception is thrown if called while in EditMode.
1169                 @type direction: int
1170                 @param direction: specifies outward (0) or inward (1) normals.  Outward
1171                 is the default.  Value must be in the range [0,1].
1172                 """
1173
1174         def __copy__ ():
1175                 """
1176                 Make a copy of this mesh
1177                 @rtype: Mesh
1178                 @return:  a copy of this mesh
1179                 """
1180
1181 import id_generics
1182 Mesh.__doc__ += id_generics.attributes