1. Epic GamesDeveloper
  3. FDisplayClusterLightCardEditorHelper

FDisplayClusterLightCardEditorHelper

Helper class for moving lightcards in an nDisplay cluster in various projection modes.

API > API/Plugins > API/Plugins/DisplayClusterScenePreview

Helper class for moving lightcards in an nDisplay cluster in various projection modes. Contains functions to perform coordinate conversion, scene setup, and lightcard movement, and manages the normal maps needed to convert from projected to world coordinates.

   
Name FDisplayClusterLightCardEditorHelper
Type struct
Header File /Engine/Plugins/Runtime/nDisplay/Source/DisplayClusterScenePreview/Public/DisplayClusterLightCardEditorHelper.h
Include Path #include "DisplayClusterLightCardEditorHelper.h"

Syntax

struct FDisplayClusterLightCardEditorHelper

Constructors

Name Remarks Include Path Unreal Specifiers
Create a projection helper that uses an existing preview renderer for normal map generation. DisplayClusterLightCardEditorHelper.h  
Create a projection helper that automatically creates its own preview renderer for normal map generation. DisplayClusterLightCardEditorHelper.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FDisplayClusterLightCardEditorHelper()

 Clean up the projection renderer and any data used by the helper. DisplayClusterLightCardEditorHelper.h  

Structs

Name Remarks
FAddLightCardArgs  
FSpawnActorArgs  
FSphericalCoordinates  

Enums

Public

Name Remarks
ECoordinateSystem  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bCreatedRenderer bool Whether this created its own preview renderer (and therefore is responsible for destroying it). DisplayClusterLightCardEditorHelper.h  
bIsOrthographic bool If true, this is using an orthographic projection mode. DisplayClusterLightCardEditorHelper.h  
bNormalMapInvalid bool Indicates if the cached normal map is invalid and needs to be redrawn DisplayClusterLightCardEditorHelper.h  
CachedRootActor TWeakObjectPtr< ADisplayClusterRootActor > The cached root actor of the DisplayCluster being controlled. DisplayClusterLightCardEditorHelper.h  
LevelInstanceRootActor TWeakObjectPtr< ADisplayClusterRootActor > The level instance root actor of the DisplayCluster being controlled, if RootActor is a proxy. DisplayClusterLightCardEditorHelper.h  
NormalMapMeshComponent TWeakObjectPtr< UProceduralMeshComponent > A morphed ico-sphere mesh component that approximates the normal and depth map. DisplayClusterLightCardEditorHelper.h  
NormalMeshScene TSharedPtr< FPreviewScene > The preview scene containing NormalMapMeshComponent. DisplayClusterLightCardEditorHelper.h  
ProjectionMode EDisplayClusterMeshProjectionType The projection mode of the view this is helping. DisplayClusterLightCardEditorHelper.h  
ProjectionOriginComponent TWeakObjectPtr< USceneComponent > The component of the root actor that is acting as the projection origin. DisplayClusterLightCardEditorHelper.h  
RendererId int32 The ID of the preview renderer used for normal map generation, as returned by IDisplayClusterScenePreview. DisplayClusterLightCardEditorHelper.h  
RootActorBoundingRadius float The radius of the bounding sphere that entirely encapsulates the root actor DisplayClusterLightCardEditorHelper.h  
ViewportClient TWeakPtr< FEditorViewportClient > The viewport client for which this is handling projections. This can be null. DisplayClusterLightCardEditorHelper.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CalculateNormalAndPositionInDirection ( const FVector& InOrigin,
const FVector& InDirection,
FVector& OutWorldPosition,
FVector& OutRelativeNormal,
double InDesiredDistanceFromFlush
)

 Calculates the relative normal vector and world position in the specified direction from the given origin. DisplayClusterLightCardEditorHelper.h  

bool CalculateOriginAndDirectionFromPixelPosition ( const FIntPoint& InPixelPos,
const FSceneView& InSceneView,
const FVector& InOriginOffset,
FVector& OutOrigin,
FVector& OutDirection
)

 Calculates the desired direction from the origin given a pixel position within the view. DisplayClusterLightCardEditorHelper.h  

void ConfigureRenderProjectionSettings ( FDisplayClusterMeshProjectionRenderSettings& OutRenderSettings,
FVector ViewLocation
) const

 Sets up projection-related settings of a preview render in a consistent way. DisplayClusterLightCardEditorHelper.h  

FDisplayClusterMeshProjectionPrimitiveFilter::FPrimitiveFilter CreateDefaultShouldApplyProjectionToPrimitiveFilter ()

 Creates the default ShouldApplyProjectionToPrimitive filter that most FDisplayClusterMeshProjectionRenderSettings will use. DisplayClusterLightCardEditorHelper.h  

FDisplayClusterMeshProjectionPrimitiveFilter::FPrimitiveFilter CreateDefaultShouldRenderPrimitiveFilter ()

 Creates the default ShouldRenderPrimitive filter that most FDisplayClusterMeshProjectionRenderSettings will use. DisplayClusterLightCardEditorHelper.h  

