texture_mapper.py

# Copyright (C) 2019 h0bB1T
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
#
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA

import os

class TextureMapper:
    """
    Automatically map different types of textures based on the ending of the core file name.
    /path/to/file/xxxEXT.jpg/png
    Below the known extensions, feel free to add more.
    """
    diffuse_ext = "basecolor,base_color,diffuse,diff,albedo,color,col".split(",")
    spec_ext = "specular,spec,spc".split(",")
    rough_ext = "roughness,rough,rgh".split(",")
    gloss_ext = "gloss,gls".split(",")
    normal_ext = "normal,norm,nor,nrm".split(",")
    metal_ext = "metallic,metal,met".split(",")
    height_ext = "height,hgt".split(",")


    def endsWithAny(self, name, exts):
        """
        Check if name ends with any of the exts given.
        """
        name = name.lower()
        for e in exts:
            if name.endswith(e):
                return True
        return False


    def parseTextures(self, path, baseName):
        """
        Find textures that match the basename prefix and map based on the extension.
        """
        # print("Parse '%s' for '%s'" % (path, baseName))
        self.baseName = baseName.strip("_")
        for f in os.listdir(path):
            fullName = os.path.join(path, f)
            name = os.path.split(f)[1]
            if name.startswith(baseName):
                bName = os.path.splitext(name)[0]
                if (self.endsWithAny(bName, self.diffuse_ext)):
                    self.diffuse = fullName
                elif (self.endsWithAny(bName, self.spec_ext)):
                    self.specular = fullName
                elif (self.endsWithAny(bName, self.rough_ext)):
                    self.roughness = fullName
                elif (self.endsWithAny(bName, self.gloss_ext)):
                    self.gloss = fullName
                elif (self.endsWithAny(bName, self.normal_ext)):
                    self.normal = fullName
                elif (self.endsWithAny(bName, self.metal_ext)):
                    self.metal = fullName
                elif (self.endsWithAny(bName, self.height_ext)):
                    self.height = fullName

        self.valid = self.diffuse != None


    def __init__(self, image):
        """
        CTor, create mapping from any selected texture (independent to ext).
        """
        # Default values.
        self.valid = False
        self.diffuse = self.specular = self.roughness = self.gloss = self.normal = self.metal = self.height = None

        # Prepare search.
        path, name = os.path.split(image)
        baseName = os.path.splitext(name)[0]
        allExt = self.diffuse_ext + self.spec_ext + self.rough_ext + self.gloss_ext + self.normal_ext + self.metal_ext + self.height_ext

        # Check if selected texture matches at least any of the valid extensions.
        for ext in allExt:
            if baseName.lower().endswith(ext):
                self.parseTextures(path, baseName[0:-len(ext)])
                break