matalogue.py

# BEGIN GPL LICENSE BLOCK #####
#
#  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 2
#  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.
#
# END GPL LICENSE BLOCK #####

bl_info = {
    "name": "Matalogue",
    "description": " Catalogue of node trees in the sidebar to switch between quickly",
    "author": "Greg Zaal",
    "version": (1, 4),
    "blender": (4, 0, 0),
    "location": "Node Editor > Sidebar (N) > Trees",
    "warning": "",
    "wiki_url": "https://github.com/gregzaal/Matalogue",
    "tracker_url": "https://github.com/gregzaal/Matalogue/issues",
    "category": "Node",
}

import bpy


class MatalogueSettings(bpy.types.PropertyGroup):
    mat_selected_only: bpy.props.BoolProperty(
        name="Selected Objects Only", default=False, description="Only show materials used by objects that are selected"
    )
    mat_visible_only: bpy.props.BoolProperty(
        name="Visible Collections Only",
        default=False,
        description="Only show materials used by objects that are visible in the current scene.",
    )

    light_visible_only: bpy.props.BoolProperty(
        name="Visible Collections Only",
        default=False,
        description="Only show lights that are visible in the current scene.",
    )

    geo_selected_only: bpy.props.BoolProperty(
        name="Selected Objects Only",
        default=False,
        description="Only show geometry node trees used by objects that are selected",
    )
    geo_visible_only: bpy.props.BoolProperty(
        name="Visible Only",
        default=False,
        description="Only show geometry node trees used by objects that are visible in the current scene",
    )


#####################################################################
# Functions
#####################################################################


def dummy_object(delete=False):
    """Return the existing dummy object, or create one if it doesn't exist."""
    scene = bpy.context.scene

    if delete:
        for obj in scene.objects:
            if "Matalogue Dummy Object" in obj.name:
                scene.collection.objects.unlink(obj)
        return "DONE"

    dummy = None
    previous_dummy = [obj for obj in bpy.data.objects if obj.name == "Matalogue Dummy Object"]
    if previous_dummy:
        dummy = previous_dummy[0]
    else:
        m = bpy.data.meshes.new("Matalogue Dummy Mesh")
        dummy = bpy.data.objects.new("Matalogue Dummy Object", m)

    if dummy not in list(obj for obj in scene.objects):
        scene.collection.objects.link(dummy)

    dummy.select_set(True)
    bpy.context.view_layer.objects.active = dummy

    if len(dummy.material_slots) == 0:
        bpy.ops.object.material_slot_add()

    return dummy


#####################################################################
# Operators
#####################################################################


class MATALOGUE_OT_go_to_material(bpy.types.Operator):
    "Show the nodes for this material"
    bl_idname = "matalogue.goto_mat"
    bl_label = "Go To Material"

    mat: bpy.props.StringProperty(default="")

    def execute(self, context):
        dummy_object(delete=True)
        context.space_data.tree_type = "ShaderNodeTree"
        context.space_data.shader_type = "OBJECT"
        mat = bpy.data.materials[self.mat]

        try:  # Go up one group as many times as possible - error will occur when the top level is reached
            while True:
                bpy.ops.node.tree_path_parent()
        except RuntimeError:
            pass

        objs_with_mat = 0
        active_set = False
        for obj in context.view_layer.objects:
            obj_materials = [slot.material for slot in obj.material_slots]
            if mat in obj_materials:
                objs_with_mat += 1
                obj.select_set(True)
                if not active_set:  # set first object as active
                    active_set = True
                    context.view_layer.objects.active = obj
                    if mat != obj.active_material:
                        for i, x in enumerate(obj.material_slots):
                            if x.material == mat:
                                obj.active_material_index = i
                                break
            else:
                obj.select_set(False)

        if objs_with_mat == 0:
            self.report({"WARNING"}, "No objects in this scene use '" + mat.name + "' material")
            dummy = dummy_object()
            slot = dummy.material_slots[0]
            slot.material = mat

        return {"FINISHED"}


