TEXT3UText3DComponent

Inheritance Hierarchy

References

Module

Text3D

Header

/Engine/Plugins/Experimental/Text3D/Source/Text3D/Public/Text3DComponent.h

Include

#include "Text3DComponent.h"

Syntax

UCLASS(ClassGroup=(Text3D), Meta=(BlueprintSpawnableComponent))
class TEXT3UText3DComponent : public USceneComponent

Variables

Name Description

Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter

TObjectPtr< UMa...

 

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< UMa...

 

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

EText3DBevelTyp...

 

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< UMa...

 

ExtrudeMaterial

Material for the extruded part

Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter

TObjectPtr< UFo...

 

Font

Text font

Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter

TObjectPtr< UMa...

 

FrontMaterial

Material for the front part

Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter

EText3DHorizont...

 

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

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

EText3DVertical...

 

VerticalAlignment

Vertical text alignment

Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite setter

float

 

WordSpacing

Extra word spacing

Functions

Name Description

Public function Const

bool

 

CastsShadow()

Get the value of CastShadow.

Protected function

void

 

ClearTextMesh()

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

UMaterialInt...

 

GetBackMaterial()

Get the text back material

Public function Const

float

 

GetBevel()

Get the 3d bevel value

Public function Const

UMaterialInt...

 

GetBevelMaterial()

Get the text bevel material

Public function Const

int32

 

GetBevelSegments()

Get the amount of segments that will be used to tessellate the Bevel

Public function Const

EText3DBevel...

 

GetBevelType()

Get the 3d bevel type

Public function UFunction BlueprintCallable, Category

void

 

GetBounds

(
    FVector& Origin,
    FVector& BoxExtent
)

Public function Const

float

 

GetExtrude()

Get the text extrusion size and signal the primitives to be rebuilt

Public function Const

UMaterialInt...

 

GetExtrudeMaterial()

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

 

GetFormattedText()

Returns the Text property, after being formatted by the FormatText virtual function.

Public function Const

UMaterialInt...

 

GetFrontMaterial()

Get the text front material

Public function UFunction BlueprintCallable, Category

int32

 

GetGlyphCount()

Gets the number of font glyphs that are currently used

Public function UFunction BlueprintCallable, Category

USceneCompon...

 

GetGlyphKerningComponent

(
    int32 Index
)

Gets the USceneComponent that a glyph is attached to

Public function UFunction BlueprintCallable, Category

const TArray...

 

GetGlyphKerningComponents()

Gets all the glyph kerning components

Public function UFunction BlueprintCallable, Category

UStaticMeshC...

 

GetGlyphMeshComponent

(
    int32 Index
)

Gets the StaticMeshComponent of a glyph

Public function UFunction BlueprintCallable, Category

const TArray...

 

GetGlyphMeshComponents()

Gets all the glyph meshes

Public function Const

EText3DHoriz...

 

GetHorizontalAlignment()

Get the horizontal alignment value and signal the primitives to be rebuilt

Public function Const

float

 

GetKerning()

Get the kerning value and signal the primitives to be rebuilt

Public function Const

float

 

GetLineSpacing()

Get the line spacing value and signal the primitives to be rebuilt

Public function Const

float

 

GetMaxHeight()

Get the Maximum Height - If height is larger, mesh will scale down to fit MaxHeight value

Public function Const

float

 

GetMaxWidth()

Get the Maximum Width - If width is larger, mesh will scale down to fit MaxWidth value

Public function Const

float

 

GetOutlineExpand()

Get the outline width.

Public function Const

const FText ...

 

GetText()

Get the text value and signal the primitives to be rebuilt

Public function UFunction BlueprintCallable, Category

FVector

 

GetTextScale()

Gets the scale of actual text geometry, taking into account MaxWidth and MaxHeight constraints.

Public function Const

EText3DVerti...

 

GetVerticalAlignment()

Get the vertical alignment and signal the primitives to be rebuilt

Public function Const

float

 

GetWordSpacing()

Get the word spacing value and signal the primitives to be rebuilt

Public function Const

bool

 

HasMaxHeight()

Whether a maximum height is specified

Public function Const

bool

 

HasMaxWidth()

Whether a maximum width is specified

Public function Const

bool

 

HasOutline()

Get whether an outline is applied.

Public function Const

bool

 

IsFrozen()

Freeze mesh rebuild, to avoid unnecessary mesh rebuilds when setting a few properties together

Public function

FTextGenerat...

 

OnTextGenerated()

Public function

void

 

Rebuild()

Manually update the geometry, ignoring RefreshOnChange (but still accounting for the Freeze flag)

Public function Const

bool

 

RefreshesOnChange()

Get whether to allow automatic refresh/mesh generation

Public function Const

bool

 

ScalesProportionally()

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

 

SetHorizontalAlignment

(
    const EText3DHorizontalTextAlignmen...
)

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

 

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 UFunction BlueprintCallable, Category, Meta

void

 

SetVerticalAlignment

(
    const EText3DVerticalTextAlignment ...
)

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 InModifyFl...
)

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

Public function

 

UText3DComponent()

Overridden from USceneComponent

Name Description

Protected function Virtual

void

 

OnHiddenInGameChanged()

Intercept and propagate a change on this component to all children.

Protected function Virtual

void

 

OnVisibilityChanged()

Intercept and propagate a change on this component to all children.

Overridden from UActorComponent

Name Description

Public function Virtual

void

 

OnRegister()

Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.

Public function Virtual

void

 

OnUnregister()

Called when a component is unregistered.

Overridden from UObject

Name Description

Public function Virtual

void

 

BeginDestroy()

Called before destroying the object.

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Public function Virtual

void

 

PostTransacted

(
    const FTransactionObjectEvent& Tra...
)

Called after the object has been transacted in some way.

Classes

Name

Description

Public class

FTextGenerated

Delegate called after text is rebuilt

Typedefs

Name

Description

FTextGeneratedNative

Delegate called after text is rebuilt

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Cancel