1. Epic GamesDeveloper
  3. UDisplayClusterConfigurationData

UDisplayClusterConfigurationData

Main configuration data container.

API > API/Plugins > API/Plugins/DisplayClusterConfiguration

Main configuration data container.

   
Name UDisplayClusterConfigurationData
Type class
Header File /Engine/Plugins/Runtime/nDisplay/Source/DisplayClusterConfiguration/Public/DisplayClusterConfigurationTypes.h
Include Path #include "DisplayClusterConfigurationTypes.h"

Syntax

UCLASS (Blueprintable, BlueprintType, PerObjectConfig, Config=EditorPerProjectUserSettings)  
class UDisplayClusterConfigurationData : public UDisplayClusterConfigurationData_Base

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UDisplayClusterConfigurationData()

   DisplayClusterConfigurationTypes.h  

Constants

Name Type Remarks Include Path
InputSyncPolicies const TSet< FString >   DisplayClusterConfigurationTypes.h
ProjectionPolicies const TSet< FString >   DisplayClusterConfigurationTypes.h
RenderSyncPolicies const TSet< FString >   DisplayClusterConfigurationTypes.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bExitOnEsc bool   DisplayClusterConfigurationTypes.h
  • EditDefaultsOnly
  • BlueprintReadWrite
  • Category=Configuration
  • Meta=(DisplayName="Exit When ESC Pressed", DisplayAfter="bFollowLocalPlayerCamera")
bFollowLocalPlayerCamera bool   DisplayClusterConfigurationTypes.h
  • EditDefaultsOnly
  • BlueprintReadWrite
  • Category=Configuration
  • Meta=(DisplayName="Follow Local Player Camera", DisplayAfter="CustomParameters")
bOverrideTransformsFromExternalConfig bool   DisplayClusterConfigurationTypes.h
  • EditDefaultsOnly
  • BlueprintReadWrite
  • Category=Configuration
  • Meta=(DisplayName="Override Transforms From .ndisplay", DisplayAfter="bOverrideViewportsFromExternalConfig")
bOverrideViewportsFromExternalConfig bool   DisplayClusterConfigurationTypes.h
  • EditDefaultsOnly
  • BlueprintReadWrite
  • Category=Configuration
  • Meta=(DisplayName="Override Viewports From .ndisplay", DisplayAfter="bExitOnEsc")
Cluster TObjectPtr< UDisplayClusterConfigurationCluster >   DisplayClusterConfigurationTypes.h
  • VisibleInstanceOnly
  • BlueprintReadOnly
  • Instanced
  • Category=NDisplay
CustomParameters TMap< FString, FString >   DisplayClusterConfigurationTypes.h
  • EditDefaultsOnly
  • BlueprintReadWrite
  • Category=Configuration
  • Meta=(DisplayAfter="Diagnostics")
Diagnostics FDisplayClusterConfigurationDiagnostics   DisplayClusterConfigurationTypes.h
  • EditDefaultsOnly
  • BlueprintReadWrite
  • Category=Configuration
  • Meta=(DisplayAfter="Info")
ImportedPath FString The path used when originally importing. DisplayClusterConfigurationTypes.h  
Info FDisplayClusterConfigurationInfo   DisplayClusterConfigurationTypes.h
  • EditDefaultsOnly
  • BlueprintReadWrite
  • Category=Configuration
  • Meta=(DisplayAfter="RenderFrameSettings")
MediaSettings FDisplayClusterConfigurationGlobalMediaSettings   DisplayClusterConfigurationTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Configuration
  • Meta=(DisplayName="Global Media Settings")
Meta FDisplayClusterConfigurationDataMetaInfo   DisplayClusterConfigurationTypes.h  
PathToConfig FString   DisplayClusterConfigurationTypes.h
  • Config
RenderFrameSettings FDisplayClusterConfigurationRenderFrame   DisplayClusterConfigurationTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Configuration
  • Meta=(HidePropertyInstanceOnly, DisplayAfter="DefaultFrameSizeRef")
Scene TObjectPtr< UDisplayClusterConfigurationScene >   DisplayClusterConfigurationTypes.h
  • VisibleInstanceOnly
  • BlueprintReadOnly
  • Transient
  • Category=NDisplay
  • Meta=(HideProperty)
StageSettings FDisplayClusterConfigurationICVFX_StageSettings   DisplayClusterConfigurationTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=NDisplay
  • Meta=(HideProperty)

Protected

Name Type Remarks Include Path Unreal Specifiers
DefaultFrameSizeRef FDisplayClusterEditorPropertyReference Details Panel Property Referencers. DisplayClusterConfigurationTypes.h
  • EditDefaultsOnly
  • Transient
  • Category=Configuration
  • Meta=(PropertyPath="StageSettings.DefaultFrameSize")

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AssignPostprocess ( const FString& NodeId,
const FString& PostprocessId,
const FString& Type,
TMap< FString, FString > Parameters,
int32 Order
)

 Update\Create node postprocess DisplayClusterConfigurationTypes.h
  • BlueprintCallable
  • Category="NDisplay|Configuration"

void ForEachViewport ( const TFunction< void(const TObjectPtr< UDisplayClusterConfigurationViewport >&)>& Function
) const

 Execute a function on each viewport in each cluster node DisplayClusterConfigurationTypes.h  

UDisplayClusterConfigurationClusterNode * GetNode ( const FString& NodeId
) const

 Returns specific node configuration. Otherwise nullptr. DisplayClusterConfigurationTypes.h
  • BlueprintPure
  • Category="NDisplay|Configuration"

uint32 GetNumberOfClusterNodes()

 Returns number of nodes in current cluster DisplayClusterConfigurationTypes.h  

bool GetPostprocess ( const FString& NodeId,
const FString& PostprocessId,
FDisplayClusterConfigurationPostprocess& OutPostprocess
) const

   DisplayClusterConfigurationTypes.h
  • BlueprintCallable
  • Category="NDisplay|Configuration"
Returns primary node configuration. Otherwise nullptr. DisplayClusterConfigurationTypes.h
  • BlueprintPure
  • Category="NDisplay|Configuration"

FString GetPrimaryNodeAddress()

 Returns primary node IP address of current cluster DisplayClusterConfigurationTypes.h  

bool GetProjectionPolicy ( const FString& NodeId,
const FString& ViewportId,
FDisplayClusterConfigurationProjection& OutProjection
) const

   DisplayClusterConfigurationTypes.h
  • BlueprintCallable
  • Category="NDisplay|Configuration"

void GetReferencedMeshNames ( TArray< FString >& OutMeshNames
) const

 Return all references to meshes from policy, and other. DisplayClusterConfigurationTypes.h
  • BlueprintCallable
  • Category="NDisplay|Configuration"

UDisplayClusterConfigurationViewport * GetViewport ( const FString& NodeId,
const FString& ViewportId
) const

 Viewports API. DisplayClusterConfigurationTypes.h
  • BlueprintPure
  • Category="NDisplay|Configuration"

bool RemovePostprocess ( const FString& NodeId,
const FString& PostprocessId
)

   DisplayClusterConfigurationTypes.h
  • BlueprintCallable
  • Category="NDisplay|Configuration"

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedEvent
)

   DisplayClusterConfigurationTypes.h  

Static

Name Remarks Include Path Unreal Specifiers

static UDisplayClusterConfigurationData * CreateNewConfigData ( UObject* Owner,
EObjectFlags ObjectFlags
)

 Create empty config data. DisplayClusterConfigurationTypes.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page