Navigation
API > API/Plugins > API/Plugins/DisplayClusterScenePreview > API/Plugins/DisplayClusterScenePreview/IDisplayClusterScenePreview
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool SetRendererRootActorPath
(
int32 RendererId, |
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, |
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 |
SetRendererRootActorPath(int32, const FString &, bool)
Description
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. Whenever a render is performed with this renderer, it will try to find the actor at that path and use it as the root.
| Name | SetRendererRootActorPath |
| Type | function |
| Header File | /Engine/Plugins/Runtime/nDisplay/Source/DisplayClusterScenePreview/Public/IDisplayClusterScenePreview.h |
| Include Path | #include "IDisplayClusterScenePreview.h" |
virtual bool SetRendererRootActorPath
(
int32 RendererId,
const FString & ActorPath,
bool bAutoUpdateLightcards
)
Parameters
| Name | Remarks |
|---|---|
| RendererId | The ID of the renderer as returned from CreateRenderer. |
| ActorPath | The path of the ADisplayClusterRootActor actor to preview. |
| bAutoUpdateLightcards | If true, the renderer scene will also be automatically populated with the actor's associated lightcards, including future changes to them. |
SetRendererRootActorPath(int32, const FString &, const FDisplayClusterRootActorPropertyOverrides &, const EDisplayClusterScenePreviewFlags)
Description
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. Whenever a render is performed with this renderer, it will try to find the actor at that path and use it as the root.
| Name | SetRendererRootActorPath |
| Type | function |
| Header File | /Engine/Plugins/Runtime/nDisplay/Source/DisplayClusterScenePreview/Public/IDisplayClusterScenePreview.h |
| Include Path | #include "IDisplayClusterScenePreview.h" |
bool SetRendererRootActorPath
(
int32 RendererId,
const FString & ActorPath,
const FDisplayClusterRootActorPropertyOverrides & InPropertyOverrides,
const EDisplayClusterScenePreviewFlags PreviewFlags
)
Parameters
| Name | Remarks |
|---|---|
| RendererId | The ID of the renderer as returned from CreateRenderer. |
| ActorPath | The path of the ADisplayClusterRootActor actor to preview. |
| InPropertyOverrides | optional overrides for root actor |
| PreviewFlags | Special flags that control the behavior of the renderer. |