1. Epic GamesDeveloper
  3. FHittestGrid

FHittestGrid

API > API/Runtime > API/Runtime/SlateCore

   
Name FHittestGrid
Type class
Header File /Engine/Source/Runtime/SlateCore/Public/Input/HittestGrid.h
Include Path #include "Input/HittestGrid.h"

Syntax

class FHittestGrid : public FNoncopyable

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FHittestGrid()

   Input/HittestGrid.h  

Structs

Name Remarks
FAppendedGridData  
FCell All the available space is partitioned into Cells.
FDebuggingFindNextFocusableWidgetArgs  
FGridTestingParams  
FIndexAndDistance  
FWidgetData Widget Data we maintain internally store along with the widget reference
FWidgetIndex  
FWidgetSortData  

Enums

Public

Name Remarks
EDisplayGridFlags  

Typedefs

Name Type Remarks Include Path
FCollapsedHittestGridArray TArray< const FHittestGrid *, TInlineAllocator< 16 > >   Input/HittestGrid.h
FCollapsedWidgetsArray TArray< FWidgetIndex, TInlineAllocator< 100 > >   Input/HittestGrid.h
FDebuggingFindNextFocusableWidget TMulticastDelegate_TwoParams< void, const FHittestGrid *, const FDebuggingFindNextFocusableWidgetArgs & >   Input/HittestGrid.h

Constants

Name Type Remarks Include Path
CellSize const FVector2f The size in pixels of a cell Input/HittestGrid.h
OnFindNextFocusableWidgetExecuted FDebuggingFindNextFocusableWidget   Input/HittestGrid.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AppendedGridArray TArray< FAppendedGridData > The collapsed grid cached untiled it's dirtied. Input/HittestGrid.h  
Cells TArray< FCell > The cells that make up the space partition. Input/HittestGrid.h  
CullingRect FSlateRect Culling Rect used when the widget was painted. Input/HittestGrid.h  
CurrentUserIndex int32 The current slate user index that should be associated with any added widgets Input/HittestGrid.h  
GridOrigin FVector2f Where the 0,0 of the upper-left-most cell corresponds to in desktop space. Input/HittestGrid.h  
GridSize FVector2f The Size of the current grid. Input/HittestGrid.h  
GridWindowOrigin FVector2f Where the 0,0 of the upper-left-most cell corresponds to in window space. Input/HittestGrid.h  
LastNavigationMethod TInstancedStruct< FNavigationMethod > Cache the state of the most recent FindNextFocusableWidget request Input/HittestGrid.h  
NumCells FIntPoint The size of the grid in cells. Input/HittestGrid.h  
Owner const SWidget * A grid needs a owner to be appended. Input/HittestGrid.h  
WidgetArray TSparseArray< FWidgetData > Stable indexed sparse array of all the widget data we track. Input/HittestGrid.h  
WidgetMap TMap< const SWidget *, int32 > Map of all the widgets currently in the hit test grid to their stable index. Input/HittestGrid.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddGrid ( const TSharedRef< const FHittestGrid >& OtherGrid
)

 Add an already existing grid that occupy the same space. Input/HittestGrid.h  

void AddWidget ( const SWidget* InWidget,
int32 InBatchPriorityGroup,
int32 InLayerId,
FSlateInvalidationWidgetSortOrder InSecondarySort
)

 Add SWidget from the HitTest Grid Input/HittestGrid.h  

void Clear()

 Clear the grid Input/HittestGrid.h  

bool ContainsWidget ( const SWidget* InWidget
) const

 Check if SWidget is contained within the HitTest Grid Input/HittestGrid.h  

void DisplayGrid ( int32 InLayer,
const FGeometry& AllottedGeometry,
FSlateWindowElementList& WindowElementList,
EDisplayGridFlags DisplayFlags
) const

   Input/HittestGrid.h  

