1. Epic GamesDeveloper
  3. ADisplayClusterLightCardActor

ADisplayClusterLightCardActor

API > API/Plugins > API/Plugins/DisplayCluster

Inheritance Hierarchy

References

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

Syntax

UCLASS (Blueprintable, DisplayName="Light Card",  
       HideCategories=(Tick, Physics, Collision, Networking, Replication, Cooking, Input, Actor, HLOD))  
class ADisplayClusterLightCardActor :  
    public AActor ,  
    public IDisplayClusterStageActor

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite FLightCardAlphaGradientSettings AlphaGradient Settings related to an alpha gradient effect
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite bool bAlwaysFlushToWall Indicates whether the light card is always made to be flush to a stage wall or not
Protected variable UProperty Meta getter, setter bool bIsLightCardFlag Indicates this light card should be considered a flag
Public variable UProperty getter, setter bool bIsUVLightCard Indicates if the light card exists in 3D space or in UV space
Public variable UProperty bool bLockToOwningRootActor A flag that controls whether the light card's location and rotation are locked to its "owning" root actor
Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite FLinearColor Color Light card color, before any modifier is applied
Protected variable UProperty Category, EditDefaultsOnly BlueprintReadOnly TObjectPtr< USceneComponent > DefaultSceneRootComponent  
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite double DistanceFromCenter Radius of light card polar coordinates. Does not include the effect of RadialOffset
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite float Exposure 2^Exposure color value multiplier
Protected variable UProperty Category visibleanywhere TMap< FName, TObjectPtr< UActorComponent > > ExtenderNameToComponentMap Components added by the IDisplayLightCardActorExtender
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite float Feathering Feathers in the alpha from the edges
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite float Gain Linear color value multiplier
Protected variable UProperty Category BlueprintReadOnly Transient TObjectPtr< UDisplayClusterLabelComponent > LabelComponent  
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite double Latitude Related to the Elevation of light card polar coordinates
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< UStaticMeshComponent > LightCardComponent  
Protected variable UProperty Category, EditDefaultsOnly BlueprintReadOnly TObjectPtr< USceneComponent > LightCardTransformerComponent  
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite double Longitude Related to the Azimuth of light card polar coordinates
Protected variable UProperty Category, EditDefaultsOnly BlueprintReadOnly TObjectPtr< USpringArmComponent > MainSpringArmComponent  
Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite EDisplayClusterLightCardMask Mask  
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite float Opacity Linear alpha multiplier
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite EDisplayClusterConfigurationICVFX_PerLightcardRenderMode PerLightcardRenderMode Specify how to render this Light Card Actor in relation to the inner frustum.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite double Pitch  
Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite TArray< FVector2D > Polygon Polygon points when using this type of mask
Public variable UProperty Transient TObjectPtr< UTexture > PolygonMask Used to flag this light card as a proxy of a "real" light card. Used by the LightCard Editor
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite double RadialOffset Used by the flush constraint to offset the location of the light card form the wall
Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite FVector2D Scale  
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite double Spin Roll rotation of light card around its plane axis
Protected variable UProperty Category visibleanywhere TObjectPtr< UDisplayClusterStageActorComponent > StageActorComponent Manages stage actor properties
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite float Temperature  
Public variable UProperty Category, EditAnywhere, Interp BlueprintReadWrite TObjectPtr< UTexture > Texture  
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite float Tint  
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite FVector2D UVCoordinates The UV coordinates of the light card, if it is in UV space
Protected variable UProperty Category BlueprintReadOnly Transient TObjectPtr< UStaticMeshComponent > UVIndicatorComponent  
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite double Yaw  

Constructors

  Type Name Description
Public function  

