Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. ADisplayClusterRootActor

ADisplayClusterRootActor

VR root. This contains nDisplay VR hierarchy in the game.

API > API/Plugins > API/Plugins/DisplayCluster

Inheritance Hierarchy

References

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

Syntax

UCLASS (NotPlaceable,  
       HideCategories=(Replication, Collision, Input, Actor, HLOD, Cooking, Physics, Activation, AssetUserData, ActorTick, Advanced, DataLayers, Events),  
       Meta=(DisplayName="nDisplay Root Actor"))  
class ADisplayClusterRootActor : public AActor

Remarks

VR root. This contains nDisplay VR hierarchy in the game.

Variables

  Type Name Description
Public variable UProperty Category displayname, visibledefaultsonly TObjectPtr< UDisplayClusterDisplayDeviceBaseComponent > BasicDisplayDeviceComponent The included display device nDisplay provides by default
Public variable UProperty Transient nontransactional bool bEnablePreviewEditableMesh Enable the use of a preview editable mesh for the preview for this DCRA.
Public variable UProperty Transient nontransactional bool bEnablePreviewMesh Enable the use of a preview mesh for the preview for this DCRA.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite bool bEnablePreviewTechvis Configure the root actor for Techvis rendering with preview components.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bFreezePreviewRender Freeze preview render. This will impact editor performance.
Public variable UProperty Transient nontransactional bool bMoviePipelineRenderPass When the MRQ is rendered, this flag is raised.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bPreviewEnable EDITOR RELATED SETTINGS.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite bool bPreviewEnableOverlayMaterial Show overlay material on the preview mesh when preview rendering is enabled (UMeshComponent::OverlayMaterial).
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter bool bPreviewEnablePostProcess Enable PostProcess for preview.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bPreviewICVFXFrustums Render ICVFX Frustums
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite bool bPreviewInGameEnable Render this DCRA in game for Standalone/Package builds.
Public variable UProperty bool bPreviewInGameRenderFrustum Enables the use of 'bPreviewICVFXFrustums' in the game.
Public variable UProperty Category, AdvancedDisplay editinstanceonly bool bPreviewStageGeometryMesh Toggles the visibility of the stage's geometry mesh, a smooth, continuous mesh generated and processed from the stage's geometry
Public variable UProperty Category, Meta BlueprintReadOnly instanced, visibleanywhere TObjectPtr< UDisplayClusterConfigurationData > CurrentConfigData If set from the DisplayCluster BP Compiler it will be loaded from the class default subobjects in run-time.
Protected variable UProperty Transient nontransactional TObjectPtr< UDisplayClusterDisplayDeviceBaseComponent > DefaultDisplayDeviceComponent The default display device to use for preview rendering
Public variable UProperty Category, EditDefaultsOnly, AdvancedDisplay displayname FName DefaultDisplayDeviceName Select the default display device class to use when a viewport doesn't have one assigned
Public variable UProperty Category, Meta editfixedsize, editinstanceonly TArray< FDisplayClusterComponentRef > InnerFrustumPriority Set the priority for inner frustum rendering if there is any overlap when enabling multiple ICVFX cameras.
Protected variable UProperty Transient nontransactional TObjectPtr< ULineBatchComponent > LineBatcherComponent Line Batchers. All lines to be drawn in the world, but not inside viewports.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite float PreviewICVFXFrustumsFarDistance Render ICVFX Frustums
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite int PreviewMaxTextureDimension The maximum dimension of any internal texture for preview.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FString PreviewNodeId Selectively preview a specific viewport or show all/none.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float PreviewRenderTargetRatioMult Adjust resolution scaling for the editor preview.
Public variable UProperty Transient nontransactional EDisplayClusterConfigurationRootActorPreviewSettingsSource PreviewSetttingsSource Determines where the preview settings will be retrieved from.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite EDisplayClusterConfigurationRenderMode RenderMode Render Mode
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite int TickPerFrame Tick Per Frame
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite int ViewportsPerFrame Max amount of Viewports Per Frame

Constructors

  Type Name Description
Public function  

