TextRenderComponent.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/TextProperty.h"
#include "Components/PrimitiveComponent.h"
#include "TextRenderComponent.generated.h"
 
class FPrimitiveSceneProxy;
class UFont;
class UMaterialInterface;
 
UENUM()
enum EHorizTextAligment : int
{
    EHTA_Left UMETA(DisplayName="Left"),
    EHTA_Center UMETA(DisplayName="Center"),
    EHTA_Right UMETA(DisplayName="Right"),
};
 
UENUM()
enum EVerticalTextAligment : int
{
    EVRTA_TextTop UMETA(DisplayName="Text Top"),
    EVRTA_TextCenter UMETA(DisplayName="Text Center"),
    EVRTA_TextBottom UMETA(DisplayName="Text Bottom"),
    EVRTA_QuadTop UMETA(DisplayName="Quad Top"),
};
 
UCLASS(Blueprintable, ClassGroup=Rendering, hidecategories=(Object,LOD,Physics,TextureStreaming,Activation,"Components|Activation",Collision), editinlinenew, meta=(BlueprintSpawnableComponent), MinimalAPI)
class UTextRenderComponent : public UPrimitiveComponent
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Text, meta=(MultiLine=true))
    FText Text;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Text)
    TObjectPtr<class UMaterialInterface> TextMaterial;
    
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Text)
    TObjectPtr<class UFont> Font;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Text, meta=(DisplayName = "Horizontal Alignment"))
    TEnumAsByte<enum EHorizTextAligment> HorizontalAlignment;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Text, meta=(DisplayName = "Vertical Alignment"))
    TEnumAsByte<enum EVerticalTextAligment> VerticalAlignment;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Text)
    FColor TextRenderColor;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Text)
    float XScale;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Text)
    float YScale;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Text)
    float WorldSize;
    
    UPROPERTY()
    float InvDefaultSize;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, AdvancedDisplay, Category=Text)
    float HorizSpacingAdjust;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, AdvancedDisplay, Category=Text)
    float VertSpacingAdjust;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, AdvancedDisplay, Category=Rendering)
    uint32 bAlwaysRenderAsText:1;
 
    // -----------------------------
    
    UFUNCTION()
    ENGINE_API void SetText(const FText& Value);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|TextRender", meta=(DisplayName="Set Text", ScriptName="SetText"))
    ENGINE_API void K2_SetText(const FText& Value);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|TextRender")
    ENGINE_API void SetTextMaterial(UMaterialInterface* Material);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|TextRender")
    ENGINE_API void SetFont(UFont* Value);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|TextRender")
    ENGINE_API void SetHorizontalAlignment(EHorizTextAligment Value);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|TextRender")
    ENGINE_API void SetVerticalAlignment(EVerticalTextAligment Value);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|TextRender")
    ENGINE_API void SetTextRenderColor(FColor Value);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|TextRender")
    ENGINE_API void SetXScale(float Value);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|TextRender")
    ENGINE_API void SetYScale(float Value);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|TextRender")
    ENGINE_API void SetHorizSpacingAdjust(float Value);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|TextRender")
    ENGINE_API void SetVertSpacingAdjust(float Value);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|TextRender")
    ENGINE_API void SetWorldSize(float Value);
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|TextRender")
    ENGINE_API FVector GetTextLocalSize() const;
 
    UFUNCTION(BlueprintCallable, Category="Rendering|Components|TextRender")
    ENGINE_API FVector GetTextWorldSize() const;
 
    // -----------------------------
 
    //~ Begin UPrimitiveComponent Interface.
    ENGINE_API virtual FPrimitiveSceneProxy* CreateSceneProxy() override;
    ENGINE_API virtual void GetUsedMaterials( TArray<UMaterialInterface*>& OutMaterials, bool bGetDebugMaterials = false ) const override;
    ENGINE_API virtual int32 GetNumMaterials() const override;
    ENGINE_API virtual UMaterialInterface* GetMaterial(int32 ElementIndex) const override;
    ENGINE_API virtual bool ShouldRecreateProxyOnUpdateTransform() const override;
    ENGINE_API virtual void SetMaterial(int32 ElementIndex, UMaterialInterface* InMaterial) override;
    ENGINE_API virtual FMatrix GetRenderMatrix() const override;
    //~ End UPrimitiveComponent Interface.
 
    //~ Begin USceneComponent Interface.
#if WITH_EDITOR
    ENGINE_API virtual bool GetMaterialPropertyPath(int32 ElementIndex, UObject*& OutOwner, FString& OutPropertyPath, FProperty*& OutProperty) override;
#endif // WITH_EDITOR
    ENGINE_API virtual FBoxSphereBounds CalcBounds(const FTransform& LocalToWorld) const override;
    // Note: this is required because GetRenderMatrix is overridden, and therefore the updated world-space bounds must be based on that (not the component transform)
    ENGINE_API virtual void UpdateBounds() override;
    //~ End USceneComponent Interface.
 
    //~ Begin UActorComponent Interface.
    ENGINE_API virtual bool RequiresGameThreadEndOfFrameUpdates() const override;
    ENGINE_API virtual void PrecachePSOs() override;
    //~ End UActorComponent Interface.
 
    //~ Begin UObject Interface.
    ENGINE_API virtual void PostLoad() override;
    //~ End UObject interface.
 
    static ENGINE_API void InitializeMIDCache();
    static ENGINE_API void ShutdownMIDCache();
};