| UObjectBase
|
Module |
|
Header |
/Engine/Plugins/Experimental/Text3D/Source/Text3D/Public/Text3DComponent.h |
Include |
#include "Text3DComponent.h" |
UCLASS(ClassGroup=(Text3D), Meta=(BlueprintSpawnableComponent))
class TEXT3UText3DComponent : public USceneComponent
Name | Description | ||
---|---|---|---|
|
TObjectPtr< UMa... |
BackMaterial |
Material for the back part |
|
bool |
bCastShadow |
Controls whether the text glyphs should cast a shadow or not. |
|
float |
Bevel |
Size of bevel |
|
TObjectPtr< UMa... |
BevelMaterial |
Material for the bevel part |
|
int32 |
BevelSegments |
Bevel Segments (Defines the amount of tesselation for the bevel part) |
|
BevelType |
Bevel Type |
|
|
bool |
bHasMaxHeight |
Enables a maximum height to the 3D Text |
|
bool |
bHasMaxWidth |
Enables a maximum width to the 3D Text |
|
bool |
bOutline |
Generate Outline |
|
bool |
bRefreshOnChange |
Whether to allow automatic refresh/mesh generation |
|
bool |
bScaleProportionally |
Should the mesh scale proportionally when Max Width/Height is set |
|
float |
Extrude |
Size of the extrude |
|
TObjectPtr< UMa... |
ExtrudeMaterial |
Material for the extruded part |
|
TObjectPtr< UFo... |
Font |
Text font |
|
TObjectPtr< UMa... |
FrontMaterial |
Material for the front part |
|
HorizontalAlignment |
Horizontal text alignment |
|
|
float |
Kerning |
Text kerning |
|
float |
LineSpacing |
Extra line spacing |
|
float |
MaxHeight |
Sets a maximum height to the 3D Text |
|
float |
MaxWidth |
Sets a maximum width to the 3D Text |
|
float |
OutlineExpand |
Outline expand/offset amount |
|
Text |
The text to generate a 3d mesh |
|
|
VerticalAlignment |
Vertical text alignment |
|
|
float |
WordSpacing |
Extra word spacing |
Name | Description | ||
---|---|---|---|
|
bool |
CastsShadow() |
Get the value of CastShadow. |
|
void |
ClearTextMesh() |
Clears all generated components and meshes from this component. |
|
void |
FormatText ( |
Will be called when text geometry is generated. |
|
UMaterialInt... |
GetBackMaterial() |
Get the text back material |
|
float |
GetBevel() |
Get the 3d bevel value |
|
UMaterialInt... |
GetBevelMaterial() |
Get the text bevel material |
|
int32 |
GetBevelSegments() |
Get the amount of segments that will be used to tessellate the Bevel |
|
EText3DBevel... |
GetBevelType() |
Get the 3d bevel type |
|
void |
GetBounds ( |
|
|
float |
GetExtrude() |
Get the text extrusion size and signal the primitives to be rebuilt |
|
UMaterialInt... |
GetExtrudeMaterial() |
Get the text extrude material |
|
const UFont ... |
GetFont() |
Get the text font and signal the primitives to be rebuilt |
|
GetFormattedText() |
Returns the Text property, after being formatted by the FormatText virtual function. |
|
|
UMaterialInt... |
GetFrontMaterial() |
Get the text front material |
|
int32 |
GetGlyphCount() |
Gets the number of font glyphs that are currently used |
|
USceneCompon... |
GetGlyphKerningComponent ( |
Gets the USceneComponent that a glyph is attached to |
|
const TArray... |
GetGlyphKerningComponents() |
Gets all the glyph kerning components |
|
UStaticMeshC... |
GetGlyphMeshComponent ( |
Gets the StaticMeshComponent of a glyph |
|
const TArray... |
GetGlyphMeshComponents() |
Gets all the glyph meshes |
|
EText3DHoriz... |
GetHorizontalAlignment() |
Get the horizontal alignment value and signal the primitives to be rebuilt |
|
float |
GetKerning() |
Get the kerning value and signal the primitives to be rebuilt |
|
float |
GetLineSpacing() |
Get the line spacing value and signal the primitives to be rebuilt |
|
float |
GetMaxHeight() |
Get the Maximum Height - If height is larger, mesh will scale down to fit MaxHeight value |
|
float |
GetMaxWidth() |
Get the Maximum Width - If width is larger, mesh will scale down to fit MaxWidth value |
|
float |
GetOutlineExpand() |
Get the outline width. |
|
const FText ... |
GetText() |
Get the text value and signal the primitives to be rebuilt |
|
FVector |
GetTextScale() |
Gets the scale of actual text geometry, taking into account MaxWidth and MaxHeight constraints. |
|
EText3DVerti... |
GetVerticalAlignment() |
Get the vertical alignment and signal the primitives to be rebuilt |
|
float |
GetWordSpacing() |
Get the word spacing value and signal the primitives to be rebuilt |
|
bool |
HasMaxHeight() |
Whether a maximum height is specified |
|
bool |
HasMaxWidth() |
Whether a maximum width is specified |
|
bool |
HasOutline() |
Get whether an outline is applied. |
|
bool |
IsFrozen() |
Freeze mesh rebuild, to avoid unnecessary mesh rebuilds when setting a few properties together |
|
FTextGenerat... |
OnTextGenerated() |
|
|
void |
Rebuild() |
Manually update the geometry, ignoring RefreshOnChange (but still accounting for the Freeze flag) |
|
bool |
RefreshesOnChange() |
Get whether to allow automatic refresh/mesh generation |
|
bool |
ScalesProportionally() |
Get if the mesh should scale proportionally when Max Width/Height is set |
|
void |
SetBackMaterial ( |
Set the text back material |
|
void |
SetBevel ( |
Set the 3d bevel value |
|
void |
SetBevelMaterial ( |
Set the text bevel material |
|
void |
SetBevelSegments ( |
Set the amount of segments that will be used to tessellate the Bevel |
|
void |
SetBevelType ( |
Set the 3d bevel type |
|
void |
SetCastShadow ( |
Set the value of CastShadow. |
|
void |
SetExtrude ( |
Set the text extrusion size and signal the primitives to be rebuilt |
|
void |
SetExtrudeMaterial ( |
Set the text extrude material |
|
void |
SetFont ( |
Set the text font and signal the primitives to be rebuilt |
|
void |
SetFreeze ( |
Freeze mesh rebuild, to avoid unnecessary mesh rebuilds when setting a few properties together |
|
void |
SetFrontMaterial ( |
Set the text front material |
|
void |
SetHasMaxHeight ( |
Enable / Disable a Maximum Height |
|
void |
SetHasMaxWidth ( |
Enable / Disable a Maximum Width |
|
void |
SetHasOutline ( |
Set whether an outline is applied. |
|
void |
SetHorizontalAlignment ( |
Set the horizontal alignment value and signal the primitives to be rebuilt |
|
void |
SetKerning ( |
Set the kerning value and signal the primitives to be rebuilt |
|
void |
SetLineSpacing ( |
Set the line spacing value and signal the primitives to be rebuilt |
|
void |
SetMaxHeight ( |
Set the Maximum Height - If height is larger, mesh will scale down to fit MaxHeight value |
|
void |
SetMaxWidth ( |
Set the Maximum Width - If width is larger, mesh will scale down to fit MaxWidth value |
|
void |
SetOutlineExpand ( |
Set the outline width. |
|
void |
SetRefreshOnChange ( |
Set whether to allow automatic refresh/mesh generation |
|
void |
SetScaleProportionally ( |
Set if the mesh should scale proportionally when Max Width/Height is set |
|
void |
SetText ( |
Set the text value and signal the primitives to be rebuilt |
|
void |
SetVerticalAlignment ( |
Set the vertical alignment and signal the primitives to be rebuilt |
|
void |
SetWordSpacing ( |
Set the word spacing value and signal the primitives to be rebuilt |
|
void |
TriggerInternalRebuild ( |
Can be used to force an internal geometry and/or layout rebuild |
|
UText3DComponent() |
Name | Description | ||
---|---|---|---|
|
void |
OnHiddenInGameChanged() |
Intercept and propagate a change on this component to all children. |
|
void |
OnVisibilityChanged() |
Intercept and propagate a change on this component to all children. |
Name | Description | ||
---|---|---|---|
|
void |
OnRegister() |
Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called. |
|
void |
OnUnregister() |
Called when a component is unregistered. |
Name | Description | ||
---|---|---|---|
|
void |
BeginDestroy() |
Called before destroying the object. |
|
void |
PostEditChangeProperty ( |
Called when a property on this object has been modified externally |
|
void |
PostLoad() |
Do any object-specific cleanup required immediately after loading an object. |
|
void |
PostTransacted ( |
Called after the object has been transacted in some way. |
Name |
Description |
|
---|---|---|
|
FTextGenerated |
Delegate called after text is rebuilt |
Name |
Description |
---|---|
FTextGeneratedNative |
Delegate called after text is rebuilt |