PhysicsHandleComponent.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Components/ActorComponent.h"
#include "PhysicsEngine/ConstraintInstance.h"
#include "PhysicsHandleComponent.generated.h"
 
UCLASS(collapsecategories, ClassGroup=Physics, hidecategories=Object, meta=(BlueprintSpawnableComponent), MinimalAPI)
class UPhysicsHandleComponent : public UActorComponent
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY()
    TObjectPtr<class UPrimitiveComponent> GrabbedComponent;
 
    FName GrabbedBoneName;
 
    uint32 bRotationConstrained:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=PhysicsHandle)
    uint32 bSoftAngularConstraint : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = PhysicsHandle)
    uint32 bSoftLinearConstraint : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = PhysicsHandle)
    uint32 bInterpolateTarget : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=PhysicsHandle, meta = (EditCondition = "bSoftLinearConstraint"))
    float LinearDamping;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=PhysicsHandle, meta = (EditCondition = "bSoftLinearConstraint"))
    float LinearStiffness;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=PhysicsHandle, meta = (EditCondition = "bSoftAngularConstraint"))
    float AngularDamping;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=PhysicsHandle, meta = (EditCondition = "bSoftAngularConstraint"))
    float AngularStiffness;
 
    FTransform TargetTransform;
    FTransform CurrentTransform;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=PhysicsHandle, meta = (EditCondition = "bInterpolateTarget"))
    float InterpolationSpeed;
 
 
protected:
 
    FTransform PreviousTransform;
    bool bPendingConstraint;
 
    FPhysicsUserData PhysicsUserData;
    FConstraintInstance ConstraintInstance;
    FPhysicsActorHandle GrabbedHandle;
    FPhysicsActorHandle KinematicHandle;
    FPhysicsConstraintHandle ConstraintHandle;
    FVector ConstraintLocalPosition; // Position of constraint in the grabbed body local space (updated when grabbing)
    FRotator ConstraintLocalRotation;
 
    //~ Begin UActorComponent Interface.
    ENGINE_API virtual void OnUnregister() override;
    ENGINE_API virtual void TickComponent(float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction *ThisTickFunction) override;
    //~ End UActorComponent Interface.
 
public:
 
    UE_DEPRECATED(4.14, "Please use GrabComponentAtLocation or GrabComponentAtLocationWithRotation")
    UFUNCTION(BlueprintCallable, Category="Physics|Components|PhysicsHandle", meta = (DeprecatedFunction, DeprecationMessage = "Please use GrabComponentAtLocation or GrabComponentAtLocationWithRotation"))
    ENGINE_API virtual void GrabComponent(class UPrimitiveComponent* Component, FName InBoneName, FVector GrabLocation, bool bConstrainRotation);
 
    UFUNCTION(BlueprintCallable, Category = "Physics|Components|PhysicsHandle")
    ENGINE_API void GrabComponentAtLocation(class UPrimitiveComponent* Component, FName InBoneName, FVector GrabLocation);
 
    UFUNCTION(BlueprintCallable, Category = "Physics|Components|PhysicsHandle")
    ENGINE_API void GrabComponentAtLocationWithRotation(class UPrimitiveComponent* Component, FName InBoneName, FVector Location, FRotator Rotation);
 
    UFUNCTION(BlueprintCallable, Category="Physics|Components|PhysicsHandle")
    ENGINE_API virtual void ReleaseComponent();
 
    UFUNCTION(BlueprintCallable, Category = "Physics|Components|PhysicsHandle")
    ENGINE_API class UPrimitiveComponent* GetGrabbedComponent() const;
 
    UFUNCTION(BlueprintCallable, Category="Physics|Components|PhysicsHandle")
    ENGINE_API void SetTargetLocation(FVector NewLocation);
 
    UFUNCTION(BlueprintCallable, Category="Physics|Components|PhysicsHandle")
    ENGINE_API void SetTargetRotation(FRotator NewRotation);
 
    UFUNCTION(BlueprintCallable, Category="Physics|Components|PhysicsHandle")
    ENGINE_API void SetTargetLocationAndRotation(FVector NewLocation, FRotator NewRotation);
 
    UFUNCTION(BlueprintCallable, Category="Physics|Components|PhysicsHandle")
    ENGINE_API void GetTargetLocationAndRotation(FVector& TargetLocation, FRotator& TargetRotation) const;
 
    UFUNCTION(BlueprintCallable, Category = "Physics|Components|PhysicsHandle")
    ENGINE_API void SetLinearDamping(float NewLinearDamping);
 
    UFUNCTION(BlueprintCallable, Category = "Physics|Components|PhysicsHandle")
    ENGINE_API void SetLinearStiffness(float NewLinearStiffness);
 
    UFUNCTION(BlueprintCallable, Category = "Physics|Components|PhysicsHandle")
    ENGINE_API void SetAngularDamping(float NewAngularDamping);
 
    UFUNCTION(BlueprintCallable, Category = "Physics|Components|PhysicsHandle")
    ENGINE_API void SetAngularStiffness(float NewAngularStiffness);
 
    UFUNCTION(BlueprintCallable, Category = "Physics|Components|PhysicsHandle")
    ENGINE_API void SetInterpolationSpeed(float NewInterpolationSpeed);
 
protected:
    ENGINE_API virtual void UpdateHandleTransform(const FTransform& NewTransform);
 
    ENGINE_API virtual void UpdateDriveSettings();
 
    ENGINE_API virtual void GrabComponentImp(class UPrimitiveComponent* Component, FName InBoneName, const FVector& Location, const FRotator& Rotation, bool bRotationConstrained);
 
};