Blender Python 編程

支持的特性：

• 編輯用戶界面可以編輯的任何數(shù)據(jù)(場(chǎng)景，網(wǎng)格，粒子等)。
• 修改用戶首選項(xiàng)、鍵映射和主題。
• 使用自己的設(shè)置運(yùn)行工具。
• 創(chuàng)建用戶界面元素，如菜單、標(biāo)題和面板。
• 創(chuàng)建新的工具。
• 創(chuàng)建交互式工具。
• 創(chuàng)建與 Blender 集成的新渲染引擎。
• 訂閱對(duì)數(shù)據(jù)及其屬性的更改。
• 在現(xiàn)有的 Blender 數(shù)據(jù)中定義新設(shè)置。
• 使用 Python 繪制3D視圖。

(仍然)缺失的特性:

• 創(chuàng)建新的空間類型。
• 為每個(gè)類型分配自定義屬性。

數(shù)據(jù)訪問(wèn)

Python 以與動(dòng)畫系統(tǒng)和用戶界面相同的方式訪問(wèn) Blender 的數(shù)據(jù)。這意味著可以通過(guò)按鈕更改的任何設(shè)置也可以從 Python 更改。

使用模塊可以完成從當(dāng)前加載的 Blender 文件訪問(wèn)數(shù)據(jù)的操作 bpy.data 。這樣就可以訪問(wèn)庫(kù)數(shù)據(jù)。例如：

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

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

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

訪問(wèn)集合

您會(huì)注意到索引和字符串都可以用來(lái)訪問(wèn)集合的成員。與 Python 字典不同，這兩種方法都是可用的; 但是，在運(yùn)行 Blender 時(shí)，成員的索引可能會(huì)改變。

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"]

訪問(wèn)屬性

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

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

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

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

對(duì)于測(cè)試要訪問(wèn)哪些數(shù)據(jù)，使用 Python Console 是很有用的，它是自己的空間類型。這支持自動(dòng)完成，為您提供了一種快速探索文件中的數(shù)據(jù)的方法。

可以通過(guò)控制臺(tái)快速找到的數(shù)據(jù)路徑示例:

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

數(shù)據(jù)創(chuàng)建/刪除

當(dāng)你熟悉其他 Python API 時(shí)，你可能會(huì)驚訝于 bpy API 中新的數(shù)據(jù)塊不能通過(guò)調(diào)用類來(lái)創(chuàng)建:

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 數(shù)據(jù)庫(kù)（bpy.data訪問(wèn)的那個(gè)）外的任何地方新建數(shù)據(jù)，因?yàn)檫@些數(shù)據(jù)是由 Blender 管理的(保存、加載、撤銷、追加等)。

而只能使用以下方法進(jìn)行數(shù)據(jù)增刪：

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

bpy.data.meshes.remove(mesh)

自定義屬性

Python 可以訪問(wèn)具有 ID 的任何數(shù)據(jù)塊上的屬性。當(dāng)分配屬性時(shí)候，如果該屬性本不存在，就會(huì)新建該屬性。

這些屬性同樣保存在 Blender 文件中，并隨著對(duì)象一同繼承或者復(fù)制。

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 數(shù)據(jù)類型。如：

• int/float/string
• int/ float 的數(shù)組
• 字典（僅支持字符串鍵，值也必須是基本類型）

自定義屬性在 Python 外部同樣有效。它們可以通過(guò)曲線設(shè)置動(dòng)畫或在驅(qū)動(dòng)路徑中使用。

上下文 Context

能夠直接通過(guò)名稱或列表訪問(wèn)數(shù)據(jù)非常有用，但更常見(jiàn)的是根據(jù)用戶的選擇進(jìn)行操作。這些上下文信息始終可從 bpy.context 中獲得。

常用案例：

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

請(qǐng)注意，上下文是只讀的。這些值不能直接修改，盡管可以通過(guò)運(yùn)行 API 函數(shù)或使用數(shù)據(jù) API 進(jìn)行更改。

因此這樣會(huì)引發(fā)錯(cuò)誤：bpy.context.object = obj

但是這樣會(huì)正常工作：bpy.context.scene.objects.active = obj

運(yùn)算符 Operators (Tools)

Operators 通常是用戶從按鈕、菜單項(xiàng)或快捷鍵訪問(wèn)的工具。從用戶的角度來(lái)看，它們是一個(gè)工具，但是 Python 可以通過(guò) bpy.ops 模塊訪問(wèn)、設(shè)置并運(yùn)行他們。

舉例：

bpy.ops.mesh.flip_normals()
{'FINISHED'}
>>> bpy.ops.mesh.hide(unselected=False)
{'FINISHED'}
>>> bpy.ops.object.transform_apply()
{'FINISHED'}

Operator Cheat Sheet 給出了 Python 語(yǔ)法中所有操作符及其默認(rèn)值的列表，以及生成的文檔。這是一個(gè)了解 Blender 所有操作符的好方法。

Operator Poll()

