Merge pull request #70 from einarf/missing-mat-attrs

Missing material properties + tests

Author: Kurt Yoder

.gitignore

@@ -1,12 +1,21 @@
-.DS_Store
+
+# build
+*.egg-info
+dist
 *.pyc
 *.pyo
 build
 MANIFEST
-dist
 *.swp
-.idea
-*.egg-info
+
+# virtualenvs
 .venv
 .venv2
 .venv3
+
+# IDEs
+.idea
+.vscode
+
+# osx
+.DS_Store

pywavefront/material.py

@@ -52,8 +52,30 @@ def __init__(self, name, is_default=False):
         self.ambient = [.2, .2, .2, 1.]
         self.specular = [0., 0., 0., 1.]
         self.emissive = [0., 0., 0., 1.]
+        self.transparency = 1.0
         self.shininess = 0.
-        self.texture = None
+        self.optical_density = 1.0
+        # Multiple illumination models are available, per material. These are enumerated as follows: 
+        # 0. Color on and Ambient off
+        # 1. Color on and Ambient on
+        # 2. Highlight on
+        # 3. Reflection on and Ray trace on
+        # 4. Transparency: Glass on, Reflection: Ray trace on
+        # 5. Reflection: Fresnel on and Ray trace on
+        # 6. Transparency: Refraction on, Reflection: Fresnel off and Ray trace on
+        # 7. Transparency: Refraction on, Reflection: Fresnel on and Ray trace on
+        # 8. Reflection on and Ray trace off
+        # 9. Transparency: Glass on, Reflection: Ray trace off
+        # 10. Casts shadows onto invisible surfaces
+        self.illumination_model = 0
+
+        self.texture = None  # diffuse
+        self.texture_ambient = None
+        self.texture_specular_color = None
+        self.texture_specular_highlight = None
+        self.texture_alpha = None
+        self.texture_bump = None
+
         self.is_default = is_default
 
         # Interleaved array of floats in GL_T2F_N3F_V3F format
@@ -62,11 +84,6 @@ def __init__(self, name, is_default=False):
 
         self.gl_floats = None
 
-    @property
-    def file(self):
-        """File with full path"""
-        return os.path.join(self.path, self.name)
-
     @property
     def has_normals(self):
         return "N3F" in self.vertex_format
@@ -95,7 +112,7 @@ def pad_light(self, values):
 
     def set_alpha(self, alpha):
         """Set alpha/last value on all four lighting attributes."""
-        alpha = float(alpha)
+        self.transparency = alpha
         self.diffuse[3] = alpha
         self.ambient[3] = alpha
         self.specular[3] = alpha
@@ -116,6 +133,21 @@ def set_emissive(self, values=None):
     def set_texture(self, path):
         self.texture = Texture(path)
 
+    def set_texture_ambient(self, path):
+        self.texture_ambient = Texture(path)
+
+    def set_texture_specular_color(self, path):
+        self.texture_specular_color = Texture(path)
+
+    def set_texture_specular_highlight(self, path):
+        self.texture_specular_highlight = Texture(path)
+
+    def set_texture_alpha(self, path):
+        self.texture_alpha = Texture(path)
+
+    def set_texture_bump(self, path):
+        self.texture_bump = Texture(path)
+
     def unset_texture(self):
         self.texture = None
 
@@ -166,24 +198,57 @@ def parse_Ns(self):
 
     @auto_consume
     def parse_d(self):
-        self.this_material.set_alpha(self.values[1])
+        """Transparency"""
+        self.this_material.set_alpha(float(self.values[1]))
+
+    @auto_consume
+    def parse_Tr(self):
+        """Transparency (alternative)"""
+        self.this_material.set_alpha(1.0 - float(self.values[1]))
 
     @auto_consume
     def parse_map_Kd(self):
+        """Diffuse map"""
         Kd = os.path.join(self.dir, " ".join(self.values[1:]))
         self.this_material.set_texture(Kd)
 
     @auto_consume
-    def parse_Ni(self):
-        # unimplemented
-        pass
+    def parse_map_Ka(self):
+        """Ambient map"""
+        Kd = os.path.join(self.dir, " ".join(self.values[1:]))
+        self.this_material.set_texture_ambient(Kd)
 
     @auto_consume
-    def parse_Tr(self):
-        # unimplemented
-        pass
+    def parse_map_Ks(self):
+        """Specular color map"""
+        Kd = os.path.join(self.dir, " ".join(self.values[1:]))
+        self.this_material.set_texture_specular_color(Kd)
+
+    @auto_consume
+    def parse_map_Ns(self):
+        """Specular color map"""
+        Kd = os.path.join(self.dir, " ".join(self.values[1:]))
+        self.this_material.set_texture_specular_highlight(Kd)
+
+    @auto_consume
+    def parse_map_d(self):
+        """Alpha map"""
+        Kd = os.path.join(self.dir, " ".join(self.values[1:]))
+        self.this_material.set_texture_alpha(Kd)
+
+    @auto_consume
+    def parse_map_bump(self):
+        """Bump map"""
+        Kd = os.path.join(self.dir, " ".join(self.values[1:]))
+        self.this_material.set_texture_bump(Kd)
+
+    def parse_bump(self):
+        self.parse_map_bump()
+
+    @auto_consume
+    def parse_Ni(self):
+        self.this_material.optical_density = float(self.values[1])
 
     @auto_consume
     def parse_illum(self):
