オーサリング API¶
オーサリング API は、pme パッケージとその pme.editing モジュールを通じて、
Python から PME のメニューを作成・読み取り・編集・書き出しします。
Python Console、Text Editor、ほかのアドオン、Blender を操作する AI エージェントから呼び出します。
スロットの中(Command、Custom、Poll)に書くコードは別の話題で、スクリプティング で説明します。
ページ一覧¶
各ページは単独で読めます。基本事項 と 結果とガード は、 すべての編集関数が従う規則を定めます。API 全体が Experimental です。
ページ |
扱う内容 |
|---|---|
編集関数を実行できる場所、対象、行わないこと、安定している範囲。 |
|
操作ごとの |
|
メニューの作成・検索・一覧・呼び出し・読み取り・改名・有効化・タグ付け・複製・削除と、 メニューを参照している箇所の検索。 |
|
スロット入力の読み取りと、 スロットの編集・消去・追加・削除・移動・入れ替え・移送。 |
|
Pop-up Dialog と Floating Panel の行、spacer、揃え、Layout Panel。 |
|
Pop-up Dialog の Mode や幅など、メニューの種類が持つ設定。 |
|
メニューのホットキー割り当ての読み取りと変更。 |
|
Property の作成(型、引数、Enum 項目、コールバック、保存先、Property ID)。 |
|
Property Stack の作成と、条件行の編集。 |
|
Context Router の分岐の追加・更新・削除・並べ替え。 |
|
メニューを PME の JSON 文書として書き出す処理と、文書の検証。 |
|
登録済みのスクリプトとアイコンの場所、スクリプト参照の確認。 |
|
コードの実行、ユーザープロパティの読み書き、実行中のアドオンパッケージの特定、 UID の形式の確認。 |
実行中の API を読み込む¶
例では import pme を使います。これは 起動オプション で設定する任意の短縮エイリアスです。
エイリアスが無効な場合は、有効化済みアドオンのパッケージを名前で読み込みます。
起動設定の変更も Blender の再読み込みも不要です。
import bpy
import importlib
packages = [
addon.module for addon in bpy.context.preferences.addons
if addon.module.rsplit(".", 1)[-1].replace("-", "_") == "pie_menu_editor"
]
if len(packages) != 1:
raise RuntimeError(f"Select the enabled PME package: {packages}")
pme = importlib.import_module(packages[0] + ".api")
print(pme.ADDON_ID)
このコードは、
bl_ext.<repository>.pie_menu_editorとしてインストールした Blender Extension と、 Extension ID にハイフンを使うもの(bl_ext.<repository>.pie-menu-editor)も見つけます。 モジュール名はリポジトリの ID に従うため、比較ではハイフンとアンダースコアの違いを無視します。複数のパッケージが該当する場合は、編集の前に目的のインストール先を特定します。 このコードは、その一覧を付けて
RuntimeErrorを送出します。明示的な読み込みで得た
pme変数は、エイリアスと同じ API です。 この変数を使うコードではimport pmeを省きます。
クイックスタート¶
import pme
# Runtime package identity (Legacy add-on or Blender Extension)
addon_id = pme.ADDON_ID
# Find a menu
pm = pme.find_pm("My Pie Menu")
pm = pme.find_pm(uid="pm_7f3c2k3h")
# Invoke a menu
pme.invoke_pm("My Pie Menu")
pme.invoke_pm(uid="pm_7f3c2k3h")
# List menus
all_menus = pme.list_pms()
pie_menus = pme.list_pms(mode="PMENU", enabled_only=True)
tags = pme.list_tags()
# Execute code
result = pme.execute("bpy.ops.mesh.primitive_cube_add()")
print(result.success, result.error_message)
# Evaluate an expression
value = pme.evaluate("len(C.selected_objects)")
# Validate JSON
result = pme.validate_json(json_string)
for err in result.errors:
print(err.code, err.message)
関数一覧¶
pme¶
関数 |
用途 |
ページ |
|---|---|---|
|
||
名前または UID で見つけたメニューの |
||
|
||
使用中のタグ名を Tag Registry の順で返します。 |
||
ホットキーと同じように、メニューの呼び出しを要求します。 |
||
メニューを PME の JSON 文書として書き出します。ファイルへの書き込みは任意です。 |
||
PME の JSON 文字列を静的に検証します。 |
||
文字列がメニュー UID の形式かどうかを返します。 |
||
PME の標準名前空間でコードを実行します。 |
||
PME の標準名前空間で式を評価します。失敗時は例外を送出します。 |
||
コードを実行せずに Python の構文を確認します。
|
||
PME が登録したユーザープロパティを読み書きします。 |
pme が公開するその他の名前:
名前 |
用途 |
ページ |
|---|---|---|
|
||
|
||
|
||
実行中のアドオンパッケージのモジュール ID。 |
||
PME のアドオン Preferences オブジェクト。
アドオンのエントリーがあり、PME の Preferences クラスがない間は |
||
PME1 の実行コンテキスト。後方互換のために残されています (後方互換)。 |
サブモジュール:
モジュール |
用途 |
ページ |
|---|---|---|
保存済みのメニュー定義を UID で読み取り・編集します。 関数の一覧は下にあります。 |
このページ |
|
PME JSON の静的検証( |
||
登録済みのスクリプトとアイコンのフォルダー・ファイルの読み取り専用の探索と、 スクリプト参照の確認。 |
||
|
結果とハンドルの型。 |
型ごと |
|
メニューの種類とスロットのモードの識別子( |
(なし) |
|
ツール作成者向けの名前空間のイントロスペクション( |
(なし) |
pme.editing¶
関数 |
用途 |
ページ |
|---|---|---|
メニューの名前、説明、説明の形式、Poll 本文を変更します。 |
||
一括操作の処理を通じて、メニューを有効または無効にします。 |
||
複数のメニューにまたがるタグ名の追加と解除を、1 回の一括処理で行います。 |
||
メニューを 1 つ、複製元の直後へ複製します。 |
||
メニューを削除します。または、削除とその参照を事前確認します。 |
||
メニューを参照している保存済みの箇所を列挙します。読み取り専用です。 |
||
1 つのメニューの保存定義を返します。スロット UID による絞り込みは任意です。 |
||
|
||
Slot Editor の入力フィールドの説明(名前、型、Enum の値)を返します。 |
||
各 Auto Icon スロットが、この Blender セッションでアイコンを見つけられるかを報告します。 読み取り専用です。 |
||
Slot Editor の通常の保存を通じて、スロット UID で指定したスロットの内容を変更します。 |
||
スロットの UID と位置を保ったまま、内容を消去します。 |
||
既定の項目を 1 件、スロットの隣、末尾、 または Panel ヘッダーに追加します。 |
||
項目を 1 件削除します。 |
||
項目を 1 件、別の項目の前後、行端、新しい行、 または Panel ヘッダーへ移動します。 |
||
固定枠の項目 2 件、または Pop-up の項目 2 件を入れ替えます。 |
||
項目 1 件の内容を別のメニューへ移します。 |
||
既定のボタンを持つレイアウト行を追加します。 |
||
既定のアンカーを持つ Layout Panel 行を追加します。 |
||
レイアウト行全体を、その内容とともに削除します。 |
||
レイアウト行全体を別の行の前後へ移動します。 |
||
レイアウト行を、その中の項目の直前で分割します。 |
||
隣接する 2 つのレイアウト行を結合します。 |
||
1 行、揃えでつながった行群、またはすべての行について、 保存された行設定を変更します。 |
||
spacer の設定を 1 つ変更します。必要なときは隣接する spacer を作成します。 |
||
項目を行の LEFT、CENTER、RIGHT の区分に配置します。または配置を解除します。 |
||
メニューの種類が受け付ける設定の説明を返します。 |
||
メニューの種類の設定を変更します。 |
||
メニューのホットキー割り当てを変更します。または変更を事前確認します。 |
||
Property の型、引数、Enum 項目、コールバック、保存先、 Property ID を変更します。 |
||
Property Stack のロジック全体を置き換えます。 |
||
空の条件行を末尾に追加します。 |
||
条件行 1 件と、対応する SET 項目を変更します。 |
||
条件行 1 件と、対応する SET 項目を削除します。 |
||
Property Stack の While True HUD を変更します。 |
||
Context Router の分岐と Otherwise を変更・追加・維持します。 |
||
Otherwise を保ったまま、分岐を 1 件削除します。 |
||
分岐を 1 件、別の分岐の前後へ移動します。 |
||
1 回の保存で、すべての分岐を指定した順序に並べます。 |
PME1 からの変更点¶
観点 |
PME1 |
PME2 |
|---|---|---|
インポート |
|
|
実行中のアドオン ID |
|
|
設計 |
内部モジュールの露出 |
公開 API ファサード |
メニュー呼び出し |
|
|
コード実行 |
|
|
メニュー検索 |
なし |
|
JSON 検証 |
なし |
|
型・定数 |
なし |
|