Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
Trivial InputBehavior that forwards InputBehavior hover events to a Target object via the IHoverBehaviorTarget interface.
| Name | UMouseHoverBehavior |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseBehaviors/MouseHoverBehavior.h |
| Include Path | #include "BaseBehaviors/MouseHoverBehavior.h" |
Syntax
UCLASS (MinimalAPI)
class UMouseHoverBehavior : public UInputBehavior
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UInputBehavior → UMouseHoverBehavior
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMouseHoverBehavior() |
BaseBehaviors/MouseHoverBehavior.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| HoverModifierCheckFunc | TFunction< bool(const FInputDeviceState &)> | WantsHoverCapture() will only return capture request if this function returns true (or is null) | BaseBehaviors/MouseHoverBehavior.h | |
| Modifiers | FInputBehaviorModifierStates | The modifier set for this behavior | BaseBehaviors/MouseHoverBehavior.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Initialize
(
IHoverBehaviorTarget* Target |
BaseBehaviors/MouseHoverBehavior.h |
Overridden from UInputBehavior
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInputCaptureUpdate BeginHoverCapture
(
const FInputDeviceState& InputState, |
Called after WantsHoverCapture() returns a capture request that was accepted | BaseBehaviors/MouseHoverBehavior.h | |
virtual void EndHoverCapture() |
If a different hover capture begins, focus is lost, a tool starts, etc, any active hover visualization needs to terminate | BaseBehaviors/MouseHoverBehavior.h | |
virtual EInputDevices GetSupportedDevices() |
Which device types does this Behavior support | BaseBehaviors/MouseHoverBehavior.h | |
virtual FInputCaptureUpdate UpdateHoverCapture
(
const FInputDeviceState& InputState |
Called on each new hover input event, ie if no other behavior is actively capturing input | BaseBehaviors/MouseHoverBehavior.h | |
virtual FInputCaptureRequest WantsHoverCapture
(
const FInputDeviceState& InputState |
Given the input state, does this Behavior want to begin capturing some input devices for hover | BaseBehaviors/MouseHoverBehavior.h | |
virtual bool WantsHoverEvents() |
Hover support (optional) return true if this Behavior supports hover (ie passive input events) | BaseBehaviors/MouseHoverBehavior.h |