Blender on 醉后的星星

blender脚本新建物体的方法

Tue, 08 Dec 2020 07:55:51 +0000

blender插件脚本里新建物体的两种方法，其实本质上是一样的，这里做个记录以防日后忘记。

方法一

来自之前在网络上搜到的方法，是直接在data里新建物体并link到场景集合里。

class PointsImport(bpy.types.Operator):
 bl_idname = 'obj.import_points'
 bl_label = '导入点云'
 bl_options = {'REGISTER', 'UNDO'}

 name: bpy.props.StringProperty(default='points')
 path: bpy.props.StringProperty(subtype='FILE_PATH')

 def execute(self, context):
 points = np.load(self.path)
 verts = []
 for i in points:
 verts.append(tuple(i))

 # 新建mesh
 mymesh = bpy.data.meshes.new(self.name)
 mymesh.from_pydata(verts, [], [])
 mymesh.update()

 # 新建object并添加到场景
 myobject = bpy.data.objects.new(self.name, mymesh)
 bpy.context.scene.collection.objects.link(myobject)

 self.report({'INFO'}, f'import {len(points)} points')
 return {'FINISHED'}

方法二

来自blender自带的demo，直接调用了object_data_add方法，是更正规的方法，需要注意的是需要继承AddObjectHelper

import bpy
from bpy.types import Operator
from bpy.props import FloatVectorProperty
from bpy_extras.object_utils import AddObjectHelper, object_data_add
from mathutils import Vector

def add_object(self, context):
 scale_x = self.scale.x
 scale_y = self.scale.y

 verts = [
 Vector((-1 * scale_x, 1 * scale_y, 0)),
 Vector((1 * scale_x, 1 * scale_y, 0)),
 Vector((1 * scale_x, -1 * scale_y, 0)),
 Vector((-1 * scale_x, -1 * scale_y, 0)),
 ]

 edges = []
 faces = [[0, 1, 2, 3]]

 mesh = bpy.data.meshes.new(name="New Object Mesh")
 mesh.from_pydata(verts, edges, faces)
 # useful for development when the mesh may be invalid.
 # mesh.validate(verbose=True)
 object_data_add(context, mesh, operator=self)


class OBJECT_OT_add_object(Operator, AddObjectHelper):
 """Create a new Mesh Object"""
 bl_idname = "mesh.add_object"
 bl_label = "Add Mesh Object"
 bl_options = {'REGISTER', 'UNDO'}

 scale: FloatVectorProperty(
 name="scale",
 default=(1.0, 1.0, 1.0),
 subtype='TRANSLATION',
 description="scaling",
 )

 def execute(self, context):

 add_object(self, context)

 return {'FINISHED'}

blender插件编写入门

Sat, 05 Dec 2020 14:12:00 +0000

都说blender的python脚本编写起来很简单，虽然已经能够在脚本里调用一些api实现自动化，但实际写成插件还是有很多东西需要摸索的，这里记录一些关键知识点。

参考

先将一些重要的和有益的参考或学习资料列一下：

一篇相当棒的入门教程 Blender Python小白向入门
主要是第2期和第3期杂志关于插件一节写的很棒 blendercn电子杂志
其中Quickstart部分不错，不过需要一定经验后回头看才能看的更明白，其他时候主要是当作字典查询，其中有许多example值得参考 blenderAPI
blender软件中自带的Templates

概览

blender插件大部分内容都是写在class中的，无论是新建一个api接口，还是绘制一个新的界面，都是新建一个class，然后继承相应的类，所以找到相应的类，是编写插件的第一步。然后新写的类都要通过下面的注册函数register才能成为blender的一部分，有注册就有注销，注册函数在启用插件时激活，注销函数在取消启用插件时激活。

bpy.utils.register_class(CLASS_NAME)
bpy.utils.unregister_class(CLASS_NAME)

下面是一个在顶部添加语言切换功能的面板示例代码，关键的部分有继承bpy.types.Header，定义bl_space_type等内容，这些参数可以通过查阅api获取，或者从别人的代码参考过来，绘制界面就是重写draw()函数。

class LanguageChange(bpy.types.Header):
 bl_space_type = "TOPBAR"
 bl_idname = "MY_HT_LanguageChange"

 def draw(self, context):
 if context.region.alignment != "RIGHT":
 self.layout.prop(context.preferences.view,
 "use_translate_interface", text="Language")

传入的context就表示当前上下文，通过打印dir(context)可知其包涵以下属性和方法：

