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 > UDisplayClusterRootComponent

Light Theme

Dark Theme

UDisplayClusterRootComponent

DisplayCluster root component (nDisplay root)

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UDisplayClusterRootComponent

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(ClassGroup=(Custom))
class UDisplayClusterRootComponent : public USceneComponent

Remarks

DisplayCluster root component (nDisplay root)

Variables

	Name	Description
TMap< FString, ...	CameraComponents	Available cameras (from config file)
UDisplayCluster...	DefaultCameraComponent	Default camera for this root.
TMap< FString, ...	SceneNodeComponents	All available DisplayCluster nodes in hierarchy.
TMap< FString, ...	ScreenComponents	Available screens (from config file)

Constructors

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

Functions

	Name	Description
bool	CreateCameras()
bool	CreateNodes()
bool	CreateScreens()
TArray< UDis...	GetAllCameras()
TArray< UDis...	GetAllNodes()
TArray< UDis...	GetAllScreens()
UDisplayClus...	GetCameraById ( const FString& id )
int32	GetCamerasAmount()
UDisplayClus...	GetDefaultCamera()
UDisplayClus...	GetNodeById ( const FString& id )
UDisplayClus...	GetScreenById ( const FString& id )
int32	GetScreensAmount()
bool	InitializeHierarchy()	Creates all hierarchy objects declared in a config file.
void	SetDefaultCamera ( const FString& id )

Overridden from UActorComponent

		Name	Description
	void	BeginPlay()	Begins Play for the component.

Overridden from UObject

		Name	Description
	void	BeginDestroy()	Called before destroying the object.

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

Take our survey

Dismiss