class MATALOGUE_OT_go_to_group(bpy.types.Operator):
    "Show the nodes inside this group"
    bl_idname = "matalogue.goto_group"
    bl_label = "Go To Group"
    first_run = True

    tree_type: bpy.props.StringProperty(default="")
    tree: bpy.props.StringProperty(default="")

    def execute(self, context):
        try:  # Go up one group as many times as possible - error will occur when the top level is reached
            while True:
                bpy.ops.node.tree_path_parent()
        except RuntimeError:
            pass

        g = bpy.data.node_groups[self.tree]
        context.space_data.tree_type = self.tree_type
        context.space_data.path.append(g)

        current_tree = context.space_data.path[-1].node_tree if len(context.space_data.path) > 0 else None
        if self.first_run and current_tree is not g:
            # Sometimes we need to run this twice? Not sure why...
            self.first_run = False
            self.execute(context)
        return {"FINISHED"}


class MATALOGUE_OT_go_to_geonodes(bpy.types.Operator):
    "Show this Geometry Nodes tree"
    bl_idname = "matalogue.goto_geo"
    bl_label = "Go To Geo Nodes"
    first_run = True

    tree: bpy.props.StringProperty(default="")
    is_tool: bpy.props.BoolProperty(default=False)

    def execute(self, context):
        try:  # Go up one group as many times as possible - error will occur when the top level is reached
            while True:
                bpy.ops.node.tree_path_parent()
        except RuntimeError:
            pass

        g = bpy.data.node_groups[self.tree]
        context.space_data.tree_type = "GeometryNodeTree"
        if self.is_tool:
            context.space_data.geometry_nodes_type = "TOOL"
            context.space_data.path.append(g)
        else:
            context.space_data.geometry_nodes_type = "MODIFIER"
            objs_with_modifier = 0
            active_set = False
            for obj in context.view_layer.objects:
                obj_groups = [mod.node_group for mod in obj.modifiers if mod.type == "NODES"]
                if g in obj_groups:
                    objs_with_modifier += 1
                    obj.select_set(True)
                    if not active_set:  # set first object as active
                        active_set = True
                        context.view_layer.objects.active = obj
                        for mod in obj.modifiers:
                            if g == mod.node_group and not mod.is_active:
                                mod.is_active = True
                                break
                else:
                    obj.select_set(False)
            if objs_with_modifier == 0:
                context.space_data.path.append(g)

        current_tree = context.space_data.path[-1].node_tree if len(context.space_data.path) > 0 else None
        if self.first_run and current_tree is not g:
            # Sometimes we need to run this twice? Not sure why...
            self.first_run = False
            self.execute(context)

        return {"FINISHED"}


class MATALOGUE_OT_go_to_light(bpy.types.Operator):
    "Show the nodes for this material"
    bl_idname = "matalogue.goto_light"
    bl_label = "Go To Material"

    light: bpy.props.StringProperty(default="")
    world: bpy.props.BoolProperty(default=False)

    def execute(self, context):
        dummy_object(delete=True)
        context.space_data.tree_type = "ShaderNodeTree"
        if self.world:
            context.space_data.shader_type = "WORLD"
        else:
            context.space_data.shader_type = "OBJECT"
            light = bpy.data.objects[self.light]
            context.view_layer.objects.active = light

        return {"FINISHED"}


class MATALOGUE_OT_go_to_comp(bpy.types.Operator):
    "Show the nodes for this material"
    bl_idname = "matalogue.goto_comp"
    bl_label = "Go To Composite"
    scene: bpy.props.StringProperty(default="")

    def execute(self, context):
        context.space_data.tree_type = "CompositorNodeTree"
        scene = bpy.data.scenes[self.scene]
        context.window.scene = scene

        try:  # Go up one group as many times as possible - error will occur when the top level is reached
            while True:
                bpy.ops.node.tree_path_parent()
        except RuntimeError:
            pass

        return {"FINISHED"}


#####################################################################
# UI
#####################################################################


