1. Epic GamesDeveloper
  3. ADisplayClusterRootActor

ADisplayClusterRootActor

VR root. This contains nDisplay VR hierarchy in the game.

API > API/Plugins > API/Plugins/DisplayCluster

VR root. This contains nDisplay VR hierarchy in the game.

   
Name ADisplayClusterRootActor
Type class
Header File /Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/DisplayClusterRootActor.h
Include Path #include "DisplayClusterRootActor.h"

Syntax

UCLASS (NotPlaceable,  
       HideCategories=(Replication, Collision, Input, Actor, HLOD, Cooking, Physics, Activation, AssetUserData, ActorTick, Advanced, DataLayers, Events),  
       Meta=(DisplayName="nDisplay Root Actor"))  
class ADisplayClusterRootActor : public AActor

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

ADisplayClusterRootActor ( const FObjectInitializer& ObjectInitializer
)

   DisplayClusterRootActor.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~ADisplayClusterRootActor()

   DisplayClusterRootActor.h  

Typedefs

Name Type Remarks Include Path
FOnPreviewUpdated TBaseDelegate_NoParams< void >   DisplayClusterRootActor.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
BasicDisplayDeviceComponent TObjectPtr< UDisplayClusterDisplayDeviceBaseComponent > The included display device nDisplay provides by default DisplayClusterRootActor.h
  • VisibleDefaultsOnly
  • Category="Preview"
  • DisplayName="Basic Display Device"
bEnablePreviewEditableMesh bool Enable the use of a preview editable mesh for the preview for this DCRA. DisplayClusterRootActor.h
  • Transient
  • NonTransactional
bEnablePreviewMesh bool Enable the use of a preview mesh for the preview for this DCRA. DisplayClusterRootActor.h
  • Transient
  • NonTransactional
bEnablePreviewTechvis bool Configure the root actor for Techvis rendering with preview components. DisplayClusterRootActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Preview"
  • AdvancedDisplay
bFreezePreviewRender bool Freeze preview render. This will impact editor performance. DisplayClusterRootActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Preview"
  • Meta=(DisplayName="Freeze Editor Preview")
bMoviePipelineRenderPass bool When the MRQ is rendered, this flag is raised. DisplayClusterRootActor.h
  • Transient
  • NonTransactional
bPreviewEnable bool EDITOR RELATED SETTINGS. DisplayClusterRootActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Preview"
  • Meta=(DisplayName="Enable Editor Preview")
bPreviewEnableHoldoutComposite bool Render a preview with postprocessing in the scene using the HoldoutComposite plugin. DisplayClusterRootActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Preview"
  • Meta=(DisplayName="Enable Preview Holdout", EditCondition="bPreviewEnablePostProcess")
  • BlueprintSetter=SetPreviewEnableHoldoutComposite
bPreviewEnableOCIO bool Enable OCIO on preview. DisplayClusterRootActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Preview"
  • Meta=(DisplayName="Enable OCIO on Preview")
bPreviewEnableOverlayMaterial bool Show overlay material on the preview mesh when preview rendering is enabled (UMeshComponent::OverlayMaterial). DisplayClusterRootActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Preview"
  • AdvancedDisplay
  • Meta=(DisplayName="Enable Preview Overlay")
bPreviewEnablePostProcess bool Enable PostProcess for preview. DisplayClusterRootActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Preview"
  • Meta=(DisplayName="Enable Post Process")
  • BlueprintSetter=SetPreviewEnablePostProcess
bPreviewEnableTSR bool Enable TemporalAA/TSR in preview. DisplayClusterRootActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Preview"
  • Meta=(DisplayName="Allow TemporalAA/TSR in Preview")
bPreviewICVFXFrustums bool Render ICVFX Frustums DisplayClusterRootActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Preview"
  • Meta=(DisplayName="Enable Camera Frustums")
bPreviewInGameEnable bool Render this DCRA in game for Standalone/Package builds. DisplayClusterRootActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Preview"
  • AdvancedDisplay
  • Meta=(DisplayName="Enable Preview in Game")
