1. Epic GamesDeveloper
  3. DisplayClusterConfigurator

DisplayClusterConfigurator

API > API/Plugins

   
Name DisplayClusterConfigurator
Type Runtime
Part of Plugins nDisplay
Location /Engine/Plugins/Runtime/nDisplay/Source/DisplayClusterConfigurator/
Module Build Rules DisplayClusterConfigurator.Build.cs

Classes

Name Remarks
TAttribute  
UDisplayClusterConfiguratorFactory  
UDisplayClusterConfiguratorReimportFactory  

Structs

Name Remarks
FDisplayClusterConfiguratorTreeArgs  
FDisplayClusterConfiguratorTreeBuilderOutput Output struct for builders to use
FDisplayClusterConfiguratorTreeFilterArgs Basic filter used when re-filtering the tree
FHostNodeArrangementSettings  
FNodeAlignmentSettings  
FOutputMappingSettings  

Interfaces

Name Remarks
IDisplayClusterConfigurator Configurator editor module
IDisplayClusterConfiguratorBlueprintEditor TODO: Remove this completely, don't expose the BP Editor outside of the configuration module.
IDisplayClusterConfiguratorBuilder  
IDisplayClusterConfiguratorItem  
IDisplayClusterConfiguratorOutputMappingBuilder The Interface for generation of nodes from config
IDisplayClusterConfiguratorOutputMappingItem The Interface holsd object and setting from Details View
IDisplayClusterConfiguratorPreviewScene  
IDisplayClusterConfiguratorTreeBuilder Interface to implement to provide custom build logic to tree views
IDisplayClusterConfiguratorTreeItem  
IDisplayClusterConfiguratorView  
IDisplayClusterConfiguratorViewDetails  
IDisplayClusterConfiguratorViewLog  
IDisplayClusterConfiguratorViewOutputMapping The Interface for controll the Output Mapping Мiew
IDisplayClusterConfiguratorViewportBuilder  
IDisplayClusterConfiguratorViewTree Base interface for editor tree view
IDisplayClusterConfiguratorViewViewport  

Typedefs

Name Type Remarks Include Path
FOnDisplayClusterConfiguratorReadOnlyChanged TMulticastDelegate_OneParam< void, bool > Read only delegate. IDisplayClusterConfigurator.h
FOnDisplayClusterConfiguratorReadOnlyChangedDelegate FOnDisplayClusterConfiguratorReadOnlyChanged::FDelegate   IDisplayClusterConfigurator.h

Enums

Public

Name Remarks
EDisplayClusterConfiguratorTreeFilterResult  
EDisplayClusterConfiguratorTreeMode  
EHostArrangementType  

Functions

Public

Name Remarks Include Path Unreal Specifiers

UDisplayClusterConfigurationClusterNode * UE::DisplayClusterConfiguratorClusterUtils::AddClusterNodeToCluster ( UDisplayClusterConfigurationClusterNode* ClusterNode,
UDisplayClusterConfigurationCluster* Cluster,
FString NewClusterNodeName
)

 Adds a cluster node to a cluster, removing it from its current cluster if it belongs to one. ClusterConfiguration/DisplayClusterConfiguratorClusterUtils.h  

UDisplayClusterConfigurationViewport * UE::DisplayClusterConfiguratorClusterUtils::AddViewportToClusterNode ( UDisplayClusterConfigurationViewport* Viewport,
UDisplayClusterConfigurationClusterNode* ClusterNode,
FString NewViewportName
)

 Adds a viewport to a cluster node, removing it from its current cluster node if it belongs to one. ClusterConfiguration/DisplayClusterConfiguratorClusterUtils.h  

UDisplayClusterConfigurationHostDisplayData * UE::DisplayClusterConfiguratorClusterUtils::FindOrCreateHostDisplayData ( UDisplayClusterConfigurationCluster* Cluster,
FString HostIPAddress
)

 Attempts to find a preexisting display data object for the specified host, and if one can't be found, creates a new one. ClusterConfiguration/DisplayClusterConfiguratorClusterUtils.h  

FString UE::DisplayClusterConfiguratorClusterUtils::GetAddressForHost ( UDisplayClusterConfigurationHostDisplayData* HostDisplayData
)

 Gets the address of a host using its host display data. ClusterConfiguration/DisplayClusterConfiguratorClusterUtils.h  

FString UE::DisplayClusterConfiguratorClusterUtils::GetClusterNodeName ( UDisplayClusterConfigurationClusterNode* ClusterNode
)

 Gets the name that the cluster node is stored under in its parent cluster. ClusterConfiguration/DisplayClusterConfiguratorClusterUtils.h  

UDisplayClusterConfigurationHostDisplayData * UE::DisplayClusterConfiguratorClusterUtils::GetHostDisplayDataForClusterNode ( UDisplayClusterConfigurationClusterNode* ClusterNode
)

 Attempts to get the host display data for the host of a cluster node. ClusterConfiguration/DisplayClusterConfiguratorClusterUtils.h  

