unreal.Text3DDefaultLayoutExtension

class unreal.Text3DDefaultLayoutExtension(outer: Object | None = None, name: Name | str = 'None')

Bases: Text3DLayoutExtensionBase

Text 3DDefault Layout Extension

C++ Source:

• Plugin: Text3D

• Module: Text3D

• File: Text3DDefaultLayoutExtension.h

Editor Properties: (see get_editor_property/set_editor_property)

• horizontal_alignment (Text3DHorizontalTextAlignment): [Read-Write] Horizontal text alignment

• line_spacing (float): [Read-Write] Extra line spacing

• max_height (float): [Read-Write] Sets a maximum height to the 3D Text

• max_width (float): [Read-Write] Sets a maximum width to the 3D Text

• max_width_behavior (Text3DMaxWidthHandling): [Read-Write] Dictates how to handle the text if it exceeds the max width

• scale_proportionally (bool): [Read-Write] Should the mesh scale proportionally when Max Width/Height is set

• tracking (float): [Read-Write] Text tracking affects all characters

• use_max_height (bool): [Read-Write] Enables a maximum height to the 3D Text

• use_max_width (bool): [Read-Write] Enables a maximum width to the 3D Text

• vertical_alignment (Text3DVerticalTextAlignment): [Read-Write] Vertical text alignment

• word_spacing (float): [Read-Write] Extra word spacing

get_horizontal_alignment() → Text3DHorizontalTextAlignment

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

Return type:

Text3DHorizontalTextAlignment

get_line_spacing() → float

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

Return type:

float

get_max_height() → float

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

Return type:

float

get_max_width() → float

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

Return type:

float

get_max_width_behavior() → Text3DMaxWidthHandling

Get the Maximum Width Handling - Whether to wrap before scaling when the text size reaches the max width

Return type:

Text3DMaxWidthHandling

get_scales_proportionally() → bool

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

Return type:

bool

get_tracking() → float

Get the tracking value and signal the primitives to be rebuilt

Return type:

float

get_use_max_height() → bool

Whether a maximum height is specified

Return type:

bool

get_use_max_width() → bool

Whether a maximum width is specified

Return type:

bool

get_vertical_alignment() → Text3DVerticalTextAlignment

Get the vertical alignment and signal the primitives to be rebuilt

Return type:

Text3DVerticalTextAlignment

get_word_spacing() → float

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

Return type:

float

set_horizontal_alignment(value) → None

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

Parameters:

value (Text3DHorizontalTextAlignment)

set_line_spacing(value) → None

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

Parameters:

value (float)

set_max_height(value) → None

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

Parameters:

value (float)

set_max_width(value) → None

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

Parameters:

value (float)

set_max_width_behavior(value) → None

Set the Maximum Width Handling - Whether to wrap before scaling when the text size reaches the max width

Parameters:

value (Text3DMaxWidthHandling)

set_scale_proportionally(value) → None

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

Parameters:

value (bool)

set_tracking(value) → None

Set the tracking value and signal the primitives to be rebuilt

Parameters:

value (float)

set_use_max_height(value) → None

Enable / Disable a Maximum Height

Parameters:

value (bool)

set_use_max_width(value) → None

Enable / Disable a Maximum Width

Parameters:

value (bool)

set_vertical_alignment(value) → None

Set the vertical alignment and signal the primitives to be rebuilt

Parameters:

value (Text3DVerticalTextAlignment)

set_word_spacing(value) → None

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

Parameters:

value (float)