Navigation
| Name | Text3D |
| Type | Plugin |
| Part of Plugins | Text 3D |
| Location | /Engine/Plugins/VirtualProduction/Text3D/Source/Text3D/ |
| Module Build Rules | Text3D.Build.cs |
Classes
| Name | Remarks |
|---|---|
| TEXT3AText3DActor | |
| UText3DCharacterBase | Holds data for a single character in Text3D |
| UText3DCharacterExtensionBase | Extension that handles character data for Text3D |
| UText3DCharacterTransform | This class should no longer be used with Text3D It is only kept to migrate properties to the newer system See UText3DLayoutTransformEffect that can be added in section Text3DComponent/Layout/LayoutEffects |
| UText3DDefaultCharacter | Holds data for a single character in Text3D |
| UText3DDefaultCharacterExtension | |
| UText3DDefaultGeometryExtension | |
| UText3DDefaultLayoutExtension | |
| UText3DDefaultMaterialExtension | |
| UText3DDefaultRenderingExtension | Extension that handles rendering data for Text3D |
| UText3DDefaultStyleExtension | |
| UText3DDefaultTokenExtension | |
| UText3DEffectExtensionBase | Extension for custom effects on Text3D |
| UText3DExtensionBase | Extensions are piece of data and logic needed to render Text3D that can be reused by multiple renderers, they execute once during every renderer update at the right moment |
| UText3DGeometryExtensionBase | Extension that handles geometry data for Text3D |
| UText3DLayoutEffectBase | Extension for layout effects on Text3D |
| UText3DLayoutExtensionBase | Extension that handles layout data for Text3D |
| UText3DLayoutTransformEffect | Extension that handles transform data for Text3D |
| UText3DMaterialExtensionBase | Extension that handles materials for Text3D |
| UText3DProjectSettings | Settings for Text3D plugin |
| UText3DRendererBase | Base class for a rendering implementation of Text3D The whole rendering logic should be encapsulated into an instance of this class |
| UText3DRenderingExtensionBase | Extension that handles rendering data for Text3D |
| UText3DStyleBase | Text3D rich text format styles |
| UText3DStyleExtensionBase | Extension that handles formatting styles for Text3D |
| UText3DStyleSet | Text3D Style Set used to store multiple reusable styles |
| UText3DTokenBase | Text3D token to swap variable by its content |
| UText3DTokenExtensionBase | Extension that handles text transformation |
Structs
| Name | Remarks |
|---|---|
| FCachedFontFaceGlyphHandle | Acts as a handle for FText3DCachedMesh |
| FGlyphMeshParameters | |
| FMaterialParameters | |
| FText3DCachedMesh | |
| FText3DComponentVersion | Used for versioning, only used internally |
| FText3DFontFamily | |
| FText3DMaterialGroupKey | |
| FText3DMaterialKey | Used to identify a specific material type |
| FText3DMaterialOverride | |
| FText3DRange | |
| FText3DStatistics | |
| FText3DWordStatistics | |
| FUpdateParameters |
Enums
Public
| Name | Remarks |
|---|---|
| EText3DBevelType | |
| EText3DCharacterEffectOrder | |
| EText3DExtensionResult | |
| EText3DFontStyleFlags | |
| EText3DGroupType | |
| EText3DHorizontalTextAlignment | |
| EText3DMaterialBlendMode | |
| EText3DMaterialStyle | |
| EText3DMaxWidthHandling | |
| EText3DOutlineType | |
| EText3DRendererFlags | Enumerate Text3D update flags based on their priority |
| EText3DVerticalTextAlignment |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| UE::Text3D::Metrics::Convert26Dot6ToPixel | float | Freetype conversion ratio to pixel | Text3DTypes.h |
| UE::Text3D::Metrics::FontSize | float | Default value to match size across different Text3D version | Text3DTypes.h |
| UE::Text3D::Metrics::FontSizeInverse | float | Scale used to transform freetype face result to get normalized values based on our font size | Text3DTypes.h |
| UE::Text3D::Priority::Effect | uint16 | Text3DTypes.h | |
| UE::Text3D::Priority::Geometry | uint16 | Text3DTypes.h | |
| UE::Text3D::Priority::Layout | uint16 | Text3DTypes.h | |
| UE::Text3D::Priority::Material | uint16 | Text3DTypes.h | |
| UE::Text3D::Priority::Rendering | uint16 | Text3DTypes.h | |
| UE::Text3D::Priority::Style | uint16 | Text3DTypes.h | |
| UE::Text3D::Priority::Token | uint16 | Text3DTypes.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ClassGroup | Text3DComponent.h | |||
| HideCategories | Text3DComponent.h | |||
| meta | Text3DComponent.h | |||
| PrioritizeCategories | Text3DComponent.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!
(
EText3DRendererFlags E |
Text3DTypes.h | ||
EText3DRendererFlags operator&
(
EText3DRendererFlags Lhs, |
Text3DTypes.h | ||
EText3DRendererFlags & operator&=
(
EText3DRendererFlags& Lhs, |
Text3DTypes.h | ||
EText3DRendererFlags operator^
(
EText3DRendererFlags Lhs, |
Text3DTypes.h | ||
EText3DRendererFlags & operator^=
(
EText3DRendererFlags& Lhs, |
Text3DTypes.h | ||
EText3DRendererFlags operator|
(
EText3DRendererFlags Lhs, |
Text3DTypes.h | ||
EText3DRendererFlags & operator|=
(
EText3DRendererFlags& Lhs, |
Text3DTypes.h | ||
EText3DRendererFlags operator~
(
EText3DRendererFlags E |
Text3DTypes.h | ||
AStaticMeshActor * UE::Text3D::Utilities::Conversion::ConvertToStaticMesh
(
const UText3DComponent* InComponent |
Converts the text component in a static mesh object and spawns a static mesh actor | Utilities/Text3DUtilities.h | |
| Pick in which folder the asset object will be saved | Utilities/Text3DUtilities.h | ||
| Get font faces that compose the font | Utilities/Text3DUtilities.h | ||
| Get font name based on object/import/legacy name | Utilities/Text3DUtilities.h | ||
TEXT3bool UE::Text3D::Utilities::Font::GetFontStyle
(
const UFont* InFont, |
Detect font style (italic, bold, monospaced) | Utilities/Text3DUtilities.h | |
TEXT3bool UE::Text3D::Utilities::Font::GetFontStyle
(
const FText3DFontFamily& InFontFamily, |
Detect font style (italic, bold, monospaced) | Utilities/Text3DUtilities.h | |
| Get proper font name without invalid chars | Utilities/Text3DUtilities.h | ||
TEXT3void UE::Text3D::Utilities::Font::SanitizeFontName
(
FString& InOutFontName |
Replace invalid object name chars and spaces | Utilities/Text3DUtilities.h |