BasicSignal.h

/****************************************************************/
/***
 * @file   BasicSignal.h
 * @brief  Contains basic signal class along with enums and structs used by signals.
 * 
 * @author Endre Heksum
 * @date   March 2022
 *********************************************************************/
 
// Copyright 2022 Thomas Arinesalingam, John Ole Bjerke, Endre Heksum & Henrik Markengbakken Karlsen . All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "GameFramework/Actor.h"
#include <DeskSimV2/Trains/SplineActor.h>
#include <DeskSimV2/SaveGame/IsSaveableInterface.h>
#include "BasicSignal.generated.h"
 
UENUM(BlueprintType)
enum class ESignalStatus : uint8
{
    MClear,
    MClearReduced,
    MNotClear,
    MUnmanned,
    FClear,
    FClearReduced,
    FStop,
    FUnmanned,
    DAllowed,
    DForbidden,
    DCareful,
    DFree
};
 
UENUM(BlueprintType)
enum class ESignalType : uint8
{
    Main,
    Forward,
    Dwarf
};
 
USTRUCT()
struct FSignalLight
{
    GENERATED_BODY()
    
    UPROPERTY(VisibleAnywhere)
    UStaticMeshComponent* LightMesh;
 
    UPROPERTY(VisibleAnywhere, Transient)
    UMaterialInstanceDynamic* DynMaterial;
    
    float BlinkingTimer = 1.0f;
 
    FTimerHandle LightTimerHandle;
 
    // Needs a constructor with no params to be used with arrays
    FSignalLight() :
        LightMesh(nullptr),
        DynMaterial(nullptr)
    {}
 
    // Constructor for the struct, takes in the light mesh
    FSignalLight(UStaticMeshComponent* InLightMesh) :
        LightMesh(InLightMesh),
        DynMaterial(nullptr)
    {}
};
 
UCLASS(Blueprintable)
class DESKSIMV2_API ABasicSignal : public AActor, public IIsSaveableInterface
{
    GENERATED_BODY()
    
public: 
    // Sets default values for this actor's properties
    ABasicSignal();
 
protected:
    // Called when the game starts or when spawned
    virtual void BeginPlay() override;
 
    // Called before the actor is destroyed
    virtual void EndPlay(EEndPlayReason::Type EndPlayReason) override;
 
public: 
    // Called every frame
    virtual void Tick(float DeltaTime) override;
    
    // Sets up the lights, with meshes in sockets and dynamic materials
    UFUNCTION(BlueprintCallable, CallInEditor, Category = "Signal Light")
    void SetupLight();
 
protected:
    
    // Removes the lights, by unregistering created components
    UFUNCTION()
    void RemoveLights();
 
public:
 
    UFUNCTION(BlueprintCallable, Category = "Signal Light")
    void SetLightOnOff(int32 InLightIndex, bool bInLightOn);
    
    UFUNCTION(BlueprintCallable, Category = "Signal Light")
    void ToggleLight(int32 InLightIndex);
 
    UFUNCTION(BlueprintCallable, Category = "Signal Light")
    void SetLightColor(int32 InLightIndex, FLinearColor InColor);
 
    UFUNCTION(BlueprintCallable, Category = "Signal Light")
    void StartLightBlink(int32 InLightIndex, float InSeconds);
 
    UFUNCTION(BlueprintCallable, Category = "Signal Light")
    void StopLightBlink(int32 InLightIndex);
 
    UFUNCTION(BlueprintImplementableEvent, BlueprintCallable, Category = "Signal Light")
    void UpdateSignalStatus(ESignalStatus NewSignalStatus);
    
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Signal Light", SaveGame)
    FName ID;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Signal Light")
    ESignalType Type;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Signal Light")
    ESignalStatus SignalStatus;
 
protected:
 
    UPROPERTY()
    TArray<FSignalLight> Lights;
 
public:
 
    UPROPERTY(EditDefaultsOnly, Category = "Signal Light")
    UStaticMeshComponent* VisualComponent;
 
    UPROPERTY(EditDefaultsOnly, Category = "Signal Light")
    UStaticMesh* BaseLightMesh;
 
    UPROPERTY(EditDefaultsOnly, Category = "Signal Light")
    UMaterialInterface* BaseLightMaterial;
    
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Signal Light")
    int32 NumLights = 2;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Signal Light")
    float MaxLightLevel = 10.0f;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Signal Light")
    float LightBlinkPeriod = 2.0f;
    
    // ---------- RAILWAY INTEGRATION ------------
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Railway Integration")
    bool bSnapToNearestRailway; 
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Railway Integration")
    float OffsetFromRailway = 400.0f; 
 
protected:
 
    USplineComponent* GetNearestRailwaySplineComponent();
 
    void SnapToNearestRailway();
};