basic.py

# Copyright (C) 2021 Victor Soupday
# This file is part of CC/iC Blender Tools <https://github.com/soupday/cc_blender_tools>
#
# CC/iC Blender Tools 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.
#
# CC/iC Blender Tools 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 CC/iC Blender Tools.  If not, see <https://www.gnu.org/licenses/>.

import bpy
import os
from . import materials, nodeutils, imageutils, jsonutils, params, utils, vars


def reset_shader(nodes, links, shader_label, shader_name):
    bsdf_id = "(" + str(shader_name) + "_BSDF)"

    bsdf_node: bpy.types.Node = None
    output_node: bpy.types.Node = None

    links.clear()

    for n in nodes:

        if n.type == "BSDF_PRINCIPLED":

            if not bsdf_node:
                utils.log_info("Keeping old BSDF: " + n.name)
                bsdf_node = n
            else:
                nodes.remove(n)

        elif n.type == "OUTPUT_MATERIAL":

            if output_node:
                nodes.remove(n)
            else:
                output_node = n

        else:
            nodes.remove(n)

    if not bsdf_node:
        bsdf_node = nodes.new("ShaderNodeBsdfPrincipled")
        bsdf_node.name = utils.unique_name(bsdf_id)
        bsdf_node.label = shader_label
        bsdf_node.width = 240
        utils.log_info("Creating new BSDF: " + bsdf_node.name)

    if not output_node:
        output_node = nodes.new("ShaderNodeOutputMaterial")

    bsdf_node.location = (0,0)
    output_node.location = (400, 0)

    emission_socket = nodeutils.input_socket(bsdf_node, "Emission")
    nodeutils.set_node_input_value(bsdf_node, emission_socket, (0,0,0))
    if utils.B400():
        emission_strength_socket =  nodeutils.input_socket(bsdf_node, "Emission Strength")
        nodeutils.set_node_input_value(bsdf_node, emission_strength_socket, 0)

    # connect the shader to the output
    nodeutils.link_nodes(links, bsdf_node, "BSDF", output_node, "Surface")

    return bsdf_node


def connect_tearline_material(obj, mat, mat_json, processed_images):
    props = vars.props()
    chr_cache = props.get_character_cache(obj, mat)
    parameters = chr_cache.basic_parameters
    obj_cache = chr_cache.get_object_cache(obj)
    mat_cache = chr_cache.get_material_cache(mat)
    nodes = mat.node_tree.nodes
    links = mat.node_tree.links

    bsdf_node = reset_shader(nodes, links, "Tearline Shader", "basic_tearline")

    base_color_socket = nodeutils.input_socket(bsdf_node, "Base Color")
    metallic_socket = nodeutils.input_socket(bsdf_node, "Metallic")
    specular_socket = nodeutils.input_socket(bsdf_node, "Specular")
    roughness_socket = nodeutils.input_socket(bsdf_node, "Roughness")
    alpha_socket = nodeutils.input_socket(bsdf_node, "Alpha")

    nodeutils.set_node_input_value(bsdf_node, base_color_socket, (1.0, 1.0, 1.0, 1.0))
    nodeutils.set_node_input_value(bsdf_node, metallic_socket, 1.0)
    nodeutils.set_node_input_value(bsdf_node, specular_socket, 1.0)
    nodeutils.set_node_input_value(bsdf_node, roughness_socket, parameters.tearline_roughness)
    nodeutils.set_node_input_value(bsdf_node, alpha_socket, parameters.tearline_alpha)
    bsdf_node.name = utils.unique_name("eye_tearline_shader")

    materials.set_material_alpha(mat, "BLEND", shadows=False, refraction=True)


