1. Epic GamesDeveloper
  3. UWidgetComponent

UWidgetComponent

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

API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Components

Inheritance Hierarchy

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Components/WidgetComponent.h
Include #include "Components/WidgetComponent.h"

Syntax

class UWidgetComponent : public UMeshComponent

Remarks

The widget component provides a surface in the 3D environment on which to render widgets normally rendered to the screen. 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]

Variables

  Type Name Description
Protected variable FLinearColor BackgroundColor The background color of the component
Protected variable bool bAddedToScreen  
Protected variable bool bApplyGammaCorrection Widget components that appear in the world will be gamma corrected by the 3D renderer.
Protected variable bool bDrawAtDesiredSize Causes the render target to automatically match the desired size.
Protected variable bool bEditTimeUsable Allows the widget component to be used at editor time. For use in the VR-Editor.
Protected variable bool bIsTwoSided Is the component visible from behind?
Protected variable EWidgetBlendMode BlendMode The blend mode for the widget.
Protected variable bool bManuallyRedraw Should we wait to be told to redraw to actually draw?
Protected variable TObjectPtr< class UBodySetup > BodySetup The body setup of the displayed quad
Protected variable bool bReceiveHardwareInput Register with the viewport for hardware input from the true mouse and keyboard.
Protected variable bool bRedrawRequested Has anyone requested we redraw?
Protected variable bool bWindowFocusable Is the virtual window created to host the widget focusable?
Protected variable FIntPoint CurrentDrawSize The actual draw size, this changes based on DrawSize - or the desired size of the widget if bDrawAtDesiredSize is true.
Protected variable float CylinderArcAngle Curvature of a cylindrical widget in degrees.
Protected variable FIntPoint DrawSize The size of the displayed quad.
Protected variable EWidgetGeometryMode GeometryMode Controls the geometry of the widget component. See EWidgetGeometryMode.
Protected variable FVector2D LastLocalHitLocation The relative location of the last hit on this component
Protected variable double LastWidgetRenderTime What was the last time we rendered the widget?
Protected variable int32 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
Protected variable TObjectPtr< UMaterialInterface > MaskedMaterial The material instance for masked widget components.
Protected variable TObjectPtr< UMaterialInterface > MaskedMaterial_OneSided The material instance for masked, one-sided widget components.
Protected variable TObjectPtr< UMaterialInstanceDynamic > MaterialInstance The dynamic instance of the material that the render target is attached to
Protected variable float 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)
Protected variable TObjectPtr< UMaterialInterface > OpaqueMaterial The material instance for opaque widget components
Protected variable TObjectPtr< UMaterialInterface > OpaqueMaterial_OneSided The material instance for opaque, one-sided widget components
Protected variable TObjectPtr< ULocalPlayer > 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.
Protected variable FVector2D Pivot The Alignment/Pivot point that the widget is placed at relative to the position.
Protected variable float RedrawTime The time in between draws, if 0 - we would redraw every frame.
Protected variable TObjectPtr< UTextureRenderTarget2D > RenderTarget The target to which the user widget is rendered
Protected variable FName SharedLayerName Layer Name the widget will live on
Protected variable TSharedPtr< class SVirtualWindow > SlateWindow The slate window that contains the user widget content
Protected variable EWidgetSpace Space The coordinate space in which to render the widget
Protected variable ETickMode TickMode  
Protected variable bool TickWhenOffscreen Should the component tick the widget when it's off screen?
Protected variable EWidgetTimingPolicy TimingPolicy How this widget should deal with timing, pausing, etc.
Protected variable FLinearColor TintColorAndOpacity Tint color and opacity for this component
Protected variable TObjectPtr< UMaterialInterface > TranslucentMaterial The material instance for translucent widget components
Protected variable TObjectPtr< UMaterialInterface > TranslucentMaterial_OneSided The material instance for translucent, one-sided widget components
Protected variable TSubclassOf< UUserWidget > WidgetClass The class of User Widget to create and display an instance of
Protected variable FWidgetRenderer * WidgetRenderer Helper class for drawing widgets to a render target.
Protected variable EWindowVisibility WindowVisibility The visibility of the virtual window created to host the widget

Constructors

  Type Name Description
Public function  

UWidgetComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void  
Protected function Const bool Just because the user attempts to receive hardware input does not mean it's possible.
Protected function Const float Returns the width of the widget component taking GeometryMode into account.
Protected function Virtual void

DrawWidgetToRenderTarget ( float DeltaTime
)

 Draws the current widget to the render target if possible.
