Blender 节点插件开发全流程

最新推荐文章于 2024-05-15 09:30:06 发布
最新推荐文章于 2024-05-15 09:30:06 发布
阅读量4.2k 收藏 47
点赞数 17
分类专栏： python bpy 文章标签： blender python
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_29716067/article/details/117574940
版权

文章目录

写在前面：

由于网上关于blender自定义节点的文章极少（这也是我特意写本文的原因），本文均为自己摸索和部分参考Blender文档得到，可能会有不严谨和不正确的地方，请观者酌情采纳

目的：借用blender的节点实现自己的可视化节点编程，初步完成基本的输入输出节点

  • Blender Version: 2.92
  • 完成时间：2021.06.04
  • 会使用到的bpy模块：
  • import bpy
  • from bpy.types import NodeTree
  • from bpy.types import NodeSocket
  • from bpy.types import Node
  • from bpy.utils import register_class
  • from bpy.utils import unregister_class

blender节点插件的结构

  在正式进入Blender节点插件编写之前，先弄清楚开发流程和包含关系，如下图

img-kO8EhnFj-1622820261019

白色和蓝色方框中的内容是重点，黑色方框是本次实例要完成的内容，即创建一个和几何节点面板一样的自定义节点面板，并编写几个简单的节点

不愿意看介绍可以直接看实例

NodeTree

  如果你用过Blender，Blender中自带了几何节点和材质节点，他们都有单独的面板使用他们，同样的，我们创建的自定义节点也可以拥有自己的独立面板，我们编写的节点程序除了拥有python提供的能力外，同时可以使用Blender提供的API。


Node

如图所示：一个节点可见的部分有5个部分

  1. 标签
  2. 图标【可以没有】
  3. 输出组件(NodeSocket)
  4. 节点属性(property)
  5. 输入组件(NodeSocket)

如果把节点分为UI和内部方法两个部分，我们的UI工作也就是这些

property

  这个部分来自bpy.props，props全称是property，直译为属性。blender中很多模块都使用到了属性，属性中常用的方法有get()和set()，在需要读取和写入属性值时，会自动调用他们。

  这个部分我看了很久，至今也没太明白，主要是创建一个实例后，我怎么通过多种方法访问和修改到它的属性，以及理解他的工作方式。

NodeSocket

  直译为节点套接字，我觉得这个不好理解，下文都称为节点组件/NodeSocket。

  节点组件是节点的基本组成之一，节点组件内一般都会定义一个property，blender也自带了种类丰富的组件。

准备工作

  • 我的电脑中blender的python环境和VScode是分开的，两边的库并不连通。
  • 下面的做法并不是必须的，但能极大的帮助插件的开发工作

  为了方便开发，需要安装一个python库：使用 pip install fake-bpy-module-2.92 或 进入 https://pypi.org/project/fake-bpy-module-2.92/ 下载，安装在VScode环境中。该库的作用如其名，假的bpy库，只提供代码自动补齐，使用时同样是import bpy。

  我推荐用VScode编写，里面有一个Blender Development插件，可以极大的方便插件的编写和调试工作。

实例

所有代码：链接：https://pan.baidu.com/s/1xtUTL4gf46DT5geIUnN9ig
提取码：ldz8

创建NodeTree

  NodeTree部分的工作量不大，只是注册一个面板，填入必要的信息即可

### NOTE:第一步：创建节点树 ###

from bpy.types import NodeTree
# 自定义节点编辑面板的信息
class myCustomTree(NodeTree):
    """一个节点树类型，它将展示在编辑器类型列表中"""
    bl_idname = 'CustomTreeType' # 面板的id，唯一
    bl_label = "My NodeTree" # 面板的标签，用于展示
    bl_icon = 'RNA' # 面板的图标，使用Blender自带的图标

# 定义节点时需要这个类
class MyCustomTreeNode:
    @classmethod
    def poll(cls, ntree):
        return ntree.bl_idname == 'CustomTreeType'

import nodeitems_utils
from nodeitems_utils import NodeCategory, NodeItem

# 创建节点目录时需要这个类
class MyNodeCategory(NodeCategory):
    @classmethod
    def poll(cls, context):
        return context.space_data.tree_type == 'CustomTreeType'

创建组件NodeSocket

