ULocalMouseHoverBehavior

API > API/Runtime > API/Runtime/InteractiveToolsFramework > API/Runtime/InteractiveToolsFramework/BaseBehaviors

Inheritance Hierarchy

References


Module	InteractiveToolsFramework
Header	/Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseBehaviors/MouseHoverBehavior.h
Include	#include "BaseBehaviors/MouseHoverBehavior.h"

Syntax

class ULocalMouseHoverBehavior :  
    public UMouseHoverBehavior,  
    public IHoverBehaviorTarget

Remarks

An implementation of UMouseHoverBehavior that also implements IHoverBehaviorTarget directly, via a set of local lambda functions. To use/customize this class, the client replaces the lambda functions with their own. This avoids having to create a separate IHoverBehaviorTarget implementation for trivial use-cases.

Variables

Type	Name	Description
TUniqueFunction< FInputRayHit(const FInputDeviceRay &PressPos)>	BeginHitTestFunc	Lambda implementation of BeginHoverSequenceHitTest
TUniqueFunction< void(const FInputDeviceRay &PressPos)>	OnBeginHoverFunc	Lambda implementation of OnBeginHover
TUniqueFunction< void()>	OnEndHoverFunc	Lambda implementation of OnEndHover
TUniqueFunction< bool(const FInputDeviceRay &PressPos)>	OnUpdateHoverFunc	Lambda implementation of OnUpdateHover
TUniqueFunction< void(int, bool) >	OnUpdateModifierStateFunc	Lambda implementation of OnUpdateModifierState

Functions

	Type	Name	Description
	void	Initialize ()	Call this to initialize the class

Overridden from IHoverBehaviorTarget

Type	Name	Description
FInputRayHit	BeginHoverSequenceHitTest ( const FInputDeviceRay& PressPos )	IHoverBehaviorTarget implementation.
void	OnBeginHover ( const FInputDeviceRay& DevicePos )	Initialize hover sequence at given position
void	OnEndHover ()	Terminate active hover sequence
bool	OnUpdateHover ( const FInputDeviceRay& DevicePos )	Update active hover sequence with new input position