FHittestGrid

Windows
MacOS
Linux

References

Module

SlateCore

Header

/Engine/Source/Runtime/SlateCore/Public/Input/HittestGrid.h

Include

#include "Input/HittestGrid.h"

Syntax

class FHittestGrid

Constructors

Name Description

Public function

FHittestGrid()

Destructors

Name Description

Public function

~FHittestGrid()

Functions

Name Description

Public function

void

 

AddWidget

(
    const TSharedRef< SWidget >& InWid...,
    int32 InBatchPriorityGroup,
    int32 InLayerId,
    int32 InSecondarySort
)

Add / Remove SWidget from the HitTest Grid

Public function

void

 

AppendGrid

(
    FHittestGrid& OtherGrid
)

Public function

void

 

Clear()

Clear the grid

Public function Const

void

 

DisplayGrid

(
    int32 InLayer,
    const FGeometry& AllottedGeometry,
    FSlateWindowElementList& WindowEle...
)

Public function

TSharedPtr< ...

 

FindNextFocusableWidget

(
    const FArrangedWidget& StartingWid...,
    const EUINavigation Direction,
    const FNavigationReply& Navigation...,
    const FArrangedWidget& RuleWidget,
    int32 UserIndex
)

Finds the next focusable widget by searching through the hit test grid

Public function

TArray< FWid...

 

GetBubblePath

(
    FVector2D 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.

Public function Const

FVector2D

 

GetGridOrigin()

Public function Const

FVector2D

 

GetGridSize()

Public function Const

FVector2D

 

GetGridWindowOrigin()

Public function Const

int32

 

GetUserIndex()

Gets current slate user index that should be associated with any added widgets

Public function

void

 

InsertCustomHitTestPath

(
    const TSharedRef< SWidget > InWidge...,
    TSharedRef< ICustomHitTestPath > Cu...
)

Insert custom hit test data for a widget already in the grid

Public function Const

void

 

LogGrid()

Public function

void

 

RemoveWidget

(
    const TSharedRef< SWidget >& InWid...
)

Public function

bool

 

SetHittestArea

(
    const FVector2D& HittestPositionIn...,
    const FVector2D& HittestDimensions,
    const FVector2D& HitestOffsetInWin...
)

Set the position and size of the hittest area in desktop coordinates

Public function

void

 

SetUserIndex

(
    int32 UserIndex
)

Sets the current slate user index that should be associated with any added widgets

Classes

Name

Description

Public struct

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