Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > DisplayCluster > ADisplayClusterRootActor

Light Theme

Dark Theme

ADisplayClusterRootActor

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

ADisplayClusterRootActor

References

Module	DisplayCluster
Header	/Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/DisplayClusterRootActor.h
Include	#include "DisplayClusterRootActor.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Meta=(DisplayName="nDisplay Root Actor"))
class ADisplayClusterRootActor : public AActor

Remarks

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

Variables

	Name	Description
bool	bAreXformGizmosVisible
bool	bEditorViewportXformGizmoVisibility	If the root actor is being displayed in an editor viewport, this variable allows the viewport to hide the xform gizmos independently of the actor's gizmo visibility flag.
bool	bEnableICVFXCameraPreview	Enable the on-screen camera preview widget when selecting this actor.
bool	bEnableOuterViewportOCIO
bool	bPreviewEnable	EDITOR STUFF.
float	EditorViewportXformGizmoScale	If the root actor is being displayed in an editor viewport, this variable allows the viewport to scale the xform gizmos independently of the actor's gizmo scale property.
bool	EnableInnerFrustum
TArray< FDispla...	InnerFrustumPriority
TArray< FDispla...	OuterViewportOCIOConfigurations
FString	PreviewNodeId	Render single node preview or whole cluster.
float	PreviewRenderTargetRatioMult	Preview texture size get from viewport, and scaled by this value.
EDisplayCluster...	RenderMode	Render mode for PIE.
int	TickPerFrame	Update preview texture period in tick.
TUniquePtr< IDi...	ViewportManager	Unique viewport manager for this configuration.
float	XformGizmoScale

Constructors

	Name	Description
	ADisplayClusterRootActor ( const FObjectInitializer& ObjectIn... )

Destructors

	Name	Description
	~ADisplayClusterRootActor()

Functions

	Name	Description
void	ApplyConfigDataToComponents()
void	BeginDestroy_Editor()
bool	BuildHierarchy()	Creates all hierarchy objects declared in a config file.
void	CleanupHierarchy()	Cleans current hierarchy.
void	Constructor_Editor()
void	Destroyed_Editor()
void	Destructor_Editor()
IDisplayClus...	FindPreviewViewport ( const FString& InViewportId )
bool	FindPrimitivesByName ( const TArray< FString >& InNames, TSet< FPrimitiveComponentId >& Out... )
TSharedPtr< ...	GenerateObjectsNamingMap()
FString	GeneratePreviewComponentName ( const FString& NodeId, const FString& ViewportId )
void	GetAllCameras ( TMap< FString, UDisplayClusterCamer... )
void	GetAllMeshes ( TMap< FString, UDisplayClusterMeshC... )
void	GetAllScreens ( TMap< FString, UDisplayClusterScree... )
void	GetAllXforms ( TMap< FString, UDisplayClusterXform... )
UDisplayClus...	GetCameraById ( const FString& CameraId )
int32	GetCamerasAmount()
UDisplayClus...	GetComponentById ( const FString& ComponentId )
UDisplayClus...	GetConfigData()
UDisplayClus...	GetDefaultCamera()
UDisplayClus...	GetDefaultConfigDataFromAsset()
bool	GetHiddenInGamePrimitives ( TSet< FPrimitiveComponentId >& Out... )	Return hidden in game privitives set.
int	GetInnerFrustumPriority ( const FString& InnerFrustumID )	Return inner frustum priority by InnerFrustum name (from InnerFrustumPriority property) return -1, if not defined
UStaticMeshC...	GetMeshById ( const FString& MeshId )
int32	GetMeshesAmount()
FOnPreviewUp...	GetOnPreviewDestroyed()
FOnPreviewUp...	GetOnPreviewGenerated()
UDisplayClus...	GetPreviewComponent ( const FString& NodeId, const FString& ViewportId )
void	GetPreviewRenderTargetableTextures ( const TArray< FString >& InViewpor..., TArray< FTextureRHIRef >& OutTextu... )
float	GetPreviewRenderTargetRatioMult()
const FDispl...	GetRenderFrameSettings()
UDisplayClus...	GetScreenById ( const FString& ScreenId )
int32	GetScreensAmount()
const FDispl...	GetStageSettings()
UDisplayClus...	GetSyncTickComponent()
TWeakPtr< ID...	GetToolkit()
UDisplayClus...	GetViewportConfiguration ( const FString& ClusterNodeID, const FString& ViewportID )
IDisplayClus...	GetViewportManager()
const FOpenC...	GetViewportOCIO ( const FString& ViewportID )	Return OCIO profile by viewport name (from OuterViewportOCIOConfigurations property)
float	GetWorldDeltaSeconds()
UDisplayClus...	GetXformById ( const FString& XformId )
float	GetXformGizmoScale()
bool	GetXformGizmoVisibility()
int32	GetXformsAmount()
void	InitializeFromConfig ( UDisplayClusterConfigurationData&#... )
void	InitializeFromConfig ( const FString& ConfigFile )
void	InitializeRootActor()	Initializes the actor on spawn and load.
bool	IsBlueprint()
bool	IsInnerFrustumEnabled ( const FString& InnerFrustumID )
bool	IsPreviewEnabled()	Return true, if preview enabled for this actor
bool	IsRunningGameOrPIE()
void	PostLoad_Editor()
void	ReleasePreviewComponents()
void	RenderPreview_Editor()
void	RerunConstructionScripts_Editor()
void	ResetHierarchyMap()
void	ResetInnerFrustumPriority()
void	SelectComponent ( const FString& SelectedComponent )
void	SetDefaultCamera ( const FString& CameraId )
void	SetIsSelectedInEditor ( bool bValue )
void	SetToolkit ( TWeakPtr< IDisplayClusterConfigurat... )
void	Tick_Editor ( float DeltaSeconds )
void	UpdateConfigDataInstance ( UDisplayClusterConfigurationData&#..., bool bForceRecreate )	Update or create the config data object.
void	UpdateInnerFrustumPriority()
void	UpdatePreviewComponents()
bool	UpdatePreviewConfiguration_Editor()
void	UpdateXformGizmos()

Overridden from AActor

	Name	Description
void	BeginPlay()	AActor.
void	Destroyed()	Called when this actor is explicitly being destroyed during gameplay or in the editor, not called during level streaming or gameplay ending
void	EndPlay ( const EEndPlayReason::Type EndPlayR... )	Overridable function called whenever this actor is being removed from a level
void	PostActorCreated()	Called when an actor is done spawning into the world (from UWorld::SpawnActor), both in the editor and during gameplay For actors with a root component, the location and rotation will have already been set.
void	PostEditMove ( bool bFinished )	Called after an actor has been moved in the editor
void	RerunConstructionScripts()	Rerun construction scripts, destroying all autogenerated components; will attempt to preserve the root component location.
bool	ShouldTickIfViewportsOnly()	We need tick in Editor.
void	Tick ( float DeltaSeconds )	Function called every frame on this Actor.

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
bool	IsSelectedInEditor()	Test the selection state of a UObject
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Typedefs

Name	Description
FOnPreviewUpdated

Deprecated Functions

		Name	Description
	void	GetAllComponents ( TMap< FString, UDisplayClusterScene... )	Use 'GetComponentsByClass' instead
	int32	GetComponentsAmount()	Use 'GetComponentsByClass' instead and retrieve the length

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss