Blender Python编程入门实例分析

Blender Python 编程

支持的特性：

编辑用户界面可以编辑的任何数据(场景，网格，粒子等)。
修改用户首选项、键映射和主题。
使用自己的设置运行工具。
创建用户界面元素，如菜单、标题和面板。
创建新的工具。
创建交互式工具。
创建与 Blender 集成的新渲染引擎。
订阅对数据及其属性的更改。
在现有的 Blender 数据中定义新设置。
使用 Python 绘制3D视图。

(仍然)缺失的特性:

创建新的空间类型。
为每个类型分配自定义属性。

数据访问

Python 以与动画系统和用户界面相同的方式访问 Blender 的数据。这意味着可以通过按钮更改的任何设置也可以从 Python 更改。

使用模块可以完成从当前加载的 Blender 文件访问数据的操作 bpy.data 。这样就可以访问库数据。例如：

>>> bpy.data.objects
<bpy_collection[3], BlendDataObjects>

>>> bpy.data.scenes
<bpy_collection[1], BlendDataScenes>

>>> bpy.data.materials
<bpy_collection[1], BlendDataMaterials>

访问集合

您会注意到索引和字符串都可以用来访问集合的成员。与 Python 字典不同，这两种方法都是可用的; 但是，在运行 Blender 时，成员的索引可能会改变。

list(bpy.data.objects)
[bpy.data.objects["Cube"], bpy.data.objects["Plane"]]