Public function Const EWidgetBlendMode Gets the blend mode for the widget.
Public function Const FVector2D Returns the "actual" draw size of the quad in the world
Protected function Const double Returns current absolute time, respecting TimingPolicy.
Public function Const float Defines the curvature of the widget component when using EWidgetGeometryMode::Cylinder; ignored otherwise.
Public function Const TTuple< FVector, FVector2D >

GetCylinderHitLocation ( FVector WorldHitLocation,
FVector WorldHitDirection
)

 When using EWidgetGeometryMode::Cylinder, continues the trace from the front face of the widget component into the cylindrical geometry and returns adjusted hit results information.
Public function Const bool  
Public function Const FVector2D Returns the "specified" draw size of the quad in the world
Public function Const bool  
Public function Const EWidgetGeometryMode  
Public function TArray< FWidgetAndPointer >

GetHitWidgetPath ( FVector WorldHitLocation,
bool bIgnoreEnabledStatus,
float CursorRadius
)

 Returns the list of widgets with their geometry and the cursor position transformed into this Widget component's space.
Public function TArray< FWidgetAndPointer >

GetHitWidgetPath ( FVector2D WidgetSpaceHitCoordinate,
bool bIgnoreEnabledStatus,
float CursorRadius
)

 Returns the list of widgets with their geometry and the cursor position transformed into this Widget space.
Public function Const FVector2D Gets the last local location that was hit
Public function Virtual Const void

GetLocalHitLocation ( FVector WorldHitLocation,
FVector2D& OutLocalHitLocation
)

 Converts a world-space hit result to a hit location on the widget
Public function Const bool  
Public function Const UMaterialInstanceDynamic * Returns the dynamic material instance used to render the user widget
Public function Const ULocalPlayer * Gets the local player that owns this widget component.
Public function Const FVector2D Returns the pivot point where the UI is rendered about the origin.
Public function Const bool  
Public function Const float  
Public function Const UTextureRenderTarget2D * Returns the render target to which the user widget is rendered
Public function Const const TSharedPtr< SWidget > & Returns the Slate widget that was assigned to this component, if any
Public function Const TSharedPtr< SWindow > Returns the window containing the user widget content
Public function Const bool Gets whether the widget ticks when offscreen or not
Public function Const bool Gets whether the widget is two-sided or not
Public function Const UUserWidget * Returns the user widget object displayed by this component
Public function Const TSharedPtr< SWindow > Get the fake window we create for widgets displayed in the world.
Public function Virtual Const UUserWidget * Gets the widget that is used by this Widget Component.
Public function Const TSubclassOf< UUserWidget > Returns the class of the user widget displayed by this component
Public function Const EWidgetSpace  
Public function Const bool  
Public function Const EWindowVisibility Gets the visibility of the virtual window created to host the widget focusable.
Public function Virtual void Ensures the user widget is initialized
Public function Const bool Returns true if the the Slate window is visible and that the widget is also visible, false otherwise.
Public function Virtual FVector2D

ModifyProjectedLocalPosition ( const FGeometry& ViewportGeometry,
const FVector2D& LocalPosition
)

 Hook to allow this component modify the local position of the widget after it has been projected from world space to screen space.
Protected function void

OnLevelRemovedFromWorld ( ULevel* InLevel,
UWorld* InWorld
)

  
Protected function void  
Protected function void  
Public function Virtual void Release resources associated with the widget.
Protected function void  
Public function Virtual void Requests that the widget be redrawn.
Public function Virtual void Requests that the widget have it's render target updated, if TickMode is disabled, this will force a tick to happen to update the render target.
Public function void

SetBackgroundColor ( const FLinearColor NewBackgroundColor
)

 Sets the background color and opacityscale for this widget
Public function void

SetBlendMode ( const EWidgetBlendMode NewBlendMode
)

 Sets the blend mode to use for this widget
Public function void

SetCylinderArcAngle ( const float InCylinderArcAngle
)

 Defines the curvature of the widget component when using EWidgetGeometryMode::Cylinder; ignored otherwise.
Public function void

SetDrawAtDesiredSize ( bool bInDrawAtDesiredSize
)

  
Public function void

SetDrawSize ( FVector2D Size
)

 Sets the draw size of the quad in the world
Public function void

SetEditTimeUsable ( bool Value
)

  
Public function void

SetGeometryMode ( EWidgetGeometryMode InGeometryMode
)

  
Public function void

SetInitialLayerZOrder ( int32 NewLayerZOrder
)

 Sets layer z order used when this widget is initialized
Public function void

