1. Epic GamesDeveloper
  3. TEXT3UText3DComponent

TEXT3UText3DComponent

Unreal Engine C++ API Reference > Plugins > Text3D

Inheritance Hierarchy

  • USceneComponent
  • TEXT3UText3DComponent

References

   
Module Text3D
Header /Engine/Plugins/Experimental/Text3D/Source/Text3D/Public/Text3DComponent.h
Include #include "Text3DComponent.h"

Syntax

UCLASS (ClassGroup=(Text3D), prioritizeCategories="Text Layout Geometry Materials",  
       Meta=(BlueprintSpawnableComponent))  
class TEXT3UText3DComponent : public USceneComponent

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter TObjectPtr< UMaterialInterface > BackMaterial Material for the back part
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter bool bCastShadow Controls whether the text glyphs should cast a shadow or not.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter float Bevel Size of bevel
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter TObjectPtr< UMaterialInterface > BevelMaterial Material for the bevel part
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter int32 BevelSegments Bevel Segments (Defines the amount of tesselation for the bevel part)
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter EText3DBevelType BevelType Bevel Type
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter bool bHasMaxHeight Enables a maximum height to the 3D Text
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter bool bHasMaxWidth Enables a maximum width to the 3D Text
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter bool bOutline Generate Outline
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite getter, setter bool bRefreshOnChange Whether to allow automatic refresh/mesh generation
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter bool bScaleProportionally Should the mesh scale proportionally when Max Width/Height is set
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter float Extrude Size of the extrude
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter TObjectPtr< UMaterialInterface > ExtrudeMaterial Material for the extruded part
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter TObjectPtr< UFont > Font Text font
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter TObjectPtr< UMaterialInterface > FrontMaterial Material for the front part
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter EText3DHorizontalTextAlignment HorizontalAlignment Horizontal text alignment
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter float Kerning Text kerning
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter float LineSpacing Extra line spacing
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter float MaxHeight Sets a maximum height to the 3D Text
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter float MaxWidth Sets a maximum width to the 3D Text
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter EText3DMaxWidthHandling MaxWidthHandling Dictates how to handle the text if it exceeds the max width
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter float OutlineExpand Outline expand/offset amount
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter FText Text The text to generate a 3d mesh
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter FName Typeface  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter EText3DVerticalTextAlignment VerticalAlignment Vertical text alignment
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite setter float WordSpacing Extra word spacing

Functions

  Type Name Description
Public function Virtual void  
Public function Const bool Get the value of CastShadow.
Protected function void Clears all generated components and meshes from this component.
Protected function Virtual Const void

FormatText ( FText& InOutText
)

 Will be called when text geometry is generated.
Public function Const UMaterialInterface * Get the text back material
Public function Const float Get the 3d bevel value
Public function Const UMaterialInterface * Get the text bevel material
Public function Const int32 Get the amount of segments that will be used to tessellate the Bevel
Public function Const EText3DBevelType Get the 3d bevel type
Public function UFunction BlueprintCallable, Category void

GetBounds ( FVector& Origin,
FVector& BoxExtent
)

  
Public function Const float Get the text extrusion size and signal the primitives to be rebuilt
Public function Const UMaterialInterface * Get the text extrude material
Public function Const const UFont *

GetFont ()

 Get the text font and signal the primitives to be rebuilt
Protected function Const UFunction BlueprintCallable, Category FText Returns the Text property, after being formatted by the FormatText virtual function.
Public function Const UMaterialInterface * Get the text front material
Public function UFunction BlueprintCallable, Category int32 Gets the number of font glyphs that are currently used
Public function UFunction BlueprintCallable, Category USceneComponent * Gets the USceneComponent that a glyph is attached to
Public function UFunction BlueprintCallable, Category const TArray< USceneComponent * > & Gets all the glyph kerning components
Public function UFunction BlueprintCallable, Category UStaticMeshComponent * Gets the StaticMeshComponent of a glyph
Public function UFunction BlueprintCallable, Category const TArray< UStaticMeshComponent * > & Gets all the glyph meshes
Public function Const EText3DHorizontalTextAlignment Get the horizontal alignment value and signal the primitives to be rebuilt
Public function Const float Get the kerning value and signal the primitives to be rebuilt
Public function Const float Get the line spacing value and signal the primitives to be rebuilt
Public function Const float Get the Maximum Height - If height is larger, mesh will scale down to fit MaxHeight value
Public function Const float Get the Maximum Width - If width is larger, mesh will scale down to fit MaxWidth value
Public function Const EText3DMaxWidthHandling Get the Maximum Width Handling - Whether to wrap before scaling when the text size reaches the max width
Public function Const float Get the outline width.
Public function Const const FText3DStatistics &  
Public function Const const FText &

GetText ()

 Get the text value and signal the primitives to be rebuilt
