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"

Variables

  Type Name Description
Public variable   AlphaGradient  
Public variable   bAlwaysFlushToWall  
Protected variable   bIsLightCardFlag  
Public variable   bIsUVLightCard  
Public variable   bLockToOwningRootActor  
Public variable   Color  
Protected variable   DefaultSceneRootComponent  
Public variable   DistanceFromCenter  
Public variable   Exposure  
Protected variable   ExtenderNameToComponentMap  
Public variable   Feathering  
Public variable   Gain  
Protected variable   LabelComponent  
Public variable   Latitude  
Protected variable   LightCardComponent  
Protected variable   LightCardTransformerComponent  
Public variable   Longitude  
Protected variable   MainSpringArmComponent  
Public variable   Mask  
Public variable   Opacity  
Public variable   Pitch  
Public variable   Polygon  
Public variable   PolygonMask  
Public variable   RadialOffset  
Public variable   Scale  
Public variable   Spin  
Protected variable   StageActorComponent  
Public variable   Temperature  
Public variable   Texture  
Public variable   Tint  
Public variable   UVCoordinates  
Protected variable   UVIndicatorComponent  
Public variable   Yaw  

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual   Add this light card to a root actor
Protected function   Removes components that were added by IDisplayClusterLightCardActorExtender
Protected function   Creates components for IDisplayClusterLightCardActorExtender
Public function Virtual   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   Gets the object oriented bounding box of the light card component
Public function Virtual Const   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 Const    
Public function Static    
Public function Const   Return the label component
Public function Virtual Const    
Public function Const   Gets the light card mesh components
Public function Virtual Const    
Public function Virtual Const    
Public function Virtual Const    
Public function Virtual Const   Get an array of positional properties defined for this stage actor for use in property notifies.
Public function Virtual Const    
Public function Const   Return the root actor owner of the light card
Public function Virtual Const    
Public function Virtual Const  

GetSpin ()

  
Public function Const   Retrieve the stage actor component
Public function Virtual Const   Gets the transform in world space of the light card component
Public function Const   Returns the current static mesh used by this light card
Public function Virtual Const    
Public function Virtual Const  

GetYaw ()

  
Public function Virtual Const    
Public function Const   If this light card is considered a flag
Public function Virtual Const   Whether this actor supports movement in UV space
Public function   Makes the light card flush to the wall
Public function Virtual   Called when an instance of this class is placed (in editor) or spawned.
Protected function   Called when a level actor is deleted
Public function Virtual   Called when a property on this object has been modified externally
Public function Virtual   Do any object-specific cleanup required immediately after loading an object.
Public function Virtual   Remove this light card from the root actor
Protected function   Removes this actor from a root actor's ShowOnlyList.Actors, if possible.
Public function Virtual    
Public function Virtual    
Public function   Configures this light card as a flag
Public function   Configures this light card as a UV actor
Public function Virtual    
Public function Virtual    
Public function Virtual    
Public function Virtual    
Public function Virtual    
Public function   Set the root actor of the stage actor component
Public function Virtual    
Public function Virtual  

SetSpin ()

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

SetYaw ()

  
Public function Virtual Const   If true, actor is ticked even if TickType==LEVELTICK_ViewportsOnly
Public function   Configure light card labels
Public function Virtual  

Tick ()

 Function called every frame on this Actor.
Public function   Updates the card's material instance parameters
Public function   Sync the position to the root actor
Public function   Updates the light card actor visibility
Public function   Updates the polygon texture from the polygon points
Public function Virtual   Updates the Light Card transform based on its positional properties (Lat, Long, etc.)
Public function   Updates the UV Indicator

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

Deprecated Functions

  Type Name Description
Public function   Layers are no longer used for light cards by default, use 'AddToRootActor' instead
Public function   Use the ShowLightCardLabel function which accepts FDisplayClusterLabelConfiguration arguments.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page