bPreviewInGameRenderFrustum bool Enables the use of 'bPreviewICVFXFrustums' in the game. DisplayClusterRootActor.h  
bPreviewStageGeometryMesh bool Toggles the visibility of the stage's geometry mesh, a smooth, continuous mesh generated and processed from the stage's geometry DisplayClusterRootActor.h
  • EditInstanceOnly
  • Category="Preview"
  • AdvancedDisplay
CurrentConfigData TObjectPtr< UDisplayClusterConfigurationData > If set from the DisplayCluster BP Compiler it will be loaded from the class default subobjects in run-time. DisplayClusterRootActor.h
  • VisibleAnywhere
  • BlueprintReadOnly
  • Instanced
  • Category="NDisplay"
  • Meta=(AllowPrivateAccess="true")
DefaultDisplayDeviceName FName Select the default display device class to use when a viewport doesn't have one assigned DisplayClusterRootActor.h
  • EditDefaultsOnly
  • Category="Preview"
  • AdvancedDisplay
  • DisplayName="Default Display Device"
InnerFrustumPriority TArray< FDisplayClusterComponentRef > Set the priority for inner frustum rendering if there is any overlap when enabling multiple ICVFX cameras. DisplayClusterRootActor.h
  • EditInstanceOnly
  • EditFixedSize
  • Category="In Camera VFX"
  • Meta=(TitleProperty="Name", DisplayAfter="ShowInnerFrustumOverlapsRef")
PreviewICVFXFrustumsFarDistance float Render ICVFX Frustums DisplayClusterRootActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Preview"
  • AdvancedDisplay
  • Meta=(DisplayName="Camera Frustum Distance")
PreviewMaxTextureDimension int The maximum dimension of any internal texture for preview. DisplayClusterRootActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Preview"
  • AdvancedDisplay
  • Meta=(DisplayName="Preview Texture Max Size", ClampMin="64", UIMin="64", ClampMax="4096", UIMax="4096")
PreviewNodeId FString Selectively preview a specific viewport or show all/none. DisplayClusterRootActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Preview"
  • Meta=(DisplayName="Preview Node")
PreviewRenderTargetRatioMult float Adjust resolution scaling for the editor preview. DisplayClusterRootActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Preview"
  • Meta=(DisplayName="Preview Screen Percentage", ClampMin="0.05", UIMin="0.05", ClampMax="1", UIMax="1")
PreviewSetttingsSource EDisplayClusterConfigurationRootActorPreviewSettingsSource Determines where the preview settings will be retrieved from. DisplayClusterRootActor.h
  • Transient
  • NonTransactional
RenderMode EDisplayClusterConfigurationRenderMode Render Mode DisplayClusterRootActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Preview"
  • Meta=(DisplayName="Render Mode")
TickPerFrame int Tick Per Frame DisplayClusterRootActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Preview"
  • AdvancedDisplay
  • Meta=(DisplayName="Tick Per Frame", ClampMin="1", UIMin="1", ClampMax="200", UIMax="200")
ViewportsPerFrame int Max amount of Viewports Per Frame DisplayClusterRootActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Preview"
  • AdvancedDisplay
  • Meta=(DisplayName="Viewports Per Frame", ClampMin="1", UIMin="1", ClampMax="200", UIMax="200")

Protected

Name Type Remarks Include Path Unreal Specifiers
AllViewportColorConfigurationRef FDisplayClusterEditorPropertyReference   DisplayClusterRootActor.h
  • EditAnywhere
  • Transient
  • Category=OCIO
  • Meta=(PropertyPath="CurrentConfigData.StageSettings.ViewportOCIO.AllViewportsOCIOConfiguration.ColorConfiguration", DisplayName="All Viewports Color Configuration")
