PhysicalAnimationComponent.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 "EngineDefines.h"
#include "PhysicsEngine/ConstraintInstance.h"
#include "PhysicalAnimationComponent.generated.h"
 
class FPrimitiveDrawInterface;
class USkeletalMeshComponent;
 
USTRUCT(BlueprintType)
struct FPhysicalAnimationData
{
    GENERATED_BODY()
 
    FPhysicalAnimationData()
        : BodyName(NAME_None)
        , bIsLocalSimulation(true)
        , OrientationStrength(0.f)
        , AngularVelocityStrength(0.f)
        , PositionStrength(0.f)
        , VelocityStrength(0.f)
        , MaxLinearForce(0.f)
        , MaxAngularForce(0.f)
    {
    }
 
    UPROPERTY()
    FName BodyName;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = PhysicalAnimation)
    uint8 bIsLocalSimulation : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = PhysicalAnimation)
    float OrientationStrength;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = PhysicalAnimation)
    float AngularVelocityStrength;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = PhysicalAnimation)
    float PositionStrength;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = PhysicalAnimation)
    float VelocityStrength;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = PhysicalAnimation)
    float MaxLinearForce;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = PhysicalAnimation)
    float MaxAngularForce;
};
 
UCLASS(meta = (BlueprintSpawnableComponent), ClassGroup = Physics, Experimental, MinimalAPI)
class UPhysicalAnimationComponent : public UActorComponent
{
    GENERATED_UCLASS_BODY()
 
public:
    UFUNCTION(BlueprintCallable, Category = PhysicalAnimation)
    ENGINE_API void SetSkeletalMeshComponent(USkeletalMeshComponent* InSkeletalMeshComponent);
 
    UFUNCTION(BlueprintCallable, Category = PhysicalAnimation, meta = (UnsafeDuringActorConstruction))
    ENGINE_API void ApplyPhysicalAnimationSettings(FName BodyName, const FPhysicalAnimationData& PhysicalAnimationData);
 
    UFUNCTION(BlueprintCallable, Category = PhysicalAnimation, meta = (UnsafeDuringActorConstruction))
    ENGINE_API void ApplyPhysicalAnimationSettingsBelow(FName BodyName, const FPhysicalAnimationData& PhysicalAnimationData, bool bIncludeSelf = true);
 
    UFUNCTION(BlueprintCallable, Category = PhysicalAnimation)
    ENGINE_API void SetStrengthMultiplyer(float InStrengthMultiplyer);
    
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = PhysicalAnimation, meta = (ClampMin = "0"))
    float StrengthMultiplyer;
 
    UFUNCTION(BlueprintCallable, Category = PhysicalAnimation, meta = (UnsafeDuringActorConstruction))
    ENGINE_API void ApplyPhysicalAnimationProfileBelow(FName BodyName, FName ProfileName, bool bIncludeSelf = true, bool bClearNotFound = false);
 
    UFUNCTION(BlueprintCallable, Category = PhysicalAnimation, meta = (UnsafeDuringActorConstruction))
    ENGINE_API FTransform GetBodyTargetTransform(FName BodyName) const;
 
    ENGINE_API virtual void InitializeComponent() override;
    ENGINE_API virtual void BeginDestroy() override;
    ENGINE_API virtual void TickComponent(float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction *ThisTickFunction) override;
 
#if WITH_EDITOR
    ENGINE_API void DebugDraw(FPrimitiveDrawInterface* PDI) const;
#endif
 
    USkeletalMeshComponent* GetSkeletalMesh() const { return SkeletalMeshComponent; }
 
private:
    UPROPERTY()
    TObjectPtr<USkeletalMeshComponent> SkeletalMeshComponent;
 
    struct FPhysicalAnimationInstanceData
    {
        struct FConstraintInstance* ConstraintInstance;
        FPhysicsActorHandle TargetActor;
    };
 
    TArray<FPhysicalAnimationInstanceData> RuntimeInstanceData;
    TArray<FPhysicalAnimationData> DriveData;
 
    FDelegateHandle OnTeleportDelegateHandle;
 
    ENGINE_API void UpdatePhysicsEngine();
    ENGINE_API void UpdatePhysicsEngineImp();
    ENGINE_API void ReleasePhysicsEngine();
    ENGINE_API void InitComponent();
 
    ENGINE_API void OnTeleport();
    ENGINE_API void UpdateTargetActors(ETeleportType TeleportType);
 
    static ENGINE_API const FConstraintProfileProperties PhysicalAnimationProfile;
 
    bool bPhysicsEngineNeedsUpdating;
};