1. Epic GamesDeveloper
  3. FHittestGrid

FHittestGrid

Unreal Engine C++ API Reference > Runtime > SlateCore > Input

Inheritance Hierarchy

References

   
Module SlateCore
Header /Engine/Source/Runtime/SlateCore/Public/Input/HittestGrid.h
Include #include "Input/HittestGrid.h"

Syntax

class FHittestGrid : public FNoncopyable

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AddGrid ( const TSharedRef< const FHittestGrid >& OtherGrid
)

 Add an already existing grid that occupy the same space.
Public function void

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

 Add SWidget from the HitTest Grid
Public function void

Clear ()

 Clear the grid
Public function Const bool

ContainsWidget ( const SWidget* InWidget
)

 Check if SWidget is contained within the HitTest Grid
Public function Const void

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

  
Public function 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
Public function Const TArray< FWidgetSortData >  
Public function 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.
Public function Const UE::Slate::FDeprecateVector2DResult  
Public function Const UE::Slate::FDeprecateVector2DResult  
Public function Const UE::Slate::FDeprecateVector2DResult  
Public function Const int32 Gets current slate user index that should be associated with any added widgets
Public function void

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

 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 FHittestGrid >& OtherGrid
)

 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 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
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 InSecondarySort
)

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

Classes

  Type Name Description
Public struct FDebuggingFindNextFocusableWidgetArgs    
Public struct FGridTestingParams    
Public struct FWidgetSortData    

Enums

  Type Name Description
Public enum EDisplayGridFlags    

Typedefs

Name Description
FCollapsedHittestGridArray  
FCollapsedWidgetsArray  
FDebuggingFindNextFocusableWidget  

Constants

Name Description
OnFindNextFocusableWidgetExecuted  

Deprecated Functions

  Type Name Description
Public function void

AddWidget ( const TSharedRef< SWidget >& InWidget,
int32 InBatchPriorityGroup,
int32 InLayerId,
FSlateInvalidationWidgetSortOrder InSecondarySort
)

 Deprecated. Use the AddWidget with a pointer.
Public function void

AddWidget ( const TSharedRef< SWidget >& InWidget,
int32 InBatchPriorityGroup,
int32 InLayerId,
int32 InSecondarySort
)

 Deprecated. Use the AddWidget with the FSlateInvalidationWidgetSortOrder type parameters instead. Passing FSlateInvalidationWidgetSortOrder()
Public function void

AppendGrid ( FHittestGrid& OtherGrid
)

 Deprecated. Use the FHittestGrid::AddGrid method instead
Public function void

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

 Deprecated. Use the InsertCustomHitTestPath with a pointer.
Public function void

RemoveWidget ( const TSharedRef< SWidget >& InWidget
)

 Deprecated. Use the RemoveWidget with a pointer.
Public function void

UpdateWidget ( const TSharedRef< SWidget >& InWidget,
FSlateInvalidationWidgetSortOrder InSecondarySort
)

 Deprecated. Use the UpdateWidget with a pointer.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page