UserInterfaceSettings.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/SoftObjectPath.h"
#include "Curves/CurveFloat.h"
#include "Engine/DeveloperSettings.h"
#include "Widgets/SWidget.h"
 
#include "UserInterfaceSettings.generated.h"
 
class UDPICustomScalingRule;
 
UENUM()
enum class ERenderFocusRule : uint8
{
    Always,
    NonPointer,
    NavigationOnly,
    Never,
};
 
UENUM()
enum class EUIScalingRule : uint8
{
    ShortestSide,
    LongestSide,
    Horizontal,
    Vertical,
    ScaleToFit,
    Custom
};
 
UENUM()
enum class EFontDPI : uint8
{
    Standard UMETA(DisplayName = "72 DPI (Default)"),
    Unreal UMETA(DisplayName = "96 DPI (Unreal Engine)"),
 
    Custom UMETA(Hidden)
};
 
class UWidget;
class UDPICustomScalingRule;
 
USTRUCT()
struct FHardwareCursorReference
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, Category="Hardware Cursor")
    FName CursorPath;
 
    UPROPERTY(EditAnywhere, Category="Hardware Cursor", meta=( ClampMin=0, ClampMax=1 ))
    FVector2D HotSpot = FVector2D::ZeroVector;
};
 
UCLASS(config=Engine, defaultconfig, meta=(DisplayName="User Interface"), MinimalAPI)
class UUserInterfaceSettings : public UDeveloperSettings
{
    GENERATED_UCLASS_BODY()
 
public:
 
    UPROPERTY(config, EditAnywhere, Category = "Focus")
    ERenderFocusRule RenderFocusRule;
 
    UPROPERTY(config, EditAnywhere, Category = "Hardware Cursors")
    TMap<TEnumAsByte<EMouseCursor::Type>, FHardwareCursorReference> HardwareCursors;
 
    UPROPERTY(config, EditAnywhere, Category = "Software Cursors", meta = ( MetaClass = "/Script/UMG.UserWidget" ))
    TMap<TEnumAsByte<EMouseCursor::Type>, FSoftClassPath> SoftwareCursors;
 
    // DEPRECATED 4.16
    UPROPERTY(config)
    FSoftClassPath DefaultCursor_DEPRECATED;
 
    // DEPRECATED 4.16
    UPROPERTY(config)
    FSoftClassPath TextEditBeamCursor_DEPRECATED;
 
    // DEPRECATED 4.16
    UPROPERTY(config)
    FSoftClassPath CrosshairsCursor_DEPRECATED;
 
    // DEPRECATED 4.16
    UPROPERTY(config)
    FSoftClassPath HandCursor_DEPRECATED;
 
    // DEPRECATED 4.16
    UPROPERTY(config)
    FSoftClassPath GrabHandCursor_DEPRECATED;
    
    // DEPRECATED 4.16
    UPROPERTY(config)
    FSoftClassPath GrabHandClosedCursor_DEPRECATED;
 
    // DEPRECATED 4.16
    UPROPERTY(config)
    FSoftClassPath SlashedCircleCursor_DEPRECATED;
 
    UPROPERTY(config, EditAnywhere, Category="DPI Scaling")
    float ApplicationScale;
 
    UPROPERTY(config, EditAnywhere, Category="DPI Scaling", meta=( DisplayName="DPI Scale Rule" ))
    EUIScalingRule UIScaleRule;
 
    UPROPERTY(config, EditAnywhere, Category="DPI Scaling", meta=( MetaClass="/Script/Engine.DPICustomScalingRule" ))
    FSoftClassPath CustomScalingRuleClass;
 
    UPROPERTY(config, EditAnywhere, Category="DPI Scaling", meta=(
        DisplayName="DPI Curve",
        XAxisName="Resolution",
        YAxisName="Scale"))
    FRuntimeFloatCurve UIScaleCurve;
 
    UPROPERTY(config, EditAnywhere, Category="DPI Scaling", meta=( DisplayName="Allow High DPI in Game Mode" ))
    bool bAllowHighDPIInGameMode;
 
    UPROPERTY(config, EditAnywhere, Category="DPI Scaling|Scale To Fit Rule", meta=( DisplayName="Design Screen Size", ClampMin="1", UIMin="1" ))
    FIntPoint DesignScreenSize = FIntPoint(1920, 1080);
 
    UPROPERTY(config, EditAnywhere, Category = "Widgets")
    bool bLoadWidgetsOnDedicatedServer;
 
    UPROPERTY(config, EditAnywhere, Category = "Widgets")
    bool bAuthorizeAutomaticWidgetVariableCreation;
 
public:
 
    ENGINE_API virtual void PostInitProperties() override;
 
    ENGINE_API void ForceLoadResources(bool bForceLoadEverything = false) const;
 
    ENGINE_API float GetDPIScaleBasedOnSize(FIntPoint Size) const;
 
#if WITH_EDITOR
    ENGINE_API FText GetFontDPIDisplayString() const;
 
    ENGINE_API uint32 GetFontDisplayDPI() const;
 
    ENGINE_API virtual void PostEditChangeProperty(struct FPropertyChangedEvent& PropertyChangedEvent) override;
#endif
 
private:
    float CalculateScale(FIntPoint Size, bool& bError) const;
 
#if WITH_EDITOR
    static constexpr EFontDPI ConvertToEFontDPI(uint32 inFontDPI);
    static constexpr uint32 ConvertToFontDPI(EFontDPI inFontDPIEntry);
#endif
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(config, EditAnywhere, Category = "UMG Fonts", meta = (DisplayName = "Font Resolution", EditCondition = "bUseCustomFontDPI", EditConditionHides, ClampMin = "1", ClampMax = "1000"))
    uint32 CustomFontDPI;
 
    UPROPERTY(config, EditAnywhere, Category = "UMG Fonts", meta = (DisplayName = "Font Resolution", EditCondition = "!bUseCustomFontDPI", EditConditionHides))
    EFontDPI FontDPIPreset;
 
    UPROPERTY(config, EditAnywhere, Category = "UMG Fonts", meta = (DisplayName = "Use Custom DPI"))
    bool bUseCustomFontDPI;
#endif
 
    UFUNCTION()
    static bool ShouldDisplayDistanceFieldFontSettings();
 
public:
    UPROPERTY(config, EditAnywhere, Category = "UMG Fonts", meta = (EditCondition = "ShouldDisplayDistanceFieldFontSettings()", EditConditionHides))
    bool bEnableDistanceFieldFontRasterization;
 
private:
    // This is just holding on to references to prevent GC in the Editor (tied to the lifetime of this object)
    UPROPERTY(Transient)
    mutable TArray<TObjectPtr<UObject>> CursorClasses;
 
    UPROPERTY(Transient)
    mutable TObjectPtr<UClass> CustomScalingRuleClassInstance;
 
    UPROPERTY(Transient)
    mutable TObjectPtr<UDPICustomScalingRule> CustomScalingRule;
 
    mutable TOptional<FIntPoint> LastViewportSize;
    mutable float CalculatedScale;
};