1. Epic GamesDeveloper
  3. IDisplayClusterScenePreview

IDisplayClusterScenePreview

Interface for module containing tools for generation Display Cluster scene previews.

API > API/Plugins > API/Plugins/DisplayClusterScenePreview

Interface for module containing tools for generation Display Cluster scene previews.

   
Name IDisplayClusterScenePreview
Type class
Header File /Engine/Plugins/Runtime/nDisplay/Source/DisplayClusterScenePreview/Public/IDisplayClusterScenePreview.h
Include Path #include "IDisplayClusterScenePreview.h"

Syntax

class IDisplayClusterScenePreview : public IModuleInterface

Implements Interfaces

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IDisplayClusterScenePreview()

   IDisplayClusterScenePreview.h  

Constants

Name Type Remarks Include Path
ModuleName const TCHAR *   IDisplayClusterScenePreview.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AddActorToRenderer ( int32 RendererId,
AActor* Actor,
const TFunctionRef< bool(const UPrimitiveComponent*)>& PrimitiveFilter
)

 Add an actor to the preview scene for a renderer. IDisplayClusterScenePreview.h  

bool AddActorToRenderer ( int32 RendererId,
AActor* Actor
)

 Add an actor to the preview scene for a renderer. IDisplayClusterScenePreview.h  

bool ClearRendererScene ( int32 RendererId
)

 Clear the scene of a renderer. IDisplayClusterScenePreview.h  

int32 CreateRenderer()

 Create a preview renderer. Returns an index used to refer to this renderer in future API calls. IDisplayClusterScenePreview.h  

bool DestroyRenderer ( int32 RendererId
)

 Destroy a renderer, cleaning up all of its resources. IDisplayClusterScenePreview.h  

bool GetActorsInRendererScene ( int32 RendererId,
bool bIncludeRoot,
TArray< AActor* >& OutActors
)

 Get a list of all actors that have been added to a renderer's scene. IDisplayClusterScenePreview.h  

ADisplayClusterRootActor * GetRendererRootActor ( int32 RendererId
)

 Get the root actor of a renderer. IDisplayClusterScenePreview.h  

ADisplayClusterRootActor * GetRendererRootActorOrProxy ( int32 RendererId
)

 Get the root actor (or its proxy) of a renderer. IDisplayClusterScenePreview.h  

bool IsRealTimePreviewEnabled()

 Check whether nDisplay preview textures are being updated in real time. IDisplayClusterScenePreview.h  

bool RemoveActorFromRenderer ( int32 RendererId,
AActor* Actor
)

 Removes an actor from the preview scene for a renderer. IDisplayClusterScenePreview.h  

bool Render ( int32 RendererId,
FDisplayClusterMeshProjectionRenderSettings& RenderSettings,
FCanvas& Canvas
)

 Immediately render a preview. IDisplayClusterScenePreview.h  

bool RenderQueued ( int32 RendererId,
FDisplayClusterMeshProjectionRenderSettings& RenderSettings,
const FIntPoint& Size,
FRenderResultDelegate ResultDelegate
)

 Queue a preview to be rendered in the future, automatically creating a canvas and render target. IDisplayClusterScenePreview.h  

bool RenderQueued ( int32 RendererId,
FDisplayClusterMeshProjectionRenderSettings& RenderSettings,
TWeakPtr< FCanvas > Canvas,
FRenderResultDelegate ResultDelegate
)

 Queue a preview to be rendered in the future using an existing canvas. IDisplayClusterScenePreview.h  

bool SetRendererActorSelectedDelegate ( int32 RendererId,
FDisplayClusterMeshProjectionRenderer::FSelection ActorSelectedDelegate
)

 Set the ActorSelectedDelegate of a renderer. IDisplayClusterScenePreview.h  

bool SetRendererRenderSimpleElementsDelegate ( int32 RendererId,
FDisplayClusterMeshProjectionRenderer::FSimpleElementPass RenderSimpleElementsDelegate
)

 Set the RenderSimpleElementsDelegate of a renderer. IDisplayClusterScenePreview.h  

virtual bool SetRendererRootActor ( int32 RendererId,
ADisplayClusterRootActor* Actor,
bool bAutoUpdateLightcards
)

 Set the root DisplayCluster actor for the renderer with the given ID, which will be added to the preview scene and used to determine the render world. IDisplayClusterScenePreview.h  

bool SetRendererRootActor ( int32 RendererId,
ADisplayClusterRootActor* Actor,
const FDisplayClusterRootActorPropertyOverrides& InPropertyOverrides,
const EDisplayClusterScenePreviewFlags PreviewFlags
)

 Set the root DisplayCluster actor for the renderer with the given ID, which will be added to the preview scene and used to determine the render world. IDisplayClusterScenePreview.h  

virtual bool SetRendererRootActorPath ( int32 RendererId,
const FString& ActorPath,
bool bAutoUpdateLightcards
)

 Set the path of the ADisplayClusterRootActor actor for a renderer, which will be added to the preview scene and used to determine the render world. IDisplayClusterScenePreview.h  

bool SetRendererRootActorPath ( int32 RendererId,
const FString& ActorPath,
const FDisplayClusterRootActorPropertyOverrides& InPropertyOverrides,
const EDisplayClusterScenePreviewFlags PreviewFlags
)

 Set the path of the ADisplayClusterRootActor actor for a renderer, which will be added to the preview scene and used to determine the render world. IDisplayClusterScenePreview.h  

virtual bool SetRendererUsePostProcessTexture ( int32 RendererId,
bool bUsePostProcessTexture
)

 Set whether the renderer should use post-processed nDisplay preview textures. IDisplayClusterScenePreview.h  

Static

Name Remarks Include Path Unreal Specifiers
Singleton-like access to this module's interface. IDisplayClusterScenePreview.h  

static bool IsAvailable ()

 Checks to see if this module is loaded and ready. IDisplayClusterScenePreview.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page