Navigation
API > API/Plugins > API/Plugins/DisplayClusterOperator
Display Cluster Operator module interface
| Name | IDisplayClusterOperator |
| Type | class |
| Header File | /Engine/Plugins/Runtime/nDisplay/Source/DisplayClusterOperator/Public/IDisplayClusterOperator.h |
| Include Path | #include "IDisplayClusterOperator.h" |
Syntax
class IDisplayClusterOperator : public IModuleInterface
Implements Interfaces
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IDisplayClusterOperator() |
IDisplayClusterOperator.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnAppendOperatorPanelCommands | TMulticastDelegate_OneParam< void, TSharedRef< FUICommandList > > | IDisplayClusterOperator.h | |
| FOnGetAppInstance | TBaseDelegate_OneParam< TSharedRef< IDisplayClusterOperatorApp >, TSharedRef< IDisplayClusterOperatorViewModel > > | IDisplayClusterOperator.h | |
| FOnRegisterLayoutExtensions | TMulticastDelegate_OneParam< void, FLayoutExtender & > | IDisplayClusterOperator.h | |
| FOnRegisterStatusBarExtensions | TMulticastDelegate_OneParam< void, FDisplayClusterOperatorStatusBarExtender & > | IDisplayClusterOperator.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ModuleName | const TCHAR * | IDisplayClusterOperator.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ForceDismissDrawers() |
Forces the operator panel to dismiss any open drawers | IDisplayClusterOperator.h | |
FName GetAuxilliaryOperatorExtensionId() |
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 | IDisplayClusterOperator.h | |
FName GetDetailsTabId() |
Gets the tab ID used for the details panel | IDisplayClusterOperator.h | |
TSharedPtr< FExtensibilityManager > GetOperatorMenuExtensibilityManager() |
Gets the extensibility manager for the operator panel's menu bar | IDisplayClusterOperator.h | |
TSharedPtr< FExtensibilityManager > GetOperatorToolBarExtensibilityManager() |
Gets the extensibility manager for the operator panel's toolbar | IDisplayClusterOperator.h | |
TSharedRef< IDisplayClusterOperatorViewModel > GetOperatorViewModel() |
Gets the operator panel's view model, which stores any state used by the operator panel | IDisplayClusterOperator.h | |
FName GetPrimaryOperatorExtensionId() |
Gets the extension ID for the main window region that can be used to add tabs to the operator panel | IDisplayClusterOperator.h | |
void GetRootActorLevelInstances
(
TArray< ADisplayClusterRootActor* >& OutRootActorInstances |
Gets a list of all nDisplay root actor instances that are on the currently loaded level | IDisplayClusterOperator.h | |
FOnAppendOperatorPanelCommands & OnAppendOperatorPanelCommands() |
Gets the event handler that is raised when the operator panel binds commands to its command list | IDisplayClusterOperator.h | |
FOnRegisterLayoutExtensions & OnRegisterLayoutExtensions() |
Gets the event handler that is raised when the operator panel processes extensions to its layout | IDisplayClusterOperator.h | |
FOnRegisterStatusBarExtensions & OnRegisterStatusBarExtensions() |
Gets the event handler that is raised when the operator panel processes extensions to its status bar | IDisplayClusterOperator.h | |
FDelegateHandle RegisterApp
(
const FOnGetAppInstance& InGetAppInstanceDelegate |
Register an app with the operator panel | IDisplayClusterOperator.h | |
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 | IDisplayClusterOperator.h | |
void UnregisterApp
(
const FDelegateHandle& InHandle |
Unregisters an app from the operator panel | IDisplayClusterOperator.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IDisplayClusterOperator & Get () |
Singleton-like access to this module's interface. | IDisplayClusterOperator.h | |
static bool IsAvailable () |
Checks to see if this module is loaded and ready. | IDisplayClusterOperator.h |