TEXT3UText3DComponent

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Text3D

Header

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

Include

#include "Text3DComponent.h"

Syntax

UCLASS (ClassGroup=(Text3D))
class TEXT3UText3DComponent : public USceneComponent

Variables

Name Description

Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter

UMaterialInterf ...

 

BackMaterial

Material for the back part

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter

float

 

Bevel

Size of bevel

Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter

UMaterialInterf ...

 

BevelMaterial

Material for the bevel part

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter

int32

 

BevelSegments

Half Circle Bevel Segments (Defines the amount of tesselation for the bevel part)

Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter

EText3DBevelTyp ...

 

BevelType

Bevel Type (Linear / Half Circle)

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter

bool

 

bHasMaxHeight

Enables a maximum height to the 3D Text

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter

bool

 

bHasMaxWidth

Enables a maximum width to the 3D Text

Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter

bool

 

bScaleProportionally

Should the mesh scale proportionally when Max Width/Height is set

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter

float

 

Extrude

Size of the extrude

Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter

UMaterialInterf ...

 

ExtrudeMaterial

Material for the extruded part

Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter

UFont *

 

Font

Text font

Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter

UMaterialInterf ...

 

FrontMaterial

Material for the front part

Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter

EText3DHorizont ...

 

HorizontalAlignment

Horizontal text alignment

Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter

float

 

Kerning

Text kerning

Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter

float

 

LineSpacing

Extra line spacing

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter

float

 

MaxHeight

Sets a maximum height to the 3D Text

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter

float

 

MaxWidth

Sets a maximum width to the 3D Text

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter

FText

 

Text

The text to generate a 3d mesh

Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter

EText3DVertical ...

 

VerticalAlignment

Vertical text alignment

Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter

float

 

WordSpacing

Extra word spacing

Functions

Name Description

Public function

int32

 

GetGlyphCount()

Public function

USceneCompon ...

 

GetGlyphKerningComponent

(
    int32 Index
)

Public function

UStaticMeshC ...

 

GetGlyphMeshComponent

(
    int32 Index
)

Public function

FTextGenerat ...

 

OnTextGenerated()

Public function UFunction BlueprintCallable, Category

void

 

SetBackMaterial

(
    UMaterialInterface * Value
)

Set the text back material

Public function UFunction BlueprintCallable, Category

void

 

SetBevel

(
    const float Value
)

Set the 3d bevel value

Public function UFunction BlueprintCallable, Category

void

 

SetBevelMaterial

(
    UMaterialInterface * Value
)

Set the text bevel material

Public function UFunction BlueprintCallable, Category

void

 

SetBevelSegments

(
    const int32 Value
)

Set the amount of segments that will be used to tesselate the Half Circle Bevel

Public function UFunction BlueprintCallable, Category

void

 

SetBevelType

(
    const EText3DBevelType Value
)

Set the 3d bevel type (Linear / Half Circle)

Public function UFunction BlueprintCallable, Category

void

 

SetExtrude

(
    const float Value
)

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

Public function UFunction BlueprintCallable, Category

void

 

SetExtrudeMaterial

(
    UMaterialInterface * Value
)

Set the text extrude material

Public function UFunction BlueprintCallable, Category

void

 

SetFont

(
    UFont *const InFont
)

Set the text font and signal the primitives to be rebuilt

Public function UFunction BlueprintCallable, Category

void

 

SetFreeze

(
    const bool bFreeze
)

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

Public function UFunction BlueprintCallable, Category

void

 

SetFrontMaterial

(
    UMaterialInterface * Value
)

Set the text front material

Public function UFunction BlueprintCallable, Category

void

 

SetHasMaxHeight

(
    const bool Value
)

Enable / Disable a Maximum Height

Public function UFunction BlueprintCallable, Category

void

 

SetHasMaxWidth

(
    const bool Value
)

Enable / Disable a Maximum Width

Public function UFunction BlueprintCallable, Category

void

 

SetHorizontalAlignment

(
    const EText3DHorizontalTextAlignmen ...
)

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

Public function UFunction BlueprintCallable, Category

void

 

SetKerning

(
    const float Value
)

Set the kerning value and signal the primitives to be rebuilt

Public function UFunction BlueprintCallable, Category

void

 

SetLineSpacing

(
    const float Value
)

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

Public function UFunction BlueprintCallable, Category

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

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

void

 

SetScaleProportionally

(
    const bool Value
)

Set if the mesh should scale proportionally when Max Width/Height is set

Public function UFunction BlueprintCallable, Category

void

 

SetText

(
    const FText & Value
)

Set the text value and signal the primitives to be rebuilt

Public function UFunction BlueprintCallable, Category

void

 

SetVerticalAlignment

(
    const EText3DVerticalTextAlignment ...
)

Set the vertical alignment and signal the primitives to be rebuilt

Public function UFunction BlueprintCallable, Category

void

 

SetWordSpacing

(
    const float Value
)

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

Public function

 

UText3DComponent()

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.

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent & PropertyCha...
)

Called when a property on this object has been modified externally

Typedefs

Name

Description

FTextGenerated

Delegate called after text is rebuilt

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback