CarlaSettingsDelegate.h

Go to the documentation of this file.

// Copyright (c) 2026 Computer Vision Center (CVC) at the Universitat Autonoma
// de Barcelona (UAB).
//
// This work is licensed under the terms of the MIT license.
// For a copy, see <https://opensource.org/licenses/MIT>.
 
#pragma once
 
#include "Carla/Settings/QualityLevelUE.h"
 
#include <util/ue-header-guard-begin.h>
#include "CoreMinimal.h"
#include "Engine/StaticMesh.h"
#include "Engine/World.h"
#include <util/ue-header-guard-end.h>
 
#include "CarlaSettingsDelegate.generated.h"
 
class UCarlaSettings;
 
/// Used to set settings for every actor that is spawned into the world.
UCLASS(BlueprintType)
class CARLA_API UCarlaSettingsDelegate : public UObject
{
  GENERATED_BODY()
 
public:
 
  UCarlaSettingsDelegate();
 
  /// Reset settings to default.
  void Reset();
 
  /// Create the event trigger handler for all the newly spawned actors to be
  /// processed with a custom function here.
  void RegisterSpawnHandler(UWorld *World);
 
  /// After loading a level, apply the current settings.
  UFUNCTION(BlueprintCallable, Category = "CARLA Settings", meta = (HidePin = "InWorld"))
  void ApplyQualityLevelPostRestart();
 
  /// Before loading a level, apply the current settings.
  UFUNCTION(BlueprintCallable, Category = "CARLA Settings", meta = (HidePin = "InWorld"))
  void ApplyQualityLevelPreRestart();
 
  void SetAllActorsDrawDistance(UWorld *world, float max_draw_distance) const;
 
private:
 
  UWorld *GetLocalWorld();
 
  /// Check that the world, instance and settings are valid and save the
  /// CarlaSettings instance.
  ///
  /// @param world used to get the instance of CarlaSettings.
  void CheckCarlaSettings(UWorld *world);
 
  void SetAllRoads(
      UWorld *world,
      float max_draw_distance,
      const TArray<FStaticMaterial> &road_pieces_materials) const;
 
  void SetActorComponentsDrawDistance(AActor *actor, float max_draw_distance) const;
 
  void SetPostProcessEffectsEnabled(UWorld *world, bool enabled) const;
 
  void SetAllLights(
      UWorld *world,
      float max_distance_fade,
      bool cast_shadows,
      bool hide_non_directional) const;
 
  /// Single-pass replacement for SetAllLights + SetAllActorsDrawDistance
  /// when applying a quality tier. Walks the actor list once and dispatches
  /// per-type, halving the cost of a tier change.
  void ApplyPerActorQualitySettings(
      UWorld *world,
      float light_fade_distance,
      bool cast_directional_shadows,
      bool hide_non_directional_lights,
      float draw_distance) const;
 
private:
 
  /// Currently applied quality level after level is restarted.
  static EQualityLevel AppliedLowPostResetQualityLevel;
 
  UCarlaSettings *CarlaSettings = nullptr;
};