1. Epic GamesDeveloper
  3. ADisplayClusterLightCardActor

ADisplayClusterLightCardActor

API > API/Plugins > API/Plugins/DisplayCluster

   
Name ADisplayClusterLightCardActor
Type class
Header File /Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/DisplayClusterLightCardActor.h
Include Path #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

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

ADisplayClusterLightCardActor ( const FObjectInitializer& ObjectInitializer
)

   DisplayClusterLightCardActor.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~ADisplayClusterLightCardActor()

   DisplayClusterLightCardActor.h  

Constants

Name Type Remarks Include Path
LightCardStageActorComponentName const FName The name used for the stage actor component DisplayClusterLightCardActor.h
UVPlaneDefaultDistance const float The default distance from the view of the projection plane UV light cards are rendered to DisplayClusterLightCardActor.h
UVPlaneDefaultSize const float The default size of the projection plane UV light cards are rendered to DisplayClusterLightCardActor.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AlphaGradient FLightCardAlphaGradientSettings Settings related to an alpha gradient effect DisplayClusterLightCardActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Appearance"
bAlwaysFlushToWall bool Indicates whether the light card is always made to be flush to a stage wall or not DisplayClusterLightCardActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Orientation"
  • Meta=(EditCondition="!bIsUVLightCard", HideEditConditionToggle, EditConditionHides)
bIsUVLightCard bool Indicates if the light card exists in 3D space or in UV space DisplayClusterLightCardActor.h
  • Getter=IsUVActor
  • Setter=SetIsUVActor
bLockToOwningRootActor bool A flag that controls whether the light card's location and rotation are locked to its "owning" root actor DisplayClusterLightCardActor.h  
Color FLinearColor Light card color, before any modifier is applied DisplayClusterLightCardActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Appearance"
DistanceFromCenter double Radius of light card polar coordinates. Does not include the effect of RadialOffset DisplayClusterLightCardActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Orientation"
  • Meta=(EditCondition="!bIsUVLightCard", HideEditConditionToggle, EditConditionHides)
Exposure float 2^Exposure color value multiplier DisplayClusterLightCardActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Appearance"
  • Meta=(UIMin=100, ClampMin=100, UIMax=100, ClampMax=100)
Feathering float Feathers in the alpha from the edges DisplayClusterLightCardActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Appearance"
  • Meta=(UIMin=0, ClampMin=0)
Gain float Linear color value multiplier DisplayClusterLightCardActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Appearance"
  • Meta=(UIMin=0, ClampMin=0)
Latitude double Related to the Elevation of light card polar coordinates DisplayClusterLightCardActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Orientation"
  • Meta=(UIMin=90, ClampMin=90, UIMax=90, ClampMax=90, EditCondition="!bIsUVLightCard", HideEditConditionToggle, EditConditionHides)
Longitude double Related to the Azimuth of light card polar coordinates DisplayClusterLightCardActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Orientation"
  • Meta=(UIMin=0, ClampMin=0, UIMax=360, ClampMax=360, EditCondition="!bIsUVLightCard", HideEditConditionToggle, EditConditionHides)
Mask EDisplayClusterLightCardMask   DisplayClusterLightCardActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Appearance"
Opacity float Linear alpha multiplier DisplayClusterLightCardActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Appearance"
  • Meta=(UIMin=0, ClampMin=0, UIMax=1, ClampMax=1)
PerLightcardRenderMode EDisplayClusterConfigurationICVFX_PerLightcardRenderMode Specify how to render this Light Card Actor in relation to the inner frustum. DisplayClusterLightCardActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Appearance"
  • Meta=(DisplayName="Blending Mode")
Pitch double   DisplayClusterLightCardActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Orientation"
  • Meta=(UIMin=360, ClampMin=360, UIMax=360, ClampMax=360, EditCondition="!bIsUVLightCard", HideEditConditionToggle, EditConditionHides)
Polygon TArray< FVector2D > Polygon points when using this type of mask DisplayClusterLightCardActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Appearance"
PolygonMask TObjectPtr< UTexture > Used to flag this light card as a proxy of a "real" light card. Used by the LightCard Editor DisplayClusterLightCardActor.h
  • Transient
RadialOffset double Used by the flush constraint to offset the location of the light card form the wall DisplayClusterLightCardActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Orientation"
  • Meta=(EditCondition="!bIsUVLightCard", HideEditConditionToggle, EditConditionHides)
