FontFace.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/Object.h"
#include "Fonts/FontFaceInterface.h"
#include "Fonts/FontRasterizationMode.h"
#include "FontFace.generated.h"
 
class ITargetPlatform;
struct FPropertyChangedEvent;
 
USTRUCT(BlueprintType)
struct FFontFacePlatformRasterizationOverrides
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, Category=DistanceFieldMode, meta=(DisplayName="Override for Sharp"))
    EFontRasterizationMode MsdfOverride = EFontRasterizationMode::Msdf;
 
    UPROPERTY(EditAnywhere, Category=DistanceFieldMode, meta=(DisplayName="Override for Smooth"))
    EFontRasterizationMode SdfOverride = EFontRasterizationMode::Sdf;
 
    UPROPERTY(EditAnywhere, Category=DistanceFieldMode, meta=(DisplayName="Override for Fast"))
    EFontRasterizationMode SdfApproximationOverride = EFontRasterizationMode::SdfApproximation;
};
 
UCLASS(hidecategories=Object, autoexpandcategories=FontFace, MinimalAPI, BlueprintType)
class UFontFace : public UObject, public IFontFaceInterface
{
    GENERATED_BODY()
 
public:
    UFontFace();
 
    //~ Begin UObject Interface
    virtual void Serialize(FArchive& Ar) override;
    virtual void GetResourceSizeEx(FResourceSizeEx& CumulativeResourceSize) override;
    virtual void PostLoad() override;
#if WITH_EDITOR
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
    virtual void PostEditUndo() override;
    virtual void GetAssetRegistryTags(FAssetRegistryTagsContext Context) const override;
    UE_DEPRECATED(5.4, "Implement the version that takes FAssetRegistryTagsContext instead.")
    virtual void GetAssetRegistryTags(TArray<FAssetRegistryTag>& OutTags) const override;
#endif // WITH_EDITOR
    //~ End UObject Interface
 
#if WITH_EDITORONLY_DATA
    ENGINE_API void CacheSubFaces();
#endif // WITH_EDITORONLY_DATA
 
    //~ Begin IFontFaceInterface Interface
#if WITH_EDITORONLY_DATA
    virtual void InitializeFromBulkData(const FString& InFilename, const EFontHinting InHinting, const void* InBulkDataPtr, const int32 InBulkDataSizeBytes) override;
#endif // WITH_EDITORONLY_DATA
    virtual const FString& GetFontFilename() const override;
    virtual EFontHinting GetHinting() const override;
    virtual EFontLoadingPolicy GetLoadingPolicy() const override;
    virtual EFontLayoutMethod GetLayoutMethod() const override;
    virtual bool IsAscendOverridden() const override;
    virtual int32 GetAscendOverriddenValue() const override;
    virtual bool IsDescendOverridden() const override;
    virtual int32 GetDescendOverriddenValue() const override;
    virtual int32 GetStrikeBrushHeightPercentage() const override;
    virtual FFontFaceDataConstRef GetFontFaceData() const override;
    virtual FFontRasterizationSettings GetRasterizationSettings() const override;
    //~ End IFontFaceInterface interface
 
private:
    FString GetCookedFilename() const;
    void UpdateDeviceRasterizationSettings();
    //~ Begin UObject Interface
#if WITH_EDITOR
    virtual void CookAdditionalFilesOverride(const TCHAR* PackageFilename, const ITargetPlatform* TargetPlatform,
        TFunctionRef<void(const TCHAR* Filename, void* Data, int64 Size)> WriteAdditionalFile);
#endif // WITH_EDITOR
    //~ End UObject Interface
 
public:
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=FontFace)
    FString SourceFilename;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=FontFace)
    EFontHinting Hinting;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=FontFace)
    EFontLoadingPolicy LoadingPolicy;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=FontFace, AdvancedDisplay)
    EFontLayoutMethod LayoutMethod;
 
    UPROPERTY(EditAnywhere, Category=FontFace, AdvancedDisplay, meta = (EditCondition = bIsAscendOverridden, EditConditionHides, ClampMin = "-100", ClampMax = "100"))
    int32 AscendOverriddenValue;
 
    UPROPERTY(EditAnywhere, Category=FontFace, AdvancedDisplay)
    bool bIsAscendOverridden;
 
    UPROPERTY(EditAnywhere, Category=FontFace, AdvancedDisplay, meta = (EditCondition = bIsDescendOverridden, EditConditionHides, ClampMin = "-100", ClampMax = "100"))
    int32 DescendOverriddenValue;
 
    UPROPERTY(EditAnywhere, Category=FontFace, AdvancedDisplay)
    bool bIsDescendOverridden;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = FontFace, AdvancedDisplay, meta = (ClampMin = "0", ClampMax = "100", ForceUnits = "%"))
    int32 StrikeBrushHeightPercentage;
 
    FFontFaceDataRef FontFaceData;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    TArray<uint8> FontFaceData_DEPRECATED;
 
    UPROPERTY(VisibleAnywhere, Transient, Category=FontFace, AdvancedDisplay)
    TArray<FString> SubFaces;
#endif // WITH_EDITORONLY_DATA
 
    UPROPERTY(EditAnywhere, Category=DistanceFieldMode)
    bool bEnableDistanceFieldRendering = false;
    
    UPROPERTY(EditAnywhere, Category=DistanceFieldMode, meta=(ClampMin=8, ClampMax=256, DisplayName="Low Quality", EditCondition="bEnableDistanceFieldRendering", EditConditionHides))
    int32 MinDistanceFieldPpem = 32;
 
    UPROPERTY(EditAnywhere, Category=DistanceFieldMode, meta=(ClampMin=8, ClampMax=256, DisplayName="Medium Quality", EditCondition="bEnableDistanceFieldRendering", EditConditionHides))
    int32 MidDistanceFieldPpem = 48;
 
    UPROPERTY(EditAnywhere, Category=DistanceFieldMode, meta=(ClampMin=8, ClampMax=256, DisplayName="High Quality", EditCondition="bEnableDistanceFieldRendering", EditConditionHides))
    int32 MaxDistanceFieldPpem = 64;
    
    UPROPERTY(EditAnywhere, Category=DistanceFieldMode, meta=(ClampMin=8, ClampMax=256, DisplayName="Low Quality", EditCondition="bEnableDistanceFieldRendering", EditConditionHides))
    int32 MinMultiDistanceFieldPpem = 32;
 
    UPROPERTY(EditAnywhere, Category=DistanceFieldMode, meta=(ClampMin=8, ClampMax=256, DisplayName="Medium Quality", EditCondition="bEnableDistanceFieldRendering", EditConditionHides))
    int32 MidMultiDistanceFieldPpem = 40;
 
    UPROPERTY(EditAnywhere, Category=DistanceFieldMode, meta=(ClampMin=8, ClampMax=256, DisplayName="High Quality", EditCondition="bEnableDistanceFieldRendering", EditConditionHides))
    int32 MaxMultiDistanceFieldPpem = 56;
 
    UPROPERTY(EditAnywhere, Category=DistanceFieldMode, meta=(ClampMin=8, ClampMax=256, DisplayName="Override Platform Rasterization Mode", EditCondition="bEnableDistanceFieldRendering", EditConditionHides))
    TOptional<FFontFacePlatformRasterizationOverrides> PlatformRasterizationModeOverrides;
 
private:
    FFontRasterizationSettings DeviceRasterizationSettings;
 
};