VRGripInterface.h

Go to the documentation of this file.

// Fill out your copyright notice in the Description page of Project Settings.
 
#pragma once
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/ScriptMacros.h"
#include "VRBPDatatypes.h"
#include "GripScripts/VRGripScriptBase.h"
#include "UObject/Interface.h"
 
#include "VRGripInterface.generated.h"
 
// Forward declare
class UGripMotionControllerComponent;
 
UINTERFACE(Blueprintable)
class VREXPANSIONPLUGIN_API UVRGripInterface: public UInterface
{
    GENERATED_UINTERFACE_BODY()
};
 
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FVROnGripSignature, UGripMotionControllerComponent *, GrippingController, const FBPActorGripInformation&, GripInformation);
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_ThreeParams(FVROnDropSignature, UGripMotionControllerComponent*, GrippingController, const FBPActorGripInformation&, GripInformation, bool, bWasSocketed);
 
class VREXPANSIONPLUGIN_API IVRGripInterface
{
    GENERATED_IINTERFACE_BODY()
 
public:
 
    // Set up as deny instead of allow so that default allows for gripping
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface", meta = (DisplayName = "IsDenyingGrips"))
        bool DenyGripping(UGripMotionControllerComponent * GripInitiator = nullptr);
 
    // How an interfaced object behaves when teleporting
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
        EGripInterfaceTeleportBehavior TeleportBehavior();
 
    // Should this object simulate on drop
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
        bool SimulateOnDrop();
 
    // Grip type to use
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
        EGripCollisionType GetPrimaryGripType(bool bIsSlot);
 
    // Double Grip Type
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
        ESecondaryGripType SecondaryGripType();
 
    // Define the late update setting
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
        EGripLateUpdateSettings GripLateUpdateSetting();
 
    // Define which movement repliation setting to use
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
        EGripMovementReplicationSettings GripMovementReplicationType();
 
    // What grip stiffness and damping to use if using a physics constraint
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
    void GetGripStiffnessAndDamping(float &GripStiffnessOut, float &GripDampingOut);
 
    // Get the advanced physics settings for this grip
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
        FBPAdvGripSettings AdvancedGripSettings();
 
    // What distance to break a grip at (only relevent with physics enabled grips
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
        float GripBreakDistance();
 
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
        void ClosestGripSlotInRange(FVector WorldLocation, bool bSecondarySlot,  bool & bHadSlotInRange, FTransform & SlotWorldTransform, FName & SlotName, UGripMotionControllerComponent * CallingController = nullptr, FName OverridePrefix = NAME_None);
 
    // Events that can be called for interface inheriting actors
 
    // Event triggered each tick on the interfaced object when gripped, can be used for custom movement or grip based logic
    UFUNCTION(BlueprintNativeEvent, Category = "VRGripInterface")
        void TickGrip(UGripMotionControllerComponent * GrippingController, const FBPActorGripInformation & GripInformation, float DeltaTime);
 
    // Event triggered on the interfaced object when gripped
    UFUNCTION(BlueprintNativeEvent, Category = "VRGripInterface")
        void OnGrip(UGripMotionControllerComponent * GrippingController, const FBPActorGripInformation & GripInformation);
 
    // Event triggered on the interfaced object when grip is released
    UFUNCTION(BlueprintNativeEvent, Category = "VRGripInterface")
        void OnGripRelease(UGripMotionControllerComponent * ReleasingController, const FBPActorGripInformation & GripInformation, bool bWasSocketed = false);
 
    virtual void Native_NotifyThrowGripDelegates(UGripMotionControllerComponent* Controller, bool bGripped, const FBPActorGripInformation& GripInformation, bool bWasSocketed = false);
 
    // Event triggered on the interfaced object when child component is gripped
    UFUNCTION(BlueprintNativeEvent, Category = "VRGripInterface")
        void OnChildGrip(UGripMotionControllerComponent * GrippingController, const FBPActorGripInformation & GripInformation);
 
    // Event triggered on the interfaced object when child component is released
    UFUNCTION(BlueprintNativeEvent, Category = "VRGripInterface")
        void OnChildGripRelease(UGripMotionControllerComponent * ReleasingController, const FBPActorGripInformation & GripInformation, bool bWasSocketed = false);
 
    // Event triggered on the interfaced object when secondary gripped
    UFUNCTION(BlueprintNativeEvent, Category = "VRGripInterface")
        void OnSecondaryGrip(UGripMotionControllerComponent * GripOwningController, USceneComponent * SecondaryGripComponent, const FBPActorGripInformation & GripInformation);
 
    // Event triggered on the interfaced object when secondary grip is released
    UFUNCTION(BlueprintNativeEvent, Category = "VRGripInterface")
        void OnSecondaryGripRelease(UGripMotionControllerComponent * GripOwningController, USceneComponent * ReleasingSecondaryGripComponent, const FBPActorGripInformation & GripInformation);
 
    // Interaction Functions
 
    // Call to use an object
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
        void OnUsed();
        
    // Call to stop using an object
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
        void OnEndUsed();
 
    // Call to use an object
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
        void OnSecondaryUsed();
 
    // Call to stop using an object
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
        void OnEndSecondaryUsed();
 
    // Call to send an action event to the object
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
        void OnInput(FKey Key, EInputEvent KeyEvent);
        
    // Check if an object allows multiple grips at one time
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
        bool AllowsMultipleGrips();
 
    // Returns if the object is held and if so, which controllers are holding it
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
        void IsHeld(TArray<FBPGripPair> & HoldingControllers, bool & bIsHeld);
 
    // Sets is held, used by the plugin
    UFUNCTION(BlueprintNativeEvent, /*BlueprintCallable,*/ Category = "VRGripInterface")
        void SetHeld(UGripMotionControllerComponent * HoldingController, uint8 GripID, bool bIsHeld);
 
    // Returns if the object requests to be socketed to something
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
        bool RequestsSocketing(USceneComponent *& ParentToSocketTo, FName & OptionalSocketName, FTransform_NetQuantize & RelativeTransform);
 
    // Get grip scripts
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
        bool GetGripScripts(TArray<UVRGripScriptBase*>& ArrayReference);
};