PixoVRToolBase.h

Go to the documentation of this file.

// Copyright(c) Pixo Group. All Rights Reserved.
 
#pragma once
 
#include "PixoVRGripInterface.h"
#include "CoreMinimal.h"
#include "Interfaces/PixoVRToolInterface.h"
#include "PixoVRToolBase.generated.h"
 
class USoundBase;
class UBoxComponent;
class UStaticMeshComponent;
class UAudioComponent;
class USoundAttenuation;
 
DECLARE_MULTICAST_DELEGATE_OneParam(FGripAction, bool );
 
UCLASS(Blueprintable, ClassGroup = ToolMenu)
class PIXOCORE_API APixoVRToolBase : public AActor, public IVRGripInterface, public IPixoVRGripInterface, public IPixoVRToolInterface
{
    GENERATED_BODY()
    
public: 
    APixoVRToolBase();
 
protected:
    virtual void BeginPlay() override;
    virtual void Tick(float DeltaSeconds) override;
 
    UFUNCTION()
    virtual void OnOverlapBegin(UPrimitiveComponent* OverlappedComp, AActor* OtherActor, UPrimitiveComponent* OtherComp, int32 OtherBodyIndex, bool FromSweep, const FHitResult& SweepResult);
 
    UFUNCTION(Server, Reliable, WithValidation)
    void ServerStartPlayingSound(USoundBase* Sound, const FVector& SoundLocation, float VolumeMultiplier = 1.0f);
 
    UFUNCTION(Server, Reliable, WithValidation)
    void ServerStopPlayingSound(USoundBase* Sound);
    
    UFUNCTION(Server, Reliable, WithValidation)
    void ServerStartPlayingSoundViaComponent(USoundBase* Sound, float VolumeMultiplier = 1.0f);
    
    UFUNCTION(Server, Reliable, WithValidation)
    void ServerStopPlayingSoundViaComponent();
    
    UFUNCTION(Server, Reliable, WithValidation)
    void ServerAdjustPlayingSoundVolumeViaComponent(float InVolumeMultiplier = 1.0f);
    
    UFUNCTION(Server, Reliable, WithValidation)
    void ServerOnDropped();
    
    bool IsRightHand(UGripMotionControllerComponent* GrippingController) const;
 
public:
    
    virtual void GetLifetimeReplicatedProps(TArray<FLifetimeProperty>& OutLifetimeProps) const override;
 
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVRToolbox | Tools")
    bool IsDestroyable();
 
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVRToolbox | Tools")
    void HandleDestroy();
 
    UFUNCTION(BlueprintCallable, Category = Tool)
    bool IsGripped();
    
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVRToolbox | Tools")
    void InitializeTool(const FPixoToolData& InToolData);
    virtual void InitializeTool_Implementation(const FPixoToolData& InToolData) override;
    
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")
    bool DenyGrippingPixoVR(UGripMotionControllerComponent* GrippingController);
    virtual bool DenyGrippingPixoVR_Implementation(UGripMotionControllerComponent* GrippingController) override;
 
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")
    bool DenyTriggerGripping();
    virtual bool DenyTriggerGripping_Implementation() override;
 
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")
    bool DenyDropping();
    virtual bool DenyDropping_Implementation() override;
 
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")
    void OnGripObject(UGripMotionControllerComponent* GrippingController, AActor* GrippedActor);
    virtual void OnGripObject_Implementation(UGripMotionControllerComponent* GrippingController, AActor* GrippedActor) override;
 
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")
    void OnTryGripObject(UGripMotionControllerComponent* GrippingController, AActor* GrippedActor);
    virtual void OnTryGripObject_Implementation(UGripMotionControllerComponent* GrippingController, AActor* GrippedActor) override;
 
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")
    void OnGripObjectRelease(UGripMotionControllerComponent* GrippingController, AActor* GrippedActor);
    virtual void OnGripObjectRelease_Implementation(UGripMotionControllerComponent* GrippingController, AActor* GrippedActor) override;
 
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")
    void GripTriggerMode(EPixoVRGripTriggerModeEnum& GripTriggerMode);
    virtual void GripTriggerMode_Implementation(EPixoVRGripTriggerModeEnum& GripTriggerMode) override;
 
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")
    void GripTriggerTransform(UGripMotionControllerComponent* GrippingController, bool& bUseCustomTransform, FTransform& CustomTransform);
    virtual void GripTriggerTransform_Implementation(UGripMotionControllerComponent* GrippingController, bool& bUseCustomTransform, FTransform& CustomTransform) override;
 
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")
    void GripMode(EPixoVRGripModeEnum& GripMode);
    virtual void GripMode_Implementation(EPixoVRGripModeEnum& GripMode) override;
 
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")
    bool DisablePhysicsOnDrop();
    virtual bool DisablePhysicsOnDrop_Implementation() override;
 
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")
    void OnObjectPaused();
    virtual void OnObjectPaused_Implementation() override;
 
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")
    void OnObjectUnPaused();
    virtual void OnObjectUnPaused_Implementation() override;
    