def connect_eye_occlusion_material(obj, mat, mat_json, processed_images):
    props = vars.props()
    chr_cache = props.get_character_cache(obj, mat)
    parameters = chr_cache.basic_parameters
    obj_cache = chr_cache.get_object_cache(obj)
    mat_cache = chr_cache.get_material_cache(mat)
    nodes = mat.node_tree.nodes
    links = mat.node_tree.links

    bsdf_node = reset_shader(nodes, links, "Eye Occlusion Shader", "basic_eye_occlusion")

    bsdf_node.name = utils.unique_name("eye_occlusion_shader")
    base_color_socket = nodeutils.input_socket(bsdf_node, "Base Color")
    metallic_socket = nodeutils.input_socket(bsdf_node, "Metallic")
    specular_socket = nodeutils.input_socket(bsdf_node, "Specular")
    roughness_socket = nodeutils.input_socket(bsdf_node, "Roughness")
    alpha_socket = nodeutils.input_socket(bsdf_node, "Alpha")

    nodeutils.set_node_input_value(bsdf_node, base_color_socket, (0,0,0,1))
    nodeutils.set_node_input_value(bsdf_node, metallic_socket, 0.0)
    nodeutils.set_node_input_value(bsdf_node, specular_socket, 0.0)
    nodeutils.set_node_input_value(bsdf_node, roughness_socket, 1.0)
    nodeutils.reset_cursor()

    # groups
    group = nodeutils.get_node_group("eye_occlusion_mask")
    occ_node = nodeutils.make_node_group_node(nodes, group, "Eye Occulsion Alpha", "eye_occlusion_mask")
    # values
    nodeutils.set_node_input_value(occ_node, "Strength", parameters.eye_occlusion)
    nodeutils.set_node_input_value(occ_node, "Hardness", parameters.eye_occlusion_power)
    # links
    nodeutils.link_nodes(links, occ_node, "Alpha", bsdf_node, alpha_socket)

    materials.set_material_alpha(mat, "BLEND", shadows=False)


def connect_basic_eye_material(obj, mat, mat_json, processed_images):
    props = vars.props()
    chr_cache = props.get_character_cache(obj, mat)
    parameters = chr_cache.basic_parameters
    obj_cache = chr_cache.get_object_cache(obj)
    mat_cache = chr_cache.get_material_cache(mat)
    nodes = mat.node_tree.nodes
    links = mat.node_tree.links

    bsdf_node = reset_shader(nodes, links, "Eye Shader", "basic_eye")
    base_color_socket = nodeutils.input_socket(bsdf_node, "Base Color")
    metallic_socket = nodeutils.input_socket(bsdf_node, "Metallic")
    specular_socket = nodeutils.input_socket(bsdf_node, "Specular")
    roughness_socket = nodeutils.input_socket(bsdf_node, "Roughness")
    alpha_socket = nodeutils.input_socket(bsdf_node, "Alpha")
    normal_socket = nodeutils.input_socket(bsdf_node, "Normal")
    clearcoat_socket = nodeutils.input_socket(bsdf_node, "Clearcoat")
    clearcoat_roughness_socket = nodeutils.input_socket(bsdf_node, "Clearcoat Roughness")

    # Base Color
    #
    nodeutils.reset_cursor()
    diffuse_image =  find_material_image_basic(mat, "DIFFUSE", mat_json, processed_images)
    if diffuse_image is not None:
        diffuse_node = nodeutils.make_image_node(nodes, diffuse_image, "(DIFFUSE)")
        nodeutils.advance_cursor(1.0)
        hsv_node = nodeutils.make_shader_node(nodes, "ShaderNodeHueSaturation", 0.6)
        hsv_node.label = "HSV"
        hsv_node.name = utils.unique_name("eye_basic_hsv")
        nodeutils.set_node_input_value(hsv_node, "Value", parameters.eye_brightness)
        # links
        nodeutils.link_nodes(links, diffuse_node, "Color", hsv_node, "Color")
        nodeutils.link_nodes(links, hsv_node, "Color", bsdf_node, base_color_socket)

    # Metallic
    #
    nodeutils.reset_cursor()
    metallic_node = nodeutils.make_value_node(nodes, "Eye Metallic", "eye_metallic", 0.0)
    nodeutils.link_nodes(links, metallic_node, "Value", bsdf_node, metallic_socket)

    # Specular
    #
    nodeutils.reset_cursor()
    specular_node = nodeutils.make_value_node(nodes, "Eye Specular", "eye_specular", parameters.eye_specular)
    nodeutils.link_nodes(links, specular_node, "Value", bsdf_node, specular_socket)

    # Roughness
    #
    nodeutils.reset_cursor()
    roughness_node = nodeutils.make_value_node(nodes, "Eye Roughness", "eye_roughness", parameters.eye_roughness)
    nodeutils.link_nodes(links, roughness_node, "Value", bsdf_node, roughness_socket)

    # Alpha
    #
    nodeutils.set_node_input_value(bsdf_node, alpha_socket, 1.0)

    # Normal
    #
    nodeutils.reset_cursor()
    normal_image = find_material_image_basic(mat, "SCLERANORMAL", mat_json, processed_images)
    if normal_image is not None:
        strength_node = nodeutils.make_value_node(nodes, "Normal Strength", "eye_normal", parameters.eye_normal)
        normal_node = nodeutils.make_image_node(nodes, normal_image, "(SCLERANORMAL)")
        nodeutils.advance_cursor()
        normalmap_node = nodeutils.make_shader_node(nodes, "ShaderNodeNormalMap", 0.6)
        nodeutils.link_nodes(links, strength_node, "Value", normalmap_node, "Strength")
        nodeutils.link_nodes(links, normal_node, "Color", normalmap_node, "Color")
        nodeutils.link_nodes(links, normalmap_node, "Normal", bsdf_node, normal_socket)

    # Clearcoat
    #
    nodeutils.set_node_input_value(bsdf_node, clearcoat_socket, 1.0)
    nodeutils.set_node_input_value(bsdf_node, clearcoat_roughness_socket, 0.15)
    materials.set_material_alpha(mat, "OPAQUE")

    return