許多的 Operators 都有自己的 Poll() 方法，該方法能檢查現(xiàn)在的 Blender 上下文是否滿足該 Operator 運(yùn)行的條件。不滿足時(shí)，直接調(diào)用該 Operator 將會(huì)產(chǎn)生錯(cuò)誤。所以在操作一個(gè) Operators 的時(shí)候，建議先用一下方式檢查 context：

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

將 Python 集成到 Blender 的方式

Python 腳本可以通過(guò)以下方式與 Blender 集成：

• 通過(guò)定義渲染引擎。
• 通過(guò)定義運(yùn)算符。
• 通過(guò)定義菜單，標(biāo)題和面板。
• 通過(guò)將新按鈕插入現(xiàn)有菜單，標(biāo)題和面板

在 Python 中，這是通過(guò)定義一個(gè)類來(lái)完成的，該類是現(xiàn)有類型的子類。

Blender 官方文檔中提供了實(shí)例的類模板。如：

示例運(yùn)算符

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()

一旦這個(gè)腳本運(yùn)行，SimpleOperator 在 Blender 中注冊(cè)，可以從 Operator Search 中調(diào)用或添加到工具欄中。

運(yùn)行腳本:

• 啟動(dòng) Blender 并切換到腳本工作區(qū)。
• 單擊文本編輯器中的 New 按鈕以創(chuàng)建新的文本數(shù)據(jù)塊。
• 從上面并將其粘貼到文本編輯器中。
• 單擊 Run Script 按鈕。
• 將光標(biāo)移至 3D 視口，打開運(yùn)算符搜索菜單，輸入 “Simple”。
• 點(diǎn)擊搜索中找到的 “SimpleOperator” 項(xiàng)目。

示例面板

面板注冊(cè)為一個(gè)類，就像操作符一樣。請(qǐng)注意用于設(shè)置它們所顯示的上下文的額外 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()

運(yùn)行腳本:

• 啟動(dòng) Blender 并切換到腳本工作區(qū)。
• 單擊文本編輯器中的 New 按鈕以創(chuàng)建新的文本數(shù)據(jù)塊。
• 從上面并將其粘貼到文本編輯器中。
• 單擊 Run Script 按鈕。

要查看結(jié)果:

• 選擇默認(rèn)立方體。
• 點(diǎn)擊按鈕面板中的對(duì)象屬性圖標(biāo)(最右邊;出現(xiàn)為一個(gè)小立方體)。
• 向下滾動(dòng)查看名為 “Hello World Panel” 的面板。
• 更改對(duì)象名稱也會(huì)更新 Hello World Panel 的 name:字段。

請(qǐng)注意通過(guò)代碼定義的行分布以及標(biāo)簽和屬性。

數(shù)據(jù)類型

Blender 定義了許多 Python 類型，但也使用 Python 本機(jī)類型。

原生類型

在簡(jiǎn)單的情況下，將數(shù)字或字符串作為自定義類型會(huì)很麻煩，因此可以將它們作為普通的 Python 類型進(jìn)行訪問(wèn)。

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

>>> C.object.rotation_mode = 'AXIS_ANGLE'

• Blender枚舉器（多個(gè)）->字符串集

# 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!")

內(nèi)部類型

用于 Blender 數(shù)據(jù)塊和 Blender 集合： bpy.types.bpy_struct

用于包含 collections/meshes/bones/scenes 等屬性的數(shù)據(jù)。

包裝 Blenders 數(shù)據(jù)的主要類型有 2 種，

• 一種用于數(shù)據(jù)塊（內(nèi)部稱為 bpy_struct）

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

• 另一種用于屬性。

>>> C.scene.objects
bpy.data.scenes['Scene'].objects

Mathutils 類型

用于表示向量，四元數(shù)，euler，矩陣和顏色類型等，可從 mathutils 模塊訪問(wèn)它們。

一些屬性，如 bpy.types.Object.location, bpy.types.PoseBone.rotation_euler 和 bpy.types.Scene.Cursor_location 可以作為特殊的數(shù)學(xué)類型訪問(wèn)，這些類型可以一起使用并以各種有用的方式進(jìn)行操作。

例如，矩陣向量的乘法

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

注意：mathutils 類型保留對(duì) Blender 內(nèi)部數(shù)據(jù)的引用，這樣更改就可以應(yīng)用回來(lái)。

舉個(gè)例子

# 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()

動(dòng)畫

有兩種方法可以通過(guò) Python 添加關(guān)鍵幀。

• 第一種是直接通過(guò)鍵屬性，這類似于用戶從按鈕插入關(guān)鍵幀。
• 您也可以手動(dòng)創(chuàng)建曲線和關(guān)鍵幀數(shù)據(jù)，然后將路徑設(shè)置為屬性。

這是這兩種方法的示例。這兩個(gè)示例都在活動(dòng)對(duì)象的 Z 軸上插入關(guān)鍵幀。

簡(jiǎn)單的例子：

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)

使用低級(jí)功能：

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編程快速入門教程的詳細(xì)內(nèi)容，更多關(guān)于Blender Python編程入門的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

最新評(píng)論