Font.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 "UObject/Class.h"
#include "Fonts/CompositeFont.h"
#include "Fonts/SlateFontInfo.h"
#include "Engine/FontImportOptions.h"
#include "Fonts/FontProviderInterface.h"
#include "Font.generated.h"
 
UENUM()
enum class EFontCacheType : uint8
{
    Offline,
 
    Runtime,
};
 
UENUM()
enum class ERuntimeFontSource : uint8
{
    Asset,
 
    CoreStyleDefault,
};
 
USTRUCT()
struct FFontCharacter
{
    GENERATED_USTRUCT_BODY()
 
    UPROPERTY(EditAnywhere, Category=FontCharacter)
    int32 StartU;
 
    UPROPERTY(EditAnywhere, Category=FontCharacter)
    int32 StartV;
 
    UPROPERTY(EditAnywhere, Category=FontCharacter)
    int32 USize;
 
    UPROPERTY(EditAnywhere, Category=FontCharacter)
    int32 VSize;
 
    UPROPERTY(EditAnywhere, Category=FontCharacter)
    uint8 TextureIndex;
 
    UPROPERTY(EditAnywhere, Category=FontCharacter)
    int32 VerticalOffset;
 
 
    FFontCharacter()
        : StartU(0)
        , StartV(0)
        , USize(0)
        , VSize(0)
        , TextureIndex(0)
        , VerticalOffset(0)
    { }
 
    bool Serialize( FArchive& Ar )
    {
        Ar << *this;
        return true;
    }
 
    // Serializer.
    friend FArchive& operator<<( FArchive& Ar, FFontCharacter& Ch )
    {
        Ar << Ch.StartU << Ch.StartV << Ch.USize << Ch.VSize << Ch.TextureIndex;
        Ar << Ch.VerticalOffset;
        return Ar;
    }
};
 
 
template<>
struct TStructOpsTypeTraits<FFontCharacter> : public TStructOpsTypeTraitsBase2<FFontCharacter>
{
    enum 
    {
        WithSerializer = true,
    };
    static constexpr EPropertyObjectReferenceType WithSerializerObjectReferences = EPropertyObjectReferenceType::None;
};
 
 
UCLASS(hidecategories=Object, autoexpandcategories=Font, MinimalAPI, BlueprintType)
class UFont : public UObject, public IFontProviderInterface
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(EditAnywhere, Category=Font)
    EFontCacheType FontCacheType;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category=RuntimeFont)
    ERuntimeFontSource RuntimeFontSource = ERuntimeFontSource::Asset;
 
    UPROPERTY(EditAnywhere, Category=OfflineFont)
    TArray<struct FFontCharacter> Characters;
 
    //NOTE: Do not expose this to the editor as it has nasty crash potential
    UPROPERTY()
    TArray<TObjectPtr<class UTexture2D>> Textures;
 
    UPROPERTY()
    int32 IsRemapped;
 
    UPROPERTY(EditAnywhere, Category=OfflineFont)
    float EmScale;
 
    UPROPERTY(EditAnywhere, Category=OfflineFont)
    float Ascent;
 
    UPROPERTY(EditAnywhere, Category=OfflineFont)
    float Descent;
 
    UPROPERTY(EditAnywhere, Category=OfflineFont)
    float Leading;
 
    UPROPERTY(EditAnywhere, Category=OfflineFont)
    int32 Kerning;
 
    UPROPERTY(EditAnywhere, Category=OfflineFont)
    struct FFontImportOptionsData ImportOptions;
 
    UPROPERTY(transient)
    int32 NumCharacters;
 
    UPROPERTY(transient)
    TArray<int32> MaxCharHeight;
 
    UPROPERTY(EditAnywhere, Category=OfflineFont)
    float ScalingFactor;
 
    UPROPERTY(EditAnywhere, Category=RuntimeFont, meta = (ClampMin = 1, ClampMax = 1000))
    int32 LegacyFontSize;
 
    UPROPERTY(EditAnywhere, Category=RuntimeFont)
    FName LegacyFontName;
 
    UE_DEPRECATED(5.7, "Public access to CompositeFont is deprecated. Use GetCompositeFont(), GetInternalCompositeFont(), or GetMutableInternalCompositeFont() instead.")
    UPROPERTY(EditAnywhere, Category = RuntimeFont)
    FCompositeFont CompositeFont;
 
public:
 
    static const TCHAR NULLCHARACTER = 127;
 
    TMap<uint16,uint16> CharRemap;
 
    ENGINE_API virtual const FCompositeFont* GetCompositeFont() const override;
 
    inline const FCompositeFont& GetInternalCompositeFont() const
    {
        PRAGMA_DISABLE_DEPRECATION_WARNINGS
        return CompositeFont;
        PRAGMA_ENABLE_DEPRECATION_WARNINGS
    }
 
    inline FCompositeFont& GetMutableInternalCompositeFont()
    {
        PRAGMA_DISABLE_DEPRECATION_WARNINGS
        return CompositeFont;
        PRAGMA_ENABLE_DEPRECATION_WARNINGS
    }
 
    static FName GetInternalCompositeFontPropertyName()
    {
        PRAGMA_DISABLE_DEPRECATION_WARNINGS
        return GET_MEMBER_NAME_CHECKED(UFont, CompositeFont);
        PRAGMA_ENABLE_DEPRECATION_WARNINGS
    }
 
    ENGINE_API FSlateFontInfo GetLegacySlateFontInfo() const;
 
    virtual void GetResourceSizeEx(FResourceSizeEx& CumulativeResourceSize) override;
 
    //~ Begin UFont Interface
    ENGINE_API TCHAR RemapChar(TCHAR CharCode) const;
 
    ENGINE_API void GetCharSize(TCHAR InCh, float& Width, float& Height) const;
 
    ENGINE_API int8 GetCharKerning(TCHAR First, TCHAR Second) const;
 
    ENGINE_API int16 GetCharHorizontalOffset(TCHAR InCh) const;
 
    ENGINE_API int32 GetStringSize( const TCHAR *Text ) const;
 
    ENGINE_API int32 GetStringHeightSize( const TCHAR *Text ) const;
 
    //~ Begin UObject Interface
    virtual void Serialize( FArchive& Ar ) override;
    virtual void PostLoad() override;
    virtual void BeginDestroy() override;
    //~ End UObject interface
 
    ENGINE_API void CacheCharacterCountAndMaxCharHeight();
 
    inline void SetFontScalingFactor(float InScalingFactor)
    {
        ScalingFactor = InScalingFactor;
    }
 
    inline float GetFontScalingFactor() const
    {
        return ScalingFactor;
    }
 
    ENGINE_API float GetMaxCharHeight() const;
    
    ENGINE_API void GetStringHeightAndWidth( const FString& InString, int32& Height, int32& Width ) const;
    ENGINE_API void GetStringHeightAndWidth( const TCHAR *Text, int32& Height, int32& Width ) const;
};