def connect_basic_material(obj, mat, mat_json, processed_images):
    props = vars.props()
    chr_cache = props.get_character_cache(obj, mat)
    parameters = chr_cache.basic_parameters
    obj_cache = chr_cache.get_object_cache(obj)
    mat_cache = chr_cache.get_material_cache(mat)
    nodes = mat.node_tree.nodes
    links = mat.node_tree.links

    bsdf_node = reset_shader(nodes, links, "Basic Shader", "basic")
    base_color_socket = nodeutils.input_socket(bsdf_node, "Base Color")
    metallic_socket = nodeutils.input_socket(bsdf_node, "Metallic")
    specular_socket = nodeutils.input_socket(bsdf_node, "Specular")
    roughness_socket = nodeutils.input_socket(bsdf_node, "Roughness")
    alpha_socket = nodeutils.input_socket(bsdf_node, "Alpha")
    emission_socket = nodeutils.input_socket(bsdf_node, "Emission")
    emission_strength_socket = nodeutils.input_socket(bsdf_node, "Emission Strength")
    normal_socket = nodeutils.input_socket(bsdf_node, "Normal")
    sss_socket = nodeutils.input_socket(bsdf_node, "Subsurface")

    # Base Color
    #
    nodeutils.reset_cursor()
    diffuse_image = find_material_image_basic(mat, "DIFFUSE", mat_json, processed_images)
    ao_image = find_material_image_basic(mat, "AO", mat_json, processed_images)
    diffuse_node = ao_node = None
    if (diffuse_image is not None):
        diffuse_node = nodeutils.make_image_node(nodes, diffuse_image, "(DIFFUSE)")
        if ao_image is not None:

            if mat_cache.is_skin() or mat_cache.is_nails():
                prop = "skin_ao"
                ao_strength = parameters.skin_ao
            elif mat_cache.is_hair():
                prop = "hair_ao"
                ao_strength = parameters.hair_ao
            else:
                prop = "default_ao"
                ao_strength = parameters.default_ao

            fac_node = nodeutils.make_value_node(nodes, "Ambient Occlusion Strength", prop, ao_strength)
            ao_node = nodeutils.make_image_node(nodes, ao_image, "ao_tex")
            nodeutils.advance_cursor(1.5)
            nodeutils.drop_cursor(0.75)
            mix_node = nodeutils.make_mixrgb_node(nodes, "MULTIPLY")
            nodeutils.link_nodes(links, diffuse_node, "Color", mix_node, "Color1")
            nodeutils.link_nodes(links, ao_node, "Color", mix_node, "Color2")
            nodeutils.link_nodes(links, fac_node, "Value", mix_node, "Fac")
            nodeutils.link_nodes(links, mix_node, "Color", bsdf_node, base_color_socket)
        else:
            nodeutils.link_nodes(links, diffuse_node, "Color", bsdf_node, base_color_socket)

    # SSS
    #
    if mat_cache.is_skin():
        nodeutils.set_node_input_value(bsdf_node, sss_socket, 0.25)
    else:
        nodeutils.set_node_input_value(bsdf_node, sss_socket, 0)

    # Metallic
    #
    nodeutils.reset_cursor()
    metallic_image = find_material_image_basic(mat, "METALLIC", mat_json, processed_images)
    metallic_node = None
    if metallic_image is not None:
        metallic_node = nodeutils.make_image_node(nodes, metallic_image, "(METALLIC)")
        nodeutils.link_nodes(links, metallic_node, "Color", bsdf_node, metallic_socket)

    # Specular
    #
    nodeutils.reset_cursor()
    specular_image = find_material_image_basic(mat, "SPECULAR", mat_json, processed_images)
    mask_image = find_material_image_basic(mat, "SPECMASK", mat_json, processed_images)

    prop = "none"
    spec = 0.5
    if mat_cache.is_skin() or mat_cache.is_nails():
        prop = "skin_specular"
        spec = parameters.skin_specular
    elif mat_cache.is_hair():
        prop = "hair_specular"
        spec = parameters.hair_specular
    elif mat_cache.is_scalp() or mat_cache.is_eyelash():
        prop = "scalp_specular"
        spec = parameters.scalp_specular
    elif mat_cache.is_teeth():
        prop = "teeth_specular"
        spec = parameters.teeth_specular
    elif mat_cache.is_tongue():
        prop = "tongue_specular"
        spec = parameters.tongue_specular
    else:
        prop = "default_specular"
        spec = parameters.default_specular

    specular_node = mask_node = mult_node = None
    if specular_image is not None:
        specular_node = nodeutils.make_image_node(nodes, specular_image, "(SPECULAR)")
        nodeutils.link_nodes(links, specular_node, "Color", bsdf_node, specular_socket)
    # always make a specular value node for skin or if there is a mask (but no map)
    elif prop != "none":
        specular_node = nodeutils.make_value_node(nodes, "Specular Strength", prop, spec)
        nodeutils.link_nodes(links, specular_node, "Value", bsdf_node, specular_socket)
    if mask_image is not None:
        mask_node = nodeutils.make_image_node(nodes, mask_image, "(SPECMASK)")
        nodeutils.advance_cursor()
        mult_node = nodeutils.make_math_node(nodes, "MULTIPLY")
        if specular_node.type == "VALUE":
            nodeutils.link_nodes(links, specular_node, "Value", mult_node, 0)
        else:
            nodeutils.link_nodes(links, specular_node, "Color", mult_node, 0)
        nodeutils.link_nodes(links, mask_node, "Color", mult_node, 1)
        nodeutils.link_nodes(links, mult_node, "Value", bsdf_node, specular_socket)

    # Roughness
    #
    nodeutils.reset_cursor()
    roughness_image = find_material_image_basic(mat, "ROUGHNESS", mat_json, processed_images)
    roughness_node = None
    if roughness_image is not None:
        roughness_node = nodeutils.make_image_node(nodes, roughness_image, "(ROUGHNESS)")

        if mat_cache.is_skin():
            prop = "skin_roughness"
            roughness = parameters.skin_roughness
        elif mat_cache.is_teeth():
            prop = "teeth_roughness"
            roughness = parameters.teeth_roughness
        elif mat_cache.is_tongue():
            prop = "tongue_roughness"
            roughness = parameters.tongue_roughness
        else:
            prop = "none"
            roughness = 1

        if mat_cache.material_type.startswith("SKIN"):
            nodeutils.advance_cursor()
            remap_node = nodeutils.make_shader_node(nodes, "ShaderNodeMapRange")
            remap_node.name = utils.unique_name(prop)
            nodeutils.set_node_input_value(remap_node, "To Min", roughness)
            nodeutils.link_nodes(links, roughness_node, "Color", remap_node, "Value")
            nodeutils.link_nodes(links, remap_node, "Result", bsdf_node, roughness_socket)
        elif mat_cache.material_type.startswith("TEETH") or mat_cache.material_type == "TONGUE":
            nodeutils.advance_cursor()
            rmult_node = nodeutils.make_math_node(nodes, "MULTIPLY", 1, roughness)
            rmult_node.name = utils.unique_name(prop)
            nodeutils.link_nodes(links, roughness_node, "Color", rmult_node, 0)
            nodeutils.link_nodes(links, rmult_node, "Value", bsdf_node, roughness_socket)
        else:
            nodeutils.link_nodes(links, roughness_node, "Color", bsdf_node, roughness_socket)

    # Emission
    #
    nodeutils.reset_cursor()
    emission_image = find_material_image_basic(mat,"EMISSION", mat_json, processed_images)
    emission_node = None
    if emission_image is not None:
        emission_node = nodeutils.make_image_node(nodes, emission_image, "(EMISSION)")
        nodeutils.link_nodes(links, emission_node, "Color", bsdf_node, emission_socket)
        emission_strength = jsonutils.get_texture_channel_strength(mat_json, "Glow", 0.0)
        nodeutils.set_node_input_value(bsdf_node, emission_strength_socket, emission_strength)


    # Alpha
    #
    nodeutils.reset_cursor()
    alpha_image = find_material_image_basic(mat, "ALPHA", mat_json, processed_images)
    alpha_node = None
    if alpha_image is not None:
        alpha_node = nodeutils.make_image_node(nodes, alpha_image, "(ALPHA)")
        dir, file = os.path.split(alpha_image.filepath)
        if "_diffuse" in file.lower() or "_albedo" in file.lower():
            nodeutils.link_nodes(links, alpha_node, "Alpha", bsdf_node, alpha_socket)
        else:
            nodeutils.link_nodes(links, alpha_node, "Color", bsdf_node, alpha_socket)
    elif diffuse_node:
        nodeutils.link_nodes(links, diffuse_node, "Alpha", bsdf_node, alpha_socket)

    # material alpha blend settings
    method = materials.determine_material_alpha(obj_cache, mat_cache, mat_json)
    materials.set_material_alpha(mat, method)

    # Normal
    #
    nodeutils.reset_cursor()
    normal_strength = jsonutils.get_texture_channel_strength(mat_json, "Normal", 1.0)
    normal_image = find_material_image_basic(mat, "NORMAL", mat_json, processed_images)
    bump_image = find_material_image_basic(mat,"BUMP", mat_json, processed_images)
    normal_node = bump_node = normalmap_node = bumpmap_node = None
    if normal_image is not None:
        normal_node = nodeutils.make_image_node(nodes, normal_image, "(NORMAL)")
        nodeutils.advance_cursor()
        normalmap_node = nodeutils.make_shader_node(nodes, "ShaderNodeNormalMap", 0.6)
        nodeutils.link_nodes(links, normal_node, "Color", normalmap_node, "Color")
        nodeutils.link_nodes(links, normalmap_node, "Normal", bsdf_node, normal_socket)
        nodeutils.set_node_input_value(normalmap_node, "Strength", normal_strength)
    if bump_image is not None:

        if mat_cache.is_hair() or mat_cache.is_eyelash() or mat_cache.is_scalp():
            prop = "hair_bump"
            bump_strength = parameters.hair_bump
        else:
            prop = "default_bump"
            bump_strength = parameters.default_bump

        bump_strength_node = nodeutils.make_value_node(nodes, "Bump Strength", prop, bump_strength / 1000)
        bump_node = nodeutils.make_image_node(nodes, bump_image, "(BUMP)")
        nodeutils.advance_cursor()
        bumpmap_node = nodeutils.make_shader_node(nodes, "ShaderNodeBump", 0.7)
        nodeutils.advance_cursor()
        nodeutils.link_nodes(links, bump_strength_node, "Value", bumpmap_node, "Distance")
        nodeutils.link_nodes(links, bump_node, "Color", bumpmap_node, "Height")
        if normal_image is not None:
            nodeutils.link_nodes(links, normalmap_node, "Normal", bumpmap_node, "Normal")
        nodeutils.link_nodes(links, bumpmap_node, "Normal", bsdf_node, normal_socket)