Scale FVector2D   DisplayClusterLightCardActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Orientation"
Spin double Roll rotation of light card around its plane axis DisplayClusterLightCardActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Orientation"
  • Meta=(UIMin=360, ClampMin=360, UIMax=360, ClampMax=360)
Temperature float   DisplayClusterLightCardActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Appearance"
  • Meta=(UIMin=0, ClampMin=0, UIMax=10000, ClampMax=10000)
Texture TObjectPtr< UTexture >   DisplayClusterLightCardActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Appearance"
Tint float   DisplayClusterLightCardActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Appearance"
  • Meta=(UIMin=1, ClampMin=1, UIMax=1, ClampMax=1)
UVCoordinates FVector2D The UV coordinates of the light card, if it is in UV space DisplayClusterLightCardActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Orientation"
  • Meta=(DisplayName="UV Coodinates", EditCondition="bIsUVLightCard", HideEditConditionToggle, EditConditionHides)
Yaw double   DisplayClusterLightCardActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Orientation"
  • Meta=(UIMin=360, ClampMin=360, UIMax=360, ClampMax=360, EditCondition="!bIsUVLightCard", HideEditConditionToggle, EditConditionHides)

Protected

Name Type Remarks Include Path Unreal Specifiers
bHadRootActorMismatch bool Set if there was conflicting root actor ownership DisplayClusterLightCardActor.h  
LastOrbitLocation FVector Stores the location relative to the root actor's origin that stage actors like light cards can orbit around DisplayClusterLightCardActor.h  
WeakRootActorOwner TWeakObjectPtr< ADisplayClusterRootActor > Set by DCRA during tick. Meant for legacy light cards that don't have a SoftObjectPtr set DisplayClusterLightCardActor.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddToLightCardLayer ( ADisplayClusterRootActor* InRootActor
)

 Add this light card to a light card layer on the given root actor DisplayClusterLightCardActor.h  

virtual void AddToRootActor ( ADisplayClusterRootActor* InRootActor
)

 Add this light card to a root actor DisplayClusterLightCardActor.h  

UDisplayClusterLabelComponent * GetLabelComponent()

 Return the label component DisplayClusterLightCardActor.h  

void GetLightCardMeshComponents ( TArray< UMeshComponent* >& MeshComponents
) const

 Gets the light card mesh components DisplayClusterLightCardActor.h  

ADisplayClusterRootActor * GetRootActorOwner()

 Return the root actor owner of the light card DisplayClusterLightCardActor.h  

UDisplayClusterStageActorComponent * GetStageActorComponent()

 Retrieve the stage actor component DisplayClusterLightCardActor.h  

UStaticMesh * GetStaticMesh()

 Returns the current static mesh used by this light card DisplayClusterLightCardActor.h  

bool IsLightCardFlag()

 If this light card is considered a flag DisplayClusterLightCardActor.h  

void MakeFlushToWall()

 Makes the light card flush to the wall DisplayClusterLightCardActor.h  

virtual void RemoveFromRootActor()

 Remove this light card from the root actor DisplayClusterLightCardActor.h  

void SetIsLightCardFlag ( bool bNewFlagValue
)

 Configures this light card as a flag DisplayClusterLightCardActor.h  

void SetIsUVActor ( bool bNewUVValue
)

 Configures this light card as a UV actor DisplayClusterLightCardActor.h  

void SetRootActorOwner ( ADisplayClusterRootActor* InRootActor
)

 Set the root actor of the stage actor component DisplayClusterLightCardActor.h  

void SetStaticMesh ( UStaticMesh* InStaticMesh
)

 Sets a new static mesh for the light card DisplayClusterLightCardActor.h  
Set a weak root actor owner. DisplayClusterLightCardActor.h  

void ShowLightCardLabel ( const FDisplayClusterLabelConfiguration& InLabelConfiguration
)

 Configure light card labels DisplayClusterLightCardActor.h  

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

 Show or hide the light card label DisplayClusterLightCardActor.h  

void UpdateLightCardMaterialInstance()

 Updates the card's material instance parameters DisplayClusterLightCardActor.h  

void UpdateLightCardPositionToRootActor()

 Sync the position to the root actor DisplayClusterLightCardActor.h  

void UpdateLightCardVisibility()

 Updates the light card actor visibility DisplayClusterLightCardActor.h  

void UpdatePolygonTexture()

 Updates the polygon texture from the polygon points DisplayClusterLightCardActor.h  

void UpdateUVIndicator()

 Updates the UV Indicator DisplayClusterLightCardActor.h  

Overridden from AActor

Name Remarks Include Path Unreal Specifiers

virtual void Destroyed()

   DisplayClusterLightCardActor.h  

virtual FName GetCustomIconName()

   DisplayClusterLightCardActor.h  

virtual void OnConstruction ( const FTransform& Transform
)

   DisplayClusterLightCardActor.h  

virtual bool ShouldTickIfViewportsOnly()

   DisplayClusterLightCardActor.h  

virtual void Tick ( float DeltaSeconds
)

   DisplayClusterLightCardActor.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   DisplayClusterLightCardActor.h  

virtual void PostLoad()

   DisplayClusterLightCardActor.h  

Overridden from IDisplayClusterStageActor

Name Remarks Include Path Unreal Specifiers

virtual FBox GetBoxBounds ( bool bLocalSpace
) const

 Gets the object oriented bounding box of the light card component DisplayClusterLightCardActor.h  

virtual double GetDistanceFromCenter()

   DisplayClusterLightCardActor.h  

virtual double GetLatitude()

   DisplayClusterLightCardActor.h  

virtual double GetLongitude()

   DisplayClusterLightCardActor.h  

virtual FTransform GetOrigin()

   DisplayClusterLightCardActor.h  

virtual double GetPitch()

   DisplayClusterLightCardActor.h  

virtual void GetPositionalProperties ( FPositionalPropertyArray& OutPropertyPairs
) const

   DisplayClusterLightCardActor.h  

virtual double GetRadialOffset()

   DisplayClusterLightCardActor.h  

virtual FVector2D GetScale()

   DisplayClusterLightCardActor.h  

virtual double GetSpin()

   DisplayClusterLightCardActor.h  

virtual FTransform GetStageActorTransform ( bool bRemoveOrigin
) const

 Gets the transform in world space of the light card component DisplayClusterLightCardActor.h  

virtual FVector2D GetUVCoordinates()

   DisplayClusterLightCardActor.h  

virtual double GetYaw()

   DisplayClusterLightCardActor.h  

virtual bool IsAlwaysFlushToWall()

   DisplayClusterLightCardActor.h  

virtual bool IsUVActor()

   DisplayClusterLightCardActor.h  

virtual void SetAlwaysFlushToWall ( bool bInAlwaysFlushToWall
)

   DisplayClusterLightCardActor.h  

virtual void SetDistanceFromCenter ( double InValue
)

   DisplayClusterLightCardActor.h  

virtual void SetLatitude ( double InValue
)

   DisplayClusterLightCardActor.h  

virtual void SetLongitude ( double InValue
)

   DisplayClusterLightCardActor.h  

virtual void SetOrigin ( const FTransform& InOrigin
)

   DisplayClusterLightCardActor.h  

virtual void SetPitch ( double InValue
)

   DisplayClusterLightCardActor.h  

virtual void SetRadialOffset ( double InValue
)

   DisplayClusterLightCardActor.h  

virtual void SetScale ( const FVector2D& InScale
)

   DisplayClusterLightCardActor.h  

virtual void SetSpin ( double InValue
)

   DisplayClusterLightCardActor.h  

virtual void SetUVCoordinates ( const FVector2D& InUVCoordinates
)

   DisplayClusterLightCardActor.h  

virtual void SetYaw ( double InValue
)

   DisplayClusterLightCardActor.h  

virtual void UpdateStageActorTransform()

 Updates the Light Card transform based on its positional properties (Lat, Long, etc.) DisplayClusterLightCardActor.h  

Protected

Name Remarks Include Path Unreal Specifiers

void CleanUpComponentsForExtenders()

 Removes components that were added by IDisplayClusterLightCardActorExtender DisplayClusterLightCardActor.h  

void CreateComponentsForExtenders()

 Creates components for IDisplayClusterLightCardActorExtender DisplayClusterLightCardActor.h  

void OnLevelActorDeleted ( AActor* DeletedActor
)

 Called when a level actor is deleted DisplayClusterLightCardActor.h  

void RemoveFromRootActorList ( ADisplayClusterRootActor* RootActor
)

 Removes this actor from a root actor's ShowOnlyList.Actors, if possible. DisplayClusterLightCardActor.h  

Static

Name Remarks Include Path Unreal Specifiers

static FName GetExtenderNameToComponentMapMemberName()

   DisplayClusterLightCardActor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page