1. Epic GamesDeveloper
  3. FWidgetPath

FWidgetPath

A widget path is a vertical slice through the tree.

API > API/Runtime > API/Runtime/SlateCore > API/Runtime/SlateCore/Layout

References

   
Module SlateCore
Header /Engine/Source/Runtime/SlateCore/Public/Layout/WidgetPath.h
Include #include "Layout/WidgetPath.h"

Syntax

class FWidgetPath

Remarks

A widget path is a vertical slice through the tree. The canonical form for widget paths is "leafmost last". The top-level window always resides at index 0. A widget path also contains a reference to a top-level SWindow that contains all the widgets in the path. The window is needed for its ability to determine its own geometry, from which the geometries of the rest of the widget can be determined.

Variables

  Type Name Description
Public variable TSharedPtr< SWindow > TopLevelWindow The top level window of this widget path.
Public variable TArray< TOptional< FVirtualPointerPosition > > VirtualPointerPositions The virtual representation of the mouse at each level in the widget path.
Public variable FArrangedChildren Widgets The widgets that make up the widget path, the first item is the root widget, the end is the widget this path was built for.

Constructors

  Type Name Description
Public function    
Public function  

FWidgetPath ( TArrayView< FWidgetAndPointer > InWidgetsAndPointers
)

  
Public function  

FWidgetPath ( TSharedPtr< SWindow > InTopLevelWindow,
const FArrangedChildren& InWidgetPath
)

  

Functions

  Type Name Description
Public function Const bool

ContainsWidget ( const SWidget* WidgetToFind
)

  
Public function Const bool

ContainsWidget ( TSharedRef< const SWidget > WidgetToFind
)

  
Public function bool

ExtendPathTo ( const MatcherType& Matcher,
EVisibility VisibilityFilter
)

 Extend the current path such that it reaches some widget that qualifies as a Match The widget to match must be a descendant of the last widget currently in the path.
Public function Const TOptional< FArrangedWidget >

FindArrangedWidget ( TSharedRef< const SWidget > WidgetToFind
)

  
Public function Const TOptional< FWidgetAndPointer >

FindArrangedWidgetAndCursor ( TSharedRef< const SWidget > WidgetToFind
)

  
Public function FArrangedChildren

GeneratePathToWidget ( const MatcherType& Matcher,
const FArrangedWidget& FromWidget,
EUINavigation NavigationType,
EVisibility VisibilityFilter
)

 Generate a path from FromWidget to WidgetToFind. The path will not include FromWidget.
Public function Const const TSharedPtr< const FVirtualPointerPosition > &

GetCursorAt ( int32 Index
)

 Get the widget and associated virtual cursor at a given index.
Public function Const TSharedRef< SWindow > Get the deepest (bottom-most) window in this path; assumes path is valid.
Public function Const TSharedRef< SWidget > Get the last (leaf-most) widget in this path; assumes path is valid
Public function Const FWidgetPath

GetPathDownTo ( TSharedRef< const SWidget > MarkerWidget
)

  
Public function Const TOptional< FVirtualPointerPosition > Get the virtual representation of the mouse at each level in the widget path.
Public function Const TSharedRef< SWindow > Get the first (top-most) widget in this path, which is always a window; assumes path is valid.
Public function Const bool

IsValid ()

 A valid path has at least one widget in it
Public function bool

MoveFocus ( int32 PathLevel,
EUINavigation NavigationType,
bool bSearchFromPathWidget
)

 Move focus either forward on backward in the path level specified by PathLevel.
Public function Const FString Builds a string representation of the widget path.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page