PixoVRHand.h

Go to the documentation of this file.

// Copyright(c) Pixo Group. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "GripMotionControllerComponent.h"
#include "PixoVRGripInterface.h"
#include "GameFramework/Actor.h"
#include "Components/SphereComponent.h"
#include "Components/SplineComponent.h"
#include "Components/WidgetComponent.h"
#include "Components/WidgetInteractionComponent.h"
#include "Sound/SoundCue.h"
#include "PixoVRHand.generated.h"
 
class APixoVRCharacter;
 
struct FOverlappingInfo
{
    FOverlappingInfo()
        : OverlapActor(nullptr)
        , OverlapComponent(nullptr)
        , Socket(NAME_None)
    {}
 
    AActor* OverlapActor;
    UPrimitiveComponent* OverlapComponent;
    FName Socket;
};
 
USTRUCT(BlueprintType, Category = "Animation")
struct FFingerData
{
    GENERATED_BODY()
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    float Thumb;
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    float Index;
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    float Middle;
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    float Ring;
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    float Pinky;
};
 
UENUM(BlueprintType, Category = "Animation")
enum class EGrippableTypeChecker: uint8
{
    Default UMETA(DisplayName = "No Checker"),
    StoryObject UMETA(DisplayName = "Object is using Story Object Interface"),
    StoryActive UMETA(DisplayName = "Object is using Is Object Active"),
    VRGrip UMETA(DisplayName = "Object is using VRGrip Interface"),
};
 
UCLASS()
class PIXOCORE_API APixoVRHand : public AActor, public IPixoVRGripInterface
{
    GENERATED_BODY()
    
public: 
    // Sets default values for this actor's properties
    APixoVRHand();
 
    //Hands component
    UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Components")
    USceneComponent* Root;
    UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Components")
    UGripMotionControllerComponent* MotionController;
    UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Components")
    USphereComponent* GrabSphere;
    UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Components")
    USkeletalMeshComponent* HandMesh;
    UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Components")
    UStaticMeshComponent* LaserMesh;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Components")
    USplineComponent* ThumbSpline;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Components")
    USplineComponent* IndexSpline;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Components")
    USplineComponent* MiddleSpline;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Components")
    USplineComponent* RingSpline;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Components")
    USplineComponent* PinkySpline;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Components")
    UWidgetInteractionComponent* TouchComponent;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Components")
    UChildActorComponent* WristMenu;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Components")
    bool IsWristMenuEnabled = false;
    
    UFUNCTION()
    void GrabObject();
    UFUNCTION()
    void ReleaseObject();
    UFUNCTION()
    void ManuallyPutActorToHand(AActor* ActorRef);
    UFUNCTION()
    void OnObjectOutOfRange(const FBPActorGripInformation& GripInformation, float Distance);
    UFUNCTION(BlueprintCallable, Category = "TouchWidget")
    void OnTouchWidget(UWidgetComponent* WidgetComponent, UWidgetComponent* PreviousWidgetComponent);
    UFUNCTION(BlueprintCallable, Category = "TouchWidget")
    void DeactivateTouchCooldown();
    UFUNCTION()
    void ReleaseHeldObjectOnOtherHand(AActor* HeldActor);
    UPROPERTY(BlueprintReadOnly, Replicated, Category = "PixoVR")
    UObject* HandHoldingObject;
 
    UFUNCTION(BlueprintCallable)
    void ToggleLaser(bool Visible);
    UPROPERTY()
    USoundCue* LaserSound;
 
    //Advance grab animation
    UFUNCTION(BlueprintCallable, Category = "Animation")
    TArray<FVector> GetRelativePointsArray(USplineComponent* FingerSpline, float Precision);
    UFUNCTION(BlueprintCallable, Category = "Animation")
    float TraceFingerForObstacle(TArray<FVector> RelativePointsArray);
    UFUNCTION(BlueprintCallable, Category = "Animation")
    void SetupFingerTracePoints();
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Replicated, Category = "Animation")
    FFingerData FingerData;
    UFUNCTION(BlueprintCallable, Category = "Animation")
    void UpdateFingerData();
 
    UPROPERTY(BlueprintReadWrite, Category = "Animation")
    bool UseCustomAnimation = false; 
 
    UPROPERTY(EditDefaultsOnly, Category = "Animation")
    bool ChangeHandAnimationNearInteractableObject = false;
    UPROPERTY(EditDefaultsOnly, Category = "Animation", meta = (EditCondition = "ChangeHandAnimationNearInteractableObject == true", EditConditionHides))
    EGrippableTypeChecker GrippableTypeChecker = EGrippableTypeChecker::Default;
    UPROPERTY(EditDefaultsOnly, Category = "Animation", meta = (EditCondition = "ChangeHandAnimationNearInteractableObject == true", EditConditionHides))
    bool IsObjectHighlightActive = false;
    bool InteractableObjectNearHand = false;
    AActor* OverlapedActor = nullptr;
 
    TArray<FVector> ThumbPositionCache;
    TArray<FVector> IndexPositionCache;
    TArray<FVector> MiddlePositionCache;
    TArray<FVector> RingPositionCache;
    TArray<FVector> PinkyPositionCache;
 
    void GetOverlappingActor(FOverlappingInfo& OverlappingInfo);
protected:
    // Called when the game starts or when spawned
    virtual void BeginPlay() override;
 
    bool TouchComponentCooldownActive;
 
public: 
    // Called every frame
    virtual void Tick(float DeltaTime) override;
 
    // Initialization
    void InitPixoVRHands(EControllerHand MotionSource, APixoVRCharacter* Character);
 
    UFUNCTION(BlueprintCallable, Category = "WristMenu")
    void SetWristMenuEnabled(bool Enabled);
 
    UPROPERTY(BlueprintReadWrite, Category = "Init", meta = (ExposeOnSpawn = "true"))
    EControllerHand HandMotionSource;
 
    UPROPERTY(BlueprintReadWrite, Category = "Init")
    APixoVRCharacter* OwningCharacter;
};