Navigation
API > API/Plugins > API/Plugins/DisplayCluster > API/Plugins/DisplayCluster/Components
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UActorComponent
- UDisplayClusterPreviewShareComponent
References
| Module | DisplayCluster |
| Header | /Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/Components/DisplayClusterPreviewShareComponent.h |
| Include | #include "Components/DisplayClusterPreviewShareComponent.h" |
Syntax
UCLASS (ClassGroup=(DisplayCluster), Meta=(BlueprintSpawnableComponent),
HideCategories=(Activation, Collision, Cooking))
class UDisplayClusterPreviewShareComponent : public UActorComponent
Remarks
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.
Variables
| Type | Name | Description | |
|---|---|---|---|
   |
EDisplayClusterPreviewShareIcvfxSync | IcvfxCamerasSyncType | Type of Icvfx camera sync to be performed between the Source nDisplay actor and the owner of this component |
    |
EDisplayClusterPreviewShareMode | Mode | Current sharing mode of this component |
   |
TSoftObjectPtr< ADisplayClusterRootActor > | SourceNDisplayActor | The source nDisplay actor to pull the preview from |
    |
FString | UniqueName | Current unique name of this component, which should match between sender and receiver of viewport textures |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UDisplayClusterPreviewShareComponent
(
const FObjectInitializer& ObjectInitializer |
Constructor |
Functions
| Type | Name | Description | |
|---|---|---|---|
   |
void | SetMode
(
EDisplayClusterPreviewShareMode NewMode |
Sets the sharing mode |
   |
void | SetUniqueName
(
const FString& NewUniqueName |
Sets the unique name, which should match between sender and receiver of viewport textures |
 |
bool | UpdateCustomViewportManager
(
const ADisplayClusterRootActor* InSrcRootActor |
Creates or updates a custom rendering for the specified RootActor. |
Overridden from UActorComponent
| Type | Name | Description | |
|---|---|---|---|
  |
void | OnComponentDestroyed
(
bool bDestroyingHierarchy |
Called when a component is destroyed |
  |
void | OnRegister () |
Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called. |
  |
void | TickComponent
(
float DeltaTime, |
Function called every frame on this ActorComponent. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally |
  |
void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |
  |
void | Handles reading, writing, and reference collecting using FArchive. |