FString UE::DisplayClusterConfiguratorClusterUtils::GetUniqueNameForClusterNode ( FString InitialName,
UDisplayClusterConfigurationCluster* ParentCluster,
bool bAddZero
)

 Gets a unique name for a cluster node owned by the specified cluster. ClusterConfiguration/DisplayClusterConfiguratorClusterUtils.h  

FString UE::DisplayClusterConfiguratorClusterUtils::GetUniqueNameForHost ( FString InitialName,
UDisplayClusterConfigurationCluster* ParentCluster,
bool bAddZero
)

 Gets a unique name for a host owned by the specified cluster. ClusterConfiguration/DisplayClusterConfiguratorClusterUtils.h  

FString UE::DisplayClusterConfiguratorClusterUtils::GetUniqueNameForViewport ( FString InitialName,
UDisplayClusterConfigurationClusterNode* ParentClusterNode,
bool bAddZero
)

 Gets a unique name for a viewport owned by the specified cluster node. ClusterConfiguration/DisplayClusterConfiguratorClusterUtils.h  

FString UE::DisplayClusterConfiguratorClusterUtils::GetViewportName ( UDisplayClusterConfigurationViewport* Viewport
)

 Gets the name that the viewport is stored under in its parent cluster node. ClusterConfiguration/DisplayClusterConfiguratorClusterUtils.h  

bool UE::DisplayClusterConfiguratorClusterUtils::IsClusterNodePrimary ( UDisplayClusterConfigurationClusterNode* ClusterNode
)

 Determines if a cluster node is the primary node in its cluster. ClusterConfiguration/DisplayClusterConfiguratorClusterUtils.h  

bool UE::DisplayClusterConfiguratorClusterUtils::RemoveClusterNodeFromCluster ( UDisplayClusterConfigurationClusterNode* ClusterNode
)

 Removes a cluster node from the cluster that owns it. ClusterConfiguration/DisplayClusterConfiguratorClusterUtils.h  

bool UE::DisplayClusterConfiguratorClusterUtils::RemoveHost ( UDisplayClusterConfigurationCluster* Cluster,
FString Host
)

 Removes all cluster nodes and host display data from the cluster for the specified host. ClusterConfiguration/DisplayClusterConfiguratorClusterUtils.h  

bool UE::DisplayClusterConfiguratorClusterUtils::RemoveUnusedHostDisplayData ( UDisplayClusterConfigurationCluster* Cluster
)

 Removes all host display data objects from the cluster that aren't being used by any of the cluster nodes. ClusterConfiguration/DisplayClusterConfiguratorClusterUtils.h  

bool UE::DisplayClusterConfiguratorClusterUtils::RemoveViewportFromClusterNode ( UDisplayClusterConfigurationViewport* Viewport
)

 Removes a viewport from the cluster node that owns it. ClusterConfiguration/DisplayClusterConfiguratorClusterUtils.h  

bool UE::DisplayClusterConfiguratorClusterUtils::RenameClusterNode ( UDisplayClusterConfigurationClusterNode* ClusterNode,
FString NewClusterNodeName
)

 Renames a cluster node, which involves changing the key that the cluster node is stored under in its parent cluster. ClusterConfiguration/DisplayClusterConfiguratorClusterUtils.h  

bool UE::DisplayClusterConfiguratorClusterUtils::RenameViewport ( UDisplayClusterConfigurationViewport* Viewport,
FString NewViewportName
)

 Renames a viewport, which involves changing the key that the viewport is stored under in its parent cluster node. ClusterConfiguration/DisplayClusterConfiguratorClusterUtils.h  

bool UE::DisplayClusterConfiguratorClusterUtils::SetClusterNodeAsPrimary ( UDisplayClusterConfigurationClusterNode* ClusterNode
)

 Sets the cluster node as the primary node. ClusterConfiguration/DisplayClusterConfiguratorClusterUtils.h  

void UE::DisplayClusterConfiguratorClusterUtils::SortClusterNodesByHost ( const TMap< FString, UDisplayClusterConfigurationClusterNode* >& InClusterNodes,
TMap< FString, TMap< FString, UDisplayClusterConfigurationClusterNode* > >& OutSortedNodes
)

 Sorts a list of cluster nodes by their host. ClusterConfiguration/DisplayClusterConfiguratorClusterUtils.h  

void UE::DisplayClusterConfiguratorClusterUtils::SortClusterNodesByHost ( const TMap< FString, TObjectPtr< UDisplayClusterConfigurationClusterNode > >& InClusterNodes,
TMap< FString, TMap< FString, UDisplayClusterConfigurationClusterNode* > >& OutSortedNodes
)

 Sorts a list of cluster nodes by their host. ClusterConfiguration/DisplayClusterConfiguratorClusterUtils.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page