RaptorSuiteWindow
The RAPTOR Suite editor window.
| Namespace | Assembly | Kind | Stability |
|---|---|---|---|
Raptor.EditorTools | Raptor.Editor | class | preview, since 0.1.0 |
public sealed class RaptorSuiteWindow : RaptorSuiteWindowBaseFields
MeshHotspotEachShortcutId
public const string MeshHotspotEachShortcutId;The shortcut id of Hotspot each face (AltH). A module can use it to place its own row after this one in Settings → Hotkeys.
Properties
ExternalOwnsKeys
public bool ExternalOwnsKeys { get; }Whether a registered key owner has the keyboard in this window.
KeyOwnerIds
public static IReadOnlyList<string> KeyOwnerIds { get; }The registered key owner ids, in registration order.
Methods
PanelVisible
public bool PanelVisible(string id)Whether panel id is on screen in this window, as an open drawer or docked and shown.
| Parameter | Type | Description |
|---|---|---|
id | string | The panel's stable id. |
Returns: True when on screen. False for an unknown id.
RegisterKeyOwner
public static void RegisterKeyOwner(string id, Func<RaptorSuiteWindow, bool> owns)Registers a key owner. While owns returns true for a Suite window, that window's shared, Mesh and Mesh-priority shortcut contexts are disabled, and the owner's shortcut context takes the keys. Registering the same id again replaces the predicate. A predicate that throws is logged once and treated as false. A null or empty id, or a null predicate, is ignored.
| Parameter | Type | Description |
|---|---|---|
id | string | The owner's stable id. |
owns | Func<RaptorSuiteWindow, bool> | Returns true while the owner has this window's keys. |
Call from an [InitializeOnLoad] static constructor on the main thread.
RepaintFocusedSuite
public static void RepaintFocusedSuite()Repaints the focused Suite window's chrome, for use in a module's [Shortcut] method. Does nothing when no Suite has focus.
UnregisterKeyOwner
public static bool UnregisterKeyOwner(string id)Removes the key owner id.
| Parameter | Type | Description |
|---|---|---|
id | string | The owner's stable id. |
Returns: False when none was registered.
Related types
- RaptorSuiteWindow.MeshShortcutContext: The shortcut context for a module's Mesh-mode [Shortcut]s.
- RaptorSuiteWindowBase: The base class of the Suite window.