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

References

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

Syntax

struct FDisplayClusterLightCardEditorHelper

Remarks

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.

Constructors

  Type Name Description
Public function   Create a projection helper that automatically creates its own preview renderer for normal map generation.
Public function   Create a projection helper that uses an existing preview renderer for normal map generation.

Destructors

  Type Name Description
Public function   Clean up the projection renderer and any data used by the helper.

Functions

  Type Name Description
Public function Static void

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

 Adds the given Light Card to the root actor
Public function bool

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

 Calculates the relative normal vector and world position in the specified direction from the given view origin.
Public function bool

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

 Calculates the desired direction from the view origin given a pixel position within the view.
Public function Const void Sets up projection-related settings of a preview render in a consistent way.
Public function Const FDisplayClusterMeshProjectionPrimitiveFilter::FPrimitiveFilter Creates the default ShouldApplyProjectionToPrimitive filter that most FDisplayClusterMeshProjectionRenderSettings will use.
Public function Const FDisplayClusterMeshProjectionPrimitiveFilter::FPrimitiveFilter Creates the default ShouldRenderPrimitive filter that most FDisplayClusterMeshProjectionRenderSettings will use.
Public function 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.
Public function 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.
Public function FSphericalCoordinates Gets the spherical coordinates of the specified actor.
Public function Const bool Get whether this is using an orthographic projection.
Public function Const EDisplayClusterMeshProjectionType Get the projection mode to use.
Public function 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.
Public function void

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

 Moves specified actors to desired coordinates.
Public function 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.
Public function Const void

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

 Converts a pixel coordinate into a point and direction vector in world space
Public function void Set the viewport client for which this is handling rendering.
Public function void

SetIsOrthographic ( bool bValue
)

 Set whether to use an orthographic projection.
Public function void If the root actor is a proxy, use this to set the corresponding level instance that is being proxied.
Public function void Set the projection mode to use.
Public function void Set the root actor of the DisplayCluster being controlled.
Public function 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
Public function void Ensures that the actor root component is at the same location as the projection/view origin
Public function Const bool

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

 Converts a world coordinate into a point in screen space, and returns true if the world position is on the screen.
Public function Const bool

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

 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.

Classes

  Type Name Description
Public struct FAddLightCardArgs    
Public struct FSpawnActorArgs    
Public struct FSphericalCoordinates    

Enums

  Type Name Description
Public enum ECoordinateSystem    

Deprecated Functions

  Type Name Description
Public function const UTexture2D *

GetNormalMapTexture ( bool bShowNorthMap
)

 The raw stage geoemetry normal maps are no longer exposed by the stage geometry component

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page