Blender Python編程快速入門教程

Posted on 2022-08-07 by WalkonNet

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['Cube']
bpy.data.objects["Cube"]

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

訪問屬性

一旦你有瞭一個數據塊，比如一個材料、對象、集合等，它的屬性就可以被訪問，就像使用圖形界面更改設置一樣。事實上，每個按鈕的工具提示還顯示瞭 Python 屬性，它可以幫助查找在腳本中更改哪些設置。

bpy.data.objects[0].name
'Camera'

>>> bpy.data.scenes["Scene"]
bpy.data.scenes['Scene']

>>> bpy.data.materials.new("MyMaterial")
bpy.data.materials['MyMaterial']

對於測試要訪問哪些數據，使用 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()
{'FINISHED'}
>>> bpy.ops.mesh.hide(unselected=False)
{'FINISHED'}
>>> bpy.ops.object.transform_apply()
{'FINISHED'}

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 {'FINISHED'}
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 = 'PROPERTIES'
    bl_region_type = 'WINDOW'
    bl_context = "object"
    def draw(self, context):
        layout = self.layout
        obj = context.object
        row = layout.row()
        row.label(text="Hello world!", icon='WORLD_DATA')
        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 = 'AXIS_ANGLE'

Blender枚舉器（多個）->字符串集

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

內部類型

用於 Blender 數據塊和 Blender 集合： bpy.types.bpy_struct

用於包含 collections/meshes/bones/scenes 等屬性的數據。

包裝 Blenders 數據的主要類型有 2 種，

一種用於數據塊（內部稱為 bpy_struct）

>>> bpy.context.object
bpy.data.objects['Cube']

另一種用於屬性。

>>> C.scene.objects
bpy.data.scenes['Scene'].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編程快速入門教程的詳細內容，更多關於Blender Python編程入門的資料請關註WalkonNet其它相關文章！

Blender Python編程快速入門教程

目錄