def draw_shadernodes_panel(self, context, selected_only=False, visible_only=False):
    def draw_item(context, col, mat, indent):
        row = col.row(align=True)
        for i in range(indent):
            row.label(text="", icon="BLANK1")

        try:
            icon_val = layout.icon(mat)
        except RuntimeError:
            icon_val = 1
            print("WARNING [Mat Panel]: Could not get icon value for %s" % mat.name)

        active = mat == context.space_data.id and context.space_data.path[-1].node_tree.name == mat.node_tree.name
        op = row.operator(
            "matalogue.goto_mat",
            text=mat.name,
            emboss=active,
            icon_value=icon_val,
        )
        op.mat = mat.name
        if mat.library:
            row.label(text="", icon="LINKED")
        elif mat.use_fake_user:
            row.label(text="", icon="FAKE_USER_ON")
        elif not mat.users:
            row.alert = True
            row.label(text="", icon="ORPHAN_DATA")

        # Node trees in this tree:
        if active:
            already_drawn = []
            for node in mat.node_tree.nodes:
                if node.type == "GROUP" and node.node_tree.name not in already_drawn:
                    row = col.row(align=True)
                    row.label(text="", icon="BLANK1")
                    op = row.operator("matalogue.goto_group", text=node.node_tree.name, emboss=False, icon="NODETREE")
                    op.tree_type = "ShaderNodeTree"
                    op.tree = node.node_tree.name
                    already_drawn.append(node.node_tree.name)

    def used_by_selected(mat):
        for obj in context.selected_objects:
            for slot in obj.material_slots:
                if slot.material == mat:
                    return True
        return False

    def used_by_visible(mat):
        for obj in context.view_layer.objects:
            if obj.visible_get():
                for slot in obj.material_slots:
                    if slot.material == mat:
                        return True
        return False

    layout = self.layout

    col = layout.column(align=True)

    materials = []
    for mat in bpy.data.materials:
        if mat.use_nodes:
            if selected_only and not used_by_selected(mat):
                continue
            if visible_only and not used_by_visible(mat):
                continue
            materials.append(mat)

    num_drawn = 0
    for mat in materials:
        draw_item(context, col, mat, 0)
        num_drawn += 1

    if num_drawn == 0:
        row = col.row()
        row.alignment = "CENTER"
        row.enabled = False
        if selected_only:
            row.label(text="No selected materials")
        elif visible_only:
            row.label(text="No visible materials")
        else:
            row.label(text="None")


class MATALOGUE_PT_shader(bpy.types.Panel):
    bl_label = "Shader"
    bl_space_type = "NODE_EDITOR"
    bl_region_type = "UI"
    bl_category = "Trees"

    def draw_header(self, context):
        layout = self.layout
        layout.label(text="", icon="NODE_MATERIAL")

    def draw(self, context):
        pass


class MATALOGUE_PT_shader_materials(bpy.types.Panel):
    bl_label = "Materials"
    bl_parent_id = "MATALOGUE_PT_shader"
    bl_space_type = "NODE_EDITOR"
    bl_region_type = "UI"
    bl_category = "Trees"
    bl_options = {"HEADER_LAYOUT_EXPAND"}

    def draw_header(self, context):
        settings = context.window_manager.matalogue_settings
        row = self.layout.row(align=True)
        row.alignment = "RIGHT"
        row.prop(settings, "mat_selected_only", text="", icon="RESTRICT_SELECT_OFF")
        row.prop(settings, "mat_visible_only", text="", icon="RESTRICT_VIEW_OFF")
        row.separator()

    def draw(self, context):
        settings = context.window_manager.matalogue_settings
        draw_shadernodes_panel(self, context, settings.mat_selected_only, settings.mat_visible_only)


