Navigation
API > API/Plugins > API/Plugins/DisplayClusterOperator
Inheritance Hierarchy
- IModuleInterface
- IDisplayClusterOperator
References
| Module | DisplayClusterOperator |
| Header | /Engine/Plugins/Runtime/nDisplay/Source/DisplayClusterOperator/Public/IDisplayClusterOperator.h |
| Include | #include "IDisplayClusterOperator.h" |
Syntax
class IDisplayClusterOperator : public IModuleInterface
Remarks
Display Cluster Operator module interface
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | Forces the operator panel to dismiss any open drawers | |
  |
IDisplayClusterOperator & | Get () |
Singleton-like access to this module's interface. |
 |
FName | Gets the extension ID for the auxilliary window region intended for lower-thirds windows (e.g log output) that can be used to add tabs to the operator panel | |
 |
FName | Gets the tab ID used for the details panel | |
 |
TSharedPtr< FExtensibilityManager > | Gets the extensibility manager for the operator panel's menu bar | |
 |
TSharedPtr< FExtensibilityManager > | Gets the extensibility manager for the operator panel's toolbar | |
 |
TSharedRef< IDisplayClusterOperatorViewModel > | Gets the operator panel's view model, which stores any state used by the operator panel | |
 |
FName | Gets the extension ID for the main window region that can be used to add tabs to the operator panel | |
 |
void | GetRootActorLevelInstances
(
TArray< ADisplayClusterRootActor* >& OutRootActorInstances |
Gets a list of all nDisplay root actor instances that are on the currently loaded level |
  |
bool | IsAvailable () |
Checks to see if this module is loaded and ready. |
 |
FOnAppendOperatorPanelCommands & | Gets the event handler that is raised when the operator panel binds commands to its command list | |
 |
FOnRegisterLayoutExtensions & | Gets the event handler that is raised when the operator panel processes extensions to its layout | |
 |
FOnRegisterStatusBarExtensions & | Gets the event handler that is raised when the operator panel processes extensions to its status bar | |
 |
FDelegateHandle | RegisterApp
(
const FOnGetAppInstance& InGetAppInstanceDelegate |
Register an app with the operator panel |
 |
void | ToggleDrawer
(
const FName DrawerId |
Toggles the state of a drawer with the specified ID, closing the drawer if it is open, and opening the drawer if it is closed |
 |
void | UnregisterApp
(
const FDelegateHandle& InHandle |
Unregisters an app from the operator panel |
Typedefs
| Name | Description |
|---|---|
| FOnAppendOperatorPanelCommands | |
| FOnGetAppInstance | |
| FOnRegisterLayoutExtensions | |
| FOnRegisterStatusBarExtensions |
Constants
| Name | Description |
|---|---|
| ModuleName |