bIsInteractiveEditingSubobject bool Flag to indicate if the user is currently interacting with a subobject of CurrentConfigData. DisplayClusterRootActor.h  
bIsSelectedInEditor bool   DisplayClusterRootActor.h  
bRequiresComponentRefresh bool Flag to indicate if we need to reregister components. DisplayClusterRootActor.h  
ClusterColorGradingRef FDisplayClusterEditorPropertyReference   DisplayClusterRootActor.h
  • EditAnywhere
  • Transient
  • Category="Color Grading"
  • Meta=(PropertyPath="CurrentConfigData.StageSettings.EntireClusterColorGrading")
ClusterHideListRef FDisplayClusterEditorPropertyReference   DisplayClusterRootActor.h
  • EditAnywhere
  • Transient
  • Category=Viewports
  • Meta=(PropertyPath="CurrentConfigData.StageSettings.HideList")
ConfigDataName FName Name of the CurrentConfigData asset. DisplayClusterRootActor.h  
DefaultViewPoint TObjectPtr< UDisplayClusterCameraComponent > Default camera component. DisplayClusterRootActor.h
  • VisibleAnywhere
  • BlueprintGetter=GetDefaultCamera
  • Category="NDisplay|Components"
DeprecatedPreviewDelegate FOnPreviewUpdated UE_DEPRECATED 5.4. DisplayClusterRootActor.h  
DisplayClusterRootComponent TObjectPtr< USceneComponent > The root component for our hierarchy. DisplayClusterRootActor.h
  • EditAnywhere
  • Category="NDisplay"
  • Meta=(HideProperty)
EnableInnerFrustumChromakeyOverlapRef FDisplayClusterEditorPropertyReference   DisplayClusterRootActor.h
  • EditAnywhere
  • Transient
  • Category="Color Grading"
  • Meta=(PropertyPath="CurrentConfigData.StageSettings.EnableColorGrading")
EnableInnerFrustumsRef FDisplayClusterEditorPropertyReference   DisplayClusterRootActor.h
  • EditAnywhere
  • Transient
  • Category="In Camera VFX"
  • Meta=(PropertyPath="CurrentConfigData.StageSettings.bEnableInnerFrustums")
EnableLightcardsRef FDisplayClusterEditorPropertyReference   DisplayClusterRootActor.h
  • EditAnywhere
  • Transient
  • Category="Light Cards"
  • Meta=(PropertyPath="CurrentConfigData.StageSettings.Lightcard.bEnable")
EnableViewportOCIORef FDisplayClusterEditorPropertyReference   DisplayClusterRootActor.h
  • EditAnywhere
  • Transient
  • Category=OCIO
  • Meta=(PropertyPath="CurrentConfigData.StageSettings.ViewportOCIO.AllViewportsOCIOConfiguration.bIsEnabled", DisplayName="Enable Viewport OCIO")
FreezeRenderOuterViewportsRef FDisplayClusterEditorPropertyReference   DisplayClusterRootActor.h
  • EditAnywhere
  • Transient
  • Category=Viewports
  • Meta=(PropertyPath="CurrentConfigData.StageSettings.bFreezeRenderOuterViewports")
GlobalChromakeyColorRef FDisplayClusterEditorPropertyReference   DisplayClusterRootActor.h
  • EditAnywhere
  • Transient
  • Category=Chromakey
  • Meta=(PropertyPath="CurrentConfigData.StageSettings.GlobalChromakey.ChromakeyColor")
GlobalChromakeyMarkersRef FDisplayClusterEditorPropertyReference   DisplayClusterRootActor.h
  • EditAnywhere
  • Transient
  • Category=Chromakey
  • Meta=(PropertyPath="CurrentConfigData.StageSettings.GlobalChromakey.ChromakeyMarkers")
GlobalInnerFrustumUpscalerSettingsRef FDisplayClusterEditorPropertyReference   DisplayClusterRootActor.h
  • EditAnywhere
  • Transient
  • Category="In Camera VFX"
  • Meta=(PropertyPath="CurrentConfigData.StageSettings.GlobalInnerFrustumUpscalerSettings", DisplayName="Default Upscaler Settings")