# Created by Jiacong Zhao @CSDN-奇偕
# XXX The last modification at：2021.06.04
# XXX Topic: 自定义单选组件示例
# XXX Discription: 组件是构成节点的基础
# blender本身自带了NodeSocketInt、NodeSocketFloat、NodeSocketString等组件

import bpy
from bpy.types import NodeSocket

class Socket_Enum_List(NodeSocket):
    bl_idname = '_enum_list'
    bl_label = "enum_list"

    # 选项列表
    my_items = (
        # [(identifier, name, description, icon, number), ...]
        ('C://', "C://", ""),
        ('D://', "D://", ""),
        ('E://', "E://", ""),
        ('F://', "F://", ""),
    )

    # 组件基本信息
    myenum: bpy.props.EnumProperty(
        name="Direction",# 名称
        description="一个例子",# 描述
        items=my_items,# 可选择的项目
        default='C://',# 默认选择
    )
    def val(self):
        return self.myenum

    # 用于绘制在节点框里显示的文本【可选】
    def draw(self, context, layout, node, text):
        if self.is_linked:
            # 如果被连接，只显示的文本
            # text += bpy.props.
            layout.label(text=text)
        else:
            # 没有被连接时，显示文本和选项
            layout.prop(self, "myenum", text=text)

    # 组件颜色【那个小点点】
    def draw_color(self, context, node):
        return (1.0, 0.4, 0.216, 0.5)

创建Node

'''
in info s
'''

# Created by Jiacong Zhao @CSDN-奇偕
# XXX The last modification at：2021.06.04
# XXX Topic: 打印节点
# XXX Discription: 将得到的任何数据转为字符串并打印，实时刷新

import time
import bpy
from bpy.types import Node
from ..MyCustomTree import *
from ..MyCustomSocket import *

class PrintNode(Node, MyCustomTreeNode):
    bl_idname = 'PrintNode'
    bl_label = "打印"
    bl_icon = 'CONSOLE'

    def init(self, context):
        self.inputs.new('NodeSocketString', "info")
    
    def parent_socket(self):
        return self.inputs[0].links[0].from_socket

    def draw_buttons(self, context, layout):
        if self.inputs[0].is_linked:
            layout.label(text=str(self.parent_socket().default_value))
        else:
            layout.label(text='')

    def draw_buttons_ext(self, context, layout):
        ...

    def draw_label(self):
        return "打印"

    # 拓扑图更新时调用
    def update(self):
        print(time.ctime(),end='>>> ')
        print(str(self.parent_socket().default_value))

    # 复制时调用
    def copy(self, node):
        print("Copying from node ", node)

    # 释放时调用
    def free(self):
        print("Removing node ", self, ", Goodbye!")

创建节点目录并注册上述类

# 插件信息
bl_info = {
    "name" : "MyCustomAddon",
    "author" : "QiXie",
    "description" : "",
    "blender" : (2, 92, 0),
    "version" : (0, 0, 1),
    "location" : "",
    "warning" : "",
    "category" : "Generic"
}

import bpy
# View3d面板
from .TestHello import *
from .TestMyPanel import *

''' 自定义节点面板 '''
# 节点树--节点组件--节点--节点目录
# from .myNodes import *
from .MyCustomTree import *
from .MyCustomSocket import Socket_classes
from .MyCustomNodes import Node_classes

classes = (
    Test_OT_Hello, 
    Test_PT_HelloPanel, 
    
    myCustomTree,
)


### NOTE:创建节点目录 ###
node_categories = [
    # identifier, label, items list
    # -->标识符、标签(展示的名称)、项目列表

    MyNodeCategory('INPUT', "输入节点", items=[
        NodeItem("TextNode"),
        NodeItem("FileNode"),
    ]),
    MyNodeCategory('OUTPUT', "输出节点", items=[
        NodeItem("PrintNode"),
    ]),
    MyNodeCategory('OTHERNODES', "测试节点", items=[
        # --> 节点项可以有额外的设置，可以应用于新的节点
        # --> 注意:设置值存储为字符串表达式，因此应该使用repr()将其转换为字符串。
        # 由一个节点设置不同的值派生出新节点
        # 一个节点有四个属性
        # nodetype【类型|必填】
        # label【名称】
        # settings【设置】：settings[0]【名称】settings[1]【值】
        # poll
        NodeItem("TestNode", label="Node A", settings={
            "my_string_prop": repr("文本"),
        }),
        NodeItem("TestNode", label="Node B", settings={
            "my_string_prop": repr("文本"),
        }),
    ]),
]

