Blender Python程式設計快速入門教學

2022-08-07 22:00:35

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程式設計入門的資料請關注it145.com其它相關文章！