void DisplayNavigation ( int32 InLayer,
const FGeometry& AllottedGeometry,
FSlateWindowElementList& WindowElementList
)

   Input/HittestGrid.h  

TSharedPtr< SWidget > FindNextFocusableWidget ( const FArrangedWidget& StartingWidget,
const EUINavigation Direction,
const FNavigationReply& NavigationReply,
const FArrangedWidget& RuleWidget,
int32 UserIndex
)

 Finds the next focusable widget by searching through the hit test grid Input/HittestGrid.h  

TArray< FWidgetSortData > GetAllWidgetSortDatas()

   Input/HittestGrid.h  

TArray< FWidgetAndPointer > GetBubblePath ( UE::Slate::FDeprecateVector2DParameter DesktopSpaceCoordinate,
float CursorRadius,
bool bIgnoreEnabledStatus,
int32 UserIndex
)

 Given a Slate Units coordinate in virtual desktop space, perform a hittest and return the path along which the corresponding event would be bubbled. Input/HittestGrid.h  

const FVector2f & GetCellSize()

   Input/HittestGrid.h  

UE::Slate::FDeprecateVector2DResult GetGridOrigin()

   Input/HittestGrid.h  

UE::Slate::FDeprecateVector2DResult GetGridSize()

   Input/HittestGrid.h  

UE::Slate::FDeprecateVector2DResult GetGridWindowOrigin()

   Input/HittestGrid.h  

int32 GetUserIndex()

 Gets current slate user index that should be associated with any added widgets Input/HittestGrid.h  

FSlateRect GetWidgetRenderBoundingRect ( const TSharedPtr< SWidget >& Widget
) const

 Get the screen space rectangle that corresponds to the painted area of the widget Input/HittestGrid.h  

void InsertCustomHitTestPath ( const SWidget* InWidget,
const TSharedRef< ICustomHitTestPath >& CustomHitTestPath
)

 Insert custom hit test data for a widget already in the grid Input/HittestGrid.h  

bool IsValidCellCoord ( const int32 XCoord,
const int32 YCoord
) const

   Input/HittestGrid.h  

bool IsValidCellCoord ( const FIntPoint& CellCoord
) const

 Returns true if the CellCoordinates are within the grid Input/HittestGrid.h  

void LogGrid()

   Input/HittestGrid.h  

void RemoveGrid ( const TSharedRef< const FHittestGrid >& OtherGrid
)

 Remove a grid that was appended. Input/HittestGrid.h  

void RemoveGrid ( const SWidget* OtherGridOwner
)

 Remove a grid that was appended. Input/HittestGrid.h  

void RemoveWidget ( const SWidget* InWidget
)

 Remove SWidget from the HitTest Grid Input/HittestGrid.h  

void SetCullingRect ( const FSlateRect& InCullingRect
)

 Set the culling rect to be used by the parent grid (in case we are appended to another grid). Input/HittestGrid.h  

bool SetHittestArea ( const UE::Slate::FDeprecateVector2DParameter& HittestPositionInDesktop,
const UE::Slate::FDeprecateVector2DParameter& HittestDimensions,
const UE::Slate::FDeprecateVector2DParameter& HitestOffsetInWindow
)

 Set the position and size of the hittest area in desktop coordinates Input/HittestGrid.h  

void SetOwner ( const SWidget* InOwner
)

 Set the owner SWidget to be used by the parent grid (in case we are appended to another grid). Input/HittestGrid.h  

void SetUserIndex ( int32 UserIndex
)

 Sets the current slate user index that should be associated with any added widgets Input/HittestGrid.h  

void UpdateWidget ( const SWidget* InWidget,
FSlateInvalidationWidgetSortOrder InSecondarySort
)

 Update the widget SecondarySort without removing it and readding it again. Input/HittestGrid.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool IsCompatibleUserIndex ( int32 RequestedUserIndex,
int32 TestUserIndex
)

   Input/HittestGrid.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page