UDreamUIWidgetLibrary

Finding widgets, driving a drag, and building an image brush from Blueprint -- the parts of

Inherits from UBlueprintFunctionLibrary.

Declared in Public/DreamUIWidgetLibrary.h.

Finding widgets, driving a drag, and building an image brush from Blueprint -- the parts of UMG's UWidgetBlueprintLibrary that mean something in this framework.

The parts that do not are named in the parity table with their reasons, and they are all one reason: UMG's library is half Slate plumbing. FEventReply, the OnPaint drawing context and the Slate input-event structs describe an SWidget's conversation with Slate, and a DreamGUI widget never has that conversation -- its input arrives as a UDreamPointerEventData from the event system and its pixels come from its own mesh.

Functions

Function	Kind	Description
`bool BeginDragWithOperation(UDreamPointerEventData* InPointerEvent, UDreamDragDropOperation* InOperation)`	callable	Start a drag on a widget right now, from a pointer that is already pressed on it -- UMG's DetectDragIfPressed, minus the "if pressed" test, which the caller has already passed by having a pressed pointer's event data in hand.
`bool CancelDragDrop(UObject* WorldContextObject)`	callable	End every drag in flight without a drop -- what Escape does. True when there was one to cancel.
`UDreamDragDropOperation* CreateDragDropOperation(TSubclassOf<UDreamDragDropOperation> InOperationClass)`	callable	Make a drag operation to hand to a drag that is starting -- UMG's CreateDragDropOperation.
`int32 DismissAllMenus(UObject* WorldContextObject)`	callable	Close every menu anchor that is open, anywhere in this world -- UMG's DismissAllMenus.
`bool EqualEqual_DreamUIImageBrush(FDreamUIImageBrush A, FDreamUIImageBrush B)`	pure	Are two brushes the same brush? UMG's EqualEqual_SlateBrush, for this framework's brush type.
`void GetAllWidgetsOfClass(UObject* WorldContextObject, TSubclassOf<UDreamWidget> InWidgetClass, TArray<UDreamWidget*>& OutFoundWidgets, bool bTopLevelOnly)`	callable	Every live widget of a class, anywhere in the world.
`void GetAllWidgetsWithInterface(UObject* WorldContextObject, TSubclassOf<UInterface> InInterface, TArray<UDreamWidget*>& OutFoundWidgets, bool bTopLevelOnly)`	callable	Every live widget whose class implements an interface. Behaviours are not searched, only widgets.
`UObject* GetBrushResource(FDreamUIImageBrush InBrush)`	pure	Get Brush Resource
`UMaterialInterface* GetBrushResourceAsMaterial(FDreamUIImageBrush InBrush)`	pure	Get Brush Resource as Material
`UTexture2D* GetBrushResourceAsTexture2D(FDreamUIImageBrush InBrush)`	pure	Get Brush Resource as Texture 2D
`UDreamDragDropOperation* GetDragDroppingContent(UObject* WorldContextObject, int32 InPointerID)`	pure	The operation a pointer is carrying, or null. Pointer 0 is the mouse.
`UMaterialInstanceDynamic* GetDynamicMaterial(FDreamUIImageBrush& InBrush)`	callable	The brush's material as something whose parameters can be set -- UMG's GetDynamicMaterial.
`bool GetSafeZonePadding(UObject* WorldContextObject, FVector4& OutSafePadding, FVector2D& OutSafePaddingScale)`	pure	The platform's title-safe inset, in pixels, and the same inset as a fraction of the viewport.
`bool IsDragDropping(UObject* WorldContextObject)`	pure	Is any pointer carrying a drag operation right now?
`FDreamUIImageBrush MakeBrushFromAsset(UObject* InResource, int32 InWidth, int32 InHeight)`	pure	An image brush showing whatever the asset is -- a texture, a material, a sprite or an atlas.
`FDreamUIImageBrush MakeBrushFromMaterial(UMaterialInterface* InMaterial, int32 InWidth, int32 InHeight)`	pure	An image brush showing a material.
`FDreamUIImageBrush MakeBrushFromTexture(UTexture2D* InTexture, int32 InWidth, int32 InHeight)`	pure	An image brush showing a texture. UMG's MakeBrushFromTexture; zero size means the texture's own.
`FDreamUIImageBrush NoResourceBrush()`	pure	A brush that draws nothing. UMG's NoResourceBrush.
`void SetBrushResourceToMaterial(FDreamUIImageBrush& InBrush, UMaterialInterface* InMaterial)`	callable	Set Brush Resource to Material
`void SetBrushResourceToTexture(FDreamUIImageBrush& InBrush, UTexture2D* InTexture)`	callable	Set Brush Resource to Texture
`void SetFocusToGameViewport()`	callable	Hand keyboard focus back to the game viewport -- UMG's SetFocusToGameViewport.
`bool SetMousePosition(APlayerController* InPlayer, FVector2D InPosition)`	callable	Put the cursor somewhere -- UMG's SetMousePosition, minus the FEventReply it was built into.

Compared with UMG

Every Blueprint-facing member of the UMG class, and where it went. adopt: same name, same meaning. map: here under another name or on another type. reject: deliberately absent, with the reason.

