Class TextRenderComponent

Renders text in the world with given font. Contains usual font related attributes such as Scale, Alignment, Color etc.

Inheritance
System.Object
UObject
ActorComponent
SceneComponent
PrimitiveComponent
TextRenderComponent
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class TextRenderComponent : PrimitiveComponent

Properties

| Improve this Doc View Source

bAlwaysRenderAsText

Declaration
public bool bAlwaysRenderAsText { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static TextRenderComponent DefaultObject { get; }
Property Value
Type Description
TextRenderComponent
| Improve this Doc View Source

Font

Text font

Declaration
public Font Font { get; }
Property Value
Type Description
Font
| Improve this Doc View Source

HorizontalAlignment

Horizontal text alignment

Declaration
public byte HorizontalAlignment { get; }
Property Value
Type Description
System.Byte
| Improve this Doc View Source

HorizSpacingAdjust

Horizontal adjustment per character, default is 0.0

Declaration
public float HorizSpacingAdjust { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

InvDefaultSize

The inverse of the Font's character height.

Declaration
public float InvDefaultSize { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class
| Improve this Doc View Source

TextMaterial

Text material

Declaration
public MaterialInterface TextMaterial { get; }
Property Value
Type Description
MaterialInterface
| Improve this Doc View Source

TextRenderColor

Color of the text, can be accessed as vertex color

Declaration
public Color TextRenderColor { get; }
Property Value
Type Description
Color
| Improve this Doc View Source

VerticalAlignment

Vertical text alignment

Declaration
public byte VerticalAlignment { get; }
Property Value
Type Description
System.Byte
| Improve this Doc View Source

VertSpacingAdjust

Vertical adjustment per character, default is 0.0

Declaration
public float VertSpacingAdjust { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

WorldSize

Vertical size of the fonts largest character in world units. Transform, XScale and YScale will affect final size.

Declaration
public float WorldSize { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

XScale

Horizontal scale, default is 1.0

Declaration
public float XScale { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

YScale

Vertical scale, default is 1.0

Declaration
public float YScale { get; }
Property Value
Type Description
System.Single

Methods

| Improve this Doc View Source

GetTextLocalSize()

Get local size of text

Declaration
public Vector GetTextLocalSize()
Returns
Type Description
Vector
| Improve this Doc View Source

GetTextWorldSize()

Get world space size of text

Declaration
public Vector GetTextWorldSize()
Returns
Type Description
Vector
| Improve this Doc View Source

K2_SetText(Byte)

Change the text value and signal the primitives to be rebuilt

Declaration
public void K2_SetText(byte Value)
Parameters
Type Name Description
System.Byte Value
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static TextRenderComponent New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
TextRenderComponent
| Improve this Doc View Source

SetFont(Font)

Change the font and signal the primitives to be rebuilt

Declaration
public void SetFont(Font Value)
Parameters
Type Name Description
Font Value
| Improve this Doc View Source

SetHorizontalAlignment(Byte)

Change the horizontal alignment and signal the primitives to be rebuilt

Declaration
public void SetHorizontalAlignment(byte Value)
Parameters
Type Name Description
System.Byte Value
| Improve this Doc View Source

SetHorizSpacingAdjust(Single)

Change the text horizontal spacing adjustment and signal the primitives to be rebuilt

Declaration
public void SetHorizSpacingAdjust(float Value)
Parameters
Type Name Description
System.Single Value
| Improve this Doc View Source

SetText(String)

Set Text

Declaration
public void SetText(string Value)
Parameters
Type Name Description
System.String Value
| Improve this Doc View Source

SetTextMaterial(MaterialInterface)

Change the text material and signal the primitives to be rebuilt

Declaration
public void SetTextMaterial(MaterialInterface Material)
Parameters
Type Name Description
MaterialInterface Material
| Improve this Doc View Source

SetTextRenderColor(Color)

Change the text render color and signal the primitives to be rebuilt

Declaration
public void SetTextRenderColor(Color Value)
Parameters
Type Name Description
Color Value
| Improve this Doc View Source

SetVerticalAlignment(Byte)

Change the vertical alignment and signal the primitives to be rebuilt

Declaration
public void SetVerticalAlignment(byte Value)
Parameters
Type Name Description
System.Byte Value
| Improve this Doc View Source

SetVertSpacingAdjust(Single)

Change the text vertical spacing adjustment and signal the primitives to be rebuilt

Declaration
public void SetVertSpacingAdjust(float Value)
Parameters
Type Name Description
System.Single Value
| Improve this Doc View Source

SetWorldSize(Single)

Change the world size of the text and signal the primitives to be rebuilt

Declaration
public void SetWorldSize(float Value)
Parameters
Type Name Description
System.Single Value
| Improve this Doc View Source

SetXScale(Single)

Change the text X scale and signal the primitives to be rebuilt

Declaration
public void SetXScale(float Value)
Parameters
Type Name Description
System.Single Value
| Improve this Doc View Source

SetYScale(Single)

Change the text Y scale and signal the primitives to be rebuilt

Declaration
public void SetYScale(float Value)
Parameters
Type Name Description
System.Single Value

Operators

| Improve this Doc View Source

Implicit(IntPtr to TextRenderComponent)

Convert from IntPtr to UObject

Declaration
public static implicit operator TextRenderComponent(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
TextRenderComponent