ホットキー¶
メニューのホットキー割り当ては、保存される 13 個の項目で構成されます。
read_pm() で読み、update_hotkey() で変更します。
update_hotkey() は、Blender のキーマップへの登録を保存値とは分けて報告します。Hotkey Mode は Hotkey Mode、編集画面は
Hotkey 設定 で説明しています。
関数 |
用途 |
|---|---|
保存された割り当てを |
|
割り当てを変更し、登録状態を報告します。 |
ホットキーを読む¶
read_pm(pm_uid)["hotkey"] は、各項目名と保存値のマッピングです。すべてのメニューの種類で返ります。読み取りでは値を正規化せず、Blender のキーマップにも触れません。
>>> pme.editing.read_pm(pm_uid)["hotkey"]
{'key': 'F6', 'key_mod': 'NONE', 'ctrl': True, 'shift': False, 'alt': False,
'oskey': False, 'any': False, 'open_mode': 'PRESS', 'km_name': 'Window',
'chord': 'NONE', 'drag_dir': 'ANY', 'tweak_dir': 'ANY', 'repeat': False}
ホットキーの項目¶
項目 |
型 |
受け付ける値 |
既定値 |
意味 |
|---|---|---|---|---|
|
str |
|
|
メニューを呼び出すキーまたはボタン。 |
|
str |
|
|
修飾キーとして押し続けるキー(Key Modifier)。マウスボタン
( |
|
bool |
|
|
Ctrl を押した状態。 |
|
bool |
|
|
Shift を押した状態。 |
|
bool |
|
|
Alt を押した状態。 |
|
bool |
|
|
OS キーを押した状態。 |
|
bool |
|
|
修飾キーに関係なく一致します(Any Modifier)。このときキーマップ項目は四つの修飾キーの項目を無視します。 |
|
str |
|
|
Hotkey Mode。 |
|
str |
|
|
ホットキーが有効なキーマップ。例: |
|
str |
|
|
Key Chords の 2 番目のキー( |
|
str |
|
|
|
|
str |
|
|
|
|
bool |
|
|
キーを押し続けている間のキーリピートを受け付けます。 |
既定値 は RNA の既定値です。Enum の値は実行中の Blender の識別子なので、
key の識別子の集合は Blender のバージョンによって異なる場合があります。
Property、Property Stack、Panel Group、Hidden Panel Group のメニューはこれらの項目を保存しますが、ホットキーを持ちません。登録が必要になることはありません。
関数¶
- pme.editing.update_hotkey(pm_uid, changes, *, expected=None, dry_run=False)¶
メニューのホットキー割り当てを変更します。
最初の書き込みの前に、すべての入力を確認します。保存値は読み戻して確認します。Blender のキーマップの状態は
registrationで別に報告します。- パラメータ:
- 戻り値:
下記の結果。
- 戻り値の型:
- 例外:
TypeError --
changesまたはexpectedがマッピングでない場合、 Boolean の項目の値が bool でない場合(1は拒否)、ほかの項目の値が文字列でない場合、dry_runが bool でない場合。ValueError -- UID が見つからない、不正、または曖昧な場合、項目名が未知の場合、Enum の値が受け付ける識別子でない場合、
expectedがちょうど 13 個の項目を持たない場合。RuntimeError -- Blender のメインスレッド以外から、PME の読み込みが終わる前に、または PME の Preferences を利用できない間に呼び出された場合。書き込みの開始後にも送出します。補足 を参照。
結果
キー
型
値
statusstr
下記の ステータス を参照。
committedbool
statusが"committed"のときだけTrue。dry_runbool
引数
dry_runの値。pm_uidstr
メニューの UID。
beforedict
呼び出し前に読んだ 13 個の項目。
afterdict
最後に読んだ 13 個の項目。
statusが"committed"でない場合はbeforeと同じです。proposeddict
正規化後に、この呼び出しが書き込む、または書き込む予定の割り当て全体。
changed_fieldslist[str]
beforeとafterで値が異なる項目。planned_fieldslist[str]
beforeとproposedで値が異なる項目。adjustmentslist[dict]
正規化した項目ごとに一つのエントリ。
field、requested、proposedを持ちます。正規化 を参照。diagnosticslist[dict]
問題または警告ごとに一つのエントリ。
codeと、診断 に挙げた詳細を持ちます。registrationdict
呼び出し終了時の Blender のキーマップの状態。 登録 を参照。
ステータス
status意味
committedproposedのすべての項目を読み戻しました。キーマップを更新しました。その状態はregistrationで確認します。readydry_run=Trueで、変更は実行可能と確認済みです。何も書き込んでいません。proposedとplanned_fieldsが変更内容を示します。 この関数はvalidatedではなくreadyを返します。unchangedproposedが保存された割り当てと同じです。何も書き込んでいません。登録は修復しません。rejected何も保存していません。
diagnosticsが原因を示します。これらの値の共通の意味は 結果とガード で定義しています。 書き込みの開始後の失敗は、ステータスを返さずに例外を送出します。
診断
code原因と追加のキー
stale_hotkeyexpectedの値が保存値と異なります。fieldsに項目名を列挙します。dry_run=Trueでもstatusはrejectedです。keymap_names_unavailablekm_nameを指定しましたが、Blender のユーザーキーマップを読めません。messageにエラーが入ります。statusはrejectedです。menu_hotkey_screen_editing_leftmouse割り当てが Screen Editing キーマップに Left Mouse のイベントを置きます。これは通常のクリックを妨げます。
keymap_nameがキーマップ名を示します。statusはrejectedです。hotkey_write_mismatch書き込んだ項目を読み戻すと、書き込んだ値と異なりました。保存値を復元し、復元を確認しました。
statusはrejectedです。current_hotkey_collision警告。メニューの現在の登録が、ほかのキーマップ項目と衝突しています。
severityは"warning"で、collisionはtargetとopponentを持ちます。保存は妨げません。current_hotkey_collision_unavailable衝突の確認で例外が発生しました。
messageにエラーが入ります。正規化
入力
proposedへの影響km_nameを指定;で分割し、前後の空白を除きます。Blender のユーザー keyconfig のキーマップでない名前は除外します。残りを"; "で連結します。結果が空なら"Window"になります。km_nameを指定しない保存された名前を維持します。import したものなど、まだ存在しないキーマップの名前も維持します。
open_modeにCHORDSを指定NONEのchordはAになります。open_modeにほかのモードを指定chordはNONEになります。open_modeを指定しないchordは指定した値、または保存値のままです。Screen Editing の確認は、要求したキーマップ名と正規化後のキーマップ名の両方に対して行います。そのため、正規化で除外された名前でも拒否されます。 この確認は、ホットキーを持つメニューの種類に適用します。
例
F6 と Ctrl の割り当てを確認してから適用します。
before = pme.editing.read_pm(pm_uid)["hotkey"] changes = {"key": "F6", "ctrl": True, "open_mode": "PRESS"} preview = pme.editing.update_hotkey( pm_uid, changes, expected=before, dry_run=True, ) if preview["status"] == "ready": result = pme.editing.update_hotkey(pm_uid, changes, expected=before) print(result["after"], result["registration"])
補足
項目は
open_mode、chord、その後ほかの項目を表の順に書き込みます。値が異なる項目だけを設定します。キーマップは、すべての項目を読み戻した後に一度だけ更新します。最新かどうかは
expectedだけで確認します。ホットキーの変更はread_pm()["version"]を変えません。ready、unchanged、rejectedの結果では、registrationと衝突の警告は、proposedではなく保存された割り当てを示します。update_hotkey(pm_uid, {}, dry_run=True)は、書き込まずに現在の登録を返します。書き込みが例外を送出するか、読み戻した値が異なる場合、キーマップに触れる前に保存値を復元します。読み戻しの相違の後に復元を確認できた場合は、
hotkey_write_mismatchを含むrejectedを返します。 書き込みが例外を送出した場合は、その例外が伝播します。復元を確認できない場合、復元の段階が Hotkey saved-value restoration is unconfirmed; host application has not started という note を付けて例外を送出します(値が異なる場合はRuntimeError("hotkey_saved_value_restore_mismatch"))。キーマップの更新または画面更新が例外を送出した場合、または最後の読み戻しが
proposedと異なる場合 (RuntimeError("hotkey_final_saved_value_mismatch"))、例外が伝播します。例外には、読み戻した保存値、変更された項目、登録を示す note が付きます。保存値はすでに変わっている場合があります。再試行の前にホットキーを読み直してください。新しい
key_modのマウスボタン observer を登録できない場合、key_modを復元し、書き込んだほかの項目は新しい値のままです。 この復旧はkey_modだけが対象で、このとき登録はpartialになる場合があります。この呼び出しは、選択中のメニューや Slot Editor で編集中の内容の変更、 Preferences のディスク保存、Undo ステップの追加、ホットキーの呼び出しを行いません。
登録¶
registration は、このメニューについて PME が Blender のアドオン
keyconfig に持つキーマップ項目を示します。ユーザーキーマップ間の最終的な優先順位、入力の配送、Poll、実行は証明しません。
キー |
型 |
値 |
|---|---|---|
|
str |
下記を参照。 |
|
bool |
メニューの種類がホットキーを持ち、メニューが有効で、 |
|
list[dict] |
期待するキーマップ項目ごとに一つのエントリ( |
|
list[dict] |
観測の問題。 |
|
意味 |
|---|---|
|
登録は不要で、残ったキーマップ項目もありません。 |
|
期待するキーマップ項目がすべて存在し、一致しています。 |
|
少なくとも一つの lane が |
|
登録を完全には観測できませんでした。 |
Lane¶
キー |
型 |
値 |
|---|---|---|
|
str |
キーマップ項目が属するキーマップ。 |
|
str |
キーマップ項目のイベントの種類。読めなかった残留キーマップ項目では
|
|
dict or None |
PME が登録するキーマップ項目。 |
|
dict or None |
実際のキーマップ項目から読んだ同じキー。キーマップ項目が存在しない場合は |
|
str or None |
|
|
dict |
|
key_mod のマウスボタンは observer が扱うため、このとき expected の
key_modifier は "NONE" です。
|
意味 |
|---|---|
|
期待するキーマップ項目が登録されていません。 |
|
PME の記録が、アドオン keyconfig にないキーマップ項目を指しています。 |
|
キーマップ項目が |
|
|
|
キーマップ項目を読めませんでした。 |
|
PME の記録が、そのキーマップについて期待より多くのキーマップ項目を持っています。 |
|
アドオン keyconfig に、PME の記録が追跡していない、このメニューのキーマップ項目があります。 |
登録の |
原因 |
|---|---|
|
登録が必要ですが、PME にこのメニューの記録がありません。
|
|
Blender のアドオン keyconfig を読めませんでした。 |
|
キーマップ項目を読めませんでした。 |
|
登録は不要ですが、マウスボタン observer の使用記録が残っています。
|
無効なメニュー、key が NONE のメニュー、CLICK の Vector Menu は登録を必要としません。ステータスが not_required になるのは、キーマップ項目も observer の使用記録も残っていない場合だけです。