-        # unimplemented
-        pass
+        self.this_material.illumination_model = float(self.values[1])

pywavefront/visualization.py

@@ -87,8 +87,10 @@ def draw_material(material, face=GL_FRONT_AND_BACK):
     glEnable(GL_CULL_FACE)
     glCullFace(GL_BACK)
 
-    if material.texture and material.has_uvs:
-        bind_texture(material.texture)
+    # Fall back to ambient texture if no diffuse
+    texture = material.texture or material.texture_ambient
+    if texture and material.has_uvs:
+        bind_texture(texture)
     else:
         glDisable(GL_TEXTURE_2D)
 

test/simple_parsetest.mtl

@@ -0,0 +1,24 @@
+# Comment
+newmtl Material.simple
+Ns 1.0
+Ka 0.0 0.0 0.0
+Kd 0.1 0.1 0.1
+Ks 0.2 0.2 0.2
+d 1.0
+Tr 0.0
+illum 2
+Ni 0.75
+map_Kd kd.png
+map_Ka ka.png
+map_Ks ks.png
+map_Ns ns.png
+map_d d.png
+map_bump bump.png
+bump bump.png
+newmtl Material2.simple
+Ns 1.0
+Ka 0.0 0.0 0.0
+Kd 0.64 0.64 0.64
+Ks 0.5 0.5 0.5
+d 1.0
+map_Kd 4x4.png

test/test_material.py

@@ -13,11 +13,17 @@ def setUp(self):
         # Append current path to locate files
         self.material = pywavefront.material.Material(prepend_dir('material'))
         self.material.set_texture(prepend_dir('4x4.png'))
+        self.material.set_texture_ambient(prepend_dir('4x4.png'))
 
     def testSetTexture(self):
         """Running set_texture should set a texture."""
         self.assertEqual(self.material.texture.__class__,
-                pywavefront.texture.Texture)
+                         pywavefront.texture.Texture)
+        self.assertEqual(self.material.texture_ambient.__class__,
+                         pywavefront.texture.Texture)
+
+        self.assertEqual(self.material.texture.path, prepend_dir('4x4.png'))
+        self.assertEqual(self.material.texture_ambient.path, prepend_dir('4x4.png'))
 
     def testUnsetTexture(self):
         """Running unset_texture should set texture to None."""
@@ -57,6 +63,9 @@ def testSetEmissive(self):
         self.material.set_emissive()
         self.assertEqual(self.material.emissive, [0., 0., 0., 0.])
 
+    def testTransparency(self):
+        self.assertEqual(self.material.transparency, 1.0)
+
 
 class TestInvalidMaterial(unittest.TestCase):
 

test/test_parser.py

@@ -3,7 +3,7 @@
 
 import pywavefront.parser
 from pywavefront.exceptions import PywavefrontException
-
+from pywavefront.material import MaterialParser
 
 def prepend_dir(file):
     return os.path.join(os.path.dirname(__file__), file)
@@ -151,15 +151,15 @@ def testObjColors(self):
 
 class TestMtlParser(unittest.TestCase):
     def setUp(self):
-        # Append current path to locate files
-        meshes = pywavefront.Wavefront(prepend_dir('simple.obj'))
-        self.material1 = meshes.mesh_list[0].materials[0]
-        self.material2 = meshes.mesh_list[1].materials[0]
+        parser = MaterialParser(prepend_dir('simple_parsetest.mtl'))
+        self.materials = parser.materials
+        self.material1 = self.materials['Material.simple']
+        self.material2 = self.materials['Material2.simple']
 
     def testMtlName(self):
         """Parsing an obj file with known material names should set those names."""
-        self.assertEqual(self.material1.name, 'Material.simple')
-        self.assertEqual(self.material2.name, 'Material2.simple')
+        self.assertIn('Material.simple', self.materials.keys())
+        self.assertIn('Material2.simple', self.materials.keys())
 
     def testMtlShininess(self):
         """Parsing an obj file with known material shininess should set it."""
@@ -180,11 +180,22 @@ def testMtlSpecular(self):
         # also tests d
         self.assertEqual(self.material1.specular, [0.2, 0.2, 0.2, 1.])
 
-    def testMtlTextureName(self):
-        """Parsing an obj file with known material texture should set its name."""
-        # also tests d
-        self.assertEqual(self.material1.texture.path,
-                         prepend_dir('4x4.png'))
+    def testMtlTransparency(self):
+        self.assertEqual(self.material1.transparency, 1.0)
+
+    def testMtlIllum(self):
+        self.assertEqual(self.material1.illumination_model, 2)
+
+    def testMtlNi(self):
+        self.assertEqual(self.material1.optical_density, 0.75)
+
+    def testTextures(self):
+        self.assertEqual(self.material1.texture.path, prepend_dir('kd.png'))
+        self.assertEqual(self.material1.texture_ambient.path, prepend_dir('ka.png'))
+        self.assertEqual(self.material1.texture_specular_color.path, prepend_dir('ks.png'))
+        self.assertEqual(self.material1.texture_specular_highlight.path, prepend_dir('ns.png'))
+        self.assertEqual(self.material1.texture_alpha.path, prepend_dir('d.png'))
+        self.assertEqual(self.material1.texture_bump.path, prepend_dir('bump.png'))
 
 
 class TestParserFailure(unittest.TestCase):