blender/io_mspgl/material.py

   1 import os
   2
   3 def compute_render_method_hash(material):
   4         descr = ""
   5         for m in material.render_methods:
   6                 if descr:
   7                         descr += ","
   8                 descr += "{}={}".format(m.tag, m.shader)
   9         return hash(descr)
  10
  11 class PropertyNode:
  12         def __init__(self, node_tree, node, socket):
  13                 self.node_tree = node_tree
  14                 self.node = node
  15                 self.socket = socket
  16                 self.type = None
  17                 self.data = None
  18                 self.input = None
  19
  20                 checks = [self.check_group,
  21                         self.check_scale,
  22                         self.check_gray,
  23                         self.check_extract,
  24                         self.check_normal,
  25                         self.check_invert_channels,
  26                         self.check_additive_blend,
  27                         self.check_texture]
  28                 for c in checks:
  29                         if c():
  30                                 break
  31
  32         def set_input_from_linked(self, input_sock):
  33                 from .util import get_linked_node_and_socket
  34
  35                 from_node, from_sock = get_linked_node_and_socket(self.node_tree, input_sock)
  36                 self.input = PropertyNode(self.node_tree, from_node, from_sock)
  37                 return self.input
  38
  39         def check_group(self):
  40                 if self.node.type!='GROUP':
  41                         return
  42
  43                 from .util import get_linked_node_and_socket
  44
  45                 output = self.node.node_tree.nodes["Group Output"]
  46                 from_node, from_sock = get_linked_node_and_socket(self.node.node_tree, output.inputs[0])
  47                 inner = PropertyNode(self.node.node_tree, from_node, from_sock)
  48                 if inner.input:
  49                         # TODO This currently only supports a single operation inside the group
  50                         if inner.input.node.type=='GROUP_INPUT':
  51                                 self.type = inner.type
  52                                 self.data = inner.data
  53                                 return self.set_input_from_linked(self.node.inputs[0])
  54
  55         def check_scale(self):
  56                 if self.node.type!='MATH':
  57                         return
  58
  59                 if self.node.operation=='MULTIPLY':
  60                         for i in range(2):
  61                                 if not self.node.inputs[i].is_linked:
  62                                         self.type = 'SCALE'
  63                                         self.data = self.node.inputs[i].default_value
  64                                         return self.set_input_from_linked(self.node.inputs[1-i])
  65
  66         def check_gray(self):
  67                 if self.node.type=='RGBTOBW':
  68                         self.type = 'GRAY'
  69                         self.set_input_from_linked(self.node.inputs["Color"])
  70
  71         def check_extract(self):
  72                 if self.node.type=='SEPRGB':
  73                         self.type = 'EXTRACT'
  74                         self.data = self.socket.name[0]
  75                         return self.set_input_from_linked(self.node.inputs["Image"])
  76
  77         def check_normal(self):
  78                 if self.node.type=='NORMAL_MAP':
  79                         self.type = 'NORMAL'
  80                         return self.set_input_from_linked(self.node.inputs["Color"])
  81
  82         def check_invert_channels(self):
  83                 if self.node.type!='COMBRGB':
  84                         return
  85
  86                 from .util import get_linked_node_and_socket
  87
  88                 separate = None
  89                 invert_channels = ""
  90                 for c in ("R", "G", "B"):
  91                         from_node, _ = get_linked_node_and_socket(self.node_tree, self.node.inputs[c])
  92                         if from_node.type=='MATH' and from_node.operation=='SUBTRACT' and not from_node.inputs[0].is_linked and from_node.inputs[0].default_value==1.0:
  93                                 invert_channels += c
  94                                 from_node, _ = get_linked_node_and_socket(self.node_tree, from_node.inputs[1])
  95
  96                         if from_node.type=='SEPRGB' and (separate is None or from_node==separate):
  97                                 separate = from_node
  98                         else:
  99                                 return
 100
 101                 self.type = 'INVERT'
 102                 self.data = invert_channels
 103
 104                 return self.set_input_from_linked(separate.inputs["Image"])
 105
 106         def check_additive_blend(self):
 107                 if self.node.type=='ADD_SHADER':
 108                         from .util import get_linked_node_and_socket
 109
 110                         for i in range(2):
 111                                 shader, _ = get_linked_node_and_socket(self.node_tree, self.node.inputs[i])
 112                                 if shader.type=='BSDF_TRANSPARENT':
 113                                         self.type = 'ADDITIVE'
 114                                         return self.set_input_from_linked(self.node.inputs[1-i])
 115
 116         def check_texture(self):
 117                 if self.node.type=='TEX_IMAGE':
 118                         self.type = 'TEXTURE'
 119
 120 def get_unlit_inputs(node_tree, node, additive):
 121         from .util import get_linked_node_and_socket
 122
 123         if node.type=='MIX_SHADER' and not additive:
 124                 shader1, _ = get_linked_node_and_socket(node_tree, node.inputs[1])
 125                 shader2, _ = get_linked_node_and_socket(node_tree, node.inputs[2])
 126                 if shader1.type=='BSDF_TRANSPARENT' and shader2.type=='EMISSION':
 127                         factor_input = node.inputs["Fac"]
 128                         factor_from, _ = get_linked_node_and_socket(node_tree, factor_input)
 129                         color_input = shader2.inputs["Color"]
 130                         color_from, _ = get_linked_node_and_socket(node_tree, color_input)
 131                         if factor_from==color_from:
 132                                 return (color_input, factor_input)
 133         elif node.type=='EMISSION':
 134                 color_input = node.inputs["Color"]
 135                 if additive:
 136                         color_from, _ = get_linked_node_and_socket(node_tree, color_input)
 137                         if color_from.type=='MIX_RGB' and color_from.blend_type=='MIX':
 138                                 mix_factor_input = color_from.inputs["Fac"]
 139                                 mix_factor_from, _ = get_linked_node_and_socket(node_tree, mix_factor_input)
 140                                 mix_color_input = color_from.inputs["Color2"]
 141                                 mix_color_from, _ = get_linked_node_and_socket(node_tree, mix_color_input)
 142                                 if mix_factor_from==mix_color_from:
 143                                         return (mix_color_input, mix_factor_input)
 144                 return (color_input, None)
 145         return (None, None)
 146
 147 class MaterialProperty:
 148         def __init__(self, keyword, tex_keyword, value):
 149                 self.keyword = keyword
 150                 self.tex_keyword = tex_keyword
 151                 self.value = value
 152                 self.texture = None
 153                 self.tex_channels = None
 154                 self.scale = 1.0
 155
 156         def set_from_input(self, node_tree, input_socket, alpha_socket=None):
 157                 if self.keyword:
 158                         if type(self.value)==tuple:
 159                                 if alpha_socket:
 160                                         self.value = input_socket.default_value[:len(self.value)-1]+(alpha_socket.default_value,)
 161                                 else:
 162                                         self.value = input_socket.default_value[:len(self.value)]
 163                         else:
 164                                 self.value = input_socket.default_value
 165
 166                 if self.tex_keyword:
 167                         from .util import get_linked_node_and_socket
 168
 169                         from_node, from_sock = get_linked_node_and_socket(node_tree, input_socket)
 170                         alpha_from = None
 171                         if from_node:
 172                                 channels = None
 173                                 top_node = PropertyNode(node_tree, from_node, from_sock)
 174                                 n = top_node
 175                                 while n:
 176                                         if n.type=='NORMAL':
 177                                                 channels = ['R', 'G', 'B']
 178                                         elif n.type=='GRAY':
 179                                                 channels = ['Y']
 180                                         elif n.type=='EXTRACT':
 181                                                 channels = [n.data]
 182                                         elif n.type=='INVERT':
 183                                                 channels = ['~'+c if c in n.data else c for c in channels]
 184                                         elif n.type=='SCALE':
 185                                                 self.scale = n.data
 186                                         elif n.type=='TEXTURE':
 187                                                 self.texture = n.node
 188                                         n = n.input
 189
 190                                 if alpha_socket:
 191                                         alpha_from, _ = get_linked_node_and_socket(node_tree, alpha_socket)
 192                                         if alpha_from and alpha_from!=self.texture:
 193                                                 raise Exception("Separate textures for color and alpha are not supported")
 194
 195                                 if self.scale==0.0 and self.keyword and type(self.value)!=tuple:
 196                                         self.texture = None
 197                                         self.value = self.scale
 198                                 elif self.scale!=1.0:
 199                                         raise Exception("Unsupported material property scale {}".format(self.scale))
 200                                 elif self.texture:
 201                                         if channels:
 202                                                 self.tex_channels = channels
 203                                         elif alpha_from:
 204                                                 self.tex_channels = ['R', 'G', 'B', 'A']
 205                                         elif type(self.value)==tuple:
 206                                                 self.tex_channels = ['R', 'G', 'B']
 207                                         else:
 208                                                 self.tex_channels = ['Y']
 209                                 else:
 210                                         raise Exception("Unsupported property input node type "+from_node.type)
 211
 212 class Material:
 213         def __init__(self, material):
 214                 self.name = material.name
 215                 self.type = None
 216                 self.properties = []
 217
 218                 self.render_mode = material.render_mode
 219                 self.technique = material.technique
 220                 self.render_methods = material.render_methods[:]
 221                 self.uniforms = material.uniforms[:]
 222                 self.receive_shadows = material.receive_shadows
 223                 self.cast_shadows = (material.shadow_method!='NONE')
 224                 self.blend_type = 'ALPHA' if material.blend_method=='BLEND' else 'NONE'
 225                 self.alpha_cutoff = material.alpha_threshold if material.blend_method=='CLIP' else 0.0
 226                 self.image_based_lighting = material.image_based_lighting
 227
 228                 if self.render_mode=='EXTERNAL' and not self.technique:
 229                         raise Exception("Invalid configuration on material {}: No technique for external rendering".format(self.name))
 230                 elif self.render_mode=='CUSTOM' and not self.render_methods:
 231                         raise Exception("Invalid configuration on material {}: No render methods for custom rendering".format(self.name))
 232
 233                 out_node = next((n for n in material.node_tree.nodes if n.type=='OUTPUT_MATERIAL'), None)
 234                 if not out_node:
 235                         raise Exception("No output node found on material {}".format(self.name))
 236
 237                 from .util import get_linked_node_and_socket
 238
 239                 from_node, from_sock = get_linked_node_and_socket(material.node_tree, out_node.inputs["Surface"])
 240                 if not from_node:
 241                         if self.render_mode=='BUILTIN':
 242                                 raise Exception("Invalid configuration on material {}: Empty material with builtin rendering".format(self.name))
 243                         return
 244
 245                 surface_node = PropertyNode(material.node_tree, from_node, from_sock)
 246                 if surface_node.type=='ADDITIVE':
 247                         self.blend_type = 'ADDITIVE'
 248                         from_node = surface_node.input.node
 249
 250                 if from_node.type=='BSDF_PRINCIPLED':
 251                         self.type = "pbr"
 252
 253                         base_color = self.create_property("base_color", (0.8, 0.8, 0.8, 1.0))
 254                         metalness = self.create_property("metalness", 0.0)
 255                         roughness = self.create_property("roughness", 0.5)
 256                         normal = self.create_property("normal_map")
 257                         emission = self.create_property("emission", (0.0, 0.0, 0.0))
 258
 259                         base_color.set_from_input(material.node_tree, from_node.inputs["Base Color"], from_node.inputs["Alpha"])
 260                         metalness.set_from_input(material.node_tree, from_node.inputs["Metallic"])
 261                         roughness.set_from_input(material.node_tree, from_node.inputs["Roughness"])
 262                         normal.set_from_input(material.node_tree, from_node.inputs["Normal"])
 263                         emission.set_from_input(material.node_tree, from_node.inputs["Emission"])
 264                 elif from_node.type=='EMISSION' or from_node.type=='MIX_SHADER':
 265                         color_input, alpha_input = get_unlit_inputs(material.node_tree, from_node, self.blend_type=='ADDITIVE')
 266                         if not color_input:
 267                                 raise Exception("Unsupported configuration for unlit material {}".format(self.name))
 268
 269                         self.type = "unlit"
 270
 271                         color = self.create_property("color", "texture", (1.0, 1.0, 1.0, 1.0))
 272
 273                         color.set_from_input(material.node_tree, color_input, alpha_input)
 274                         if self.blend_type=='ADDITIVE' and alpha_input:
 275                                 self.blend_type = 'ADDITIVE_ALPHA'
 276                 else:
 277                         raise Exception("Unsupported surface node type {} on material {}".format(from_node.type, self.name))
 278
 279                 sampler_settings = None
 280                 for p in self.properties:
 281                         if p.texture:
 282                                 settings = (p.texture.interpolation, p.texture.use_mipmap, p.texture.max_anisotropy)
 283                                 if sampler_settings is None:
 284                                         sampler_settings = settings
 285                                 elif settings!=sampler_settings:
 286                                         raise Exception("Material {} has conflicting texture sampler settings".format(self.name))
 287
 288         def create_property(self, *args):
 289                 prop = None
 290                 if len(args)==1:
 291                         prop = MaterialProperty(None, args[0], None)
 292                 elif len(args)==2:
 293                         prop = MaterialProperty(args[0], args[0]+"_map", args[1])
 294                 else:
 295                         prop = MaterialProperty(*args)
 296                 self.properties.append(prop)
 297                 return prop
 298
 299
 300 class MaterialAtlas:
 301         def __init__(self, materials):
 302                 self.render_mode = materials[0].render_mode
 303                 if self.render_mode=='EXTERNAL':
 304                         raise Exception("Material atlas with external render mode does not make sense")
 305
 306                 if self.render_mode=='CUSTOM':
 307                         self.render_methods = materials[0].render_methods
 308                 else:
 309                         self.render_methods = None
 310                 if self.render_methods:
 311                         self.name = "material_atlas_"+os.path.splitext(self.render_methods[0].shader)[0]
 312                 else:
 313                         self.name = "material_atlas"
 314                 self.receive_shadows = materials[0].receive_shadows
 315                 self.cast_shadows = (materials[0].shadow_method!='NONE')
 316                 self.materials = materials
 317                 self.material_names = [m.name for m in self.materials]
 318                 self.uniforms = None
 319                 method_hash = compute_render_method_hash(self)
 320                 for m in self.materials:
 321                         if m.render_mode!=self.render_mode:
 322                                 raise Exception("Conflicting render modes in MaterialAtlas constructor")
 323                         if self.render_mode=='CUSTOM' and compute_render_method_hash(m)!=method_hash:
 324                                 raise Exception("Conflicting shaders in MaterialAtlas constructor")
 325                         if m.receive_shadows!=self.receive_shadows or m.shadow_method!=materials[0].shadow_method:
 326                                 raise Exception("Conflicting shadow settings in MaterialAtlas constructor")
 327
 328                 count = len(self.materials)
 329                 size = 1
 330                 while size*size*2<count:
 331                         size *= 2
 332                 if size*size>=count:
 333                         self.size = (size, size)
 334                 else:
 335                         self.size = (size*2, size)
 336
 337                 from .util import get_colormap
 338
 339                 cm = get_colormap(True)
 340                 self.base_color_data = ""
 341                 for m in map(Material, self.materials):
 342                         if any(p.texture for p in m.properties):
 343                                 raise Exception("Texturing is incompatible with material atlas")
 344                         base_color = [int(cm(c)*255) for c in m.base_color.value]
 345                         self.base_color_data += "\\x{:02X}\\x{:02X}\\x{:02X}\\xFF".format(*base_color)
 346                 self.base_color_data += "\\x00\\x00\\x00\\x00"*(self.size[0]*self.size[1]-count)
 347
 348         def get_material_uv(self, material):
 349                 index = self.material_names.index(material.name)
 350                 x = index%self.size[0]
 351                 y = index//self.size[0]
 352                 return ((x+0.5)/self.size[0], (y+0.5)/self.size[1])
 353
 354 def create_material_atlas(context, material):
 355         if not material.material_atlas:
 356                 raise Exception("Material is not part of a material atlas")
 357
 358         method_hash = compute_render_method_hash(material)
 359         materials = []
 360         for m in context.blend_data.materials:
 361                 if m.material_atlas and compute_render_method_hash(m)==method_hash:
 362                         materials.append(m)
 363
 364         return MaterialAtlas(materials)