UMG	Member	Status	Here	Note
`UWidgetBlueprintLibrary`	`Create`	map	`UDreamUIBPLibrary::CreateDreamWidgetOfClass`	Pre-existing. AddWidgetOfClassToViewport is the create-and-show pair.
`UWidgetBlueprintLibrary`	`CreateDragDropOperation`	adopt	`CreateDragDropOperation`	Outered to the transient package, as UMG does: an operation outlives the widget that made it, and a recycled list row mid-drag is the ordinary case.
`UWidgetBlueprintLibrary`	`SetInputMode_UIOnlyEx`	map	`UDreamUIInputModeLibrary::SetInputModeUIOnly`	Addressed by DreamGUI user index rather than by a raw controller, so split screen does not have to rediscover which player a menu belongs to. Needs UDreamGameViewportClient as the game viewport client: the engine's UI-only mode ignores input at the client, which DreamGUI's input comes through, and that client lets it through while this mode holds.
`UWidgetBlueprintLibrary`	`SetInputMode_GameAndUIEx`	map	`UDreamUIInputModeLibrary::SetInputModeGameAndUI`
`UWidgetBlueprintLibrary`	`SetInputMode_GameOnly`	map	`UDreamUIInputModeLibrary::SetInputModeGameOnly`
`UWidgetBlueprintLibrary`	`SetFocusToGameViewport`	adopt	`SetFocusToGameViewport`	A Slate focus change, not a DreamGUI one. UDreamWidget::ClearKeyboardFocus is the framework-level counterpart and the two are usually wanted together.
`UWidgetBlueprintLibrary`	`DrawBox`	reject		UMG's Draw* family writes into an FPaintContext handed to a Blueprint OnPaint override. There is no immediate-mode paint pass here: a DreamGUI widget draws by owning a mesh, so anything drawn is a widget with a visual on it rather than a call inside a paint.
`UWidgetBlueprintLibrary`	`DrawSpline`	reject		See DrawBox.
`UWidgetBlueprintLibrary`	`DrawLine`	reject		See DrawBox.
`UWidgetBlueprintLibrary`	`DrawLines`	reject		See DrawBox.
`UWidgetBlueprintLibrary`	`DrawTextFormatted`	reject		See DrawBox.
`UWidgetBlueprintLibrary`	`Handled`	reject		FEventReply is Slate's reply object, built by a handler and returned to Slate. A DreamGUI handler answers a bool meaning 'let this keep bubbling' (the IDreamPointer* interfaces), so there is no reply object to construct.
`UWidgetBlueprintLibrary`	`Unhandled`	reject		See Handled.
`UWidgetBlueprintLibrary`	`CaptureMouse`	reject		There is no capture to take: a pressed pointer's PressWidget already receives every drag and the release wherever the pointer travels. UDreamWidget::HasMouseCapture reports that state.
`UWidgetBlueprintLibrary`	`ReleaseMouseCapture`	reject		See CaptureMouse.
`UWidgetBlueprintLibrary`	`LockMouse`	map	`UDreamUIInputModeLibrary::SetMouseLockMode`	Separate from the input mode on purpose there: re-setting the whole input mode to change only the lock is how a project takes focus away from its own menu.
`UWidgetBlueprintLibrary`	`UnlockMouse`	map	`UDreamUIInputModeLibrary::SetMouseLockMode`	EMouseLockMode::DoNotLock.
`UWidgetBlueprintLibrary`	`SetUserFocus`	map	`UDreamWidget::SetUserFocus`	A verb on the widget rather than a reply built inside a handler.
`UWidgetBlueprintLibrary`	`ClearUserFocus`	map	`UDreamWidget::ClearKeyboardFocus`
`UWidgetBlueprintLibrary`	`SetMousePosition`	map	`SetMousePosition`	A verb rather than UMG's FEventReply builder. Viewport pixels, the same space GetMousePositionOnViewport reports and a geometry's absolute coordinates are in, so 'warp the cursor onto this widget' is one conversion and not two.
`UWidgetBlueprintLibrary`	`DetectDrag`	reject		UMG makes a handler arm drag detection for a key. Here the pointer pipeline detects drags itself against a distance and hold threshold (UDreamEventSystem's drag settings), so there is nothing for a handler to arm -- what a source supplies is the drag's MEANING, which is CreateDragDropOperation plus BeginDragWithOperation.
`UWidgetBlueprintLibrary`	`DetectDragIfPressed`	reject		See DetectDrag.
`UWidgetBlueprintLibrary`	`EndDragDrop`	reject		The pipeline ends a drag when the pointer is released; a handler has no reply to end it through. CancelDragDrop is the verb for ending one early.
`UWidgetBlueprintLibrary`	`IsDragDropping`	adopt	`IsDragDropping`
`UWidgetBlueprintLibrary`	`GetDragDroppingContent`	adopt	`GetDragDroppingContent`	Per pointer, because several fingers can drag at once on a touch screen; pointer 0 is the mouse.
`UWidgetBlueprintLibrary`	`CancelDragDrop`	adopt	`CancelDragDrop`
`UWidgetBlueprintLibrary`	`MakeBrushFromAsset`	adopt	`MakeBrushFromAsset`	Takes any resource the brush can draw, which here includes sprites and atlases as well as textures and materials.
`UWidgetBlueprintLibrary`	`MakeBrushFromTexture`	adopt	`MakeBrushFromTexture`	Zero width or height keeps the brush's own size rather than collapsing it.
`UWidgetBlueprintLibrary`	`MakeBrushFromMaterial`	adopt	`MakeBrushFromMaterial`
`UWidgetBlueprintLibrary`	`GetBrushResource`	adopt	`GetBrushResource`
`UWidgetBlueprintLibrary`	`GetBrushResourceAsTexture2D`	adopt	`GetBrushResourceAsTexture2D`
`UWidgetBlueprintLibrary`	`GetBrushResourceAsMaterial`	adopt	`GetBrushResourceAsMaterial`
`UWidgetBlueprintLibrary`	`SetBrushResourceToTexture`	adopt	`SetBrushResourceToTexture`
`UWidgetBlueprintLibrary`	`SetBrushResourceToMaterial`	adopt	`SetBrushResourceToMaterial`
`UWidgetBlueprintLibrary`	`NoResourceBrush`	adopt	`NoResourceBrush`
`UWidgetBlueprintLibrary`	`GetDynamicMaterial`	adopt	`GetDynamicMaterial`	Same verb on this framework's brush: a FDreamUIImageBrush holding a material is rewritten to hold a dynamic instance of it, which is returned; one already holding an instance returns it; a texture or sprite brush returns null. The brush is a value, so the caller hands it back to the image (UDreamImage::SetBrush). Not the same as a rect block's material, which belongs to the draw call and is deliberately not handed out (see Border.json).
`UWidgetBlueprintLibrary`	`DismissAllMenus`	adopt	`DismissAllMenus`	Walks the world's menu anchors and closes the open ones, skipping class defaults and archetypes. Walks rather than keeping a registry of open anchors: an anchor closed by any other route would have to remember to leave such a registry, and the one that forgot would leak a phantom. Returns how many it closed, so a caller can tell 'nothing was open' from 'did nothing'.
`UWidgetBlueprintLibrary`	`GetAllWidgetsOfClass`	adopt	`GetAllWidgetsOfClass`	Reads UDreamUIManagerWorldSubsystem's registered-widget array, which is the only honest source: widgets are UObjects outered to a widget tree, so an actor iterator cannot see them and an object iterator would also sweep up archetypes, designer previews and other worlds.
`UWidgetBlueprintLibrary`	`GetAllWidgetsWithInterface`	adopt	`GetAllWidgetsWithInterface`	Widget classes only; a behaviour implementing the interface is found through the widget's GetComponentByInterface.
`UWidgetBlueprintLibrary`	`GetInputEventFromKeyEvent`	reject		FKeyEvent and friends are Slate's input structs, delivered to SWidget handlers. Input arrives here as a UDreamPointerEventData or UDreamKeyEventData from the event system, so there is no Slate event to unwrap.
`UWidgetBlueprintLibrary`	`GetKeyEventFromAnalogInputEvent`	reject		See GetInputEventFromKeyEvent.
`UWidgetBlueprintLibrary`	`GetInputEventFromCharacterEvent`	reject		See GetInputEventFromKeyEvent.
`UWidgetBlueprintLibrary`	`GetInputEventFromPointerEvent`	reject		See GetInputEventFromKeyEvent.
`UWidgetBlueprintLibrary`	`GetInputEventFromNavigationEvent`	reject		See GetInputEventFromKeyEvent.
`UWidgetBlueprintLibrary`	`GetSafeZonePadding`	adopt	`GetSafeZonePadding`	Returns false when Slate is not running, so 'no inset needed' and 'could not ask' are not both a zero. UMG's SpillOverPadding is not returned: nothing here draws outside the viewport rect to spill over it.
`UWidgetBlueprintLibrary`	`SetColorVisionDeficiencyType`	reject		An engine-wide renderer simulation switch that happens to sit in UMG's library. It is not a widget-framework concern and the engine already exposes it; DreamGUI wrapping it would be a second door onto the same global.
`UWidgetBlueprintLibrary`	`SetHardwareCursor`	reject		Registers a cursor SHAPE with the platform. DreamGUI's Cursor property picks among the shapes a project has registered and does not own the registry.
`UWidgetBlueprintLibrary`	`SetWindowTitleBarState`	reject		The game window's title bar is a Slate window concern. DreamGUI draws inside the viewport and has no window chrome of its own.
`UWidgetBlueprintLibrary`	`RestorePreviousWindowTitleBarState`	reject		See SetWindowTitleBarState.
`UWidgetBlueprintLibrary`	`SetWindowTitleBarOnCloseClickedDelegate`	reject		See SetWindowTitleBarState.
`UWidgetBlueprintLibrary`	`SetWindowTitleBarCloseButtonActive`	reject		See SetWindowTitleBarState.

UDreamUIWidgetLibrary

Functions

Compared with UMG

On this page