# 类的注册【方法一】
# register, unregister = bpy.utils.register_classes_factory(classes)

# 类的注册【方法二】
def register():
    from bpy.utils import register_class

    # 注册
    for cls in classes:
        register_class(cls)
    
    # 组件注册
    for cls in Socket_classes:
        register_class(cls)

    # 节点注册
    for cls in Node_classes:
        register_class(cls)

    # 节点目录注册
    nodeitems_utils.register_node_categories('CUSTOM_NODES', node_categories)


def unregister():
    nodeitems_utils.unregister_node_categories('CUSTOM_NODES')

    from bpy.utils import unregister_class
    # 节点
    for cls in Node_classes:
        unregister_class(cls)

    # 组件
    for cls in Socket_classes:
        unregister_class(cls)

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


# if __name__ == "__main__":
#     register()

其他说明

控制台出现乱码

  1. 路径中包含中文，应更改路径
  2. 设置了界面语言为中文，应改为English
  3. 实际上，我建议最好全用英文，即使是下划线，放在最前面有时候也会报错

插件代码修改并重新安装后没有变化

  • 旧的插件并没有彻底删除，跳转至Blender放置插件的位置将过期代码删除，并重新尝试安装
  • 建议：开发全程使用VS Code的Blender Development插件，调用Blender: Start命令调试插件

查找Blender中的图标

  1. 打开自带插件icon Viewer，在文本编辑窗口的侧边栏Dev选项中即可查看全部图标，点击即可复制图标名称。

    参考文章

节点 刷新/输出滞后 问题

  1. 当节点自身拓扑结构发生变化时，Blender会自动调用节点的update方法，因此我们将输入与输出的逻辑关系放在这里

  2. 当我们改变某节点的父结点的参数时，此时update方法不会被调用，也就是说变化的传递会即刻终止，这在大多数情况下不符合需求，我的解决办法如下：

    • 编写自定义NodeSocket，在property of NodeSocket的set方法中，调用NodeSocket父节点的update方法，这样自身参数改变时，输出也会跟着刷新

    • 在原有的update方法中运用递归的思想，自身输出刷新后调用子节点的update方法，如下所示

for item in self.outputs:
    for cell in item.links:
        cell.to_socket.node.update()
# 我必须要说明的是，这是一种简单粗暴的方法，当整个节点树比较复杂时，update方法的调用次数是成倍上升的，好的算法应该让每个节点按照一定顺序逐个执行一遍
# 如果你需要掐断这种传递，那么添加一个不含这类代码的节点即可

参考

遇到困难的时候不妨求助以下路径

  • 点击打开Blender官方文档 直接看很头痛
  • 【Blender Python小白向入门-哔哩哔哩】https://b23.tv/c0UwtY 入门推荐
  • 【dog日常：开发blender插件#1-哔哩哔哩】https://b23.tv/zCLcR9 快速了解插件开发
  • Blender中的图标 https://blog.csdn.net/qq_42110882/article/details/107151652
  • Blender中的模板文件：Text Editor -> Templates
  • Github

最终实现效果

目前只是简单做了几个节点，当然，会做几个基本的节点后，后面会快很多。

  • Text节点为字符串节点
  • File Str节点是打开FilePath下的文件并以指定编码方式输出
  • 打印节点顾名思义是将得到的信息打印出来

最终的想法是做一个能处理数据和解决数学问题的节点插件，我认为这种方式去做这些会更为直观

奇偕
关注
  • 17
    点赞
  • 踩
  • 47
    收藏
    觉得还不错? 一键收藏
  • 6
    评论
