1. Epic GamesDeveloper
  3. IDisplayClusterViewportConfiguration

IDisplayClusterViewportConfiguration

Viewport manager configuration.

API > API/Plugins > API/Plugins/DisplayCluster > API/Plugins/DisplayCluster/Render > API/Plugins/DisplayCluster/Render/Viewport

References

   
Module DisplayCluster
Header /Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/Render/Viewport/IDisplayClusterViewportConfiguration.h
Include #include "Render/Viewport/IDisplayClusterViewportConfiguration.h"

Syntax

class IDisplayClusterViewportConfiguration

Remarks

Viewport manager configuration.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const const FString & Return current cluster node id.
Public function Const const UDisplayClusterConfigurationData * Gets a configuration data from the Configuration RootActor
Public function Const const FDisplayClusterConfigurationRenderFrame * Gets a configuration render settings from the Configuration RootActor
Public function Const UWorld * Gets a reference to the current world being rendered in DCRA
Public function Const const FDisplayClusterViewport_PreviewSettings & Gets the current preview settings.
Public function Const const IDisplayClusterViewportConfigurationProxy & Return the configuration proxy object.
Public function Const EDisplayClusterRenderFrameMode Returns the rendering mode for PIE.
Public function Const ADisplayClusterRootActor *

GetRootActor ( const EDisplayClusterRootActorType InRootActorType
)

 Gets a reference to the DCRA by type.
Public function Const const FDisplayClusterConfigurationICVFX_StageSettings * Gets a configuration stage settings from the Configuration RootActor
Public function Const IDisplayClusterViewportManager * Return the viewport manager that used by this configuration.
Public function Const const float Return current value for WorldToMeters.
Public function Const bool

IsCurrentWorldHasAnyType ( const EWorldType::Type InWorldType1,
const EWorldType::Type InWorldType2,
const EWorldType::Type InWorldType3
)

 Returns true if the current world type is equal to one of the input types.
Public function Const bool Returns true if the DCRA preview feature in Standalone/Package builds is used.
Public function Const bool Returns true if preview rendering mode is used.
Public function Const bool

IsRootActorWorldHasAnyType ( const EDisplayClusterRootActorType InRootActorType,
const EWorldType::Type InWorldType1,
const EWorldType::Type InWorldType2,
const EWorldType::Type InWorldType3
)

 Returns true if the given DCRA has a world type equal to one of the input types.
Public function Const bool Returns true if the scene is open now (The current world is assigned and DCRA has already initialized for it).
Public function Const bool Returns true, if Techvis is used.
Public function void Release the current configuration and free resources.
Public function void Assign new preview settings for rendering previews.
Public function void

SetRootActor ( const EDisplayClusterRootActorType InRootActorType,
const ADisplayClusterRootActor* InRootActor
)

 Sets a reference to the DCRA's
Public function bool

UpdateConfigurationForClusterNode ( EDisplayClusterRenderFrameMode InRenderMode,
const UWorld* InWorld,
const FString& InClusterNodeId
)

 Update\Create\Delete local node viewports Updating the configuration to render a ClusterNode in the specified mode
Public function bool

UpdateConfigurationForViewportsList ( EDisplayClusterRenderFrameMode InRenderMode,
const UWorld* InWorld,
const TArray< FString >& InViewportNames
)

 Update\Create\Delete local node viewports Updating the configuration to render a list of viewports in a given mode

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page