メニューの種類ごとの設定¶
メニューの種類ごとに固有の設定があります。Pop-up Dialog の Mode と幅、 Pie Menu の半径などです。設定は名前で読み書きします。スロット、ホットキー、 メニュー名は別の操作で扱います。
関数 |
用途 |
|---|---|
現在の値を |
|
メニューが受け付ける設定の説明を返します。 |
|
設定を変更します。 |
設定を読む¶
read_pm(pm_uid)["settings"] は、設定名と現在の値のマッピングです。
名前は メニューの種類別の設定 に挙げた保存名です。値は編集画面が表示する値です。Enum は保存された数値ではなく、識別子の文字列です。
>>> pme.editing.read_pm(pm_uid)["settings"]
{'pd_panel': 'PANEL', 'pd_width': 300, 'pd_title': True, 'pd_box': True,
'pd_use_property_split': False, 'pd_use_property_decorate': False,
'pd_extend_target': '', 'pd_extend_side': 'append', 'pd_extend_order': 0,
'pd_extend_is_right': False}
設定を持たないメニューの種類では {} を返します。保存データを解析できない場合、settings は {} になり、read_pm() はコード
settings_data_unreadable を含む settings_diagnostics も返します。
関数¶
- pme.editing.setting_fields(pm_uid)¶
メニューの種類が受け付ける設定の説明を返します。
- パラメータ:
pm_uid (str) -- メニューの UID。
- 戻り値:
設定名と、その説明の対応。
- 戻り値の型:
- 例外:
ValueError -- UID が見つからない、不正、または曖昧な場合。
RuntimeError -- Blender のメインスレッド以外から、または PME の読み込みが終わる前に呼び出された場合。
各説明は次のキーを持ちます。
キー
対象
値
typeすべて
"BOOLEAN"、"INT"、"STRING"、"ENUM"のいずれかdescriptionすべて
編集画面のツールチップ文字列。Stack Key の設定では空。
min,maxINTupdate_settings()が受け付ける範囲(両端を含む)valuesENUM受け付ける識別子
flagsvm_start_inputsフラグ名と、そのビット値の対応
>>> pme.editing.setting_fields(pm_uid)["pd_width"] {'type': 'INT', 'description': 'Width of the popup', 'min': 100, 'max': 2000}
- pme.editing.update_settings(pm_uid, changes, *, expected=None, dry_run=False)¶
メニューの種類の設定を変更します。
最初の書き込みの前に、すべての変更を確認します。一つでも拒否されると、 何も書き込みません。
- パラメータ:
- 戻り値:
下記の結果。
- 戻り値の型:
- 例外:
TypeError --
changesまたはexpectedが文字列キーのマッピングでない場合、またはdry_runが bool でない場合。ValueError -- UID が見つからない、不正、または曖昧な場合。
RuntimeError -- Blender のメインスレッド以外から、または PME の読み込みが終わる前に呼び出された場合。
結果
キー
型
値
statusstr
下記の ステータス を参照。
committedbool
statusが"committed"のときだけTrue。dry_runbool
引数
dry_runの値。pm_uidstr
引数
pm_uidの値。beforedict
呼び出し前に読んだ設定。
afterdict
呼び出し後に読んだ設定。何も書き込まなかった場合は
beforeと同じです。changed_fieldslist[str]
beforeとafterで値が異なる設定名。recoverydict or None
書き込みに失敗した後に設定されます。
scope("settings")、saved_settings_match、saved_data_matchesを持ちます。diagnosticslist[dict]
問題ごとに一つのエントリ。
code、field(またはfields)、messageと、診断 に挙げた詳細を持ちます。ステータス
status意味
committed要求した値をすべて保存しました。
validateddry_run=Trueで、変更は受理可能です。何も書き込んでいません。unchanged要求した値はすべて保存値と同じです。
rejected何も書き込んでいません。
diagnosticsが原因を示します。restored_failure書き込みに失敗し、設定を
beforeに戻しました。unknown書き込みに失敗し、復元を確認できませんでした。再試行の前に
read_pm()を呼び出してください。診断
code原因と追加のキー
setting_not_applicable名前がこのメニューの種類の設定ではありません。
availableに、 この種類の設定名を列挙します。setting_type_mismatch値の Python の型が違います。
INTの設定は float と bool を受け付けません。setting_out_of_range整数が
min..maxの範囲外です。値を範囲内に丸めません。setting_not_a_choiceEnum の値が
valuesにありません。setting_not_representable文字列が
&または=を含みます。保存形式はこれらの文字を保持できません。extend_target_unknown追加先が、登録済みの Panel、Header、Menu の型ではありません。
extend_target_not_extendable追加先が、PME 自身のパネルなど、PME が拡張しない型です。
setting_requires_extend_target追加先なしで、追加位置、順序、右側リージョンのフラグを指定しました。
stale_settingsexpectedの値が保存値と異なります。fieldsに該当する設定名を列挙します。settings_data_unreadable保存データを解析できません。
exception_typeがエラーの名前を示します。setting_value_not_retainedsetter が要求した値を保持しませんでした。
requestedとactualに両方の値が入ります。setting_write_failedsetter が例外を送出しました。
exception_typeがエラーの名前を示します。例
Popup Mode で幅 420 ピクセルの Pop-up Dialog を作成します。
created = pme.create_pm(pme.PmCreationSpec("DIALOG", name="Bone Collections")) result = pme.editing.update_settings( created.pm_uid, {"pd_panel": "POPUP", "pd_width": 420}, expected={"pd_panel": "PANEL"}, ) assert result["status"] == "committed", result["diagnostics"]
補足
追加先に関する設定は、追加先、位置、右側リージョン、順序の順に書き込みます。追加先を設定すると、位置も
"append"になります。追加先と Panel Group の配置は、編集画面と同じく、呼び出しの中で Blender に登録します。
この呼び出しは、Preferences のディスク保存、Undo ステップの追加、 メニューの呼び出しを行いません。
メニューの種類別の設定¶
メニューの種類 の値は、PmCreationSpec に渡す mode_id で、
read_pm()["mode"] としても返ります。ここに挙げていない種類には設定がありません。Property は update_property() で、Property Stack は専用の操作で編集します。
Pie Menu (PMENU)¶
名前 |
型 |
値の範囲 |
既定値 |
説明 |
|---|---|---|---|---|
|
INT |
-1 .. 1000 |
-1 |
Pie Menu の半径。-1 は既定値を使います。 |
|
INT |
-1 .. 1000 |
-1 |
項目を選択できるようになる、中心からの最小距離。-1 は既定値を使います。 |
|
INT |
-1 .. 1000 |
-1 |
自動確定までの、しきい値を超えた追加の距離。0 で自動確定を無効にし、 -1 は既定値を使います。 |
|
BOOLEAN |
True |
ホットキーを離したときに選択を確定します。 |
Vector Menu (VMENU)¶
名前 |
型 |
値の範囲 |
既定値 |
説明 |
|---|---|---|---|---|
|
BOOLEAN |
False |
開始前にマウスボタンまたはペン先の入力を待ちます。その入力を離すと確定します。 |
|
|
INT |
0 .. 15 |
15 |
メニューを開始する入力。ビットフラグで、1 は左マウスボタン、2 は中マウスボタン、4 は右マウスボタン、8 はペン先です。 |
Regular Menu (RMENU)¶
名前 |
型 |
値の範囲 |
既定値 |
説明 |
|---|---|---|---|---|
|
BOOLEAN |
True |
タイトルを表示します。 |
|
|
STRING |
Menu の型名 |
|
このメニューの内容を追加する Blender の Menu。例:
|
|
ENUM |
|
|
元の内容に対する位置。 |
|
INT |
0 以上 |
0 |
複数のメニューが同じ追加先に追加するときの表示順。 |
Pop-up Dialog (DIALOG)¶
名前 |
型 |
値の範囲 |
既定値 |
説明 |
|---|---|---|---|---|
|
ENUM |
|
|
Mode。Pie Mode、Dialog Mode、Popup Mode のいずれか。 |
|
INT |
100 .. 2000 |
300 |
ポップアップの幅。 |
|
BOOLEAN |
True |
タイトルを表示します。 |
|
|
BOOLEAN |
True |
枠を使います。 |
|
|
BOOLEAN |
False |
Blender のプロパティパネルと同じく、プロパティのラベルを別の列に描画します。 |
|
|
BOOLEAN |
False |
アニメーションのデコレーター列を表示します。Property Split と併用したときだけ有効です。 |
|
|
STRING |
Panel または Header の型名 |
|
このメニューの内容を追加する Blender の Panel または Header。例:
|
|
ENUM |
|
|
元の内容に対する位置。 |
|
INT |
0 以上 |
0 |
複数のメニューが同じ追加先に追加するときの表示順。 |
|
BOOLEAN |
False |
トップバーの右側リージョンに描画します。 |
Floating Panel (FPANEL)¶
名前 |
型 |
値の範囲 |
既定値 |
説明 |
|---|---|---|---|---|
|
BOOLEAN |
False |
プロパティのラベルを別の列に描画します。 |
|
|
BOOLEAN |
False |
アニメーションのデコレーター列を表示します。Property Split と併用したときだけ有効です。 |
Panel Group (PANEL)¶
名前 |
型 |
値の範囲 |
既定値 |
説明 |
|---|---|---|---|---|
|
ENUM |
Space の種類。 |
|
パネルを表示するエディター。 |
|
ENUM |
|
|
パネルを表示するリージョン。 |
|
ENUM |
コンテキスト。 |
|
パネルのコンテキスト。 |
|
STRING |
|
|
Sidebar のタブ。 |
|
BOOLEAN |
False |
幅の広いアイコンボタンを使います。 |
Modal Operator (MODAL)¶
名前 |
型 |
値の範囲 |
既定値 |
説明 |
|---|---|---|---|---|
|
BOOLEAN |
False |
オペレーターを開始したキーまたはマウスボタンを離したときに確定します。 |
|
|
BOOLEAN |
True |
ほかのホットキーをブロックします。 |
|
|
BOOLEAN |
True |
マウスカーソルを現在のエリア内に留めます。 |
Sticky Key (STICKY)¶
名前 |
型 |
値の範囲 |
既定値 |
説明 |
|---|---|---|---|---|
|
BOOLEAN |
False |
Sticky Key が有効な間、ほかのツールをブロックします。 |
Stack Key (SCRIPT)¶
名前 |
型 |
値の範囲 |
既定値 |
説明 |
|---|---|---|---|---|
|
BOOLEAN |
False |
直前のコマンドを取り消します。 |
|
|
BOOLEAN |
False |
最後に実行したスロットを記憶します。 |
|
|
ENUM |
|
|
記憶したスロットを進める条件。押すたびに進めるか、タイムアウト内にもう一度押したときだけ進めます。 |
|
INT |
1 以上 |
600 |
繰り返しとみなす時間の幅(ミリ秒)。 |