class MATALOGUE_PT_shader_lights(bpy.types.Panel):
    bl_label = "Lighting"
    bl_parent_id = "MATALOGUE_PT_shader"
    bl_space_type = "NODE_EDITOR"
    bl_region_type = "UI"
    bl_category = "Trees"
    bl_options = {"HEADER_LAYOUT_EXPAND"}

    def draw_header(self, context):
        settings = context.window_manager.matalogue_settings
        row = self.layout.row(align=True)
        row.alignment = "RIGHT"
        row.prop(settings, "light_visible_only", text="", icon="RESTRICT_VIEW_OFF")
        row.separator()

    def draw(self, context):
        settings = context.window_manager.matalogue_settings
        objects = context.visible_objects if settings.light_visible_only else context.view_layer.objects
        lights = [obj for obj in objects if obj.type == "LIGHT"]

        layout = self.layout
        col = layout.column(align=True)

        for light in lights:
            if light.data.use_nodes:
                active = False
                if light.data == context.space_data.id:
                    if context.space_data.path[-1].node_tree.name == light.data.node_tree.name:
                        active = True
                op = col.operator(
                    "matalogue.goto_light",
                    text=light.name,
                    emboss=active,
                    icon="LIGHT_%s" % light.data.type,
                )
                op.light = light.name
                op.world = False

        if context.scene.world:
            if context.scene.world.use_nodes:
                active = False
                if context.scene.world == context.space_data.id:
                    if context.space_data.path[-1].node_tree.name == context.scene.world.node_tree.name:
                        active = True
                op = col.operator(
                    "matalogue.goto_light",
                    text="World",
                    emboss=active,
                    icon="WORLD",
                )
                op.world = True


class MATALOGUE_PT_shader_groups(bpy.types.Panel):
    bl_label = "Groups"
    bl_parent_id = "MATALOGUE_PT_shader"
    bl_space_type = "NODE_EDITOR"
    bl_region_type = "UI"
    bl_category = "Trees"

    def draw(self, context):
        layout = self.layout

        col = layout.column(align=True)

        shader_groups = []
        for g in bpy.data.node_groups:
            if g.type == "SHADER":
                shader_groups.append(g)

        for g in shader_groups:
            emboss = False
            row = col.row(align=True)
            if len(context.space_data.path) > 0:
                emboss = context.space_data.path[-1].node_tree.name == g.name
            op = row.operator("matalogue.goto_group", text=g.name, emboss=emboss, icon="NODETREE")
            op.tree_type = "ShaderNodeTree"
            op.tree = g.name
            if g.library:
                row.label(text="", icon="LINKED")
            elif g.use_fake_user:
                row.label(text="", icon="FAKE_USER_ON")
            elif not g.users:
                row.alert = True
                row.label(text="", icon="ORPHAN_DATA")


def draw_geonodes_panel(self, context, conditions, inverse=False, selected_only=False, visible_only=False):
    def draw_item(context, col, g, indent):
        active = False
        row = col.row(align=True)
        for i in range(indent):
            row.label(text="", icon="BLANK1")
        if len(context.space_data.path) > 0:
            active = context.space_data.path[-1].node_tree.name == g.name
        op = row.operator(
            "matalogue.goto_geo",
            text=g.name,
            emboss=active,
            icon=("TOOL_SETTINGS" if g.is_tool else "MODIFIER" if g.is_modifier else "NODETREE"),
        )
        op.tree = g.name
        op.is_tool = g.is_tool
        if not indent:
            if g.library:
                row.label(text="", icon="LINKED")
            elif g.use_fake_user:
                row.label(text="", icon="FAKE_USER_ON")
            elif not g.users:
                row.alert = True
                row.label(text="", icon="ORPHAN_DATA")
        row.enabled = context.object is not None  # Avoid hard crashing Blender when there's no active object

        # Node trees in this tree:
        if active:
            already_drawn = []
            for node in g.nodes:
                if node.type == "GROUP" and node.node_tree.name not in already_drawn:
                    draw_item(context, col, node.node_tree, indent + 1)
                    already_drawn.append(node.node_tree.name)

    def used_by_selected(g):
        for obj in context.selected_objects:
            for mod in obj.modifiers:
                if mod.type == "NODES" and mod.node_group == g:
                    return True
        return False

    def used_by_visible(g):
        for obj in context.view_layer.objects:
            if obj.visible_get():
                for mod in obj.modifiers:
                    if mod.type == "NODES" and mod.node_group == g:
                        return True
        return False

    layout = self.layout

    col = layout.column(align=True)

    geo_nodes = []
    for g in bpy.data.node_groups:
        if g.type == "GEOMETRY" and any((getattr(g, c) is True for c in conditions)) != inverse:
            if selected_only and not used_by_selected(g):
                continue
            if visible_only and not used_by_visible(g):
                continue
            geo_nodes.append(g)

    num_drawn = 0
    for g in geo_nodes:
        draw_item(context, col, g, 0)
        num_drawn += 1

    if num_drawn == 0:
        row = col.row()
        row.alignment = "CENTER"
        row.enabled = False
        if selected_only:
            row.label(text="No selected geo nodes")
        elif visible_only:
            row.label(text="No visible geo nodes")
        else:
            row.label(text="None")