专栏目录
Blender动画节点插件开发文档介绍
jianshi2023的博客
03-29 106
Blender软件介绍与使用心得
热门推荐
xzljj的博客
06-22 1万+
Blender是一款免费开源而且轻量级的三维软件，小而精悍，只有300多MB大小。集建模，雕刻，绑定，粒子，动力学，动画，交互，材质，渲染，音频处理，视频剪辑以及运动跟踪，后期合成等等的一系列动画短片制作解决方案...
2022年最佳Blender插件
新缸中之脑
07-14 2484
如果你从事平面设计、动画或 3D 建模，您可能听说过Blender，这是一款开源的一体化 3D 图形软件。Blender 配备了适用于各种领域的工具和功能，包括 3D 动画、计算机辅助设计、纹理编辑、特殊效果等。Blender 的最新版本3.0于 2021 年 12 月上旬发布，其中包含许多新功能，例如新的雕刻工具、建模修改器等。然而，没有任何程序可以包含足够的功能来满足每个用户的需求——即使是像 Blender 这样多功能的程序。幸运的是，有许多附加组件可以增强程序的特性和功能。由于Blender 是开源
探索Blender开发新境界：fake-bpy-module
gitblog_00008的博客
05-15 394
探索Blender开发新境界：fake-bpy-module 项目地址:https://gitcode.com/nutti/fake-bpy-module 在数字艺术和游戏开发的世界中，Blender凭借其强大的功能和开源特性，已经成为许多创作者的首选工具。然而，在开发Blender脚本时，IDE代码补全的支持往往不尽如人意。为了解决这一问题，我们向您推荐一个令人赞叹的开源项目——fake-bpy...
Blender插件开发-插件的偏好设置
weixin_52345129的博客
02-27 1429
根据以上步骤，我们需要先定义一个 AddonPreferences 类。name="文件路径",box.label(text="插件偏好设置：")其中bl_idname必须为__name__或者插件的名称，否则该设置无法定位至对应插件的偏好设置的位置。bl_label = "测试按钮"bl_description = "测试按钮-描述"info = ("文件路径: %s, 数字: %d, 布尔值: %r" %
BlenderGIS插件 城市建筑3D模型自动生成 教程
ChaoChao66666的博客
11-18 1万+
一、下载Blender和BlenderGIS 二、解决 No imaging library...报错 三、生成城市3D模型 四、导出模型
Blender插件开发-自定义侧栏
weixin_52345129的博客
02-23 850
根据以上步骤，我们需要先定义一个 Panel 类，其中 bl_label 是面板名称。bl_label = "测试面板标签"pass这个Panel类的类名中需要包含_PT_的标识，否则Blender会在控制台窗口生成警告。
blender-mixamo插件
01-16
通过这个插件，用户能够方便地下载、应用和管理Mixamo上的3D角色动画，极大地丰富了Blender在游戏开发、电影制作或者虚拟现实项目中的角色动作资源。 在Blender中启用Mixamo插件的过程相当简单。首先，打开Blender...
Blender插件开发-HTTP 客户端
02-22
Requests允许您非常容易的发送HTTP/1.1请求，无需手动向URL添加查询字符串，也不需要对表单数据进行格式编码。由于使用了urllib3，Keep-alive和HTTP 连接池的功能是100%自动化的。
blender_sdf_node_addon:Blender SDF节点系统插件
03-29
Blender SDF节点插件该插件为SDF渲染提供SDF节点系统，并通过SDF Collision进行物理模拟。 SDF是指带符号的距离字段。 您可以在此网站上找到许多与SDF相关的令人印象深刻的内容。 由于此插件仍在开发中，并且没有...
blender常用插件合集
最新发布
06-22
本"blender常用插件合集"包含了一些热门且实用的插件，下面将对这些插件进行详细介绍。 1. DECALmachine 2.7.1：这是一个纹理贴图工具，它允许用户在3D模型表面上创建和应用各种类型的贴花，如磨损、腐蚀、标志等。...
blender-custom-nodes：Blender的自定义合成器节点
02-04
blender-custom-nodes：Blender的自定义合成器节点
HouseGeneration：Blender的插件，可创建3D房子
02-18
房屋发电 该项目旨在创建Blender 2.8插件，该插件可生成程序生成的房屋的模型。 建造 可以通过构建图生成器（ ） mkdir build cd build cmake .. make cd .. 模型生成器（ ）可以直接使用运行 用法 自动化方式： 只需使用 chmod +x run ./run 手动方式： 生成建筑图build/planrand 产生模型blender --background --python generator.py -- out/result.json 去做 核心功能 优化性能 从原始数据创建 更现实的建筑 资产放置 删除过多的顶点和面
blender 3d
03-31
blender 3d by example, Design a complete workflow with Blender to create stunning 3D scenes and films step by step!
Blender基于节点可视化脚本制作插件 Serpens Blender Visual Scripting V3.3.2
02-22
Serpens是一个基于节点的Blender脚本插件。它允许您创建真正的、可安装的 python 插件，而无需接触任何代码。 无论您是想制作带有常用按钮的简单面板，创建饼图菜单以改善工作流程，还是创建更复杂的内容以在线共享...
Blender游戏开发教程
artgolf的专栏
11-22 1518
在本书中，作者详细讲述了怎样用Blender代替3ds Max和Maya用于游戏开发的流程，学习者可以根据自己的兴趣专注于某一个环节。每一章的最后都有一系列创业课堂的话题，作者把在二十多年的独立开发生涯中遇到的经验和教训娓娓道来，指出独立开发者和小团队容易遇到的坑，并且给出了直截了当的解决方案。通过学习本书，你会发现：如果做的足够好，独立开发者实现财务自由并不是高不可攀的事情。无论你是即将毕业的大学生，还是刚刚开始创业的独立开发者，或者是资金不充裕的小团队，都可以从本书中汲取营养，助力创业成功。
试图将CGAL 作为 Blender 插件：C++, pybind11, CMake, CLion, Eigen, NumPy
风海流的豪赌
02-06 1511
1 起因 在一个参与的课题中，一直都是用C++基于CGAL编写一些处理网格（mesh）的代码。最近需要实现一个可视化，或者更进一步实现用户的简单交互。由于要同时兼顾对网格的编辑能力，我们一开始决定尝试将我们的代码变成一个Blender的插件（addon或plugin），这样既可以获得可视化的能力，又能利用Blender对网格进行其他编辑。我对Blender仅是听说过但没有真正使用过，经过两三天的尝试与折腾，目前感觉这个做成插件的想法是可行的。这里记录一下如何将基于CGAL的C++代码转换为Blender的插
Blender图解教程：内置插件Rigify小教程（六）如何重新生成控制系统
开发游戏的老王
05-09 4778
使用Rigify绑定角色的时候经常遇到这样的尴尬情况：好不容易蒙完皮，刷完权重，发现有些骨骼需要调整。之前老王总是擦干眼泪（主要还是懒，没有好好做功课），然后把模型从骨架上解绑，调整完metarig，生成控制系统以后再重新蒙皮刷权重，如此浪费着生命。 其实Rigfiy完全可以调整metarig后重新生成并自动覆盖之前的控制系统的。 这个高级选项其实不用打开，其默认值就是我们需要的。overwrite就是覆盖原先的控制系统，棒棒哒！ ...
Blender插件简单示例
linmy24的专栏
03-26 2329
编写插件： 1. bl_info = {...} 这部分在blender官网文档有介绍 2.  class Test(bpy.types.Operator): '''Add a Layout.''' bl_idname = "object.test_operator_add" bl_label = "AddOperator" bl_
blender python 插件开发
08-12
非常好的问题！Blender是一个功能强大的开源3D建模和渲染软件，它允许用户通过Python编程语言创建自定义插件。插件开发使您能够扩展Blender的功能，添加新的工具、功能和工作流程。 要开始进行Blender Python插件开发，您可以按照以下步骤进行操作： 1. 学习Python语言：如果您还不熟悉Python编程语言，建议您首先学习Python的基础知识。这将帮助您理解和编写Blender插件所需的代码。 2. 了解Blender的Python API：Blender提供了一个强大的Python API，用于访问和操作Blender的各种功能。您需要熟悉这个API，以便了解可用的函数、类和方法。 3. 编写插件代码：使用Python编写插件代码。插件可以是用于添加新工具、修改现有工具或自动化特定任务的脚本。您可以使用Blender的Python控制台进行实时测试和调试。 4. 注册插件：为了使Blender能够识别和加载您的插件，您需要在Blender中进行注册。这通常涉及在插件代码中添加一些元数据，例如名称、描述和版本。 5. 测试和调试：在开发过程中，测试和调试是非常重要的一步。您可以使用Blender的调试工具和Python控制台来检查代码，并确保插件按预期工作。 6. 分发插件：一旦您的插件开发完成并且经过测试，您可以选择将其分发给其他人使用。您可以将插件打包为.zip文件，并在Blender中进行安装。 希望这些步骤能够帮助您入门Blender Python插件开发。祝您成功！如果您有更多问题，请随时提问。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 6
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值