Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
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.
| Name | ULocalMouseHoverBehavior |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseBehaviors/MouseHoverBehavior.h |
| Include Path | #include "BaseBehaviors/MouseHoverBehavior.h" |
Syntax
UCLASS (MinimalAPI)
class ULocalMouseHoverBehavior :
public UMouseHoverBehavior ,
public IHoverBehaviorTarget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UInputBehavior → UMouseHoverBehavior → ULocalMouseHoverBehavior
Implements Interfaces
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BeginHitTestFunc | TUniqueFunction< FInputRayHit(const FInputDeviceRay &PressPos)> | Lambda implementation of BeginHoverSequenceHitTest | BaseBehaviors/MouseHoverBehavior.h | |
| OnBeginHoverFunc | TUniqueFunction< void(const FInputDeviceRay &PressPos)> | Lambda implementation of OnBeginHover | BaseBehaviors/MouseHoverBehavior.h | |
| OnEndHoverFunc | TUniqueFunction< void()> | Lambda implementation of OnEndHover | BaseBehaviors/MouseHoverBehavior.h | |
| OnUpdateHoverFunc | TUniqueFunction< bool(const FInputDeviceRay &PressPos)> | Lambda implementation of OnUpdateHover | BaseBehaviors/MouseHoverBehavior.h | |
| OnUpdateModifierStateFunc | TUniqueFunction< void(int, bool) > | Lambda implementation of OnUpdateModifierState | BaseBehaviors/MouseHoverBehavior.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Initialize () |
Call this to initialize the class | BaseBehaviors/MouseHoverBehavior.h |
Overridden from IHoverBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInputRayHit BeginHoverSequenceHitTest
(
const FInputDeviceRay& PressPos |
IHoverBehaviorTarget implementation. | BaseBehaviors/MouseHoverBehavior.h | |
virtual void OnBeginHover
(
const FInputDeviceRay& DevicePos |
Initialize hover sequence at given position | BaseBehaviors/MouseHoverBehavior.h | |
virtual void OnEndHover() |
Terminate active hover sequence | BaseBehaviors/MouseHoverBehavior.h | |
virtual bool OnUpdateHover
(
const FInputDeviceRay& DevicePos |
Update active hover sequence with new input position | BaseBehaviors/MouseHoverBehavior.h |
Overridden from IModifierToggleBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnUpdateModifierState
(
int ModifierID, |
IModifierToggleBehaviorTarget implementation. | BaseBehaviors/MouseHoverBehavior.h |
Protected
Overridden from UMouseHoverBehavior
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Initialize
(
IHoverBehaviorTarget* Target |
BaseBehaviors/MouseHoverBehavior.h |