1. Epic GamesDeveloper
  3. UDisplayClusterPreviewShareComponent

UDisplayClusterPreviewShareComponent

NDisplay Viewport preview share component

API > API/Plugins > API/Plugins/DisplayCluster

NDisplay Viewport preview share component

It shares using Shared Memory Media the viewport textures of the parent nDisplay Actor. It should only be added to DisplayClusterRootActor instances, and only one component per instance. The way it works is that the sender generates a unique name for each viewport and captures its texture by getting a pointer to it from the corresponding Preview Component. The receiver will read it using the corresponding media source, and use the Texture Replace functionality in the nDisplay actor viewports to have them used and displayed.

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

Syntax

UCLASS (ClassGroup=(DisplayCluster), Meta=(BlueprintSpawnableComponent),  
       HideCategories=(Activation, Collision, Cooking))  
class UDisplayClusterPreviewShareComponent : public UActorComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UDisplayClusterPreviewShareComponent ( const FObjectInitializer& ObjectInitializer
)

 Constructor Components/DisplayClusterPreviewShareComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
IcvfxCamerasSyncType EDisplayClusterPreviewShareIcvfxSync Type of Icvfx camera sync to be performed between the Source nDisplay actor and the owner of this component Components/DisplayClusterPreviewShareComponent.h
  • EditAnywhere
  • Category=Sharing
  • Meta=(EditCondition="Mode == EDisplayClusterPreviewShareMode::PullActor")
Mode EDisplayClusterPreviewShareMode Current sharing mode of this component Components/DisplayClusterPreviewShareComponent.h
  • EditAnywhere
  • Setter=SetMode
  • BlueprintSetter=SetMode
  • Category=Sharing
SourceNDisplayActor TSoftObjectPtr< ADisplayClusterRootActor > The source nDisplay actor to pull the preview from Components/DisplayClusterPreviewShareComponent.h
  • EditAnywhere
  • Meta=(DisplayName="Source nDisplay Actor")
  • Category=Sharing
  • Meta=(EditCondition="Mode == EDisplayClusterPreviewShareMode::PullActor")
UniqueName FString Current unique name of this component, which should match between sender and receiver of viewport textures Components/DisplayClusterPreviewShareComponent.h
  • EditAnywhere
  • Setter=SetUniqueName
  • BlueprintSetter=SetUniqueName
  • Category=Sharing
  • Meta=(EditCondition="Mode == EDisplayClusterPreviewShareMode::Send || Mode == EDisplayClusterPreviewShareMode::Receive")

Protected

Name Type Remarks Include Path Unreal Specifiers
CustomViewportManager TSharedPtr< IDisplayClusterViewportManager, ESPMode::ThreadSafe > DC ViewportManager instance for this component Used to perform rendering with custom settings from an external DCRA Components/DisplayClusterPreviewShareComponent.h  
MediaCaptures TMap< FString, TObjectPtr< UMediaCapture > > Media Captures associated with the given viewport unique names Components/DisplayClusterPreviewShareComponent.h
  • Transient
MediaOutputs TMap< FString, TObjectPtr< UMediaOutput > > Media Outputs associated with the given viewport unique names Components/DisplayClusterPreviewShareComponent.h
  • Transient
MediaPlayers TMap< FString, TObjectPtr< UMediaPlayer > > Media Players associated with the given viewport unique names Components/DisplayClusterPreviewShareComponent.h
  • Transient
MediaSources TMap< FString, TObjectPtr< UMediaSource > > Media Sources associated with the given viewport unique names Components/DisplayClusterPreviewShareComponent.h
  • Transient
MediaTextures TMap< FString, TObjectPtr< UMediaTexture > > Media Textures associated with the given viewport unique names Components/DisplayClusterPreviewShareComponent.h
  • Transient
OriginalSourceTextures TMap< FString, TObjectPtr< UTexture > > Cache of original Texture Replace Source Textures associated with the given viewport unique names. Components/DisplayClusterPreviewShareComponent.h
  • Transient
OriginalTextureReplaces TMap< FString, bool > Cache of original Texture Replace enable boolean associated with the given viewport unique names. Components/DisplayClusterPreviewShareComponent.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

void SetMode ( EDisplayClusterPreviewShareMode NewMode
)

 Sets the sharing mode Components/DisplayClusterPreviewShareComponent.h
  • BlueprintCallable
  • Category="Sharing"

void SetUniqueName ( const FString& NewUniqueName
)

 Sets the unique name, which should match between sender and receiver of viewport textures Components/DisplayClusterPreviewShareComponent.h
  • BlueprintCallable
  • Category="Sharing"

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void OnComponentDestroyed ( bool bDestroyingHierarchy
)

   Components/DisplayClusterPreviewShareComponent.h  

virtual void TickComponent ( float DeltaTime,
ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

   Components/DisplayClusterPreviewShareComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Components/DisplayClusterPreviewShareComponent.h  

virtual void PostLoad()

   Components/DisplayClusterPreviewShareComponent.h  

virtual void Serialize ( FArchive& Ar
)

   Components/DisplayClusterPreviewShareComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool UpdateCustomViewportManager ( const ADisplayClusterRootActor* InSrcRootActor
)

 Creates or updates a custom rendering for the specified RootActor. Components/DisplayClusterPreviewShareComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void OnRegister()

   Components/DisplayClusterPreviewShareComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page