[’doc’, ‘module’, ‘slots’, ‘active_annotation_layer’, ‘active_base’, ‘active_bone’, ‘active_editable_fcurve’, ‘active_gpencil_frame’, ‘active_gpencil_layer’, ‘active_object’, ‘active_operator’, ‘active_pose_bone’, ‘annotation_data’, ‘annotation_data_owner’, ‘area’, ‘bl_rna’, ‘blend_data’, ‘collection’, ‘copy’, ’edit_object’, ’editable_bones’, ’editable_fcurves’, ’editable_gpencil_layers’, ’editable_gpencil_strokes’, ’editable_objects’, ’engine’, ’evaluated_depsgraph_get’, ‘gizmo_group’, ‘gpencil_data’, ‘gpencil_data_owner’, ‘image_paint_object’, ’layer_collection’, ‘mode’, ‘object’, ‘objects_in_mode’, ‘objects_in_mode_unique_data’, ‘particle_edit_object’, ‘pose_object’, ‘preferences’, ‘region’, ‘region_data’, ‘rna_type’, ‘scene’, ‘screen’, ‘sculpt_object’, ‘selectable_objects’, ‘selected_bones’, ‘selected_editable_bones’, ‘selected_editable_fcurves’, ‘selected_editable_objects’, ‘selected_editable_sequences’, ‘selected_nla_strips’, ‘selected_objects’, ‘selected_pose_bones’, ‘selected_pose_bones_from_active_object’, ‘selected_sequences’, ‘selected_visible_fcurves’, ‘sequences’, ‘space_data’, ’tool_settings’, ‘vertex_paint_object’, ‘view_layer’, ‘visible_bones’, ‘visible_fcurves’, ‘visible_gpencil_layers’, ‘visible_objects’, ‘visible_pose_bones’, ‘weight_paint_object’, ‘window’, ‘window_manager’, ‘workspace’]

界面布局layout就不细说了，prop和operator两个控件用的比较多，前者用于显示各种属性值，后者就是一个按钮，按下可以执行关联的的api，这两个控件也不细说了，可以查阅api文档。

自定义方法

到目前位置我们还只能调用blender已有的属性和方法的api，我们实现自己的功能必然需要新建一个自己的api，同样新建api也是新写一个类，如下所示，继承bpy.types.Operator，然后定义bl_idname等内容，执行的具体代码在execute()函数中编写，同样这个类写完后记得注册后才能调用。

class PointsImport(bpy.types.Operator):
 bl_idname = 'obj.import_points'
 bl_label = '导入点云'
 bl_options = {'REGISTER', 'UNDO'}

 def execute(self, context):
 print('我的代码')
 return {'FINISHED'}

调用的方法是在界面类里调用layout.operator("obj.import_points")，可以看到，bl_idname 就是注册后api的名字。

自定义变量

除了自定义方法，有时候我们还需要自定义变量，可以参考文档 https://docs.blender.org/api/current/bpy.props.html 这一节，就是在方法的类中通过bpy.props.FloatProperty等函数定义变量，调用的时候需要将实例赋值给一个变量，然后通过变量去调用和修改，可以参考文档的示例代码。

有时候我们希望从界面视图中输入一个值，然后将这个值作为自定义api的一个输入参数，如果在界面中直接调用我们创建的方法的属性变量，你就会发现在界面中这个值只能显示出来而不能修改。

要想获得一个可以在界面中修改的属性，需要在blender的data中创建一个数据，方法如下，在Scene中加入了一个变量，或者在WindowManager中添加一个变量，当然在其他数据块中添加变量也可以，添加的变量可以在blender api data面板中进行查看。

bpy.types.Scene.points_name = bpy.props.StringProperty()
bpy.types.WindowManager.points_name = bpy.props.StringProperty()

然后将这个值再赋值给方法的属性就可以了，参考我的下面代码。

class MyPanel(bpy.types.Panel):
 bl_label = "面板" # 面板显示的名称
 bl_idname = "MY_PT_Import" # 面板的id，每个面版类的id应保持唯一，建议格式大写NAME_PT_id
 bl_space_type = "VIEW_3D" # 面板所处的模式，"VIEW_3D"=3D视窗
 bl_region_type = "UI" # 面板所在的位置，"UI"=N面板
 bl_category = "点云" # 面板所在的标签页

 bpy.types.Scene.points_name = bpy.props.StringProperty(default='yp')
 bpy.types.Scene.points_file_path = bpy.props.StringProperty(
 default=r'C:\Users\kizx\Desktop\Projects\cv\ypa.npy', subtype='FILE_PATH')

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

 row = layout.row()
 row.prop(context.scene, "points_name", text="名称")
 row = layout.row()
 row.prop(context.scene, "points_file_path", text="点云文件")
 row = layout.row()
 pc = row.operator("obj.import_points")
 pc.path = context.scene.points_file_path
 pc.name = context.scene.points_name

