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