1. Epic GamesDeveloper
  3. UText3DDefaultLayoutExtension

UText3DDefaultLayoutExtension

API > API/Plugins > API/Plugins/Text3D

   
Name UText3DDefaultLayoutExtension
Type class
Header File /Engine/Plugins/VirtualProduction/Text3D/Source/Text3D/Public/Extensions/Text3DDefaultLayoutExtension.h
Include Path #include "Extensions/Text3DDefaultLayoutExtension.h"

Syntax

UCLASS (MinimalAPI)  
class UText3DDefaultLayoutExtension : public UText3DLayoutExtensionBase

Inheritance Hierarchy

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
GlyphText TSharedPtr< UE::Text3D::Layout::FGlyphText > Caches the last result of ShapedText, to allow faster updates of layout changes. Extensions/Text3DDefaultLayoutExtension.h  
TextLayout TSharedPtr< FText3DLayout > Stores the text layout calculated by the TextLayoutMarshaller. Extensions/Text3DDefaultLayoutExtension.h  
TextLayoutMarshaller TSharedPtr< FRichTextLayoutMarshaller > Determines how text is laid out, ie. parsing line breaks. Extensions/Text3DDefaultLayoutExtension.h  
TextScale FVector Additional scale to apply to the text. Extensions/Text3DDefaultLayoutExtension.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

EText3DHorizontalTextAlignment GetHorizontalAlignment()

 Get the horizontal alignment value and signal the primitives to be rebuilt Extensions/Text3DDefaultLayoutExtension.h
  • BlueprintPure
  • Category="Text3D|Layout"

float GetLineSpacing()

 Get the line spacing value and signal the primitives to be rebuilt Extensions/Text3DDefaultLayoutExtension.h
  • BlueprintPure
  • Category="Text3D|Layout"

float GetMaxHeight()

 Get the Maximum Height - If height is larger, mesh will scale down to fit MaxHeight value Extensions/Text3DDefaultLayoutExtension.h
  • BlueprintPure
  • Category="Text3D|Layout"

float GetMaxWidth()

 Get the Maximum Width - If width is larger, mesh will scale down to fit MaxWidth value Extensions/Text3DDefaultLayoutExtension.h
  • BlueprintPure
  • Category="Text3D|Layout"

EText3DMaxWidthHandling GetMaxWidthBehavior()

 Get the Maximum Width Handling - Whether to wrap before scaling when the text size reaches the max width Extensions/Text3DDefaultLayoutExtension.h
  • BlueprintPure
  • Category="Text3D|Layout"

bool GetScalesProportionally()

 Get if the mesh should scale proportionally when Max Width/Height is set Extensions/Text3DDefaultLayoutExtension.h
  • BlueprintPure
  • Category="Text3D|Layout"

float GetTracking()

 Get the tracking value and signal the primitives to be rebuilt Extensions/Text3DDefaultLayoutExtension.h
  • BlueprintPure
  • Category="Text3D|Layout"

bool GetUseMaxHeight()

 Whether a maximum height is specified Extensions/Text3DDefaultLayoutExtension.h
  • BlueprintPure
  • Category="Text3D|Layout"

bool GetUseMaxWidth()

 Whether a maximum width is specified Extensions/Text3DDefaultLayoutExtension.h
  • BlueprintPure
  • Category="Text3D|Layout"

EText3DVerticalTextAlignment GetVerticalAlignment()

 Get the vertical alignment and signal the primitives to be rebuilt Extensions/Text3DDefaultLayoutExtension.h
  • BlueprintPure
  • Category="Text3D|Layout"

float GetWordSpacing()

 Get the word spacing value and signal the primitives to be rebuilt Extensions/Text3DDefaultLayoutExtension.h
  • BlueprintPure
  • Category="Text3D|Layout"

void SetHorizontalAlignment ( const EText3DHorizontalTextAlignment value
)

 Set the horizontal alignment value and signal the primitives to be rebuilt Extensions/Text3DDefaultLayoutExtension.h
  • BlueprintCallable
  • Category="Text3D|Layout"

void SetLineSpacing ( const float Value
)

 Set the line spacing value and signal the primitives to be rebuilt Extensions/Text3DDefaultLayoutExtension.h
  • BlueprintCallable
  • Category="Text3D|Layout"