def find_material_image_basic(mat, tex_type, mat_json, processed_images):
    json_id = imageutils.get_image_type_json_id(tex_type)
    tex_json = jsonutils.get_texture_info(mat_json, json_id)
    return imageutils.find_material_image(mat, tex_type, processed_images, tex_json, mat_json)


def update_basic_material(mat, mat_cache, prop):
    props = vars.props()
    chr_cache = props.get_character_cache(None, mat)
    parameters = chr_cache.basic_parameters
    scope = locals()

    if mat is not None and mat.node_tree is not None:

        nodes = mat.node_tree.nodes
        for node in nodes:

            for prop_info in params.BASIC_PROPS:

                prop_name = prop_info[3]
                prop_node = prop_info[2]
                if prop_node == "":
                    prop_node = prop_name

                if prop_node in node.name and (prop == "ALL" or prop == prop_name):
                    prop_dir = prop_info[0]
                    prop_socket = prop_info[1]

                    try:
                        if len(prop_info) > 5:
                            prop_eval = prop_info[5]
                        else:
                            prop_eval = "parameters." + prop_name

                        prop_value = eval(prop_eval, None, scope)

                        if prop_dir == "IN":
                            nodeutils.set_node_input_value(node, prop_socket, prop_value)
                        elif prop_dir == "OUT":
                            nodeutils.set_node_output_value(node, prop_socket, prop_value)
                    except Exception as e:
                        utils.log_error("update_basic_materials(): Unable to evaluate or set: " + prop_eval, e)


def init_basic_default(chr_cache):
    props = vars.props()
    parameters = chr_cache.basic_parameters

    for prop_info in params.BASIC_PROPS:

        prop_name = prop_info[3]
        prop_default = prop_info[4]

        try:
            prop_eval = "parameters." + prop_name + " = " + str(prop_default)
            exec(prop_eval, None, locals())

        except Exception as e:
            utils.log_error("init_basic_default(): Unable to set: " + prop_eval, e)

    if chr_cache.is_actor_core():
        chr_cache.basic_parameters.default_ao = 0.2
        chr_cache.basic_parameters.default_specular = 0.2