アクティブオブジェクとは
Blenderのアクティブオブジェクトは、処理対象あるいは処理結果のオブジェクトです。
Pythonでは、現在のコンテキスト（bpy.context）を使って、通常、下記の3通りの方法で取得できます。
| コード | 意味 |
|---|---|
| bpy.context.active_object | アクティブオブジェクト |
| bpy.context.object | コンテキストのオブジェクト |
| bpy.context.view_layer.objects.active | アクティブオブジェクト |
ここでは、この3つの違いを紹介します。
準備
Blenderを起動して、立方体（Cube）とUV球（Sphere）を作成し、Sphereを選択してください。
ワークスペースをScriptingにして、右下のプロパティ画面を「オブジェクトプロパティ」（オレンジの四角）にして、右上のピンをチェックしてください。
ピン止めすると、選択を変えてもプロパティ画面の対象のオブジェクトが固定されます。
アクティブオブジェクトの設定
contextをコンテキストとします。
アクティブオブジェクトを設定するには、context.view_layer.objects.activeを使います。
他の方法では設定できません。下記で確認できます。
import bpy
obj = bpy.data.objects["Cube"]
context = bpy.context
# アクティブオブジェクトの設定
context.view_layer.objects.active = obj
# 失敗することを確認
try:
context.active_object = obj
except AttributeError as e:
print(e)
try:
context.object = obj
except AttributeError as e:
print(e)
出力
bpy_struct: Context property "active_object" is read-only
bpy_struct: Context property "object" is read-only
出力から、active_objectとobjectが、read-onlyということがわかります。
context.view_layer.objects.activeはエラーになっていないので、アクティブオブジェクトはCubeになっています。
コンテキストを変えて確認
厳密に言うと、context.objectはコンテキストのオブジェクトです。コンテキストはパネルなどの画面ごとに異なるので、特殊な場合にcontext.objectはアクティブオブジェクトではありません。
下記を実行して確認してみましょう。下記では一時的にコンテキストを変更しています。
import bpy
# プロパティ画面の取得
area = [area for area in bpy.context.screen.areas if area.ui_type == "PROPERTIES"][0]
# プロパティ画面での3通りの方法の確認
with bpy.context.temp_override(area=area):
context = bpy.context
print(f"{context.active_object = }")
print(f"{context.object = }")
print(f"{context.view_layer.objects.active = }")
出力
context.active_object = bpy.data.objects['Cube']
context.object = bpy.data.objects['Sphere']
context.view_layer.objects.active = bpy.data.objects['Cube']
アクティブオブジェクトはCubeですが、context.objectはSphereです。
理由は、contextが、プロパティ画面のコンテキストだからです。
プロパティ画面は、準備でSphereをピン止めしたので、コンテキストのオブジェクトがSphereになっています。
Sphereはアクティブオブジェクトではありませんが、コンテキストのオブジェクトなのでこのようになります。
アドオン開発では、bpy.contextではなく、メソッドの引数であるcontextを使うことが推奨されています。そして、contextを使うとcontext.objectがアクティブオブジェクトでない可能性があります。したがってアクティブオブジェクトを取得するには、context.active_objectを使うのが無難です。
まとめ
contextを現在のコンテキストとします。
- アクティブオブジェクトの取得は、
context.active_objectを使う。 - アクティブオブジェクトの設定は、
context.view_layer.objects.activeを使う。
参考
以上