SignComponent.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/OpenDrive/OpenDrive.h"
 
#include <util/ue-header-guard-begin.h>
#include "CoreMinimal.h"
#include "Components/SceneComponent.h"
#include "Components/BoxComponent.h"
#include <util/ue-header-guard-end.h>
 
#include <utility>
 
#include "SignComponent.generated.h"
 
namespace carla
{
namespace road
{
  class Map;
namespace element
{
  class RoadInfoSignal;
}
}
}
 
namespace cr = carla::road;
namespace cre = carla::road::element;
 
/// Class representing an OpenDRIVE Signal
UCLASS( ClassGroup=(Custom), meta=(BlueprintSpawnableComponent) )
class CARLA_API USignComponent : public USceneComponent
{
  GENERATED_BODY()
 
public:
  USignComponent();
 
  UFUNCTION(Category = "Traffic Sign", BlueprintPure)
  const FString &GetSignId() const;
 
  UFUNCTION(Category = "Traffic Sign", BlueprintCallable)
  void SetSignId(const FString &Id);
 
  // Initialize sign (e.g. generate trigger boxes)
  virtual void InitializeSign(const cr::Map &Map);
 
  void AddEffectTriggerVolume(UBoxComponent* TriggerVolume);
 
  const TArray<UBoxComponent*> GetEffectTriggerVolume() const;
 
protected:
  // Called when the game starts
  virtual void BeginPlay() override;
 
  // Called every frame
  virtual void TickComponent(float DeltaTime, ELevelTick TickType, FActorComponentTickFunction* ThisTickFunction) override;
 
  TArray<std::pair<cr::RoadId, const cre::RoadInfoSignal*>>
      GetAllReferencesToThisSignal(const cr::Map &Map);
 
  const cr::Signal* GetSignal(const cr::Map &Map) const;
 
  /// Generates a trigger box component in the parent actor
  /// BoxSize should be in Unreal units
  UBoxComponent* GenerateTriggerBox(const FTransform &BoxTransform,
      float BoxSize);
 
  UBoxComponent* GenerateTriggerBox(const FTransform &BoxTransform,
      const FVector &BoxSize);
 
private:
 
  UPROPERTY(Category = "Traffic Sign", EditAnywhere)
  FString SignId = "";
 
  UPROPERTY()
  TArray<TObjectPtr<UBoxComponent>> EffectTriggerVolumes;
 
};