BehaviorTargetInterfaces.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
 
#include "InputState.h"
 
class IModifierToggleBehaviorTarget
{
public:
    virtual ~IModifierToggleBehaviorTarget() {}
 
    virtual void OnUpdateModifierState(int ModifierID, bool bIsOn)
    {
    }
 
    virtual void OnForceEndCapture()
    {
    }
};
 
class IKeyInputBehaviorTarget : public IModifierToggleBehaviorTarget
{
public:
    virtual ~IKeyInputBehaviorTarget() {}
 
    virtual void OnKeyPressed(const FKey& KeyID)
    {
    }
 
    virtual void OnKeyReleased(const FKey& KeyID)
    {
    }
 
    virtual void OnForceEndCapture()
    {
    }
};
 
 
class IClickBehaviorTarget : public IModifierToggleBehaviorTarget
{
public:
    virtual ~IClickBehaviorTarget() {}
 
    virtual FInputRayHit IsHitByClick(const FInputDeviceRay& ClickPos) = 0;
 
 
    virtual void OnClicked(const FInputDeviceRay& ClickPos) = 0;
};
 
 
 
 
class IClickDragBehaviorTarget : public IModifierToggleBehaviorTarget
{
public:
    virtual ~IClickDragBehaviorTarget() {}
 
    virtual FInputRayHit CanBeginClickDragSequence(const FInputDeviceRay& PressPos) = 0;
 
 
    virtual void OnClickPress(const FInputDeviceRay& PressPos) = 0;
 
    virtual void OnClickDrag(const FInputDeviceRay& DragPos) = 0;
 
    virtual void OnClickRelease(const FInputDeviceRay& ReleasePos) = 0;
 
    virtual void OnTerminateDragSequence() = 0;
};
 
 
class IMouseWheelBehaviorTarget : public IModifierToggleBehaviorTarget
{
public:
    virtual ~IMouseWheelBehaviorTarget() {}
 
    virtual FInputRayHit ShouldRespondToMouseWheel(const FInputDeviceRay& CurrentPos) = 0;
 
 
    virtual void OnMouseWheelScrollUp(const FInputDeviceRay& CurrentPos) = 0;
 
    virtual void OnMouseWheelScrollDown(const FInputDeviceRay& CurrentPos) = 0;
 
};
 
 
 
 
 
 
class IClickSequenceBehaviorTarget : public IModifierToggleBehaviorTarget
{
public:
    virtual ~IClickSequenceBehaviorTarget() {}
 
    virtual void OnBeginSequencePreview(const FInputDeviceRay& ClickPos) { }
 
    virtual bool CanBeginClickSequence(const FInputDeviceRay& ClickPos) = 0;
 
    virtual void OnBeginClickSequence(const FInputDeviceRay& ClickPos) = 0;
    
    virtual void OnNextSequencePreview(const FInputDeviceRay& ClickPos) { }
 
    virtual bool OnNextSequenceClick(const FInputDeviceRay& ClickPos) = 0;
 
    virtual void OnTerminateClickSequence() = 0;
 
    virtual bool RequestAbortClickSequence() { return false; }
};
 
 
 
 
 
class IHoverBehaviorTarget : public IModifierToggleBehaviorTarget
{
public:
    virtual ~IHoverBehaviorTarget() {}
 
    virtual FInputRayHit BeginHoverSequenceHitTest(const FInputDeviceRay& PressPos) = 0;
 
    virtual void OnBeginHover(const FInputDeviceRay& DevicePos) = 0;
 
    virtual bool OnUpdateHover(const FInputDeviceRay& DevicePos) = 0;
 
    virtual void OnEndHover() = 0;
};
 
 
class ITwoAxisPropertyEditBehaviorTarget
{
public:
 
    /* IPropertyInterface encapsulates a virtual 'property' (which may or may not map to a single member or property) */
    struct IPropertyInterface
    {
        virtual ~IPropertyInterface() {}
        
        virtual FText GetName() = 0;                                // Get a name for this virtual property (for display purposes).
        virtual float GetValue() = 0;
        virtual void SetValue(float NewValue) = 0;
        virtual float GetEditRate() { return 0.003f; }              // Scales how quickly this property is edited with respect to a fixed mouse movement.
        virtual float MutateDelta(float Delta) { return Delta; }    // Provides a hook to further augment the delta that is about to be applied to this property.
        virtual bool IsEnabled() { return false; }
    };
    
public:
    
    virtual ~ITwoAxisPropertyEditBehaviorTarget() {}
    
    virtual IPropertyInterface* GetHorizontalProperty() = 0;
    virtual IPropertyInterface* GetVerticalProperty() = 0;
    
    virtual FKey GetCaptureKey() { return EKeys::B; }
    virtual void PostDragUpdated() {}
};