ADisplayClusterRootActor ( const FObjectInitializer& ObjectInitializer
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AddPreviewEnableOverride ( const uint8* Object
)

 Force preview rendering to be enabled regardless of the user's setting until a matching RemovePreviewEnableOverride call is made.
Public function Static void  
Public function void  
Protected function bool Creates all hierarchy objects declared in a config file.
Public function void  
Public function void  
Public function void  
Public function Const bool If one or more observers are subscribed to receive post process preview targets.
Public function void

EnableEditorRender ( bool bValue
)

 EDITOR RELATED SETTINGS.
Public function void

EndPlay_Editor ( const EEndPlayReason::Type EndPlayReason
)

  
Public function Const IDisplayClusterViewport *

FindPreviewViewport ( const FString& InViewportId
)

  
Public function bool

FindPrimitivesByName ( const TArray< FString >& InNames,
TSet< FPrimitiveComponentId >& OutPrimitives,
bool bForceHide
)

 Collect UActorComponent primitives by names.
Public function Const UFunction BlueprintCallable, Category USceneComponent * Get the view point most commonly used by viewports in this cluster.
Public function Const TComp *

GetComponentByName ( const FString& ComponentName
)

  
Public function Const UDisplayClusterConfigurationData *  
Public function Static FName  
Public function Const UFunction blueprintgetter UDisplayClusterCameraComponent *  
Public function Const UDisplayClusterConfigurationData *  
Public function Const UFunction blueprintgetter UDisplayClusterDisplayDeviceBaseComponent * Retrieve the default display device, creating it if it doesn't exist
Public function Const UFunction BlueprintCallable, Category bool

GetDistanceToStageGeometry ( const FVector& WorldPosition,
const FVector& WorldDirection,
float& OutDistance
)

 Gets the distance from a world position to the stage's geometry along the specified direction, if there is an intersection
Public function UFunction BlueprintCallable, Category bool

GetFlushPositionAndNormal ( const FVector& WorldPosition,
FVector& OutPosition,
FVector& OutNormal
)

  
Public function bool Return hidden in game privitives set.
Public function Const int

GetInnerFrustumPriority ( const FString& InnerFrustumID
)

 Return inner frustum priority by InnerFrustum name (from InnerFrustumPriority property) return -1, if not defined
Protected function Virtual Const FName The name the internal default display device uses.
Public function Const ULineBatchComponent * Retrieve the line batch component.
Public function FOnPreviewUpdated &  
Public function FOnPreviewUpdated &  
Public function IDisplayClusterViewportManager * Get or Create ViewportManager API.
Public function Const UDisplayClusterPreviewComponent *

GetPreviewComponent ( const FString& NodeId,
const FString& ViewportId
)

  
Public function Const EDisplayClusterRenderFrameMode Returns the preview rendering mode of this DCRA.
Public function void

GetPreviewRenderTargetableTextures ( const TArray< FString >& InViewportNames,
TArray< FTextureRHIRef >& OutTextures
)

  
Public function Const float  
Public function Const FDisplayClusterViewport_PreviewSettings

GetPreviewSettings ( bool bIgnorePreviewSetttingsSource
)

 Get current settings for preview rendering.
Public function Const const FDisplayClusterConfigurationRenderFrame &  
Public function Const EDisplayClusterRenderFrameMode Returns the current rendering mode of this DCRA (not a value from configuration).
Public function Const UFunction blueprintgetter UDisplayClusterStageGeometryComponent *  
Public function Const const FDisplayClusterConfigurationICVFX_StageSettings &  
Public function Const UDisplayClusterSyncTickComponent *  
Public function Const IDisplayClusterViewportConfiguration * Get ViewportConfiguration API.
Public function Const IDisplayClusterViewportManager * Get ViewportManager API.
Public function Const float  
Protected function void

HandleAssetReload ( const EPackageReloadPhase InPackageReloadPhase,
FPackageReloadedEvent* InPackageReloadedEvent
)

 Called when the asset has been reloaded in the editor.
Public function void Initialializes the instance with specified config data
Protected function void Initializes the actor on spawn and load.
Public function Const bool  
Public function Const bool If editor rendering is enabled.
Public function Const bool

IsInnerFrustumEnabled ( const FString& InnerFrustumID
)

  
Public function Const bool Gets whether the preview output is displayed onto the stage actor's screen meshes
Public function Const bool Return true, if preview enabled for this actor
Public function Const bool Returns true if this RootActor is used as the primary RootActor in the DC GameManager.
Public function Const bool Returns true if this RootActor is primary and should be displayed in PIE mode.
Public function Const bool Returns true if this RootActor is running in DC mode.
Public function Const bool Returns true if this RootActor is running in game or in PIE mode.
Public function Const bool Returns true if this RootActor is running in PIE mode.
Public function UFunction BlueprintCallable, Category bool

MakeStageActorFlushToWall ( const TScriptInterface< IDisplayClusterStageActor >& StageActor,
double DesiredOffsetFromFlush
)

  
Protected function void Raised when any object is moved within a level.
Public function void Cherry picking settings from a specified config data
Public function void Override properties of this root actor.
Public function void  
Public function void  
Public function void  
Public function void Stop forcing preview rendering to be enabled for this caller.
Public function void Release the viewport manager instance, if it exists.
Public function void Perform a rendering of the DCRA preview.
Public function void  
Public function void  
Public function void

ResetPreviewComponents_Editor ( bool bInRestoreSceneMaterial
)

 Preview components free referenced meshes and materials
Public function UFunction BlueprintCallable, Category bool

SetFreezeOuterViewports ( bool bEnable
)

  
Public function void

SetIsSelectedInEditor ( bool bValue
)

  
Protected function void Determine which light card actors are owned by this root actor
Public function UFunction blueprintsetter void

SetPreviewEnablePostProcess ( const bool bNewPreviewEnablePostProcess
)

 Blueprint setter for the PreviewEnablePostProcess property.
Public function UFunction BlueprintCallable, Category bool  
Public function Const bool When rendering the preview determine which render target should be used for the current frame.
Public function int32 Enable the use of a post process render target when bPreviewEnablePostProcess is disabled on the actor.
Public function void The Tick() function that calls the preview renderer for this root actor.
Public function int32 Unsubscribe a registered object from requiring post process render target updates.
Public function void

UpdateConfigDataInstance ( UDisplayClusterConfigurationData* ConfigDataTemplate,
bool bForceRecreate
)

 Update or create the config data object.
Public function void  
Public function void  
Public function UFunction BlueprintCallable, Category, Meta void

UpdateProceduralMeshComponentData ( const UProceduralMeshComponent* InProceduralMeshComponent
)

 Update the geometry of the procedural mesh component(s) referenced inside nDisplay

Overridden from AActor

  Type Name Description
Protected function Virtual void AActor.
Protected function Virtual void Called when this actor is explicitly being destroyed during gameplay or in the editor, not called during level streaming or gameplay ending
Protected function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Overridable function called whenever this actor is being removed from a level
Public function Virtual Const bool Don't show actor preview in the level viewport when DCRA actor is selected, but none of its children are.
Protected function Virtual void Called when an actor is done spawning into the world (from UWorld::SpawnActor), both in the editor and during gameplay For actors with a root component, the location and rotation will have already been set.
Protected function Virtual void

PostEditMove ( bool bFinished
)

 Called after an actor has been moved in the editor
Protected function Virtual void Rerun construction scripts, destroying all autogenerated components; will attempt to preserve the root component location.
Public function Virtual Const bool We need tick in Editor.
Protected function Virtual void

Tick ( float DeltaSeconds
)

 Function called every frame on this Actor.

Overridden from UObject

  Type Name Description
Protected function Virtual void Called before destroying the object.
Public function Virtual Const bool Test the selection state of a UObject
Protected function Virtual void This alternate version of PostEditChange is called when properties inside structs are modified.
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Protected function Virtual void Do any object-specific cleanup required immediately after loading an object.
Protected function Virtual void

PostTransacted ( const FTransactionObjectEvent& TransactionEvent
)

 Called after the object has been transacted in some way.

Typedefs

Name Description
FOnPreviewUpdated  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page