Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > SlateCore > Input > FHittestGrid

Light Theme

Dark Theme

FHittestGrid

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
	FHittestGrid()

Functions

	Name	Description
void	AddGrid ( const TSharedRef< const FHittestGri... )	Add an already existing grid that occupy the same space.
void	AddWidget ( const TSharedRef< SWidget >& InWid..., int32 InBatchPriorityGroup, int32 InLayerId, FSlateInvalidationWidgetSortOrder I... )	Add SWidget from the HitTest Grid
void	Clear()	Clear the grid
void	DisplayGrid ( int32 InLayer, const FGeometry& AllottedGeometry, FSlateWindowElementList& WindowEle..., EDisplayGridFlags DisplayFlags )
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
TArray< FWid...	GetAllWidgetSortDatas()
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.
FVector2D	GetGridOrigin()
FVector2D	GetGridSize()
FVector2D	GetGridWindowOrigin()
int32	GetUserIndex()	Gets current slate user index that should be associated with any added widgets
void	InsertCustomHitTestPath ( const TSharedRef< SWidget > InWidge..., TSharedRef< ICustomHitTestPath > Cu... )	Insert custom hit test data for a widget already in the grid
void	LogGrid()
void	RemoveGrid ( const TSharedRef< const FHittestGri... )	Remove a grid that was appended.
void	RemoveGrid ( const SWidget* OtherGridOwner )	Remove a grid that was appended.
void	RemoveWidget ( const TSharedRef< SWidget >& InWid... )	Remove SWidget from the HitTest Grid
void	RemoveWidget ( const SWidget* InWidget )	Remove SWidget from the HitTest Grid
void	SetCullingRect ( const FSlateRect& InCullingRect )	Set the culling rect to be used by the parent grid (in case we are appended to another grid).
bool	SetHittestArea ( const FVector2D& HittestPositionIn..., const FVector2D& HittestDimensions, const FVector2D& HitestOffsetInWin... )	Set the position and size of the hittest area in desktop coordinates
void	SetOwner ( const SWidget* InOwner )	Set the owner SWidget to be used by the parent grid (in case we are appended to another grid).
void	SetUserIndex ( int32 UserIndex )	Sets the current slate user index that should be associated with any added widgets
void	UpdateWidget ( const TSharedRef< SWidget >& InWid..., FSlateInvalidationWidgetSortOrder I... )	Update the widget SecondarySort without removing it and readding it again.

Classes

	Name	Description
	FDebuggingFindNextFocusableWidgetArgs
	FGridTestingParams
	FWidgetSortData

Enums

	Name	Description
	EDisplayGridFlags

Typedefs

Name	Description
FCollapsedHittestGridArray
FCollapsedWidgetsArray
FDebuggingFindNextFocusableWidget

Constants

Name	Description
OnFindNextFocusableWidgetExecuted

Deprecated Functions

		Name	Description
	void	AddWidget ( const TSharedRef< SWidget >& InWid..., int32 InBatchPriorityGroup, int32 InLayerId, int32 InSecondarySort )	Use the AddWidget with the FSlateInvalidationWidgetSortOrder type parameters instead. Passing FSlateInvalidationWidgetSortOrder()
	void	AppendGrid ( FHittestGrid& OtherGrid )	Use the FHittestGrid::AddGrid method instead

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

Take our survey

Dismiss