Enable/Disable DupFaces from the Python API.
[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   """
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 = 1 - 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.
537   @type image: Image
538   @ivar mode: The texture mode bitfield (see L{FaceModes}).
539       Will throw an exception if the mesh does not have UV faces; use
540       L{Mesh.faceUV} to test.
541   @type mode: int
542   @ivar index: The face's index within the mesh.  Read-only.
543   @type index: int
544
545   @ivar flag: The face's B{texture mode} flags; indicates the selection, 
546       active , and visibility states of a textured face (see
547       L{FaceFlags} for values).
548       This is not the same as the selection or visibility states of
549       the faces in edit mode (see L{sel} and L{hide}).
550       To set the active face, use
551       the L{Mesh.activeFace} attribute instead.
552       Will throw an exception if the mesh does not have UV faces; use
553       L{Mesh.faceUV} to test.
554
555   @ivar transp: Transparency mode.  It is one of the values in 
556       L{FaceTranspModes}).
557       Will throw an exception if the mesh does not have UV faces; use
558       L{Mesh.faceUV} to test.
559   @type transp: int
560
561   @ivar uv: The face's UV coordinates.  Each vertex has its own UV coordinate.
562       Setting this attribute will create UV faces if they do not exist.
563       Getting this attribute throw an exception if the mesh does not have 
564       UV faces; use L{Mesh.faceUV} to test.  
565   @type uv: list of vectors (WRAPPED DATA)
566   @ivar uvSel: The face's UV coordinates selection state; a 1 indicates the
567       vertex is selected.  Each vertex has its own UV coordinate select state
568       (this is not the same as the vertex's edit mode selection state).
569       Setting this attribute will create UV faces if they do not exist.
570       Getting this attribute throw an exception if the mesh does not have 
571       UV faces; use L{Mesh.faceUV} to test.  
572   @type uvSel: tuple of ints
573   @ivar no: The face's normal vector (x, y, z).  Read-only.
574   @type no: vector
575   @ivar cent: The center of the face. Read-only.
576   @type cent: vector
577   @ivar area: The area of the face. Read-only.
578   @type area: float
579   @note: there are regular faces and textured faces in Blender, both currently
580     with their own selection and visibility states, due to a mix of old and new
581     code.  To (un)select or (un)hide regular faces (visible in EditMode), use
582     L{MFace.sel} and L{MFace.hide} attributes.  For textured faces (UV Face 
583     Select and Paint modes in Blender) use the L{MFace.flag} attribute.
584     Check the example above and note L{Window.EditMode}.
585   @note: Assigning UV textures to mesh faces in Blender works like this:
586     1. Select your mesh.
587     2. Enter face select mode (press f) and select at least some face(s).
588     3. In the UV/Image Editor window, load / select an image.
589     4. Play in both windows (better split the screen to see both at the same
590        time) until the UV coordinates are where you want them.  Hint: in the
591        3D window, the 'u' key opens a menu of default UV choices and the 'r'
592        key lets you rotate the UV coords.
593     5. Leave face select mode (press f).
594   """
595
596   def __iter__():
597     """
598     Iterator for MVert.  It iterates over the MVerts of the face, returning
599     v1, v2, v3 (and optionally v4);
600     @return: one of the face's vertices
601     @rtype: MVert
602     """
603
604   def __len__():
605     """
606     len for MVert.  It returns the number of vertices in the face.
607     @rtype: int
608     """
609
610 class MFaceSeq:
611   """
612   The MFaceSeq object
613   ===================
614     This object provides sequence and iterator access to the mesh's faces.
615   """
616
617   def extend(vertseq,ignoreDups=True,indexList=True):
618     """
619     Add zero or more faces and edges to the mesh.  Faces which already exist
620     in the mesh, or faces which contain the same vertex multiple times are
621     ignored.  Sequences of two vertices are accepted, but no face will be
622     created.
623
624     Example::
625       import Blender
626       from Blender import Mesh
627
628       me = Mesh.Get("Plane")          # get the mesh data called "Plane"
629       v = me.verts                    # get vertices
630       if len(v) >= 6:                 # if there are enough vertices...
631         me.faces.extend(v[1],v[2],v[3]) #   add a single edge
632         l=[(v[0],v[1]),[0,2,4,5]]
633         me.faces.extend(l)            #   add another face
634
635     @type vertseq: sequence(s) of MVerts
636     @param vertseq: either two to four ints or MVerts, or sequence (list or
637     tuple) of sequences each containing two to four ints or MVerts.
638     @type ignoreDups: boolean
639     @param ignoreDups: keyword parameter (default is False).  If supplied and
640     True, do not check the input list or mesh for duplicate faces.  This can
641     speed up scripts but can prossibly produce undesirable effects.  Only
642     use if you know what you're doing.
643     @type indexList: boolean
644     @param indexList: keyword parameter (default is False).  If supplied and
645     True, the method will return a list representing the new index for each
646     face in the input list.  If faces are removed as duplicates, None is
647     inserted in place of the index.
648     """
649
650   def delete(deledges, faces):
651     """
652     Deletes one or more faces (and optionally the edges associated with
653     the face(s)) from the mesh.  
654
655     @type deledges: int
656     @param deledges: controls whether just the faces (deledges=0)
657     or the faces and edges (deledges=1) are deleted.  These correspond to the
658     "Only Faces" and "Edges & Faces" options in the Edit Mode pop-up menu
659     @type faces: multiple ints or MFaces
660     @param faces: a sequence (list or tuple) containing one or more of:
661        - an MEdge belonging to the mesh
662        - a integer, specifying an index into the mesh's face list
663     """
664
665   def selected():
666     """
667     Get selected faces.
668     @return: a list of the indices for all faces selected in edit mode.
669     @rtype: list of ints
670     """
671
672 from IDProp import IDProperty, IDGroup, IDArray
673 class Mesh:
674   """
675   The Mesh Data object
676   ====================
677     This object gives access to mesh data in Blender.
678
679   @note: the verts, edges and faces attributes are implemented as sequences.
680   The operator[] and len() are defined for these sequences.  You cannot
681   assign to an item in the sequence, but you can assign to most of the
682   attributes of individual items.
683   @ivar properties: Returns an L{IDProperty<IDProperty>} reference of type L{IDGroup<IDGroup>} to 
684   this mesh's ID Properties.  Note that dict access is available for groups on the parent 
685   L{IDProperty<IDProperty>} object, but for everything else you need to get the L{IDGroup<IDGroup>}
686   object from the L{IDProperty<IDProperty>}'s data member.
687   @ivar edges: The mesh's edges.
688   @type edges: sequence of MEdges
689   @ivar faces: The mesh's faces.
690   @type faces: sequence of MFaces
691   @ivar verts: The mesh's vertices.
692   @type verts: sequence of MVerts
693
694   @ivar materials: The mesh's materials.  Each mesh can reference up to
695     16 materials.  Empty slots in the mesh's list are represented by B{None}.
696     B{Note}: L{Object.colbits<Object.Object.colbits>} needs to be set correctly
697     for each object in order for these materials to be used instead of
698     the object's materials.
699     B{Note}: Making the material list shorter does not change the faces material indices,
700     take care when using the faces material indices to reference a material in the materials list.
701     B{Note}: The the list thats returned is not linked to the original mesh.
702     mesh.materials.append(material) wont do anything.
703     Use mesh.materials += [material] instead.
704   @type materials: list of Materials
705   @ivar degr: The max angle for auto smoothing in [1,80].  
706   @type degr: int
707   @ivar maxSmoothAngle: Same as L{degr}.  This attribute is only for
708     compatibility with NMesh scripts and will probably be deprecated in 
709     the future.
710   @ivar mode: The mesh's mode bitfield.  See L{Modes}.
711   @type mode: int
712   @ivar sel: Sets selection status for all vertices, edges and faces in the
713     mesh (write only).
714   @type sel: boolean
715   @ivar hide: Sets hidden status for all vertices, edges and faces in the
716     mesh (write only).
717   @type hide: boolean
718   @ivar name: The Mesh name.  It's common to use this field to store extra
719      data about the mesh (to be exported to another program, for example).
720   @type name: str
721   @ivar subDivLevels: The [display, rendering] subdivision levels in [1, 6].
722   @type subDivLevels: list of 2 ints
723   @ivar users: The number of Objects using (linked to) this mesh. (read only)
724   @type users: int
725   @ivar fakeUser: The fake user status.
726     enabling this will keep it in the blend even if there are no users.
727   @type fakeUser: bool
728
729   @ivar faceUV: The mesh contains UV-mapped textured faces.  Enabling faceUV
730     does not initialize the face colors like the Blender UI does; this must
731     be done in the script.  B{Note}: if faceUV is set, L{vertexColors} cannot
732     be set.  Furthermore, if vertexColors is already set when faceUV is set,
733     vertexColors is cleared.  This is because the vertex color information
734     is stored with UV faces, so enabling faceUV implies enabling vertexColors.
735     In addition, faceUV cannot be set when the mesh has no faces defined
736     (this is the same behavior as the UI).  Attempting to do so will throw
737     a RuntimeError exception.
738   @type faceUV: bool
739   @ivar vertexColors: The mesh contains vertex colors.  See L{faceUV} for the
740     use of vertex colors when UV-mapped texture faces are enabled.
741   @type vertexColors: bool
742   @ivar vertexUV: The mesh contains "sticky" per-vertex UV coordinates.
743   @type vertexUV: bool
744   @ivar activeFace: Index of the mesh's active face in UV Face Select and
745     Paint modes.  Only one face can be active at a time.  Note that this is
746     independent of the selected faces in Face Select and Edit modes.
747     Will throw an exception if the mesh does not have UV faces; use
748     L{faceUV} to test.
749   @type activeFace: int
750   @ivar activeGroup: The mesh's active vertex group.  The mesh must be
751     linked to an object (read the comment in L{addVertGroup} for more info).
752   @type activeGroup: string or None
753   @ivar texMesh: The mesh's texMesh setting, used so coordinates from another
754     mesh can be used for rendering textures.
755   @type texMesh: Mesh or None
756
757   @ivar activeUVLayer: The mesh's active UV/Image layer index. -1 if there is no UV/Image layers.
758   @type activeUVLayer: int
759   @ivar activeColorLayer: The mesh's active Vertex Color layer index. -1 if there is no UV/Image layers.
760   @type activeColorLayer: int
761   
762   @ivar totalUVLayers: The mesh's total number of UV/Image layers.
763   @type totalUVLayers: int
764   @ivar totalColorLayers: The mesh's total number of Vertex Color layers.
765   @type totalColorLayers: int
766   
767   """
768
769   def getFromObject(object, cage=0, render=0):
770     """
771     Replace the mesh's existing data with the raw mesh data from a Blender
772     Object.  This method supports all the geometry based objects (mesh, text,
773     curve, surface, and meta).  If the object has modifiers, they will be
774     applied before to the object before extracting the vertex data unless
775     the B{cage} parameter is 1.
776     @note: The mesh coordinates are in I{local space}, not the world space of
777     its object.  For world space vertex coordinates, each vertex location must
778     be multiplied by the object's 4x4 transform matrix (see L{transform}).
779     @note: The objects materials will not be copied into the existing mesh,
780     however the face material indices will match the material list of the original data.
781     @type object: blender object or string
782     @param object: The Blender object or its name, which contains the geometry data.
783     @type cage: int
784     @param cage: determines whether the original vertices or derived vertices
785     @type render: int
786     @param render: determines whether the render setting for modifiers will be used or not.
787     (for objects with modifiers) are used.  The default is derived vertices.
788     """
789
790   def calcNormals():
791     """
792     Recalculates the vertex normals using face data.
793     """
794
795   def transform(matrix, recalc_normals = False):
796     """
797     Transforms the mesh by the specified 4x4 matrix (such as returned by
798     L{Object.Object.getMatrix}).  The matrix should be invertible.
799     Ideal usage for this is exporting to an external file where
800     global vertex locations are required for each object.
801     Sometimes external renderers or file formats do not use vertex normals.
802     In this case, you can skip transforming the vertex normals by leaving
803     the optional parameter recalc_normals as False or 0 (the default value).
804
805     Example::
806      # This script outputs deformed meshes worldspace vertex locations
807      # for a selected object without changing the object
808      import Blender
809      from Blender import Mesh, Object
810      
811      ob = Object.GetSelected()[0] # Get the first selected object
812      me = Mesh.New()              # Create a new mesh
813      me.getFromObject(ob.name)    # Get the object's mesh data
814      verts = me.verts[:]          # Save a copy of the vertices
815      me.transform(ob.matrix)      # Convert verts to world space
816      for v in me.verts:
817        print 'worldspace vert', v.co
818      me.verts = verts             # Restore the original verts
819     
820     @type matrix: Py_Matrix
821     @param matrix: 4x4 Matrix which can contain location, scale and rotation. 
822     @type recalc_normals: int
823     @param recalc_normals: if True or 1, also transform vertex normals.
824     @warn: unlike L{NMesh.transform()<NMesh.NMesh.transform>}, this method
825     I{will immediately modify the mesh data} when it is used.  If you
826     transform the mesh using the object's matrix to get the vertices'
827     world positions, the result will be a "double transform".  To avoid
828     this you either need to set the object's matrix to the identity
829     matrix, perform the inverse transform after outputting the transformed
830     vertices, or make a copy of the vertices prior to using this method
831     and restore them after outputting the transformed vertices (as shown
832     in the example).
833     """
834
835   def vertexShade(object):
836     """
837     Colors vertices based on the current lighting setup, like when there
838     are no vertex colors and no textured faces and a user enters Vertex Paint
839     Mode in Blender (only lamps in visible layers account).  An exception is
840     thrown if called while in EditMode.
841     @type object: Object
842     @param object: The Blender Object linked to the mesh.
843     """
844
845   def update():
846     """
847     Update display lists after changes to mesh.  B{Note}: with changes taking
848     place for using a directed acyclic graph (DAG) for scene and object
849     updating, this method may be only temporary and may be removed in future
850     releases.
851     """
852
853   def findEdges(edges):
854     """
855     Quickly search for the location of an edges.  
856     @type edges: sequence(s) of ints or MVerts
857     @param edges: can be tuples of MVerts or integer indexes (B{note:} will
858        not work with PVerts) or a sequence (list or tuple) containing two or
859        more sequences.
860     @rtype: int, None or list
861     @return: if an edge is found, its index is returned; otherwise None is
862     returned.  If a sequence of edges is passed, a list is returned.
863     """
864
865   def addVertGroup(group):
866     """
867     Add a named and empty vertex (deform) group to the object this mesh is
868     linked to.  The mesh must first be linked to an object (with object.link()
869     or object.getData() ) so the method knows which object to update.  
870     This is because vertex groups in Blender are stored in I{the object} --
871     not in the mesh, which may be linked to more than one object. 
872     @type group: string
873     @param group: the name for the new group.
874     """
875
876   def removeVertGroup(group):
877     """
878     Remove a named vertex (deform) group from the object linked to this mesh.
879     All vertices assigned to the group will be removed (just from the group,
880     not deleted from the mesh), if any. If this mesh was newly created, it
881     must first be linked to an object (read the comment in L{addVertGroup} for
882     more info).
883     @type group: string
884     @param group: the name of a vertex group.
885     """
886
887   def assignVertsToGroup(group, vertList, weight, assignmode = AssignModes['REPLACE']):
888     """
889     Adds an array (a Python list) of vertex points to a named vertex group
890     associated with a mesh. The vertex list is a list of vertex indices from
891     the mesh. You should assign vertex points to groups only when the mesh has
892     all its vertex points added to it and is already linked to an object.
893
894     I{B{Example:}}
895     The example here adds a new set of vertex indices to a sphere primitive::
896      import Blender
897      sphere = Blender.Object.Get('Sphere')
898      replace = Blender.Mesh.AssignModes.REPLACE
899      mesh = sphere.getData(mesh=True)
900      mesh.addVertGroup('firstGroup')
901      vertList = []
902      for x in range(300):
903          if x % 3 == 0:
904              vertList.append(x)
905      mesh.assignVertsToGroup('firstGroup', vertList, 0.5, replace)
906
907     @type group: string
908     @param group: the name of the group.
909     @type vertList: list of ints
910     @param vertList: a list of vertex indices.
911     @type weight: float
912     @param weight: the deform weight for (which means: the amount of influence
913         the group has over) the given vertices. It should be in the range
914         [0.0, 1.0]. If weight <= 0, the given vertices are removed from the
915         group.  If weight > 1, it is clamped.
916     @type assignmode: module constant
917     @param assignmode: Three choices: REPLACE, ADD or SUBTRACT. 
918         See L{AssignModes} for a complete description.
919        """
920
921   def removeVertsFromGroup(group, vertList = None):
922     """
923     Remove a list of vertices from the given group.  If this mesh was newly
924     created, it must first be linked to an object (check L{addVertGroup}).
925     @type group: string
926     @param group: the name of a vertex group
927     @type vertList: list of ints
928     @param vertList: a list of vertex indices to be removed from I{group}.
929         If None, all vertices are removed -- the group is emptied.
930     """
931
932   def getVertsFromGroup(group, weightsFlag = 0, vertList = None):
933     """
934     Return a list of vertex indices associated with the passed group. This
935     method can be used to test whether a vertex index is part of a group and
936     if so, what its weight is. 
937
938     I{B{Example:}}
939     Append this to the example from L{assignVertsToGroup}::
940      # ...
941      print "Vertex indices from group %s :" % groupName
942      print mesh.getVertsFromGroup('firstGroup')
943      print "Again, with weights:"
944      print mesh.getVertsFromGroup('firstGroup',1)
945      print "Again, with weights and restricted to the given indices:"
946      print mesh.getVertsFromGroup('firstGroup',1,[1,2,3,4,5,6])     
947
948     @type group: string
949     @param group: the group name.
950     @type weightsFlag: bool
951     @param weightsFlag: if 1, the weight is returned along with the index. 
952     @type vertList: list of ints
953     @param vertList: if given, only those vertex points that are both in the
954         list and group passed in are returned.
955     """
956
957   def renameVertGroup(groupName, newName):
958     """
959     Renames a vertex group.
960     @type groupName: string
961     @param groupName: the vertex group name to be renamed.
962     @type newName: string
963     @param newName: the name to replace the old name.
964     """
965
966   def getVertGroupNames():
967     """
968     Return a list of all vertex group names.
969     @rtype: list of strings
970     @return: returns a list of strings representing all vertex group
971     associated with the mesh's object
972     """
973
974   def getVertexInfluences(index):
975     """
976     Get the bone influences for a specific vertex.
977     @type index: int
978     @param index: The index of a vertex.
979     @rtype: list of lists
980     @return: List of pairs [name, weight], where name is the bone name (string)
981         and weight is a float value.
982     """
983
984   def removeAllKeys():
985     """
986     Remove all mesh keys stored in this mesh.
987     @rtype: bool
988     @return: True if successful or False if the Mesh has no keys.
989     """
990
991   def insertKey(frame = None, type = 'relative'):
992     """
993     Insert a mesh key at the given frame. 
994     @type frame: int
995     @type type: string
996     @param frame: The Scene frame where the mesh key should be inserted.  If
997         None or the arg is not given, the current frame is used.
998     @param type: The mesh key type: 'relative' or 'absolute'.  This is only
999         relevant on meshes with no keys.
1000     @warn: This and L{removeAllKeys} were included in this release only to
1001         make accessing vertex keys possible, but may not be a proper solution
1002         and may be substituted by something better later.  For example, it
1003         seems that 'frame' should be kept in the range [1, 100]
1004         (the curves can be manually tweaked in the Ipo Curve Editor window in
1005         Blender itself later).
1006     """
1007
1008   def addUVLayer():
1009     """
1010     Adds a new UV/Image layer to this mesh, it will always be the last layer and made active.
1011     """
1012
1013   def addColorLayer():
1014     """
1015     Adds a new Vertex Color layer to this mesh, it will always be the last layer and made active.
1016     """
1017
1018   def removeUVLayer():
1019     """
1020     Removes the active UV/Image layer.
1021     """
1022
1023   def removeColorLayer():
1024     """
1025     Removes the active Vertex Color layer.
1026     """
1027
1028   def smooth():
1029     """
1030     Flattens angle of selected faces. Experimental mesh tool.
1031     An exception is thrown if called while in EditMode.
1032     """
1033
1034   def flipNormals():
1035     """
1036     Toggles the direction of selected face's normals. Experimental mesh tool.
1037     An exception is thrown if called while in EditMode.
1038     """
1039
1040   def toSphere():
1041     """
1042     Moves selected vertices outward in a spherical shape. Experimental mesh
1043     tool.
1044     An exception is thrown if called while in EditMode.
1045     """
1046
1047   def fill():
1048     """
1049     Scan fill a closed selected edge loop. Experimental mesh tool.
1050     An exception is thrown if called while in EditMode.
1051     """
1052
1053   def triangleToQuad():
1054     """
1055     Convert selected triangles to quads. Experimental mesh tool.
1056     An exception is thrown if called while in EditMode.
1057     """
1058
1059   def quadToTriangle(mode=0):
1060     """
1061     Convert selected quads to triangles. Experimental mesh tool.
1062     An exception is thrown if called while in EditMode.
1063     @type mode: int
1064     @param mode: specifies whether a to add the new edge between the
1065     closest (=0) or farthest(=1) vertices.
1066     """
1067
1068   def subdivide(beauty=0):
1069     """
1070     Subdivide selected edges in a mesh. Experimental mesh tool.
1071     An exception is thrown if called while in EditMode.
1072     @type beauty: int
1073     @param beauty: specifies whether a "beauty" subdivide should be
1074     enabled (disabled is default).  Value must be in the range [0,1].
1075     """
1076
1077   def remDoubles(limit):
1078     """
1079     Removes duplicates from selected vertices. Experimental mesh tool.
1080     An exception is thrown if called while in EditMode.
1081     @type limit: float
1082     @param limit: specifies the maximum distance considered for vertices
1083     to be "doubles".  Value is clamped to the range [0.0,1.0].
1084     @rtype: int
1085     @return: the number of vertices deleted
1086     """
1087
1088   def recalcNormals(direction=0):
1089     """
1090     Recalculates inside or outside normals for selected faces. Experimental
1091     mesh tool.
1092     An exception is thrown if called while in EditMode.
1093     @type direction: int
1094     @param direction: specifies outward (0) or inward (1) normals.  Outward
1095     is the default.  Value must be in the range [0,1].
1096     """