FDesignerExtension

The Designer extension allows developers to provide additional widgets and custom painting to the designer surface for specific widgets.

Windows
MacOS
Linux

Inheritance Hierarchy

TSharedFromThis

FDesignerExtension

References

Module

UMGEditor

Header

/Engine/Source/Editor/UMGEditor/Public/DesignerExtension.h

Include

#include "DesignerExtension.h"

Syntax

class FDesignerExtension : public TSharedFromThis< FDesignerExtension >

Remarks

The Designer extension allows developers to provide additional widgets and custom painting to the designer surface for specific widgets. Allowing for a more customized and specific editors for the different widgets.

Variables

Name Description

Protected variable

UWidgetBlueprin...

 

Blueprint

Protected variable

IUMGDesigner &#...

 

Designer

Protected variable

FName

 

ExtensionId

Protected variable

TArray< FWidget...

 

SelectionCache

Constructors

Name Description

Public function

FDesignerExtension()

Constructor

Destructors

Name Description

Public function Virtual

~FDesignerExtension()

Functions

Name Description

Protected function

void

 

BeginTransaction

(
    const FText& SessionName
)

Public function Virtual Const

bool

 

CanExtendSelection

(
    const TArray< FWidgetReference >& ...
)

Returns true if the designer extension can extend the current selection.

Protected function

void

 

EndTransaction()

Public function Virtual

void

 

ExtendSelection

(
    const TArray< FWidgetReference >& ...,
    TArray< TSharedRef< FDesignerSurfac...
)

Called every time a element the designer can extend is selected.

Public function Const

FName

 

GetExtensionId()

Gets the ID identifying this extension.

Public function Virtual

void

 

Initialize

(
    IUMGDesigner* InDesigner,
    UWidgetBlueprint* InBlueprint
)

Initializes the designer extension, this is called the first time a designer extension is registered

Public function Virtual Const

void

 

Paint

(
    const TSet< FWidgetReference >& Se...,
    const FGeometry& AllottedGeometry,
    const FSlateRect& MyCullingRect,
    FSlateWindowElementList& OutDrawEl...,
    int32 LayerId
)

Called to paint the extension.

Public function Virtual

void

 

Tick

(
    const FGeometry& AllottedGeometry,
    const double InCurrentTime,
    const float InDeltaTime
)

Called each frames to tick the extension.

Operators

Name Description

Public function Const

bool

 

operator==

(
    const FDesignerExtension& Other
)

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