void SetMaxHeight ( const float Value
)

 Set the Maximum Height - If height is larger, mesh will scale down to fit MaxHeight value Extensions/Text3DDefaultLayoutExtension.h
  • BlueprintCallable
  • Category="Text3D|Layout"

void SetMaxWidth ( const float Value
)

 Set the Maximum Width - If width is larger, mesh will scale down to fit MaxWidth value Extensions/Text3DDefaultLayoutExtension.h
  • BlueprintCallable
  • Category="Text3D|Layout"

void SetMaxWidthBehavior ( const EText3DMaxWidthHandling Value
)

 Set the Maximum Width Handling - Whether to wrap before scaling when the text size reaches the max width Extensions/Text3DDefaultLayoutExtension.h
  • BlueprintCallable
  • Category="Text3D|Layout"

void SetScaleProportionally ( const bool Value
)

 Set if the mesh should scale proportionally when Max Width/Height is set Extensions/Text3DDefaultLayoutExtension.h
  • BlueprintCallable
  • Category="Text3D|Layout"

void SetTracking ( const float Value
)

 Set the tracking value and signal the primitives to be rebuilt Extensions/Text3DDefaultLayoutExtension.h
  • BlueprintCallable
  • Category="Text3D|Layout"

void SetUseMaxHeight ( const bool Value
)

 Enable / Disable a Maximum Height Extensions/Text3DDefaultLayoutExtension.h
  • BlueprintCallable
  • Category="Text3D|Layout"

void SetUseMaxWidth ( const bool Value
)

 Enable / Disable a Maximum Width Extensions/Text3DDefaultLayoutExtension.h
  • BlueprintCallable
  • Category="Text3D|Layout"

void SetVerticalAlignment ( const EText3DVerticalTextAlignment value
)

 Set the vertical alignment and signal the primitives to be rebuilt Extensions/Text3DDefaultLayoutExtension.h
  • BlueprintCallable
  • Category="Text3D|Layout"

void SetWordSpacing ( const float Value
)

 Set the word spacing value and signal the primitives to be rebuilt Extensions/Text3DDefaultLayoutExtension.h
  • BlueprintCallable
  • Category="Text3D|Layout"

Protected

Name Remarks Include Path Unreal Specifiers

void CalculateTextScale()

   Extensions/Text3DDefaultLayoutExtension.h  

void OnLayoutOptionsChanged()

   Extensions/Text3DDefaultLayoutExtension.h  

Overridden from UText3DLayoutExtensionBase

Name Remarks Include Path Unreal Specifiers

virtual FVector GetLineLocation ( int32 LineIndex
) const

   Extensions/Text3DDefaultLayoutExtension.h  

virtual float GetTextHeight()

   Extensions/Text3DDefaultLayoutExtension.h  

virtual FVector GetTextScale()

   Extensions/Text3DDefaultLayoutExtension.h  

Overridden from UText3DExtensionBase

Name Remarks Include Path Unreal Specifiers

virtual EText3DExtensionResult PostRendererUpdate ( const UE::Text3D::Renderer::FUpdateParameters& InParameters
)

 Perform an update of the extension behavior after renderer execute based on condition above Extensions/Text3DDefaultLayoutExtension.h  

virtual EText3DExtensionResult PreRendererUpdate ( const UE::Text3D::Renderer::FUpdateParameters& InParameters
)

 Perform an update of the extension behavior before renderer execute based on condition above Extensions/Text3DDefaultLayoutExtension.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& InEvent
)

   Extensions/Text3DDefaultLayoutExtension.h  

virtual void PostEditUndo()

   Extensions/Text3DDefaultLayoutExtension.h  

Static

Name Remarks Include Path Unreal Specifiers

static TEXT3FName GetMaxHeightPropertyName()

   Extensions/Text3DDefaultLayoutExtension.h  

static TEXT3FName GetMaxWidthPropertyName()

   Extensions/Text3DDefaultLayoutExtension.h  

static TEXT3FName GetScaleProportionallyPropertyName()

   Extensions/Text3DDefaultLayoutExtension.h  

static TEXT3FName GetUseMaxHeightPropertyName()

   Extensions/Text3DDefaultLayoutExtension.h  

static TEXT3FName GetUseMaxWidthPropertyName()

   Extensions/Text3DDefaultLayoutExtension.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page