SetInitialSharedLayerName ( FName NewSharedLayerName
)

 Sets shared layer name used when this widget is initialized
Public function void

SetManuallyRedraw ( bool bUseManualRedraw
)

  
Public function void

SetOpacityFromTexture ( const float NewOpacityFromTexture
)

 Sets how much opacity from the UI widget's texture alpha is used when rendering to the viewport (0.0-1.0)
Public function void

SetOwnerPlayer ( ULocalPlayer* LocalPlayer
)

 Sets the local player that owns this widget component.
Public function void

SetPivot ( const FVector2D& InPivot
)

  
Public function void

SetRedrawTime ( float InRedrawTime
)

  
Public function Virtual void

SetSlateWidget ( const TSharedPtr< SWidget >& InSlateWidget
)

 Sets a Slate widget to be rendered.
Public function void

SetTickMode ( ETickMode InTickMode
)

 Sets the Tick mode of the Widget Component.
Public function void

SetTickWhenOffscreen ( const bool bWantTickWhenOffscreen
)

 Sets whether the widget ticks when offscreen or not
Public function void

SetTintColorAndOpacity ( const FLinearColor NewTintColorAndOpacity
)

 Sets the tint color and opacity scale for this widget
Public function void

SetTwoSided ( const bool bWantTwoSided
)

 Sets whether the widget is two-sided or not
Public function Virtual void

SetWidget ( UUserWidget* Widget
)

 Sets the widget to use directly.
Public function void

SetWidgetClass ( TSubclassOf< UUserWidget > InWidgetClass
)

 Sets the widget class used to generate the widget for this component
Public function void

SetWidgetSpace ( EWidgetSpace NewSpace
)

  
Public function void

SetWindowFocusable ( bool bInWindowFocusable
)

  
Public function void

SetWindowVisibility ( EWindowVisibility InVisibility
)

 Sets the visibility of the virtual window created to host the widget focusable.
Protected function Virtual Const bool Allows subclasses to control if the widget should be drawn. Called right before we draw the widget.
Protected function void  
Protected function void  
Public function void

UpdateBodySetup ( bool bDrawSizeChanged
)

 Ensures the body setup is initialized and updates it if needed.
Protected function void  
Public function void Updates the dynamic parameters on the material instance, without re-creating it
Public function Virtual void

UpdateRenderTarget ( FIntPoint DesiredRenderTargetSize
)

 Ensure the render target is initialized and updates it if needed.
Public function Virtual void Ensures the 3d window is created its size and content.

Overridden from UPrimitiveComponent

  Type Name Description
Public function Virtual FPrimitiveSceneProxy * UPrimitiveComponent Interface
Public function Virtual UBodySetup * Return the BodySetup to use for this PrimitiveComponent (single body case)
Public function Virtual Const FCollisionShape

GetCollisionShape ( float Inflation
)

 Return a CollisionShape that most closely matches this primitive.
Public function Virtual Const UMaterialInterface *

GetMaterial ( int32 ElementIndex
)

 Returns the material used by the element at the specified index
Public function Virtual Const int32 Return number of material elements in this primitive
Public function Virtual Const void

GetUsedMaterials ( TArray< UMaterialInterface* >& OutMaterials,
bool bGetDebugMaterials
)

 Retrieves the materials used in this component
Public function Virtual void

SetMaterial ( int32 ElementIndex,
UMaterialInterface* Material
)

 Changes the material applied to an element of the mesh.

Overridden from USceneComponent

  Type Name Description
Public function Virtual Const FBoxSphereBounds

CalcBounds ( const FTransform& LocalToWorld
)

 Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.
Protected function Virtual void Overridable internal function to respond to changes in the hidden in game value of the component.

Overridden from UActorComponent

  Type Name Description
Public function Virtual void UActorComponent Interface
Public function Virtual void

DestroyComponent ( bool bPromoteChildren
)

 Unregister the component, remove it from its outer Actor's Components array and mark for pending kill.
Public function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Ends gameplay for this component.
Public function Virtual Const TStructOnScope< FActorComponentInstanceData > Called before we throw away components during RerunConstructionScripts, to cache any data we wish to persist across that operation
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Public function Virtual void Called when a component is unregistered.
Public function Virtual void

TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

 Function called every frame on this ActorComponent.

Overridden from UObject

  Type Name Description
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

 Called by the editor to query whether a property of this object is allowed to be modified.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from UObjectBaseUtility

  Type Name Description
Public function Virtual Const bool Called during cluster construction if the object can be added to a cluster

Constants

Name Description
WidgetHitTester The hit tester to use for this component

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page