Class WidgetComponent

The widget component provides a surface in the 3D environment on which to render widgets normally rendered to the screen.

Inheritance
System.Object
UObject
ActorComponent
SceneComponent
PrimitiveComponent
MeshComponent
WidgetComponent
VREditorWidgetComponent
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.UMG
Assembly: UE4DotNet.dll
Syntax
public class WidgetComponent : MeshComponent
Remarks

Widgets are first rendered to a render target, then that render target is displayed in the world.

Material Properties set by this component on whatever material overrides the default. SlateUI [Texture] BackColor [Vector] TintColorAndOpacity [Vector] OpacityFromTexture [Scalar]

Properties

| Improve this Doc View Source

BackgroundColor

The background color of the component

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

bAddedToScreen

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

bApplyGammaCorrection

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

bDrawAtDesiredSize

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

bEditTimeUsable

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

bIsTwoSided

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

bManuallyRedraw

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

BodySetup

The body setup of the displayed quad

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

bReceiveHardwareInput

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

bRedrawRequested

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

bWindowFocusable

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

CurrentDrawSize

The actual draw size, this changes based on DrawSize - or the desired size of the widget if bDrawAtDesiredSize is true.

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

CylinderArcAngle

Curvature of a cylindrical widget in degrees.

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

DefaultObject

Get UE4 Default Object for this Class

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

DrawSize

The size of the displayed quad.

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

LayerZOrder

ZOrder the layer will be created on, note this only matters on the first time a new layer is created, subsequent additions to the same layer will use the initially defined ZOrder

Declaration
public int LayerZOrder { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

MaskedMaterial

The material instance for masked widget components.

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

MaskedMaterial_OneSided

The material instance for masked, one-sided widget components.

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

MaterialInstance

The dynamic instance of the material that the render target is attached to

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

OpacityFromTexture

Sets the amount of opacity from the widget's UI texture to use when rendering the translucent or masked UI to the viewport (0.0-1.0)

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

OpaqueMaterial

The material instance for opaque widget components

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

OpaqueMaterial_OneSided

The material instance for opaque, one-sided widget components

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

OwnerPlayer

The owner player for a widget component, if this widget is drawn on the screen, this controls what player's screen it appears on for split screen, if not set, users player 0.

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

Pivot

The Alignment/Pivot point that the widget is placed at relative to the position.

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

RedrawTime

The time in between draws, if 0 - we would redraw every frame.

Declaration
public float RedrawTime { get; set; }
Property Value
Type Description
System.Single
Remarks

If 1, we would redraw every second. This will work with bManuallyRedraw as well. So you can say, manually redraw, but only redraw at this maximum rate.

| Improve this Doc View Source

RenderTarget

The target to which the user widget is rendered

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

SharedLayerName

Layer Name the widget will live on

Declaration
public Name SharedLayerName { get; set; }
Property Value
Type Description
Name
| 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

TickWhenOffscreen

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

TintColorAndOpacity

Tint color and opacity for this component

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

TranslucentMaterial

The material instance for translucent widget components

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

TranslucentMaterial_OneSided

The material instance for translucent, one-sided widget components

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

Widget

The User Widget object displayed and managed by this component

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

WidgetClass

The class of User Widget to create and display an instance of

Declaration
public SubclassOf<UserWidget> WidgetClass { get; set; }
Property Value
Type Description
SubclassOf<UserWidget>

Methods

| Improve this Doc View Source

GetDrawSize()

@return The draw size of the quad in the world

Declaration
public Vector2D GetDrawSize()
Returns
Type Description
Vector2D
| Improve this Doc View Source

GetMaterialInstance()

@return The dynamic material instance used to render the user widget

Declaration
public MaterialInstanceDynamic GetMaterialInstance()
Returns
Type Description
MaterialInstanceDynamic
| Improve this Doc View Source

GetOwnerPlayer()

Gets the local player that owns this widget component.

Declaration
public LocalPlayer GetOwnerPlayer()
Returns
Type Description
LocalPlayer
| Improve this Doc View Source

GetRenderTarget()

@return The render target to which the user widget is rendered

Declaration
public TextureRenderTarget2D GetRenderTarget()
Returns
Type Description
TextureRenderTarget2D
| Improve this Doc View Source

GetUserWidgetObject()

@return The user widget object displayed by this component

Declaration
public UserWidget GetUserWidgetObject()
Returns
Type Description
UserWidget
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

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

RequestRedraw()

Requests that the widget be redrawn.

Declaration
public void RequestRedraw()
| Improve this Doc View Source

SetBackgroundColor(LinearColor)

Sets the background color and opacityscale for this widget

Declaration
public void SetBackgroundColor(LinearColor NewBackgroundColor)
Parameters
Type Name Description
LinearColor NewBackgroundColor
| Improve this Doc View Source

SetDrawSize(Vector2D)

Sets the draw size of the quad in the world

Declaration
public void SetDrawSize(Vector2D Size)
Parameters
Type Name Description
Vector2D Size
| Improve this Doc View Source

SetManuallyRedraw(Boolean)

@see bManuallyRedraw

Declaration
public void SetManuallyRedraw(bool bUseManualRedraw)
Parameters
Type Name Description
System.Boolean bUseManualRedraw
| Improve this Doc View Source

SetOwnerPlayer(LocalPlayer)

Sets the local player that owns this widget component.

Declaration
public void SetOwnerPlayer(LocalPlayer LocalPlayer)
Parameters
Type Name Description
LocalPlayer LocalPlayer
Remarks

Setting the owning player controls which player's viewport the widget appears on in a split screen scenario. Additionally it forwards the owning player to the actual UserWidget that is spawned.

| Improve this Doc View Source

SetTintColorAndOpacity(LinearColor)

Sets the tint color and opacity scale for this widget

Declaration
public void SetTintColorAndOpacity(LinearColor NewTintColorAndOpacity)
Parameters
Type Name Description
LinearColor NewTintColorAndOpacity
| Improve this Doc View Source

SetWidget(UserWidget)

Sets the widget to use directly.

Declaration
public void SetWidget(UserWidget Widget)
Parameters
Type Name Description
UserWidget Widget
Remarks

This function will keep track of the widget till the next time it's called with either a newer widget or a nullptr

Operators

| Improve this Doc View Source

Implicit(IntPtr to WidgetComponent)

Convert from IntPtr to UObject

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