LastDeltaSecondsValue float   DisplayClusterRootActor.h  
LightcardAllViewportColorConfigurationRef FDisplayClusterEditorPropertyReference   DisplayClusterRootActor.h
  • EditAnywhere
  • Transient
  • Category="Light Cards"
  • Meta=(PropertyPath="CurrentConfigData.StageSettings.Lightcard.LightcardOCIO.CustomOCIO.AllViewportsOCIOConfiguration.ColorConfiguration", DisplayName="All Viewports Color Configuration")
LightCardBlendingModeRef FDisplayClusterEditorPropertyReference   DisplayClusterRootActor.h
  • EditAnywhere
  • Transient
  • Category="Light Cards"
  • Meta=(PropertyPath="CurrentConfigData.StageSettings.Lightcard.Blendingmode", EditConditionPath="CurrentConfigData.StageSettings.Lightcard.bEnable")
LightCardContentRef FDisplayClusterEditorPropertyReference   DisplayClusterRootActor.h
  • EditAnywhere
  • Transient
  • Category="Light Cards"
  • Meta=(PropertyPath="CurrentConfigData.StageSettings.Lightcard.ShowOnlyList", EditConditionPath="CurrentConfigData.StageSettings.Lightcard.bEnable")
LightcardOCIOModeRef FDisplayClusterEditorPropertyReference   DisplayClusterRootActor.h
  • EditAnywhere
  • Transient
  • Category="Light Cards"
  • Meta=(PropertyPath="CurrentConfigData.StageSettings.Lightcard.LightcardOCIO.LightcardOCIOMode", DisplayName="Light Cards OCIO")
LightcardPerViewportOCIOProfilesRef FDisplayClusterEditorPropertyReference   DisplayClusterRootActor.h
  • EditAnywhere
  • Transient
  • Category="Light Cards"
  • Meta=(PropertyPath="CurrentConfigData.StageSettings.Lightcard.LightcardOCIO.CustomOCIO.PerViewportOCIOProfiles", DisplayName="Per-Viewport OCIO Overrides")
MediaSettingsRef FDisplayClusterEditorPropertyReference Media. DisplayClusterRootActor.h
  • EditDefaultsOnly
  • Transient
  • Category="Media"
  • Meta=(PropertyPath="CurrentConfigData.MediaSettings")
OperationMode EDisplayClusterOperationMode Current operation mode. DisplayClusterRootActor.h  
OuterHideListRef FDisplayClusterEditorPropertyReference   DisplayClusterRootActor.h
  • EditAnywhere
  • Transient
  • Category=Viewports
  • Meta=(PropertyPath="CurrentConfigData.StageSettings.OuterViewportHideList")
OuterViewportUpscalerSettingsRef FDisplayClusterEditorPropertyReference Details Panel Property Referencers Placed here to ensure layout builders process referencers first DisplayClusterRootActor.h
  • EditAnywhere
  • Transient
  • Category=Viewports
  • Meta=(PropertyPath="CurrentConfigData.StageSettings.OuterViewportUpscalerSettings", DisplayName="Default Upscaler Settings")
PerOuterHideListRef FDisplayClusterEditorPropertyReference   DisplayClusterRootActor.h
  • EditInstanceOnly
  • Transient
  • Category=Viewports
  • Meta=(DisplayName="Content Hidden Per-Viewport", PropertyPath="CurrentConfigData.Cluster.Nodes.Viewports.RenderSettings.HiddenContent", ToolTip="Hide actors from a specific viewport.")
PerViewportColorGradingRef FDisplayClusterEditorPropertyReference   DisplayClusterRootActor.h
  • EditAnywhere
  • Transient
  • Category="Color Grading"
  • Meta=(PropertyPath="CurrentConfigData.StageSettings.PerViewportColorGrading")
PerViewportOCIOProfilesRef FDisplayClusterEditorPropertyReference   DisplayClusterRootActor.h
  • EditAnywhere
  • Transient
  • Category=OCIO
  • Meta=(PropertyPath="CurrentConfigData.StageSettings.ViewportOCIO.PerViewportOCIOProfiles", DisplayName="Per-Viewport OCIO Overrides")