Public function UFunction BlueprintCallable, Category FVector Gets the scale of actual text geometry, taking into account MaxWidth and MaxHeight constraints.
Public function Const FName Get the typeface
Protected function Const UFunction TArray< FName >  
Public function Const EText3DVerticalTextAlignment Get the vertical alignment and signal the primitives to be rebuilt
Public function Const float Get the word spacing value and signal the primitives to be rebuilt
Public function Const bool Whether a maximum height is specified
Public function Const bool Whether a maximum width is specified
Public function Const bool Get whether an outline is applied.
Public function Const bool Freeze mesh rebuild, to avoid unnecessary mesh rebuilds when setting a few properties together
Protected function Virtual void Intercept and propagate a change on this component to all children.
Public function Virtual void  
Public function FTextGeneratedNative &  
Public function Virtual void  
Protected function Virtual void Intercept and propagate a change on this component to all children.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Virtual void  
Public function Virtual void

PostTransacted ( const FTransactionObjectEvent& TransactionEvent
)

  
Public function void

Rebuild ()

 Manually update the geometry, ignoring RefreshOnChange (but still accounting for the Freeze flag)
Public function Const bool Get whether to allow automatic refresh/mesh generation
Public function Const bool Get if the mesh should scale proportionally when Max Width/Height is set
Public function UFunction BlueprintCallable, Category, Meta void

SetBackMaterial ( UMaterialInterface* Value
)

 Set the text back material
Public function UFunction BlueprintCallable, Category, Meta void

SetBevel ( const float Value
)

 Set the 3d bevel value
Public function UFunction BlueprintCallable, Category, Meta void

SetBevelMaterial ( UMaterialInterface* Value
)

 Set the text bevel material
Public function UFunction BlueprintCallable, Category, Meta void

SetBevelSegments ( const int32 Value
)

 Set the amount of segments that will be used to tessellate the Bevel
Public function UFunction BlueprintCallable, Category, Meta void

SetBevelType ( const EText3DBevelType Value
)

 Set the 3d bevel type
Public function UFunction BlueprintCallable, Category, Meta void

SetCastShadow ( bool NewCastShadow
)

 Set the value of CastShadow.
Public function UFunction BlueprintCallable, Category, Meta void

SetExtrude ( const float Value
)

 Set the text extrusion size and signal the primitives to be rebuilt
Public function UFunction BlueprintCallable, Category, Meta void

SetExtrudeMaterial ( UMaterialInterface* Value
)

 Set the text extrude material
Public function UFunction BlueprintCallable, Category, Meta void

SetFont ( UFont* InFont
)

 Set the text font and signal the primitives to be rebuilt
Public function UFunction BlueprintCallable, Category, Meta void

SetFreeze ( const bool bFreeze
)

 Freeze mesh rebuild, to avoid unnecessary mesh rebuilds when setting a few properties together
Public function UFunction BlueprintCallable, Category, Meta void

SetFrontMaterial ( UMaterialInterface* Value
)

 Set the text front material
Public function UFunction BlueprintCallable, Category, Meta void

SetHasMaxHeight ( const bool Value
)

 Enable / Disable a Maximum Height
Public function UFunction BlueprintCallable, Category, Meta void

SetHasMaxWidth ( const bool Value
)

 Enable / Disable a Maximum Width
Public function UFunction BlueprintCallable, Category, Meta void

SetHasOutline ( const bool bValue
)

 Set whether an outline is applied.
Public function UFunction BlueprintCallable, Category, Meta void Set the horizontal alignment value and signal the primitives to be rebuilt
Public function UFunction BlueprintCallable, Category, Meta void

SetKerning ( const float Value
)

 Set the kerning value and signal the primitives to be rebuilt
Public function UFunction BlueprintCallable, Category, Meta void

SetLineSpacing ( const float Value
)

 Set the line spacing value and signal the primitives to be rebuilt
Public function UFunction BlueprintCallable, Category, Meta void

SetMaxHeight ( const float Value
)

 Set the Maximum Height - If height is larger, mesh will scale down to fit MaxHeight value
Public function UFunction BlueprintCallable, Category, Meta void

SetMaxWidth ( const float Value
)

 Set the Maximum Width - If width is larger, mesh will scale down to fit MaxWidth value
Public function UFunction BlueprintCallable, Category, Meta void Set the Maximum Width Handling - Whether to wrap before scaling when the text size reaches the max width
Public function UFunction BlueprintCallable, Category, Meta void

SetOutlineExpand ( const float Value
)

 Set the outline width.
Public function void

SetRefreshOnChange ( const bool Value
)

 Set whether to allow automatic refresh/mesh generation
Public function UFunction BlueprintCallable, Category, Meta void

SetScaleProportionally ( const bool Value
)

 Set if the mesh should scale proportionally when Max Width/Height is set
Public function UFunction BlueprintCallable, Category, Meta void

SetText ( const FText& Value
)

 Set the text value and signal the primitives to be rebuilt
Public function void

SetTypeface ( const FName InTypeface
)

 Set the typeface
Public function UFunction BlueprintCallable, Category, Meta void Set the vertical alignment and signal the primitives to be rebuilt
Public function UFunction BlueprintCallable, Category, Meta void

SetWordSpacing ( const float Value
)

 Set the word spacing value and signal the primitives to be rebuilt
Protected function void

TriggerInternalRebuild ( const EText3DModifyFlags InModifyFlags
)

 Can be used to force an internal geometry and/or layout rebuild
Public function    

Classes

  Type Name Description
Public class FTextGenerated Delegate called after text is rebuilt  

Typedefs

Name Description
FTextGeneratedNative Delegate called after text is rebuilt

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page