]> git.tdb.fi Git - libs/gl.git/blobdiff - blender/io_mspgl/mesh.py
Add a bunch of comments to the Mesh class in the Blender exporter
[libs/gl.git] / blender / io_mspgl / mesh.py
index 077acc2e57014227a652ad64ff268061b18c1e7b..b58637b7f76bb00515c82f29d211c7a380d51395 100644 (file)
@@ -6,19 +6,19 @@ def make_edge_key(i1, i2):
        return (min(i1, i2), max(i1, i2))
 
 class Edge:
-       def __init__(self, me):
-               if me.__class__==Edge:
-                       self._medge = me._medge
-                       self.vertices = me.vertices[:]
-                       self.smooth = me.smooth
+       def __init__(self, edge):
+               if edge.__class__==Edge:
+                       self._edge = edge._edge
+                       self.vertices = edge.vertices[:]
+                       self.smooth = edge.smooth
                else:
-                       self._medge = me
+                       self._edge = edge
                        self.smooth = False
-               self.key = me.key
+               self.key = edge.key
                self.faces = []
 
        def __getattr__(self, attr):
-               return getattr(self._medge, attr)
+               return getattr(self._edge, attr)
 
        def check_smooth(self, limit):
                if len(self.faces)!=2:
@@ -44,27 +44,27 @@ class Edge:
 
 
 class Vertex:
-       def __init__(self, mv):
-               if mv.__class__==Vertex:
-                       self._mvert = mv._mvert
-                       self.uvs = mv.uvs[:]
-                       self.tan = mv.tan
-                       self.bino = mv.bino
+       def __init__(self, vertex):
+               if vertex.__class__==Vertex:
+                       self._vertex = vertex._vertex
+                       self.uvs = vertex.uvs[:]
+                       self.tan = vertex.tan
+                       self.bino = vertex.bino
                else:
-                       self._mvert = mv
+                       self._vertex = vertex
                        self.uvs = []
                        self.tan = None
                        self.bino = None
-               self.index = mv.index
-               self.co = mv.co
-               self.normal = mv.normal
+               self.index = vertex.index
+               self.co = vertex.co
+               self.normal = vertex.normal
                self.flag = False
                self.edges = []
                self.faces = []
-               self.groups = mv.groups[:]
+               self.groups = vertex.groups[:]
 
        def __getattr__(self, attr):
-               return getattr(self._mvert, attr)
+               return getattr(self._vertex, attr)
 
        def __cmp__(self, other):
                if other is None:
@@ -73,26 +73,26 @@ class Vertex:
 
 
 class VertexGroup:
-       def __init__(self, base):
-               self._base = base
-               self.group = base.group
-               self.weight = base.weight
+       def __init__(self, group):
+               self._group = group
+               self.group = group.group
+               self.weight = group.weight
 
        def __getattr__(self, attr):
-               return getattr(self._mvert, attr)
+               return getattr(self._group, attr)
 
 
 class Face:
-       def __init__(self, mf):
-               self._mface = mf
-               self.index = mf.index
+       def __init__(self, face):
+               self._face = face
+               self.index = face.index
                self.edges = []
-               self.vertices = mf.vertices[:]
+               self.vertices = face.vertices[:]
                self.uvs = []
                self.flag = False
 
        def __getattr__(self, attr):
-               return getattr(self._mface, attr)
+               return getattr(self._face, attr)
 
        def __cmp__(self, other):
                if other is None:
@@ -160,19 +160,24 @@ class UvLayer:
 
 
 class Mesh:
-       def __init__(self, m):
-               self._mesh = m
+       def __init__(self, mesh):
+               self._mesh = mesh
 
-               self.winding_test = m.winding_test
-               self.tbn_vecs = m.tbn_vecs
-               self.vertex_groups = m.vertex_groups
+               self.winding_test = mesh.winding_test
+               self.tbn_vecs = mesh.tbn_vecs
+               self.vertex_groups = mesh.vertex_groups
 
+               # Clone basic data
                self.vertices = [Vertex(v) for v in self.vertices]
+               for v in self.vertices:
+                       v.groups = [VertexGroup(g) for g in v.groups]
+
                self.faces = [Face(f) for f in self.polygons]
                self.edges = [Edge(e) for e in self.edges]
                self.loops = self.loops[:]
-
                self.materials = self.materials[:]
+
+               # Clone only the desired UV layers
                if self.use_uv=='NONE' or not self.uv_layers:
                        self.uv_layers = []
                else:
@@ -182,15 +187,15 @@ class Mesh:
                        if self.use_uv=='UNIT0':
                                self.uv_layers = [self.uv_layers[0]]
 
+                       # Assign texture unit numbers to UV layers that lack one
                        next_unit = max((u.unit+1 for u in self.uv_layers if u.unit is not None), default=0)
                        for u in self.uv_layers:
                                if not u.unit:
                                        u.unit = next_unit
                                        next_unit += 1
 
-               for v in self.vertices:
-                       v.groups = [VertexGroup(g) for g in v.groups]
-
+               # Rewrite links between elements to point to cloned data, or create links
+               # where they don't exist
                edge_map = {e.key: e for e in self.edges}
                for f in self.faces:
                        if len(f.vertices)>4:
@@ -210,6 +215,7 @@ class Mesh:
                        for v in e.vertices:
                                v.edges.append(e)
 
