API reference
API reference
Select your platform
No SDKs available
No versions available

AMRUKLightDispatcher Class

Extends AActor
If you want to have highlights from lights over passthrough use this actor to collect all point lights in the scene and send them to the M_Highlights material. It lights and sends them to a highlight material, which can be used to achieve highlights over Passthrough. The highlight effect is achieved by using a material parameter collection. See the PTRL Sample Project for an example of how to use this.

Constructors

AMRUKLightDispatcher ()
Signature
AMRUKLightDispatcher::AMRUKLightDispatcher()

Protected Fields

PointLightComponents : TArray< class UPointLightComponent * >
Signature
TArray<class UPointLightComponent*> AMRUKLightDispatcher::PointLightComponents

Fields

AdditionalActorsToLookForPointLightComponents : TArray< AActor * >
List of actor(s) that contain a PointLightComponent that should contribute to the highlight effect. Use AddAdditionalPointLightActor to add actors during runtime.
Signature
TArray<AActor*> AMRUKLightDispatcher::AdditionalActorsToLookForPointLightComponents
Collection : class UMaterialParameterCollection *
The material parameter collection in which to fill lights data. This parameter collection gets then send to the shader.
Signature
class UMaterialParameterCollection* AMRUKLightDispatcher::Collection
ManualPointLights : TArray< class APointLight * >
PointLightActors to use for the highlight effect (not available if "Fetch Point Lights At Begin Play" is true).
Signature
TArray<class APointLight*> AMRUKLightDispatcher::ManualPointLights
ShouldFetchPointLightsAtBeginPlay : bool
Whether all point lights should be fetched automatically at BeginPlay(). The automatic fetching only works for PointLightActors. Actors that have PointLightComponents attached to them will not be detected. These should be specified in AdditionalActorsToLookForPointLightComponents.
Signature
bool AMRUKLightDispatcher::ShouldFetchPointLightsAtBeginPlay

Protected Member Functions

AddPointLightsFromActor ( Actor )
Signature
void AMRUKLightDispatcher::AddPointLightsFromActor(const AActor *Actor)
Parameters
Actor: const AActor *
Returns
void
BeginPlay ()
Signature
void AMRUKLightDispatcher::BeginPlay() override
Returns
void
FillPointLights ()
Signature
void AMRUKLightDispatcher::FillPointLights()
Returns
void

Member Functions

AddAdditionalPointLightActor ( Actor )
Add a actor to the AdditionalActorsToLookForPointLightComponents list. This should be used during runtime instead of adding actors directly to AdditionalActorsToLookForPointLightComponents.
Signature
void AMRUKLightDispatcher::AddAdditionalPointLightActor(AActor *Actor)
Parameters
Actor: AActor *  Actor to add to AdditionalActorsToLookForPointLightComponents.
Returns
void
FillParameterCollection ()
Signature
void AMRUKLightDispatcher::FillParameterCollection()
Returns
void
ForceUpdateCollection ()
Only callable in the editor from the scene, will update the linked parameter collection with the info of the point lights in the scene (based on the parameters), updating the highlight effect in the process. This is meant to preview the effect in the editor.
Signature
void AMRUKLightDispatcher::ForceUpdateCollection()
Returns
void
Tick ( DeltaSeconds )
Signature
void AMRUKLightDispatcher::Tick(float DeltaSeconds) override
Parameters
DeltaSeconds: float
Returns
void