ADisplayClusterLightCardActor ( const FObjectInitializer& ObjectInitializer
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void Add this light card to a light card layer on the given root actor
Public function Virtual void Add this light card to a root actor
Protected function void Removes components that were added by IDisplayClusterLightCardActorExtender
Protected function void Creates components for IDisplayClusterLightCardActorExtender
Public function Static FName  
Public function Const UDisplayClusterLabelComponent * Return the label component
Public function Const void Gets the light card mesh components
Public function Const ADisplayClusterRootActor * Return the root actor owner of the light card
Public function Const UDisplayClusterStageActorComponent * Retrieve the stage actor component
Public function Const UStaticMesh * Returns the current static mesh used by this light card
Public function Const bool If this light card is considered a flag
Public function void Makes the light card flush to the wall
Protected function void

OnLevelActorDeleted ( AActor* DeletedActor
)

 Called when a level actor is deleted
Public function Virtual void Remove this light card from the root actor
Protected function void Removes this actor from a root actor's ShowOnlyList.Actors, if possible.
Public function void

SetIsLightCardFlag ( bool bNewFlagValue
)

 Configures this light card as a flag
Public function void

SetIsUVActor ( bool bNewUVValue
)

 Configures this light card as a UV actor
Public function void Set the root actor of the stage actor component
Public function void

SetStaticMesh ( UStaticMesh* InStaticMesh
)

 Sets a new static mesh for the light card
Public function void Set a weak root actor owner.
Public function void

ShowLightCardLabel ( const FDisplayClusterLabelConfiguration& InLabelConfiguration
)

 Configure light card labels
Public function void

ShowLightCardLabel ( bool bValue,
float ScaleValue,
ADisplayClusterRootActor* InRootActor
)

 Show or hide the light card label
Public function void Updates the card's material instance parameters
Public function void Sync the position to the root actor
Public function void Updates the light card actor visibility
Public function void Updates the polygon texture from the polygon points
Public function void Updates the UV Indicator

Overridden from AActor

  Type Name Description
Public 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
Public function Virtual Const FName Returns a custom brush icon name to use in place of the automatic class icon where actors are represented via 2d icons in the editor (e.g scene outliner and menus)
Public function Virtual void

OnConstruction ( const FTransform& Transform
)

 Called when an instance of this class is placed (in editor) or spawned.
Public function Virtual Const bool If true, actor is ticked even if TickType==LEVELTICK_ViewportsOnly
Public function Virtual void

Tick ( float DeltaSeconds
)

 Function called every frame on this Actor.

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

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

Overridden from IDisplayClusterStageActor

  Type Name Description
Public function Virtual Const FBox

GetBoxBounds ( bool bLocalSpace
)

 Gets the object oriented bounding box of the light card component
Public function Virtual Const double  
Public function Virtual Const double  
Public function Virtual Const double  
Public function Virtual Const FTransform  
Public function Virtual Const double  
Public function Virtual Const void Get an array of positional properties defined for this stage actor for use in property notifies.
Public function Virtual Const double  
Public function Virtual Const FVector2D  
Public function Virtual Const double

GetSpin ()

  
Public function Virtual Const FTransform

GetStageActorTransform ( bool bRemoveOrigin
)

 Gets the transform in world space of the light card component
Public function Virtual Const FVector2D  
Public function Virtual Const double

GetYaw ()

  
Public function Virtual Const bool  
Public function Virtual Const bool Whether this actor supports movement in UV space
Public function Virtual void

SetAlwaysFlushToWall ( bool bInAlwaysFlushToWall
)

  
Public function Virtual void

SetDistanceFromCenter ( double InValue
)

  
Public function Virtual void

SetLatitude ( double InValue
)

  
Public function Virtual void

SetLongitude ( double InValue
)

  
Public function Virtual void

SetOrigin ( const FTransform& InOrigin
)

  
Public function Virtual void

SetPitch ( double InValue
)

  
Public function Virtual void

SetRadialOffset ( double InValue
)

  
Public function Virtual void

SetScale ( const FVector2D& InScale
)

  
Public function Virtual void

SetSpin ( double InValue
)

  
Public function Virtual void

SetUVCoordinates ( const FVector2D& InUVCoordinates
)

  
Public function Virtual void

SetYaw ( double InValue
)

  
Public function Virtual void Updates the Light Card transform based on its positional properties (Lat, Long, etc.)

Constants

Name Description
LightCardStageActorComponentName The name used for the stage actor component
UVPlaneDefaultDistance The default distance from the view of the projection plane UV light cards are rendered to
UVPlaneDefaultSize The default size of the projection plane UV light cards are rendered to

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page