ShowInnerFrustumOverlapsRef FDisplayClusterEditorPropertyReference   DisplayClusterRootActor.h
  • EditAnywhere
  • Transient
  • Category="In Camera VFX"
  • Meta=(PropertyPath="CurrentConfigData.StageSettings.bEnableInnerFrustumChromakeyOverlap", DisplayName="Enable Chromakey Overlap")
StageGeometryComponent TObjectPtr< UDisplayClusterStageGeometryComponent > Component that stores the stage's geometry map, which is used to make objects flush with the stage's walls and ceilings DisplayClusterRootActor.h  
StageIsosphereComponent TObjectPtr< UDisplayClusterStageIsosphereComponent > Component that stores a 3D representation of the stage's geometry map, which can be used to perform ray traces against the processed stage geometry DisplayClusterRootActor.h  
SyncTickComponent TObjectPtr< UDisplayClusterSyncTickComponent > Helper sync component. Performs sync procedure during Tick phase. DisplayClusterRootActor.h  
ToolkitPtr TWeakPtr< IDisplayClusterConfiguratorBlueprintEditor >   DisplayClusterRootActor.h  
ViewportManagerPtr TSharedPtr< FDisplayClusterViewportManager, ESPMode::ThreadSafe > DC ViewportManager instance for this DCRA. DisplayClusterRootActor.h  
ViewportOverscanRef FDisplayClusterEditorPropertyReference   DisplayClusterRootActor.h
  • EditInstanceOnly
  • Transient
  • Category=Viewports
  • Meta=(DisplayName="Viewport Overscan", PropertyPath="CurrentConfigData.Cluster.Nodes.Viewports.RenderSettings.Overscan", ToolTip="Render a larger frame than specified in the configuration to achieve continuity across displays when using post-processing effects.")
ViewportScreenPercentageMultiplierRef FDisplayClusterEditorPropertyReference   DisplayClusterRootActor.h
  • EditAnywhere
  • Transient
  • Category=Viewports
  • Meta=(PropertyPath="CurrentConfigData.RenderFrameSettings.ClusterICVFXOuterViewportBufferRatioMult")
ViewportScreenPercentageRef FDisplayClusterEditorPropertyReference   DisplayClusterRootActor.h
  • EditInstanceOnly
  • Transient
  • Category=Viewports
  • Meta=(DisplayName="Viewport Screen Percentage", PropertyPath="CurrentConfigData.Cluster.Nodes.Viewports.RenderSettings.BufferRatio", ToolTip="Adjust resolution scaling for an individual viewport. Viewport Screen Percentage Multiplier is applied to this value.")
ViewportUpscalerSettingsRef FDisplayClusterEditorPropertyReference   DisplayClusterRootActor.h
  • EditInstanceOnly
  • Transient
  • Category=Viewports
  • Meta=(DisplayName="Per-Viewport Upscaling Setting Overrides", PropertyPath="CurrentConfigData.Cluster.Nodes.Viewports.RenderSettings.UpscalerSettings", ToolTip="Adjust upscaler settings for an individual viewport.")

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddPreviewEnableOverride ( const uint8* Object
)

 Force preview rendering to be enabled regardless of the user's setting until a matching RemovePreviewEnableOverride call is made. DisplayClusterRootActor.h  

void BeginDestroy_Editor()

   DisplayClusterRootActor.h  

void Constructor_Editor()

   DisplayClusterRootActor.h  

void Destroyed_Editor()

   DisplayClusterRootActor.h  

void Destructor_Editor()

   DisplayClusterRootActor.h  

bool DoObserversNeedPostProcessRenderTarget()

 If one or more observers are subscribed to receive post process preview targets. DisplayClusterRootActor.h  

void EnableEditorRender ( bool bValue
)

 EDITOR RELATED SETTINGS. DisplayClusterRootActor.h  

void EndPlay_Editor ( const EEndPlayReason::Type EndPlayReason
)

   DisplayClusterRootActor.h  

