1. Epic GamesDeveloper
  3. IDisplayClusterScenePreview

IDisplayClusterScenePreview

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

API > API/Plugins > API/Plugins/DisplayClusterScenePreview

Inheritance Hierarchy

References

   
Module DisplayClusterScenePreview
Header /Engine/Plugins/Runtime/nDisplay/Source/DisplayClusterScenePreview/Public/IDisplayClusterScenePreview.h
Include #include "IDisplayClusterScenePreview.h"

Syntax

class IDisplayClusterScenePreview : public IModuleInterface

Remarks

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

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function bool

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

 Add an actor to the preview scene for a renderer.
Public function bool

AddActorToRenderer ( int32 RendererId,
AActor* Actor
)

 Add an actor to the preview scene for a renderer.
Public function bool

ClearRendererScene ( int32 RendererId
)

 Clear the scene of a renderer.
Public function int32 Create a preview renderer. Returns an index used to refer to this renderer in future API calls.
Public function bool

DestroyRenderer ( int32 RendererId
)

 Destroy a renderer, cleaning up all of its resources.
Public function Static IDisplayClusterScenePreview &

Get ()

 Singleton-like access to this module's interface.
Public function bool

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

 Get a list of all actors that have been added to a renderer's scene.
Public function ADisplayClusterRootActor *

GetRendererRootActor ( int32 RendererId
)

 Get the root actor of a renderer.
Public function Static bool Checks to see if this module is loaded and ready.
Public function Const bool Check whether nDisplay preview textures are being updated in real time.
Public function bool

RemoveActorFromRenderer ( int32 RendererId,
AActor* Actor
)

 Removes an actor from the preview scene for a renderer.
Public function bool

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

 Immediately render a preview.
Public function 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.
Public function bool

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

 Queue a preview to be rendered in the future using an existing canvas.
Public function bool Set the ActorSelectedDelegate of a renderer.
Public function bool Set the RenderSimpleElementsDelegate of a renderer.
Public function 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.
Public function 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.
Public function bool

SetRendererUsePostProcessTexture ( int32 RendererId,
bool bUsePostProcessTexture
)

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

Constants

Name Description
ModuleName  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page