WeatherParameters.h

Go to the documentation of this file.

// Copyright (c) 2023 FrostBit Software Lab at the Lapland University of Applied Sciences
//
// This work is licensed under the terms of the MIT license.
// For a copy, see <https://opensource.org/licenses/MIT>.
 
#pragma once
 
#include "Math/Color.h"
 
#include "WeatherParameters.generated.h"
 
USTRUCT(BlueprintType)
struct AGRARSENSE_API FWeatherParameters
{
    GENERATED_BODY()
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, meta = (ClampMin = "-40.0", ClampMax = "40.0", UIMin = "-40.0", UIMax = "40.0"))
    float Temperature = 10.0f;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, meta = (ClampMin = "0.0", ClampMax = "100.0", UIMin = "0.0", UIMax = "100.0"))
    float Precipitation = 0.0f;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, meta = (ClampMin = "1.0", ClampMax = "5.0", UIMin = "1.0", UIMax = "5.0"))
    float PrecipitationParticleSize = 1.0f;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, meta = (ClampMin = "0.0", ClampMax = "1.0", UIMin = "0.0", UIMax = "1.0"))
    float Cloudiness = 0.05f;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, meta = (ClampMin = "0.0", ClampMax = "100.0", UIMin = "0.0", UIMax = "100.0"))
    float Fog = 0.0f;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, meta = (ClampMin = "0.0", ClampMax = "10.0", UIMin = "0.0", UIMax = "10.0"))
    float FogFalloff = 0.2f;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, meta = (ClampMin = "0.0", ClampMax = "25.0", UIMin = "0.0", UIMax = "25.0"))
    float WindIntensity = 0.0f;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, meta = (ClampMin = "0.0", ClampMax = "360.0", UIMin = "0.0", UIMax = "360.0"))
    float WindDirection = 15.0f;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, meta = (ClampMin = "0.0", ClampMax = "100.0", UIMin = "0.0", UIMax = "100.0"))
    float SnowAmount = 0.0f;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, meta = (ClampMin = "0.0", ClampMax = "1.0", UIMin = "0.0", UIMax = "1.0"))
    float TreeSnowiness = 0.0f;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, meta = (ClampMin = "1", ClampMax = "12", UIMin = "1", UIMax = "12"))
    int Month = 7;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, meta = (ClampMin = "0.0", ClampMax = "24", UIMin = "0.0", UIMax = "24"))
    int Time = 12;
 
    /*
    * Should Tree leaves be hidden (underground).
    */
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    bool HideTreeLeaves = false;
 
    /*
    * Should Tree branches be hidden (underground).
    */
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    bool HideTreeBranches = false;
 
    /*
    * Use manual leaf colors or change tree leaf colors based on the month.
    * If any color is (0.0f, 0.0f, 0.0f, 0.0f), it will be ignored.
    */
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    bool UseManualLeafColors = false;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    FLinearColor BirchLeafColor = FLinearColor(0.0f, 0.0f, 0.0f, 0.0f);
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    FLinearColor PineLeafColor = FLinearColor(0.0f, 0.0f, 0.0f, 0.0f);
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    FLinearColor SpruceLeafColor = FLinearColor(0.0f, 0.0f, 0.0f, 0.0f);
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    FLinearColor AlderLeafColor = FLinearColor(0.0f, 0.0f, 0.0f, 0.0f);
 
    bool IsWinterSnowCondition()
    {
        return SnowAmount != 0.0f;
    }
 
    bool IsWinterSeason()
    {
        return (Month == 12 || Month <= 3);
    }
 
    bool IsLidarNoiseModelCondition()
    {
        return Temperature <= 0.0f && Precipitation != 0.0f;
    }
 
    FString ToString() const
    {
        return FString::Printf(
            TEXT("%f, %f, %f, %f, %f, %f, %f, %f, %f, %f, %d, %d"),
            Temperature,
            Precipitation,
            PrecipitationParticleSize,
            Cloudiness,
            Fog,
            FogFalloff,
            WindIntensity,
            WindDirection,
            SnowAmount,
            TreeSnowiness,
            Month,
            Time
        );
    }
 
    FString ToStringHumanReadable() const
    {
        return FString::Printf(
            TEXT("Temperature: %.2f, Precipitation: %.2f, Precipitation Particle Size: %.2f, Cloudiness: %.2f, Fog: %.2f, Fog Falloff: %.2f, Wind Intensity: %.2f, Wind Direction: %.2f, Snow Amount: %.2f, Tree Snowiness: %.2f, Month: %d, Time: %d"),
            Temperature,
            Precipitation,
            PrecipitationParticleSize,
            Cloudiness,
            Fog,
            FogFalloff,
            WindIntensity,
            WindDirection,
            SnowAmount,
            TreeSnowiness,
            Month,
            Time
        );
    }
};