IDisplayClusterViewport * FindPreviewViewport ( const FString& InViewportId
) const

   DisplayClusterRootActor.h  

bool FindPrimitivesByName ( const TArray< FString >& InNames,
TSet< FPrimitiveComponentId >& OutPrimitives,
bool bForceHide
)

 Collect UActorComponent primitives by names. DisplayClusterRootActor.h  
Get the view point most commonly used by viewports in this cluster. DisplayClusterRootActor.h
  • BlueprintCallable
  • Category="NDisplay|DCRA"

TComp * GetComponentByName ( const FString& ComponentName
) const

   DisplayClusterRootActor.h  
  DisplayClusterRootActor.h  

UDisplayClusterCameraComponent * GetDefaultCamera()

   DisplayClusterRootActor.h
  • BlueprintGetter

UDisplayClusterConfigurationData * GetDefaultConfigDataFromAsset()

   DisplayClusterRootActor.h  

UDisplayClusterDisplayDeviceBaseComponent * GetDefaultDisplayDevice()

 Retrieve the default display device, creating it if it doesn't exist DisplayClusterRootActor.h
  • BlueprintGetter

bool GetDistanceToStageGeometry ( const FVector& WorldPosition,
const FVector& WorldDirection,
float& OutDistance
) const

 Gets the distance from a world position to the stage's geometry along the specified direction, if there is an intersection DisplayClusterRootActor.h
  • BlueprintCallable
  • Category="NDisplay|Stage"

bool GetFlushPositionAndNormal ( const FVector& WorldPosition,
FVector& OutPosition,
FVector& OutNormal
)

   DisplayClusterRootActor.h
  • BlueprintCallable
  • Category="NDisplay|DCRA"

bool GetHiddenInGamePrimitives ( TSet< FPrimitiveComponentId >& OutPrimitives
)

 Return hidden in game privitives set. DisplayClusterRootActor.h  

int GetInnerFrustumPriority ( const FString& InnerFrustumID
) const

 Return inner frustum priority by InnerFrustum name (from InnerFrustumPriority property) return -1, if not defined DisplayClusterRootActor.h  

ULineBatchComponent * GetLineBatchComponent()

 Retrieve the line batch component. DisplayClusterRootActor.h  

FOnPreviewUpdated & GetOnPreviewDestroyed()

   DisplayClusterRootActor.h  

FOnPreviewUpdated & GetOnPreviewGenerated()

   DisplayClusterRootActor.h  

IDisplayClusterViewportManager * GetOrCreateViewportManager()

 Get or Create ViewportManager API. DisplayClusterRootActor.h  

UDisplayClusterPreviewComponent * GetPreviewComponent ( const FString& NodeId,
const FString& ViewportId
) const

   DisplayClusterRootActor.h  

EDisplayClusterRenderFrameMode GetPreviewRenderMode()

 Returns the preview rendering mode of this DCRA. DisplayClusterRootActor.h  

void GetPreviewRenderTargetableTextures ( const TArray< FString >& InViewportNames,
TArray< FTextureRHIRef >& OutTextures
)

   DisplayClusterRootActor.h  

float GetPreviewRenderTargetRatioMult()

   DisplayClusterRootActor.h  

FDisplayClusterViewport_PreviewSettings GetPreviewSettings ( bool bIgnorePreviewSetttingsSource
) const

 Get current settings for preview rendering. DisplayClusterRootActor.h  

const FDisplayClusterConfigurationRenderFrame & GetRenderFrameSettings()

   DisplayClusterRootActor.h  
Returns the current rendering mode of this DCRA (not a value from configuration). DisplayClusterRootActor.h  

UDisplayClusterStageGeometryComponent * GetStageGeometryComponent()

   DisplayClusterRootActor.h
  • BlueprintGetter
  DisplayClusterRootActor.h  

UDisplayClusterSyncTickComponent * GetSyncTickComponent()

   DisplayClusterRootActor.h  

IDisplayClusterViewportConfiguration * GetViewportConfiguration()

 Get ViewportConfiguration API. DisplayClusterRootActor.h  

