FHittestGrid

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FNoncopyable

FHittestGrid

References

Module

SlateCore

Header

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

Include

#include "Input/HittestGrid.h"

Syntax

class FHittestGrid : public FNoncopyable

Constructors

Name Description

Public function

FHittestGrid()

Functions

Name Description

Public function

void

 

AddGrid

(
    const TSharedRef< const FHittestGri...
)

Add an already existing grid that occupy the same space.

Public function

void

 

AddWidget

(
    const SWidget* InWidget,
    int32 InBatchPriorityGroup,
    int32 InLayerId,
    FSlateInvalidationWidgetSortOrder I...
)

Add SWidget from the HitTest Grid

Public function

void

 

Clear()

Clear the grid

Public function Const

void

 

DisplayGrid

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

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 Const

TArray< FWid...

 

GetAllWidgetSortDatas()

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 SWidget* InWidget,
    const TSharedRef< ICustomHitTestPat...
)

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

Public function Const

void

 

LogGrid()

Public function

void

 

RemoveGrid

(
    const SWidget* OtherGridOwner
)

Remove a grid that was appended.

Public function

void

 

RemoveGrid

(
    const TSharedRef< const FHittestGri...
)

Remove a grid that was appended.

Public function

void

 

RemoveWidget

(
    const SWidget* InWidget
)

Remove SWidget from the HitTest Grid

Public function

void

 

SetCullingRect

(
    const FSlateRect& InCullingRect
)

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

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

 

SetOwner

(
    const SWidget* InOwner
)

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

Public function

void

 

SetUserIndex

(
    int32 UserIndex
)

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

Public function

void

 

UpdateWidget

(
    const SWidget* InWidget,
    FSlateInvalidationWidgetSortOrder I...
)

Update the widget SecondarySort without removing it and readding it again.

Classes

Enums

Name

Description

Public enum

EDisplayGridFlags

Typedefs

Constants

Deprecated Functions

Name Description

Public function

void

 

AddWidget

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

  1. Use the AddWidget with a pointer.

Public function

void

 

AddWidget

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

  1. Use the AddWidget with the FSlateInvalidationWidgetSortOrder type parameters instead. Passing FSlateInvalidationWidgetSortOrder()

Public function

void

 

AppendGrid

(
    FHittestGrid& OtherGrid
)

  1. Use the FHittestGrid::AddGrid method instead

Public function

void

 

InsertCustomHitTestPath

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

  1. Use the InsertCustomHitTestPath with a pointer.

Public function

void

 

RemoveWidget

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

  1. Use the RemoveWidget with a pointer.

Public function

void

 

UpdateWidget

(
    const TSharedRef< SWidget >& InWid...,
    FSlateInvalidationWidgetSortOrder I...
)

  1. Use the UpdateWidget with a pointer.