KnobLogic.h

Go to the documentation of this file.

// Copyright 2024 Lost in Game Studio. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "ComponentLogic.h"
#include "Styling/SlateBrush.h"
#include "KnobLogic.generated.h"
 
class UComponentDecorator;
 
UENUM(BlueprintType)
enum class EKnobMode : uint8
{
    //Free rotation
    Free,
 
    //Limited rotation value
    InRange,
 
    //Snap to desired rotation value. Act as selector
    Switch
};

UCLASS()
class TOUCHINTERFACE_API UKnobLogic : public UComponentLogic
{
    GENERATED_BODY()
 
public:
    UKnobLogic();
 
    virtual void Initialize_Implementation() override;
 
private:
    virtual void InitSwitch();
    
public:
    virtual void OnPress_Implementation(const FGeometry& ComponentGeometry, const FPointerEvent& PointerEvent) override;
    virtual void OnMove_Implementation(const FGeometry& ComponentGeometry, const FPointerEvent& PointerEvent) override;
    virtual void OnRelease_Implementation(const FGeometry& ComponentGeometry, const FPointerEvent& PointerEvent) override;
 
    virtual void SetInputAction_Implementation(UInputAction* NewInputAction) override;
 
    //Return current rotation of knob
    UFUNCTION(Category="Knob", BlueprintCallable, BlueprintPure)
    float GetCurrentKnobRotation() const { return CurrentKnobArtRotation; }
 
    //Return input value based on touch or last touch in absolute
    UFUNCTION(Category="Knob", BlueprintCallable, BlueprintPure)
    float GetKnobInput(const bool bMapTo360) const;
 
    //TODO: Set range min and max rotation, min and max input value
 
    //TODO: Get range min max rotation, min max input value
    
    //TODO: Set switch array, Set switch index
 
    //TODO: Get Switch array, get switch index
    
#if WITH_EDITOR
    //virtual void PostEditChangeProperty(struct FPropertyChangedEvent& PropertyChangedEvent) override;
#endif
    
private:
    virtual void SendFreeInputValue(const FVector2D& Offset);
    
public:
    UPROPERTY(Category="Knob", EditAnywhere, BlueprintReadOnly)
    TObjectPtr<UInputAction> InputAction;

    UPROPERTY(Category="Knob", EditAnywhere, BlueprintReadOnly, meta=(GetOptions="GetAllDecoratorNames"))
    FName KnobLayer;
 
    //Select the knob rotation mode
    UPROPERTY(Category="Knob", EditAnywhere, BlueprintReadOnly)
    EKnobMode Mode;
 
    // If enabled, the forward of knob is snapped to finger position on press
    UPROPERTY(Category="Knob", EditAnywhere, BlueprintReadOnly)
    uint8 bSnapOnPress:1;

    UPROPERTY(Category="Knob", EditAnywhere, BlueprintReadOnly)
    uint8 bSendInputOnPress:1;
 
    // If enabled, reset knob rotation to default rotation on release
    UPROPERTY(Category="Knob", EditAnywhere, BlueprintReadOnly, meta=(EditCondition="Mode==EKnobMode::Free || Mode==EKnobMode::InRange", EditConditionHides))
    uint8 bBackToCenter:1;
    
    //TODO: Back to center smoothly
 
    
    //FREE
 
    // By default, forward begin from Top Center (FVector2D(0.0f, -1.0f)), but you can add an offset to set the start value at different angle
    UPROPERTY(Category="Knob|Free", EditAnywhere, BlueprintReadOnly, meta=(EditCondition="Mode==EKnobMode::Free"))
    float StartOffset;
    
    //In Free mode, send absolute value (offset from start) instead of delta
    UPROPERTY(Category="Knob|Free", EditAnywhere, BlueprintReadOnly, meta=(EditCondition="Mode==EKnobMode::Free"))
    uint8 bAbsoluteValue:1;
 
    UPROPERTY(Category="Knob|Free", EditAnywhere, BlueprintReadOnly, meta=(EditCondition="Mode==EKnobMode::Free && bAbsoluteValue==true"))
    uint8 bMapRangeTo360:1;

    UPROPERTY(Category="Knob|Free", EditAnywhere, BlueprintReadOnly, meta=(EditCondition="Mode==EKnobMode::Free && bAbsoluteValue==false"))
    float MinDeltaToSendEvent;
 
    //TODO: Additive value (0 to infinite)
 
    
    // IN RANGE
 
    // Minimum rotation value allowed in degree
    UPROPERTY(Category="Knob|Range", EditAnywhere, BlueprintReadOnly, meta=(EditCondition="Mode==EKnobMode::InRange"))
    float MinRotationAngle;
 
    // Maximum rotation value allowed in degree
    UPROPERTY(Category="Knob|Range", EditAnywhere, BlueprintReadOnly, meta=(EditCondition="Mode==EKnobMode::InRange"))
    float MaxRotationAngle;
 
    // Input raw value at minimum rotation. Can be different from Minimum Rotation Value.
    UPROPERTY(Category="Knob|Range", EditAnywhere, BlueprintReadOnly, meta=(EditCondition="Mode==EKnobMode::InRange"))
    float MinValue;
 
    // Input raw value at maximum rotation. Can be different from Maximum Rotation Value.
    UPROPERTY(Category="Knob|Range", EditAnywhere, BlueprintReadOnly, meta=(EditCondition="Mode==EKnobMode::InRange"))
    float MaxValue;
 
    // If enabled, inject input each frame. Otherwise inject input only when rotation is changed.
    UPROPERTY(Category="Knob|Range", EditAnywhere, BlueprintReadOnly, meta=(EditCondition="Mode==EKnobMode::InRange"))
    uint8 bContinuousInput:1;
 
    // Center knob in middle of range instead of forward middle of art
    UPROPERTY(Category="Knob|Range", EditAnywhere, BlueprintReadOnly, meta=(EditCondition="Mode==EKnobMode::InRange"))
    uint8 bCenterOrigin:1;
 
 
    // SWITCH
 
    //If enabled, use SwitchLocations array instead of automatically computed positions.
    UPROPERTY(Category="Knob|Switch", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=1), meta=(EditCondition="Mode==EKnobMode::Switch"))
    uint8 bCustomLocation:1;
 
    // Number of switch
    UPROPERTY(Category="Knob|Switch", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=1), meta=(EditCondition="Mode==EKnobMode::Switch && bCustomLocation==false"))
    int32 SwitchAmount;
 
    // Gap between each switch
    UPROPERTY(Category="Knob|Switch", EditAnywhere, BlueprintReadOnly, meta=(EditCondition="Mode==EKnobMode::Switch && bCustomLocation==false"))
    float SwitchGap;
 
    // If enabled, switch is centered based on amount and gap
    UPROPERTY(Category="Knob|Switch", EditAnywhere, BlueprintReadOnly, meta=(EditCondition="Mode==EKnobMode::Switch && bCustomLocation==false"))
    uint8 bCenterSwitch:1;

    UPROPERTY(Category="Knob|Switch", EditAnywhere, BlueprintReadOnly, meta=(EditCondition="Mode==EKnobMode::Switch && bCustomLocation==true"))
    TArray<float> SwitchLocations;
 
    //Index used to set knob rotation on start
    UPROPERTY(Category="Knob|Switch", EditAnywhere, BlueprintReadOnly, meta=(EditCondition="Mode==EKnobMode::Switch"))
    int32 StartIndex;
    

    UPROPERTY(Category="Knob|Appearance", EditAnywhere, BlueprintReadOnly, meta=(Experimental="true"))
    FSlateBrush KnobBrush;

    //UPROPERTY(Category="Knob|Appearance", EditAnywhere, BlueprintReadOnly, meta=(EditCondition="Mode==EKnobMode::Switch", EditConditionHides))
    //FSlateBrush SwitchBrush;
 
    //TODO: Allow KnobLogic to add texture or material in decorator. Add option like center offset, size, opacity, etc.
 
    //TODO: Preview in editor
 
protected:
    UPROPERTY()
    TWeakObjectPtr<UComponentDecorator> KnobLayerRef;
    
private:
    // Knob layer rotation
    float CurrentKnobArtRotation;
 
    // Knob Raw input
    float CurrentKnobLogicRotation;
 
    FVector2D CurrentOffset;
    FVector2D PreviousOffset;
 
    TArray<float> SwitchDesiredPositions;
 
    float StartKnobRotation;
 
    FVector2D PressOffset;
};