IDisplayClusterViewportManager * GetViewportManager()

 Get ViewportManager API. DisplayClusterRootActor.h  

float GetWorldDeltaSeconds()

   DisplayClusterRootActor.h  

void InitializeFromConfig ( UDisplayClusterConfigurationData* ConfigData
)

 Initialializes the instance with specified config data DisplayClusterRootActor.h  

bool IsBlueprint()

   DisplayClusterRootActor.h  

bool IsEditorRenderEnabled()

 If editor rendering is enabled. DisplayClusterRootActor.h  

bool IsInnerFrustumEnabled ( const FString& InnerFrustumID
) const

   DisplayClusterRootActor.h  

bool IsPreviewDrawnToScreens()

 Gets whether the preview output is displayed onto the stage actor's screen meshes DisplayClusterRootActor.h  

bool IsPreviewEnabled()

 Return true, if preview enabled for this actor DisplayClusterRootActor.h  

bool IsPrimaryRootActor()

 Returns true if this RootActor is used as the primary RootActor in the DC GameManager. DisplayClusterRootActor.h  

bool IsPrimaryRootActorForPIE()

 Returns true if this RootActor is primary and should be displayed in PIE mode. DisplayClusterRootActor.h  

bool IsRunningDisplayCluster()

 Returns true if this RootActor is running in DC mode. DisplayClusterRootActor.h  

bool IsRunningGameOrPIE()

 Returns true if this RootActor is running in game or in PIE mode. DisplayClusterRootActor.h  

bool IsRunningPIE()

 Returns true if this RootActor is running in PIE mode. DisplayClusterRootActor.h  

bool MakeStageActorFlushToWall ( const TScriptInterface< IDisplayClusterStageActor >& StageActor,
double DesiredOffsetFromFlush
)

   DisplayClusterRootActor.h
  • BlueprintCallable
  • Category="NDisplay|DCRA"

void OverrideFromConfig ( UDisplayClusterConfigurationData* ConfigData
)

 Cherry picking settings from a specified config data DisplayClusterRootActor.h  

void OverrideRootActorProperties ( const FDisplayClusterRootActorPropertyOverrides& InPropertyOverrides
)

 Override properties of this root actor. DisplayClusterRootActor.h  

void PostActorCreated_Editor()

   DisplayClusterRootActor.h  

void PostLoad_Editor()

   DisplayClusterRootActor.h  

void ReleasePreviewComponents()

   DisplayClusterRootActor.h  

void RemovePreviewEnableOverride ( const uint8* Object
)

 Stop forcing preview rendering to be enabled for this caller. DisplayClusterRootActor.h  

void RemoveViewportManager()

 Release the viewport manager instance, if it exists. DisplayClusterRootActor.h  

void RenderPreview_Editor()

 Perform a rendering of the DCRA preview. DisplayClusterRootActor.h  

void RerunConstructionScripts_Editor()

   DisplayClusterRootActor.h  

void ResetInnerFrustumPriority()

   DisplayClusterRootActor.h  

void ResetPreviewComponents_Editor ( bool bInRestoreSceneMaterial
)

 Preview components free referenced meshes and materials DisplayClusterRootActor.h  

bool SetFreezeOuterViewports ( bool bEnable
)

   DisplayClusterRootActor.h
  • BlueprintCallable
  • Category="NDisplay|Render"

void SetIsSelectedInEditor ( bool bValue
)

   DisplayClusterRootActor.h  

void SetPreviewEnableHoldoutComposite ( const bool bNewPreviewEnableHoldoutComposite
)

 Blueprint setter for the PreviewEnableHoldoutComposite property. DisplayClusterRootActor.h
  • BlueprintSetter

void SetPreviewEnablePostProcess ( const bool bNewPreviewEnablePostProcess
)

 Blueprint setter for the PreviewEnablePostProcess property. DisplayClusterRootActor.h
  • BlueprintSetter

