BaseGrippableStoryActor.h

Go to the documentation of this file.

// Copyright(c) Pixo Group. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "BaseStoryActor.h"
#include "PixoVRHand.h"
#include "Grippables/GrippableActor.h"
#include "Interfaces/GripResponseAnimationInterface.h"
#include "BaseGrippableStoryActor.generated.h"
 
class ABaseGrippableStoryActor;
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnActorStopped, ABaseGrippableStoryActor*, GrippableStoryActor);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnActorPositionReset, ABaseGrippableStoryActor*, GrippableStoryActor);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnDroppedActorDeleted, UClass*, DeletedClass);
 
UENUM(BlueprintType)
enum class EHandGripLogic : uint8
{
    AttachToHand UMETA("AttachToHand"),
    AttachToHandWithCustomTransform UMETA("AttachToHandWithCustomTransform"),
    CustomTransformAttachWithPhysics UMETA("CustomTransformAttachWithPhysics"),
    OnlyOnGripEvent UMETA("TriggerOnlyOnGripEvent"),
    NativeVRGripInterfaceSettings UMETA("NativeVRGripInterfaceSettings")
};
 
UCLASS(Blueprintable)
class PIXOCORE_API ABaseGrippableStoryActor : public ABaseStoryActor, public IVRGripInterface,
                                              public IGripResponseAnimationInterface
{
    GENERATED_BODY()
 
public:
    ABaseGrippableStoryActor();
 
    virtual void BeginPlay() override;
 
    virtual void ObjectActivated_Implementation() override;
    virtual void ObjectDeactivated_Implementation() override;
    virtual void UpdateObjectHighlight_Implementation(bool Activate) override;
 
    virtual void OnGrip_Implementation(UGripMotionControllerComponent* GrippingController,
                                       const FBPActorGripInformation& GripInformation) override;
    virtual void OnGripRelease_Implementation(UGripMotionControllerComponent* ReleasingController,
                                              const FBPActorGripInformation& GripInformation,
                                              bool bWasSocketed) override;
    virtual void OnSecondaryGrip_Implementation(UGripMotionControllerComponent* GripOwningController,
                                                USceneComponent* SecondaryGripComponent,
                                                const FBPActorGripInformation& GripInformation) override;
    virtual void OnSecondaryGripRelease_Implementation(UGripMotionControllerComponent* GripOwningController,
                                                       USceneComponent* ReleasingSecondaryGripComponent,
                                                       const FBPActorGripInformation& GripInformation) override;
    virtual void IsHeld_Implementation(TArray<FBPGripPair>& HoldingControllers, bool& bIsHeld) override;
    virtual void SetHeld_Implementation(UGripMotionControllerComponent* HoldingController, uint8 GripID,
                                        bool bIsHeld) override;
    virtual bool DenyGripping_Implementation(UGripMotionControllerComponent* GripInitiator = nullptr) override;
    virtual EGripInterfaceTeleportBehavior TeleportBehavior_Implementation() override;
    virtual bool SimulateOnDrop_Implementation() override;
    virtual EGripCollisionType GetPrimaryGripType_Implementation(bool bIsSlot) override;
    virtual ESecondaryGripType SecondaryGripType_Implementation() override;
    virtual EGripMovementReplicationSettings GripMovementReplicationType_Implementation() override;
    virtual EGripLateUpdateSettings GripLateUpdateSetting_Implementation() override;
    virtual void GetGripStiffnessAndDamping_Implementation(float& GripStiffnessOut, float& GripDampingOut) override;
    virtual FBPAdvGripSettings AdvancedGripSettings_Implementation() override;
    virtual float GripBreakDistance_Implementation() override;
    virtual void ClosestGripSlotInRange_Implementation(FVector WorldLocation, bool bSecondarySlot,
                                                       bool& bHadSlotInRange, FTransform& SlotWorldTransform,
                                                       FName& SlotName,
                                                       UGripMotionControllerComponent* CallingController = nullptr,
                                                       FName OverridePrefix = NAME_None) override;
    virtual bool AllowsMultipleGrips_Implementation() override;
 
    virtual bool IsGrabbingWrongActorActive_Implementation() override;
    
    virtual void SendWrongGrabbingNotification_Implementation() override;
 
    virtual FTransform GetObjectGrabTransform_Implementation(APixoVRHand* GrabbedHand) override;
 
    UPROPERTY(BlueprintAssignable, Category = "Grip Events")
    FVROnGripSignature OnGripped; 
    UPROPERTY(BlueprintAssignable, Category = "Grip Events")
    FVROnDropSignature OnDropped; 
 
    UPROPERTY(BlueprintAssignable, Category = "Grip Events")
    FVROnGripSignature OnSecondaryGripAdded; 
 
    UPROPERTY(BlueprintAssignable, Category = "Grip Events")
    FVROnGripSignature OnSecondaryGripRemoved; 
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "VRGripInterface")
    FBPInterfaceProperties VRGripInterfaceSettings; 
 
    UFUNCTION(BlueprintImplementableEvent, Category = "Grip Events")
    void OnGrippedEvent(UGripMotionControllerComponent* GrippingController,
                        const FBPActorGripInformation& GripInformation);
    UFUNCTION(BlueprintImplementableEvent, Category = "Grip Events")
    void OnReleasedEvent(UGripMotionControllerComponent* ReleasingController,
                         const FBPActorGripInformation& GripInformation, bool bWasSocketed);
 
    // Different grip behavior
    UFUNCTION(BlueprintCallable, Category = "GrippableObject")
    void UpdateHandGripLogic(EHandGripLogic NewHandGripLogic);
    UFUNCTION(BlueprintCallable, Category = "GrippableObject")
    void AttachToHandObject(UGripMotionControllerComponent* GrippingController,
                            const FBPActorGripInformation& GripInformation);
    UFUNCTION(BlueprintCallable, Category = "GrippableObject")
    void DetachObjectFromHand();
 
    virtual void GrabWithTwoHands_Implementation(UMotionControllerComponent* GrabbingController) override;
    virtual void ReleaseTwoHands_Implementation(UMotionControllerComponent* ReleasingController) override;
    virtual bool IsObjectHeldWithTwoHands_Implementation() override;
    virtual void ResetTwoHandsHoldingFunctionality_Implementation() override;
    virtual void EnableOnePressDetach_Implementation(bool Enable) override;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Two Hands Grip")
    bool ObjectHeldWithTwoHands = false;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = "GrippableObject")
    EHandGripLogic HandGripLogic; 
    UPROPERTY(VisibleInstanceOnly, BlueprintReadWrite, Category = "GrippableObject")
    APixoVRHand* CurrentHoldingHand; 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "GrippableObject")
    FTransform ObjectTransformInLeftHand; 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "GrippableObject")
    FTransform ObjectTransformInRightHand; 
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Components")
    UStaticMeshComponent* StaticMeshComponent;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Feedback Effect")
    bool bGripSoundsEnabled; 
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Feedback Effect", meta = (EditCondition = "bGripSoundsEnabled", EditConditionHides))
    USoundCue* GripSoundCue;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Feedback Effect")
    bool bReleaseSoundsEnabled; 
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Feedback Effect", meta = (EditCondition = "bReleaseSoundsEnabled", EditConditionHides))
    USoundCue* ReleaseSoundCue;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Feedback Effect")
    bool bFeedbackEnabled; 
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Feedback Effect", meta=(EditCondition = "bFeedbackEnabled", EditConditionHides))
    float HapticDuration; 
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Feedback Effect", meta=(EditCondition = "bFeedbackEnabled", EditConditionHides))
    float HapticStrength; 
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "GrippableObject")
    bool StoryActivationAffectsDenyGripping { true }; 
    
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "GrippableObject")
    bool bActivateLocationResetAfterDrop { false }; 
 
    UPROPERTY(BlueprintReadWrite, Category = "GrippableObject")
    bool bCanResetPosition { true }; 
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "GrippableObject")
    bool bDestroyActorAfterFailedDrop { false }; 
    
    UPROPERTY(BlueprintReadOnly, Category = "GrippableObject")
    FTransform ResetTransform; 
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "GrippableObject")
    float PositionResetCheckRate { 0.1f }; 
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "GrippableObject")
    float PositionResetMaximumDelay { 5.0f }; 
 
    UPROPERTY(BlueprintReadWrite, BlueprintCallable, BlueprintAssignable)
    FOnActorStopped OnActorStoppedDelegate; 
 
    UPROPERTY(BlueprintReadWrite, BlueprintCallable, BlueprintAssignable)
    FOnActorStopped OnActorPositionResetDelegate; 
 
    UPROPERTY(BlueprintReadWrite, BlueprintCallable, BlueprintAssignable)
    FOnDroppedActorDeleted OnDroppedActorDeleted; 
 
    UFUNCTION(BlueprintCallable, Category = "GrippableObject")
    void ResetPosition();
 
    UFUNCTION(BlueprintCallable, Category = "GrippableObject")
    void StartPositionResetTimer();
 
    UFUNCTION(BlueprintCallable, Category = "GrippableObject")
    void StopPositionResetTimer();
 
    UFUNCTION()
    void CheckPositionResetConditions();
 
private:
 
    bool bSaveResetTransformOnGrip { true }; 
    
    float TimeSinceResetTimerStarted { 0.0f }; 
 
    FTimerHandle PositionResetTimer; 
    
    void PlayHapticFeedbackEffect(UGripMotionControllerComponent* GripMotionControllerComponent) const;
 
    void PlayGripSound() const;
 
    void PlayReleaseSound() const;
 
    void TwoHandGrab();
    void HandCrossDetection(float CurrentPitch, float RightLeftHandVPitch);
    bool CrossDetected;
    bool CrossChanged;
    float PitchBeforeCross = 0;
    float MoveBackPitchDelta = 0;
    float ResultedPitch = 0;
    TWeakObjectPtr<APixoVRHand> PixoVRHandLeft;
    TWeakObjectPtr<APixoVRHand> PixoVRHandRight;
    float TwoHandZAxisValue = 0.0;
    FTimerHandle TwoHandTimer;
    TWeakObjectPtr<UMotionControllerComponent> TwoHandMainGrabController;
    bool EnableOnePressDetach;
};