def poll_geonodes_panel(conditions, inverse=False):
    for g in bpy.data.node_groups:
        if g.type == "GEOMETRY" and any((getattr(g, c) is True for c in conditions)) != inverse:
            return True
    return False


class MATALOGUE_PT_geonodes(bpy.types.Panel):
    bl_label = "Geo Nodes"
    bl_space_type = "NODE_EDITOR"
    bl_region_type = "UI"
    bl_category = "Trees"

    def draw_header(self, context):
        layout = self.layout
        layout.label(text="", icon="GEOMETRY_NODES")

    def draw(self, context):
        pass


class MATALOGUE_PT_geonodes_modifiers(bpy.types.Panel):
    bl_label = "Modifiers"
    bl_parent_id = "MATALOGUE_PT_geonodes"
    bl_space_type = "NODE_EDITOR"
    bl_region_type = "UI"
    bl_category = "Trees"
    bl_options = {"HEADER_LAYOUT_EXPAND"}

    conditions = ["is_modifier"]
    inverse = False

    def draw_header(self, context):
        settings = context.window_manager.matalogue_settings
        row = self.layout.row(align=True)
        row.alignment = "RIGHT"
        row.prop(settings, "geo_selected_only", text="", icon="RESTRICT_SELECT_OFF")
        row.prop(settings, "geo_visible_only", text="", icon="RESTRICT_VIEW_OFF")
        row.separator()

    @classmethod
    def poll(self, context):
        return poll_geonodes_panel(self.conditions, self.inverse)

    def draw(self, context):
        settings = context.window_manager.matalogue_settings
        draw_geonodes_panel(
            self, context, self.conditions, self.inverse, settings.geo_selected_only, settings.geo_visible_only
        )


class MATALOGUE_PT_geonodes_tools(bpy.types.Panel):
    bl_label = "Tools"
    bl_parent_id = "MATALOGUE_PT_geonodes"
    bl_space_type = "NODE_EDITOR"
    bl_region_type = "UI"
    bl_category = "Trees"

    conditions = ["is_tool"]
    inverse = False

    @classmethod
    def poll(self, context):
        return poll_geonodes_panel(self.conditions, self.inverse)

    def draw(self, context):
        draw_geonodes_panel(self, context, self.conditions, self.inverse)


class MATALOGUE_PT_geonodes_groups(bpy.types.Panel):
    bl_label = "Groups"
    bl_parent_id = "MATALOGUE_PT_geonodes"
    bl_space_type = "NODE_EDITOR"
    bl_region_type = "UI"
    bl_category = "Trees"

    conditions = ["is_modifier", "is_tool"]
    inverse = True

    @classmethod
    def poll(self, context):
        return poll_geonodes_panel(self.conditions, self.inverse)

    def draw(self, context):
        draw_geonodes_panel(self, context, self.conditions, self.inverse)


class MATALOGUE_PT_compositing(bpy.types.Panel):
    bl_label = "Compositing"
    bl_space_type = "NODE_EDITOR"
    bl_region_type = "UI"
    bl_category = "Trees"

    def draw_header(self, context):
        layout = self.layout
        layout.label(text="", icon="NODE_COMPOSITING")

    def draw(self, context):
        pass