bool SetReplaceTextureFlagForAllViewports ( bool bReplace
)

   DisplayClusterRootActor.h
  • BlueprintCallable
  • Category="NDisplay|Render"

bool ShouldThisFrameOutputPreviewToPostProcessRenderTarget()

 When rendering the preview determine which render target should be used for the current frame. DisplayClusterRootActor.h  

int32 SubscribeToPostProcessRenderTarget ( const uint8* Object
)

 Enable the use of a post process render target when bPreviewEnablePostProcess is disabled on the actor. DisplayClusterRootActor.h  

void TickPreviewRenderer()

 The Tick() function that calls the preview renderer for this root actor. DisplayClusterRootActor.h  

int32 UnsubscribeFromPostProcessRenderTarget ( const uint8* Object
)

 Unsubscribe a registered object from requiring post process render target updates. DisplayClusterRootActor.h  

void UpdateConfigDataInstance ( UDisplayClusterConfigurationData* ConfigDataTemplate,
bool bForceRecreate
)

 Update or create the config data object. DisplayClusterRootActor.h  

void UpdateInnerFrustumPriority()

   DisplayClusterRootActor.h  

void UpdatePreviewComponents()

   DisplayClusterRootActor.h  

void UpdateProceduralMeshComponentData ( const UProceduralMeshComponent* InProceduralMeshComponent
)

 Update the geometry of the procedural mesh component(s) referenced inside nDisplay DisplayClusterRootActor.h
  • BlueprintCallable
  • Meta=(DisplayName="Update ProceduralMeshComponent data")
  • Category="NDisplay|Components"

Overridden from AActor

Name Remarks Include Path Unreal Specifiers

virtual bool IsDefaultPreviewEnabled()

 Don't show actor preview in the level viewport when DCRA actor is selected, but none of its children are. DisplayClusterRootActor.h  

virtual bool ShouldTickIfViewportsOnly()

 We need tick in Editor. DisplayClusterRootActor.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool IsSelectedInEditor()

   DisplayClusterRootActor.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool BuildHierarchy()

 Creates all hierarchy objects declared in a config file. DisplayClusterRootActor.h  

virtual FName GetInternalDisplayDeviceName()

 The name the internal default display device uses. DisplayClusterRootActor.h  

void HandleAssetReload ( const EPackageReloadPhase InPackageReloadPhase,
FPackageReloadedEvent* InPackageReloadedEvent
)

 Called when the asset has been reloaded in the editor. DisplayClusterRootActor.h  

void InitializeRootActor()

 Initializes the actor on spawn and load. DisplayClusterRootActor.h  

void OnEndObjectMovement ( UObject& InObject
)

 Raised when any object is moved within a level. DisplayClusterRootActor.h  

void SetLightCardOwnership()

 Determine which light card actors are owned by this root actor DisplayClusterRootActor.h  

Overridden from AActor

Name Remarks Include Path Unreal Specifiers

virtual void BeginPlay()

 AActor. DisplayClusterRootActor.h  

virtual void Destroyed()

   DisplayClusterRootActor.h  

virtual void EndPlay ( const EEndPlayReason::Type EndPlayReason
)

   DisplayClusterRootActor.h  

virtual void PostActorCreated()

   DisplayClusterRootActor.h  

virtual void PostEditMove ( bool bFinished
)

   DisplayClusterRootActor.h  

virtual void RerunConstructionScripts()

   DisplayClusterRootActor.h  

virtual void Tick ( float DeltaSeconds
)

   DisplayClusterRootActor.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   DisplayClusterRootActor.h  

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChainEvent
)

   DisplayClusterRootActor.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   DisplayClusterRootActor.h  

virtual void PostLoad()

   DisplayClusterRootActor.h  

virtual void PostTransacted ( const FTransactionObjectEvent& TransactionEvent
)

   DisplayClusterRootActor.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AddReferencedObjects ( UObject* InThis,
FReferenceCollector& Collector
)

   DisplayClusterRootActor.h  

static FName GetCurrentConfigDataMemberName()

   DisplayClusterRootActor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page