void DragActors ( const TArray< FDisplayClusterWeakStageActorPtr >& Actors,
const FIntPoint& PixelPos,
const FSceneView& SceneView,
ECoordinateSystem CoordinateSystem,
const FVector& DragWidgetOffset,
EAxisList::Type DragAxis,
FDisplayClusterWeakStageActorPtr PrimaryActor
)

 Moves specified cards to a coordinate in viewport space as if dragged by a translate widget. DisplayClusterLightCardEditorHelper.h  

void DragUVActors ( const TArray< FDisplayClusterWeakStageActorPtr >& Actors,
const FIntPoint& PixelPos,
const FSceneView& SceneView,
const FVector& DragWidgetOffset,
EAxisList::Type DragAxis,
FDisplayClusterWeakStageActorPtr PrimaryActor
)

 Moves specified UV actors to a coordinate in viewport space as if dragged by a translate widget. DisplayClusterLightCardEditorHelper.h  

FSphericalCoordinates GetActorCoordinates ( const FDisplayClusterWeakStageActorPtr& Actor
)

 Gets the spherical coordinates of the specified actor. DisplayClusterLightCardEditorHelper.h  

bool GetIsOrthographic()

 Get whether this is using an orthographic projection. DisplayClusterLightCardEditorHelper.h  

const UTexture2D * GetNormalMapTexture ( bool bShowNorthMap
)

 Get (or generate) a visualization of one of the helper's normal maps. DisplayClusterLightCardEditorHelper.h  

EDisplayClusterMeshProjectionType GetProjectionMode()

 Get the projection mode to use. DisplayClusterLightCardEditorHelper.h  

void GetSceneViewInitOptions ( FSceneViewInitOptions& OutViewInitOptions,
float InFOV,
const FIntPoint& InViewportSize,
const FVector& InLocation,
const FRotator& InRotation,
const EAspectRatioAxisConstraint InAspectRatioAxisConstraint,
float InNearClipPlane,
const FMatrix* InRotationMatrix,
float InDPIScale
)

 Sets up FSceneViewInitOptions' basic settings in a consistent way for preview renders. DisplayClusterLightCardEditorHelper.h  

void MoveActorsTo ( const TArray< FDisplayClusterWeakStageActorPtr >& Actors,
const FSphericalCoordinates& SphericalCoords
)

 Moves specified actors to desired coordinates. DisplayClusterLightCardEditorHelper.h  

void MoveActorsToPixel ( const TArray< FDisplayClusterWeakStageActorPtr >& Actors,
const FIntPoint& PixelPos,
const FSceneView& SceneView
)

 Moves the given light cards to the specified pixel position within the provided scene view. DisplayClusterLightCardEditorHelper.h  

void PixelToWorld ( const FSceneView& View,
const FIntPoint& PixelPos,
FVector& OutOrigin,
FVector& OutDirection
) const

 Converts a pixel coordinate into a point and direction vector in world space DisplayClusterLightCardEditorHelper.h  

void SetEditorViewportClient ( TWeakPtr< FEditorViewportClient > InViewportClient
)

 Set the viewport client for which this is handling rendering. DisplayClusterLightCardEditorHelper.h  

void SetIsOrthographic ( bool bValue
)

 Set whether to use an orthographic projection. DisplayClusterLightCardEditorHelper.h  

void SetLevelInstanceRootActor ( ADisplayClusterRootActor& NewRootActor
)

 If the root actor is a proxy, use this to set the corresponding level instance that is being proxied. DisplayClusterLightCardEditorHelper.h  

void SetProjectionMode ( EDisplayClusterMeshProjectionType Value
)

 Set the projection mode to use. DisplayClusterLightCardEditorHelper.h  

void SetRootActor ( ADisplayClusterRootActor& NewRootActor
)

 Set the root actor of the DisplayCluster being controlled. DisplayClusterLightCardEditorHelper.h  

void VerifyAndFixActorOrigin ( const FDisplayClusterWeakStageActorPtr& Actor
)

 Ensures that the actor root component is at the same location as the projection/origin DisplayClusterLightCardEditorHelper.h  

bool WorldToPixel ( const FSceneView& View,
const FVector& WorldPos,
FVector2D& OutPixelPos
) const

 Converts a world coordinate into a point in screen space, and returns true if the world position is on the screen. DisplayClusterLightCardEditorHelper.h  

bool WorldToPixel ( const FSceneView& View,
const FVector& WorldPos,
FVector2D& OutPixelPos,
EDisplayClusterMeshProjectionType OverrideProjectionMode
) const

 Converts a world coordinate into a point in screen space using a specific projection mode, and returns true if the world position is on the screen. DisplayClusterLightCardEditorHelper.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AddLightCardsToRootActor ( const TArray< ADisplayClusterLightCardActor* >& LightCards,
ADisplayClusterRootActor* RootActor,
const FAddLightCardArgs& AddLightCardArgs
)

 Adds the given Light Card to the root actor DisplayClusterLightCardEditorHelper.h  

static AActor * SpawnStageActor ( const FSpawnActorArgs& InSpawnArgs
)

 Spawns a new actor for stage use and adds it to the root actor if it is a light card DisplayClusterLightCardEditorHelper.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page