blender脚本python代码自动补全方法

Wed, 19 Aug 2020 12:13:16 +0000

只要安装fake-bpy-module这个模块就可以实现代码自动补全了，正如其名，这个库只用于代码提示补全作用，并不具备任何实质可运行代码。

pip安装

如果你编程时使用的是自己的python坏境，那么使用以下的pip命令安装即可。

pip install fake-bpy-module- <version>
# version: 2.78|2.79|2.80|2.81|2.82|2.83
# e.g.
pip install fake-bpy-module-2.80

手动安装

如果你用的是blender自带的python坏境，不好用pip进行安装，此时只能手动安装了。

vscode

从 https://github.com/nutti/fake-bpy-module/releases 页面下载对应版本的包并解压，打开vscode，Ctrl+Shift+P搜索Settings打开工作区设置（打开设置文件setting.json），设置以下内容，其中填写刚才解压的路径。

{
"python.autoComplete.extraPaths": [
"<path-to-generated-modules>"
]
}

保存后重启vscode就行了。

pycharm

日后补充

参考

https://github.com/nutti/fake-bpy-module

在vscode中开发blender插件和脚本

Tue, 18 Aug 2020 14:50:00 +0000

用blender内置的文本编辑器来编写代码体验实在是太糟糕了，利用JacquesLucke大神编写的vscode插件Blender Development就可以开心的在vscode里编写代码了。打开vscode在插件市场里搜索Blender Development安装即可，该插件依赖于python和C/C++插件，安装时会自动安装依赖，如果没有安装请手动安装。

使用

插件

ctrl+shift+P打开控制台，输入blender就能看到本插件的所有命令，点击Blender: New Addon，弹出模板选项，可以选择Simple简单模板或者WithAutoLoad模板。然后输入插件名和作者名，最后给插件选择一个目录，一个插件模板就新建成功了。

如果你选的是Simple模板，那么就只会生成一个__init__.py，如果你选择的是WithAutoLoad模板，会生成__init__.py、auto_load.py、operators.py三个文件，两个模板的主要区别在于后者会自动注册register()和注销unregister()operators.py中的类，当然我们我们自己写一下注册方法也不是多麻烦。

代码有了，下面就是如何联合blender了，我们都知道blender里自带一个python解释器，首先我们应该在vscode中点击左下角的python解释器选择blender安装文件夹里的python.exe作为解释器，这个路径一般形如 \blender-2.83.0-windows64\2.83\python\bin\python.exe。当然你不用blender自带的解释器也行，但是需要在vscode设置里打开blender.allowModifyExternalPython，允许后面自动下载依赖库。

然后ctrl+shift+P打开控制台，搜索执行Blender: Start命令，这时选择你的blender.exe，一切正常的话，程序会自动下载ptvsd、flask、requests几个库，所以第一次启动会慢点，如果你卡在这里的话，一般是网络原因，请尝试更新pip、更换pip镜像源，再不济手动安装这些库。

[post cid=“156” cover=“http://”/]

启动blender后，打开N面板有一个Dev的面板就说明成功了。

保存自动刷新

当我们更改代码后，我们总是希望已保存代码blender那边就立马更新，只需要在vscode设置里打开blender.addon.reloadOnSave即可。

脚本

插件还提供了快速脚本功能，脚本就是类似于直接在blender交互式命令行直接输入命令，不用像写插件一样那么麻烦了，ctrl+shift+P打开控制台选择Blender: New Script就可以新建一个脚本，然后通过Blender: Start打开blender，运行脚本用Blender: Run Script命令，不过我测试了下这个脚本命令写的一不留神一运行就闪退了，感觉不如在blender的文本编辑器里好用。

更改上下文

有时脚本需要特定的模式下，通过Blender: Set Script Context命令可以设置形如#context.area: VIEW_3D的注释来达到控制上下文的作用。

Debug

用vscode的一大好处在于可以打断点进行debug，这些都是vscode的基本操作就不说了。

后记

vscode插件更新到0.0.15版本后，只能适配blender2.92及以上版本，如果还用小于2.92的版本，就需要安装0.0.14版本的插件，并禁用vscode插件自动更新功能。

参考

https://github.com/JacquesLucke/blender_vscode

https://www.bilibili.com/video/BV1EJ41187hT