    bool DestroyOnExit() { return bDestroyOnExit; }
    bool CanExitsWithoutOwner() const { return ToolData.CanExistWithoutOwner; }
 
private:
    UFUNCTION(NetMulticast, Reliable)
    void MulticastStartPlayingSound(USoundBase* Sound, const FVector& SoundLocation, float VolumeMultiplier);
 
    UFUNCTION(NetMulticast, Reliable)
    void MulticastStopPlayingSound(USoundBase* Sound);
    
    UFUNCTION(NetMulticast, Reliable)
    void MulticastStartPlayingSoundViaComponent(USoundBase* Sound, float VolumeMultiplier);
 
    UFUNCTION(NetMulticast, Reliable)
    void MulticastStopPlayingSoundViaComponent();
 
    UFUNCTION(NetMulticast, Reliable)
    void MulticastAdjustPlayingSoundVolumeViaComponent(float InVolumeMultiplier);
 
    UFUNCTION(NetMulticast, Reliable)
    void MulticastToggleCollision(ECollisionEnabled::Type Type);
 
    UFUNCTION(Server, Reliable, WithValidation)
    void ServerUseTool(UGripMotionControllerComponent* GrippingController, AActor* GrippedActor);
 
    UFUNCTION(Server, Reliable, WithValidation)
    void ServerDestroyTool();
 
    USoundAttenuation* GetDefaultAttenuationSettings();
 
protected:
#pragma region Components
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category = Tool)
    UStaticMeshComponent* ToolMeshComponent;
 
    UPROPERTY(VisibleAnywhere, Category = Tool)
    UBoxComponent* GrabBoxComponent;
 
    UPROPERTY(VisibleAnywhere, Category = Tool)
    UAudioComponent* AudioComponent;
 
    UPROPERTY()
    USoundAttenuation* DefaultAttenuationSettings;
 
#pragma endregion Components
 
#pragma region Variables
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = GripBehavior)
    USoundBase* GripSound;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = DropBehavior)
    bool bDestroyOnDrop;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = DropBehavior)
    bool bDestroyOnExit;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = DropBehavior)
    float DestroyDelay;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = DropBehavior)
    bool bAdvancedDrop;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = GripBehavior)
    bool bToggleCollisionOnUsage;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = TransformOffset)
    FTransform RightHandGrip;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = TransformOffset)
    FTransform LeftHandGrip;
#pragma endregion Variables
 
#pragma region State
    UPROPERTY(Replicated, BlueprintReadOnly, Category = ToolData)
    FPixoToolData ToolData;
 
    UPROPERTY(Replicated, BlueprintReadOnly, Category = GripBehavior)
    EControllerHand GrabHand;
 
    UPROPERTY(Replicated, BlueprintReadOnly, Category = GripBehavior)
    bool bIsGripped;
 
    UPROPERTY(BlueprintReadOnly, Category = GripBehavior)
    bool bIsGripAllowed;
 
    FGripAction OnGripAction;
 
    UPROPERTY(Replicated, BlueprintReadOnly, Category = ToolBehavior)
    bool bIsPaused;
 
    struct  
    {
        bool bIsPendingKill;
        float TimeBeforeKilled;
    } DestroyState;
 
#pragma endregion State
};