FWidget

Windows
MacOS
Linux

Inheritance Hierarchy

FGCObject

FWidget

References

Module

UnrealEd

Header

/Engine/Source/Editor/UnrealEd/Public/UnrealWidget.h

Include

#include "UnrealWidget.h"

Syntax

class FWidget : public FGCObject

Constructors

Name Description

Public function

FWidget()

Functions

Name Description

Public function

void

 

AbsoluteTranslationConvertMouseMovementToAxisMovement

(
    FSceneView* InView,
    FEditorViewportClient* InViewp...,
    const FVector& InLocation,
    const FVector2D& InMousePosition,
    FVector& OutDrag,
    FRotator& OutRotation,
    FVector& OutScale
)

Absolute Translation conversion from mouse movement on the screen to widget axis movement/rotation.

Public function Static

bool

 

AllowsAbsoluteRotationMovement

(
    EWidgetMode WidgetMode,
    EAxisList::Type InAxisType
)

Only some modes support Absolute Rotation Movement.

Public function Static

bool

 

AllowsAbsoluteTranslationMovement

(
    FWidget::EWidgetMode WidgetMode
)

Only some modes support Absolute Translation Movement.

Public function

void

 

ConvertMouseMovementToAxisMovement

(
    FSceneView* InView,
    FEditorViewportClient* InViewp...,
    bool bInUsedDragModifier,
    FVector& InDiff,
    FVector& OutDrag,
    FRotator& OutRotation,
    FVector& OutScale
)

Converts mouse movement on the screen to widget axis movement/rotation.

Public function

void

 

DrawHUD

(
    FCanvas* Canvas
)

Renders any widget specific HUD text

Public function Const

EAxisList::T...

 

GetAxisToDraw

(
    EWidgetMode WidgetMode
)

Gets the axis to draw based on the current widget mode

Public function Const

EAxisList::T...

 

GetCurrentAxis()

Public function Const

FVector2D

 

GetOrigin()

Public function Static

float

 

GetRotationSpeed()

Public function Const

bool

 

IsDragging()

Returns whether we are actively dragging

Public function Const

bool

 

IsWidgetDisabled()

Public function

void

 

Render

(
    const FSceneView* View,
    FPrimitiveDrawInterface* PDI,
    FEditorViewportClient* Viewpor...
)

Public function

void

 

ResetDeltaRotation()

Resets the total delta rotation back to zero

Public function

void

 

ResetInitialTranslationOffset()

Grab the initial offset again first time input is captured

Public function

void

 

SetCurrentAxis

(
    EAxisList::Type InCurrentAxis
)

Sets the axis currently being moused over.

Public function

void

 

SetDefaultVisibility

(
    bool bInDefaultVisibility
)

Sets the default visibility of the widget, if it is not overridden by an active editor mode tool.

Public function

void

 

SetDragging

(
    const bool InDragging
)

Sets if we are currently engaging the widget in dragging

Public function

void

 

SetDragStartPosition

(
    const FVector2D& Position
)

Public function

void

 

SetSnapEnabled

(
    const bool InSnapEnabled
)

Sets if we are currently engaging the widget in dragging

Public function

void

 

SetUsesEditorModeTools

(
    FEditorModeTools* InEditorMode...
)

Sets editor mode tools to use in this widget

Public function

void

 

UpdateDeltaRotation()

Updates the delta rotation on the widget

Overridden from FGCObject

Name Description

Public function Virtual

void

 

AddReferencedObjects

(
    FReferenceCollector& Collector
)

FGCObject interface: Serializes the widget reference so they dont get garbage collected.

Public function Virtual Const

FString

 

GetReferencerName()

Use this method to report a name for your referencer.

Enums

Name

Description

Public enum

EWidgetMode

Constants

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss