MotionRecognizer.h

Go to the documentation of this file.

// Copyright Lost in Game Studio. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Components/ActorComponent.h"
#include "MotionRecognizer.generated.h"
 
UENUM(BlueprintType)
enum class EShake : uint8
{
    Horizontal,
    Vertical,
    BackAndForth
};
 
UENUM(BlueprintType)
enum class EAccelerationType : uint8
{
    None UMETA(Hidden),
    
    //Quick acceleration to the left
    Left,
 
    //Quick acceleration to the right
    Right,
 
    //Quick forward acceleration (device moves away from you)
    Forward,
 
    //Quick acceleration backwards (device moves closer to you)
    Backward,
 
    //Quick upward acceleration 
    Up,
 
    //Quick downward acceleration
    Down
};
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_FiveParams(FOnSimpleMotionDelegate, int32, PlayerIndex, FVector, Acceleration, FVector, Gravity, FVector, RotationRate, FVector, Tilt);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnShakeMotionDelegate, int32, PlayerIndex, EShake, ShakeType);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnQuickAccelerationDelegate, int32, PlayerIndex, EAccelerationType, Type );
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnMotionDelegate, int32, PlayerIndex, FVector, Value);

UCLASS(ClassGroup=(TouchInterfaceDesigner), meta=(BlueprintSpawnableComponent))
class TOUCHINTERFACE_API UMotionRecognizer : public UActorComponent
{
    GENERATED_BODY()
 
public:
    // Sets default values for this component's properties
    UMotionRecognizer();
 
protected:
    // Called when the game starts
    virtual void BeginPlay() override;
 
public:
    // Called every frame
    virtual void TickComponent(float DeltaTime, ELevelTick TickType, FActorComponentTickFunction* ThisTickFunction) override;
 
    // Calibrate tilt
    UFUNCTION(Category="Motion Manager", BlueprintCallable)
    virtual void Calibrate();
    
    // Tries to counteract the parasitic rotation of the sensor
    //UFUNCTION(Category="Motion Manager", BlueprintCallable)
    //virtual void StabilizeGyroscope();
 
    UFUNCTION(Category="Motion Manager", BlueprintCallable)
    virtual void Recenter(const bool bRememberOffset, const FRotator CurrentOffset);
 
private:
    void QuickAccDetector();
    void ShakeDetector();
    void MotionBasedRotation(const float DeltaTime);
    
public:
    UPROPERTY(Category="Input", EditAnywhere, BlueprintReadOnly)
    TEnumAsByte<EAutoReceiveInput::Type> AutoReceiveInput;
 
    
    UPROPERTY(Category="Quick Acceleration", EditAnywhere, BlueprintReadWrite)
    float QuickAccelerationThreshold;

    UPROPERTY(Category="Quick Acceleration", EditAnywhere, BlueprintReadWrite, meta=(ClampMin=0.25f))
    float DelayBetweenQuickAccDetection;
 
    
    UPROPERTY(Category="Shake", EditAnywhere, BlueprintReadWrite)
    float ShakeDetectionThreshold;
    
    UPROPERTY(Category="Shake", EditAnywhere, BlueprintReadWrite, meta=(ClampMin=0.25f))
    float ShakeAllowedTime;

    UPROPERTY(Category="Shake", EditAnywhere, BlueprintReadWrite)
    uint8 bCallShakeEachFrame:1;
    

    UPROPERTY(Category="Motion Based Rotation", EditAnywhere, BlueprintReadWrite)
    float TurnRate;
 
    //TODO: Useful param if motion manager drive the camera rotation directly
    //UPROPERTY(Category="Motion Based Rotation", EditAnywhere, BlueprintReadWrite)
    //uint8 bAllowRoll:1;

    UPROPERTY(Category="Motion Based Rotation", EditAnywhere, BlueprintReadWrite)
    uint8 bInvertAxis:1;
    
    UPROPERTY(Category="Motion Based Rotation", EditAnywhere, BlueprintReadWrite)
    uint8 bLimitRotation:1;
    
    UPROPERTY(Category="Motion Based Rotation", EditAnywhere, BlueprintReadWrite)
    FVector MaxAmplitude;

    uint8 bRememberLimit:1;
    
 
    // EVENT
    
    UPROPERTY(Category="Motion Manager", BlueprintAssignable)
    FOnSimpleMotionDelegate OnIMUInputState;

    UPROPERTY(Category="Motion Manager", BlueprintAssignable)
    FOnQuickAccelerationDelegate OnQuickAcceleration;
    
    UPROPERTY(Category="Motion Manager", BlueprintAssignable)
    FOnShakeMotionDelegate OnShakeStart;
 
    UPROPERTY(Category="Motion Manager", BlueprintAssignable)
    FOnShakeMotionDelegate OnShaking;
 
    UPROPERTY(Category="Motion Manager", BlueprintAssignable)
    FOnShakeMotionDelegate OnShakeEnd;

    UPROPERTY(Category="Motion Manager", BlueprintAssignable)
    FOnMotionDelegate OnMotionBasedRotation;
    
private:
    EAccelerationType GetAccelerationType(float Threshold) const;
    
    UPROPERTY()
    APlayerController* PlayerController;
 
    FVector Tilt;
    FVector LastTilt;
    FVector Gravity;
    FVector RotationRate;
    FVector Acceleration;
 
    TArray<FVector> TiltValues;
 
    uint8 bCanDetectTap:1;
    uint8 bShakeDetected:1;
    uint8 bAccelerationDetected:1;
 
    FTimerHandle TapDetectorTimerHandle;
    FTimerHandle StabilizationTimerHandle;
    FTimerHandle ShakeTimerHandle;
 
    double CurrentTime;
    double LastQuickAccTime;
 
    int32 ShakeAccCount;
    
    EAccelerationType ShakeNextDirectionExpected;
    EShake CurrentShake;
    EShake ShakeDirectionExpected;
 
    float LastAccelerationZ;
 
    FRotator CameraRotation;
};