class MATALOGUE_PT_compositing_scenes(bpy.types.Panel):
    bl_label = "Scenes"
    bl_parent_id = "MATALOGUE_PT_compositing"
    bl_space_type = "NODE_EDITOR"
    bl_region_type = "UI"
    bl_category = "Trees"

    def draw(self, context):
        layout = self.layout

        col = layout.column(align=True)

        for sc in bpy.data.scenes:
            name = sc.name
            if not sc.use_nodes:
                col.prop(sc, "use_nodes", text=name, emboss=False, icon="ADD")
                continue
            active = False
            if len(context.space_data.path) > 0:
                active = (
                    context.space_data.path[-1].node_tree.name == context.scene.node_tree.name and sc == context.scene
                )
            op = col.operator("matalogue.goto_comp", text=name, emboss=active, icon="SCENE_DATA")
            op.scene = name

            # Node trees in this tree:
            if active and len(bpy.data.scenes) > 1:
                already_drawn = []
                for node in context.scene.node_tree.nodes:
                    if node.type == "GROUP" and node.node_tree.name not in already_drawn:
                        g = node.node_tree
                        row = col.row()
                        row.label(text="", icon="BLANK1")
                        op = row.operator("matalogue.goto_group", text=g.name, emboss=False, icon="NODETREE")
                        op.tree_type = "CompositorNodeTree"
                        op.tree = g.name
                        already_drawn.append(g.name)


class MATALOGUE_PT_compositing_groups(bpy.types.Panel):
    bl_label = "Groups"
    bl_parent_id = "MATALOGUE_PT_compositing"
    bl_space_type = "NODE_EDITOR"
    bl_region_type = "UI"
    bl_category = "Trees"

    @classmethod
    def poll(self, context):
        comp_groups = (g for g in bpy.data.node_groups if g.type == "COMPOSITING")
        return len(list(comp_groups)) > 0

    def draw(self, context):
        layout = self.layout
        col = layout.column(align=True)

        comp_groups = (g for g in bpy.data.node_groups if g.type == "COMPOSITING")

        for g in comp_groups:
            emboss = False
            row = col.row(align=True)
            if len(context.space_data.path) > 0:
                emboss = context.space_data.path[-1].node_tree.name == g.name
            op = row.operator("matalogue.goto_group", text=g.name, emboss=emboss, icon="NODETREE")
            op.tree_type = "CompositorNodeTree"
            op.tree = g.name
            if g.library:
                row.label(text="", icon="LINKED")
            elif g.use_fake_user:
                row.label(text="", icon="FAKE_USER_ON")
            elif not g.users:
                row.alert = True
                row.label(text="", icon="ORPHAN_DATA")


#####################################################################
# Registration
#####################################################################


classes = [
    MatalogueSettings,
    MATALOGUE_OT_go_to_material,
    MATALOGUE_OT_go_to_group,
    MATALOGUE_OT_go_to_geonodes,
    MATALOGUE_OT_go_to_light,
    MATALOGUE_OT_go_to_comp,
    MATALOGUE_PT_shader,
    MATALOGUE_PT_shader_materials,
    MATALOGUE_PT_shader_lights,
    MATALOGUE_PT_shader_groups,
    MATALOGUE_PT_geonodes,
    MATALOGUE_PT_geonodes_modifiers,
    MATALOGUE_PT_geonodes_tools,
    MATALOGUE_PT_geonodes_groups,
    MATALOGUE_PT_compositing,
    MATALOGUE_PT_compositing_scenes,
    MATALOGUE_PT_compositing_groups,
]


def register():
    from bpy.utils import register_class

    for cls in classes:
        register_class(cls)

    bpy.types.WindowManager.matalogue_settings = bpy.props.PointerProperty(type=MatalogueSettings)


def unregister():
    del bpy.types.WindowManager.matalogue_settings

    from bpy.utils import unregister_class

    for cls in reversed(classes):
        unregister_class(cls)


if __name__ == "__main__":
    register()