+               # Store loose edges as lines
                if self.use_lines:
                        self.lines = [Line(e) for e in self.edges if not e.faces]
                else:
@@ -229,6 +235,8 @@ class Mesh:
                        if u.name!=other.uv_layers[i].name:
                                raise ValueError("Meshes have incompatible UV layers")
 
+               # Merge materials and form a lookup from source material indices to the
+               # merged material list
                material_map = []
                for m in other.materials:
                        if m in self.materials:
@@ -237,6 +245,8 @@ class Mesh:
                                material_map.append(len(self.materials))
                                self.materials.append(m)
 
+               # Append data and adjust indices where necessary.  Since the data is
+               # spliced from the source mesh, rebuilding references is not necessary.
                for i, u in enumerate(self.uv_layers):
                        u.uvs += other.uv_layers[i].uvs
 
@@ -325,6 +335,8 @@ class Mesh:
                                for i in f.loop_indices:
                                        layer.uvs[i] = uv
 
+               # Form a list of UV layers referenced by materials with the array atlas
+               # property set
                array_uv_layers = [t.uv_layer for m in self.materials if m.array_atlas for t in m.texture_slots if t and t.texture_coords=='UV']
                array_uv_layers = [u for u in self.uv_layers if u.name in array_uv_layers]
 
@@ -340,6 +352,7 @@ class Mesh:
                                        for i in f.loop_indices:
                                                l.uvs[i] = mathutils.Vector((*l.uvs[i], layer))
 
+               # Copy UVs from layers to faces
                for f in self.faces:
                        for u in self.uv_layers:
                                f.uvs.append([u.uvs[i] for i in f.loop_indices])
@@ -347,6 +360,8 @@ class Mesh:
                prog_count = len(self.uv_layers)
                prog_step = 0
 
+               # Split by the UV layer used for TBN vectors first so connectivity
+               # remains intact for TBN vector computation
                tbn_layer_index = -1
                if self.tbn_vecs:
                        uv_names = [u.name for u in self.uv_layers]
@@ -360,6 +375,7 @@ class Mesh:
                                progress.pop_task()
                                prog_step = 2
 
+               # Split by the remaining UV layers
                for i, u in enumerate(self.uv_layers):
                        if i==tbn_layer_index:
                                continue
@@ -369,8 +385,10 @@ class Mesh:
                        progress.pop_task()
                        prog_step += 1
 
+               # Copy UVs from faces to vertices
                for v in self.vertices:
                        if v.faces:
+                               # All faces still connected to the vertex have the same UV value
                                f = v.faces[0]
                                i = f.vertices.index(v)
                                v.uvs = [u[i] for u in f.uvs]
@@ -384,11 +402,13 @@ class Mesh:
                        for f in v.faces:
                                f.flag = False
 
+                       # Find all groups of faces on this vertex
                        groups = []
                        for f in v.faces:
                                if not f.flag:
                                        groups.append(find_group_func(v, f, *args))
 
+                       # Give groups after the first separate copies of the vertex
                        for g in groups[1:]:
                                nv = Vertex(v)
                                nv.index = len(self.vertices)
@@ -400,6 +420,7 @@ class Mesh:
                                                continue
 
                                        if len(e_faces_in_g)<len(e.faces):
+                                               # Create a copy of an edge at the boundary of the group
                                                ne = Edge(e)
                                                ne.index = len(self.edges)
                                                self.edges.append(ne)
@@ -418,6 +439,7 @@ class Mesh:
 
                                        e.key = make_edge_key(e.vertices[0].index, e.vertices[1].index)
 
+                               # Filter out any edges that were removed from the original vertex
                                v.edges = [e for e in v.edges if v in e.vertices]
 
                                for f in g:
@@ -466,6 +488,9 @@ class Mesh:
                                edge1 = fv[1].co-fv[0].co
                                edge2 = fv[-1].co-fv[0].co
                                if edge1.length and edge2.length:
+                                       # Use the angle between edges as a weighting factor.  This gives
+                                       # more consistent normals on bends with an inequal number of
+                                       # faces on each side.
                                        v.normal += f.normal*edge1.angle(edge2)
 
                        if v.normal.length:
@@ -476,6 +501,8 @@ class Mesh:
                        progress.set_progress(i/len(self.vertices))
 
        def compute_tbn(self, index, progress):
+               # This function is called at an early stage during UV preparation when
+               # face UVs are not available yet
                layer_uvs = self.uv_layers[index].uvs
 
                for i, v in enumerate(self.vertices):
@@ -507,13 +534,13 @@ class Mesh:
 
        def drop_references(self):
                for v in self.vertices:
-                       v._mvert = None
+                       v._vertex = None
                        for g in v.groups:
-                               g._base = None
+                               g._group = None
                for e in self.edges:
-                       e._medge = None
+                       e._edge = None
                for f in self.faces:
-                       f._mface = None
+                       f._face = None
                for u in self.uv_layers:
                        u._layer = None
                self._mesh = None
@@ -609,6 +636,8 @@ def create_mesh_from_object(context, obj, progress):
        progress.set_task("Preparing UVs", 0.7, 1.0)
        mesh.prepare_uv(obj, progress)
 
+       # Discard the temporary Blender meshes after making sure there's no
+       # references to the data
        mesh.drop_references()
        for m in bmeshes:
                bpy.data.meshes.remove(m)