>>> bpy.data.objects[&#39;Cube&#39;]
bpy.data.objects["Cube"]

>>> bpy.data.objects[0]
bpy.data.objects["Cube"]

访问属性

一旦你有了一个数据块，比如一个材料、对象、集合等，它的属性就可以被访问，就像使用图形界面更改设置一样。事实上，每个按钮的工具提示还显示了 Python 属性，它可以帮助查找在脚本中更改哪些设置。

bpy.data.objects[0].name
&#39;Camera&#39;

>>> bpy.data.scenes["Scene"]
bpy.data.scenes[&#39;Scene&#39;]

>>> bpy.data.materials.new("MyMaterial")
bpy.data.materials[&#39;MyMaterial&#39;]

对于测试要访问哪些数据，使用 Python Console 是很有用的，它是自己的空间类型。这支持自动完成，为您提供了一种快速探索文件中的数据的方法。

可以通过控制台快速找到的数据路径示例:

bpy.data.scenes[0].render.resolution_percentage
100
>>> bpy.data.scenes[0].objects["Torus"].data.vertices[0].co.x
1.0

数据创建/删除

当你熟悉其他 Python API 时，你可能会惊讶于 bpy API 中新的数据块不能通过调用类来创建:

bpy.types.Mesh()
Traceback (most recent call last):
  File "<blender_console>", line 1, in <module>
TypeError: bpy_struct.__new__(type): expected a single argument

用户不能在 Blender 数据库（bpy.data访问的那个）外的任何地方新建数据，因为这些数据是由 Blender 管理的(保存、加载、撤销、追加等)。

而只能使用以下方法进行数据增删：

mesh = bpy.data.meshes.new(name="MyMesh")
>>> print(mesh)
<bpy_struct, Mesh("MyMesh.001")>

bpy.data.meshes.remove(mesh)

自定义属性

Python 可以访问具有 ID 的任何数据块上的属性。当分配属性时候，如果该属性本不存在，就会新建该属性。

这些属性同样保存在 Blender 文件中，并随着对象一同继承或者复制。

bpy.context.object["MyOwnProperty"] = 42
if "SomeProp" in bpy.context.object:
    print("Property found")
# Use the get function like a Python dictionary
# which can have a fallback value.
value = bpy.data.scenes["Scene"].get("test_prop", "fallback value")
# dictionaries can be assigned as long as they only use basic types.
collection = bpy.data.collections.new("MyTestCollection")
collection["MySettings"] = {"foo": 10, "bar": "spam", "baz": {}}
del collection["MySettings"]

但是，这些自定义属性的值必须是基本的 Python 数据类型。如：

int/float/string
int/ float 的数组
字典（仅支持字符串键，值也必须是基本类型）

自定义属性在 Python 外部同样有效。它们可以通过曲线设置动画或在驱动路径中使用。

上下文 Context

能够直接通过名称或列表访问数据非常有用，但更常见的是根据用户的选择进行操作。这些上下文信息始终可从 bpy.context 中获得。

常用案例：

>>> bpy.context.object
>>> bpy.context.selected_objects
>>> bpy.context.visible_bones

请注意，上下文是只读的。这些值不能直接修改，尽管可以通过运行 API 函数或使用数据 API 进行更改。

因此这样会引发错误：bpy.context.object = obj

但是这样会正常工作：bpy.context.scene.objects.active = obj

运算符 Operators (Tools)

Operators 通常是用户从按钮、菜单项或快捷键访问的工具。从用户的角度来看，它们是一个工具，但是 Python 可以通过 bpy.ops 模块访问、设置并运行他们。

举例：

bpy.ops.mesh.flip_normals()
{&#39;FINISHED&#39;}
>>> bpy.ops.mesh.hide(unselected=False)
{&#39;FINISHED&#39;}
>>> bpy.ops.object.transform_apply()
{&#39;FINISHED&#39;}

Operator Cheat Sheet 给出了 Python 语法中所有操作符及其默认值的列表，以及生成的文档。这是一个了解 Blender 所有操作符的好方法。

Operator Poll()

许多的 Operators 都有自己的 Poll() 方法，该方法能检查现在的 Blender 上下文是否满足该 Operator 运行的条件。不满足时，直接调用该 Operator 将会产生错误。所以在操作一个 Operators 的时候，建议先用一下方式检查 context：

if bpy.ops.view3d.render_border.poll():
    bpy.ops.view3d.render_border()

将 Python 集成到 Blender 的方式

Python 脚本可以通过以下方式与 Blender 集成：

通过定义渲染引擎。
通过定义运算符。
通过定义菜单，标题和面板。
通过将新按钮插入现有菜单，标题和面板

在 Python 中，这是通过定义一个类来完成的，该类是现有类型的子类。

Blender 官方文档中提供了实例的类模板。如：

示例运算符

import bpy
def main(context):
    for ob in context.scene.objects:
        print(ob)
class SimpleOperator(bpy.types.Operator):
    """Tooltip"""
    bl_idname = "object.simple_operator"
    bl_label = "Simple Object Operator"
    @classmethod
    def poll(cls, context):
        return context.active_object is not None
    def execute(self, context):
        main(context)
        return {&#39;FINISHED&#39;}
def register():
    bpy.utils.register_class(SimpleOperator)
def unregister():
    bpy.utils.unregister_class(SimpleOperator)
if __name__ == "__main__":
    register()
# test call
bpy.ops.object.simple_operator()

一旦这个脚本运行，SimpleOperator 在 Blender 中注册，可以从 Operator Search 中调用或添加到工具栏中。

运行脚本:

启动 Blender 并切换到脚本工作区。
单击文本编辑器中的 New 按钮以创建新的文本数据块。
从上面并将其粘贴到文本编辑器中。
单击 Run Script 按钮。
将光标移至 3D 视口，打开运算符搜索菜单，输入 “Simple”。
点击搜索中找到的 “SimpleOperator” 项目。

示例面板

面板注册为一个类，就像操作符一样。请注意用于设置它们所显示的上下文的额外 bl_ 变量。

import bpy
class HelloWorldPanel(bpy.types.Panel):
    """Creates a Panel in the Object properties window"""
    bl_label = "Hello World Panel"
    bl_idname = "OBJECT_PT_hello"
    bl_space_type = &#39;PROPERTIES&#39;
    bl_region_type = &#39;WINDOW&#39;
    bl_context = "object"
    def draw(self, context):
        layout = self.layout
        obj = context.object
        row = layout.row()
        row.label(text="Hello world!", icon=&#39;WORLD_DATA&#39;)
        row = layout.row()
        row.label(text="Active object is: " + obj.name)
        row = layout.row()
        row.prop(obj, "name")
        row = layout.row()
        row.operator("mesh.primitive_cube_add")
def register():
    bpy.utils.register_class(HelloWorldPanel)
def unregister():
    bpy.utils.unregister_class(HelloWorldPanel)
if __name__ == "__main__":
    register()

运行脚本:

启动 Blender 并切换到脚本工作区。
单击文本编辑器中的 New 按钮以创建新的文本数据块。
从上面并将其粘贴到文本编辑器中。
单击 Run Script 按钮。

要查看结果:

选择默认立方体。
点击按钮面板中的对象属性图标(最右边;出现为一个小立方体)。
向下滚动查看名为 “Hello World Panel” 的面板。
更改对象名称也会更新 Hello World Panel 的 name:字段。

请注意通过代码定义的行分布以及标签和属性。

数据类型

Blender 定义了许多 Python 类型，但也使用 Python 本机类型。

原生类型

在简单的情况下，将数字或字符串作为自定义类型会很麻烦，因此可以将它们作为普通的 Python 类型进行访问。

Blender float / int / boolean-> float / int / boolean
Blender 枚举器->字符串

>>> C.object.rotation_mode = &#39;AXIS_ANGLE&#39;

Blender枚举器（多个）->字符串集

# setting multiple camera overlay guides
bpy.context.scene.camera.data.show_guide = {&#39;GOLDEN&#39;, &#39;CENTER&#39;}
# passing as an operator argument for report types
self.report({&#39;WARNING&#39;, &#39;INFO&#39;}, "Some message!")

内部类型

用于 Blender 数据块和 Blender 集合： bpy.types.bpy_struct

用于包含 collections/meshes/bones/scenes 等属性的数据。

包装 Blenders 数据的主要类型有 2 种，

一种用于数据块（内部称为 bpy_struct）

>>> bpy.context.object
bpy.data.objects[&#39;Cube&#39;]

另一种用于属性。

>>> C.scene.objects
bpy.data.scenes[&#39;Scene&#39;].objects

Mathutils 类型

用于表示向量，四元数，euler，矩阵和颜色类型等，可从 mathutils 模块访问它们。

一些属性，如 bpy.types.Object.location, bpy.types.PoseBone.rotation_euler 和 bpy.types.Scene.Cursor_location 可以作为特殊的数学类型访问，这些类型可以一起使用并以各种有用的方式进行操作。

例如，矩阵向量的乘法

bpy.context.object.matrix_world @ bpy.context.object.data.verts[0].co

注意：mathutils 类型保留对 Blender 内部数据的引用，这样更改就可以应用回来。

举个例子

# modifies the Z axis in place.
bpy.context.object.location.z += 2.0
# location variable holds a reference to the object too.
location = bpy.context.object.location
location *= 2.0
# Copying the value drops the reference so the value can be passed to
# functions and modified without unwanted side effects.
location = bpy.context.object.location.copy()

动画

有两种方法可以通过 Python 添加关键帧。

第一种是直接通过键属性，这类似于用户从按钮插入关键帧。
您也可以手动创建曲线和关键帧数据，然后将路径设置为属性。

这是这两种方法的示例。这两个示例都在活动对象的 Z 轴上插入关键帧。

简单的例子：

obj = bpy.context.object
obj.location[2] = 0.0
obj.keyframe_insert(data_path="location", frame=10.0, index=2)
obj.location[2] = 1.0
obj.keyframe_insert(data_path="location", frame=20.0, index=2)

使用低级功能：

obj = bpy.context.object
obj.animation_data_create()
obj.animation_data.action = bpy.data.actions.new(name="MyAction")
fcu_z = obj.animation_data.action.fcurves.new(data_path="location", index=2)
fcu_z.keyframe_points.add(2)
fcu_z.keyframe_points[0].co = 10.0, 0.0
fcu_z.keyframe_points[1].co = 20.0, 1.0

以上就是Blender Python编程入门实例分析的详细内容，更多请关注其它相关文章！