BlueprintSpringMathLibrary.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "BlueprintFunctionLibrary.h"
 
#include "BlueprintSpringMathLibrary.generated.h"
 
UCLASS(MinimalAPI, Experimental, meta=(BlueprintThreadSafe))
class UBlueprintSpringMathLibrary : public UBlueprintFunctionLibrary
{
    GENERATED_BODY()
 
public:
    // Simple Spring //
 
    UE_EXPERIMENTAL(5.7, "SpringMath is experimental")
    UFUNCTION(BlueprintCallable, meta=(Category="Math|Spring|Experimental"))
    static ENGINE_API void CriticalSpringDampFloat(UPARAM(ref) float& InOutX, UPARAM(ref) float& InOutV, const float& TargetX, float DeltaTime, float SmoothingTime = 0.2f);
 
    UE_EXPERIMENTAL(5.7, "SpringMath is experimental")
    UFUNCTION(BlueprintCallable, meta = (Category = "Math|Spring|Experimental"))
    static ENGINE_API void CriticalSpringDampAngle(UPARAM(ref) float& InOutAngle, UPARAM(ref) float& InOutAngularVelocity, const float& TargetAngle, float DeltaTime, float SmoothingTime = 0.2f);
 
    UE_EXPERIMENTAL(5.7, "SpringMath is experimental")
    UFUNCTION(BlueprintCallable, meta=(Category="Math|Spring|Experimental"))
    static ENGINE_API void CriticalSpringDampVector(UPARAM(ref) FVector& InOutX, UPARAM(ref) FVector& InOutV, const FVector& TargetX, float DeltaTime, float SmoothingTime = 0.2f);
 
    UE_EXPERIMENTAL(5.7, "SpringMath is experimental")
    UFUNCTION(BlueprintCallable, meta=(Category="Math|Spring|Experimental"))
    static ENGINE_API void CriticalSpringDampVector2D(UPARAM(ref) FVector2D& InOutX, UPARAM(ref) FVector2D& InOutV, const FVector2D& TargetX, float DeltaTime, float SmoothingTime = 0.2f);
 
    UE_EXPERIMENTAL(5.7, "SpringMath is experimental")
    UFUNCTION(BlueprintCallable, meta=(Category="Math|Spring|Experimental"))
    static ENGINE_API void CriticalSpringDampQuat(UPARAM(ref) FQuat& InOutRotation, UPARAM(ref) FVector& InOutAngularVelocity, const FQuat& TargetRotation, float DeltaTime, float SmoothingTime = 0.2f);
 
    UE_EXPERIMENTAL(5.7, "SpringMath is experimental")
    UFUNCTION(BlueprintCallable, meta=(Category="Math|Spring|Experimental"))
    static ENGINE_API void CriticalSpringDampRotator(UPARAM(ref) FRotator& InOutRotation, UPARAM(ref) FVector& InOutAngularVelocity, const FRotator& TargetRotation, float DeltaTime, float SmoothingTime = 0.2f);
 
    UE_EXPERIMENTAL(5.7, "SpringMath is experimental")
    UFUNCTION(BlueprintCallable, meta=(Category="Math|Spring|Experimental"))
    static ENGINE_API void VelocitySpringDampFloat(UPARAM(ref) float& InOutX, UPARAM(ref) float& InOutV, UPARAM(ref) float& InOutVi, float TargetX, float MaxSpeed, float DeltaTime, float SmoothingTime = 0.2f);
 
    UE_EXPERIMENTAL(5.7, "SpringMath is experimental")
    UFUNCTION(BlueprintCallable, meta=(Category="Math|Spring|Experimental"))
    static ENGINE_API void VelocitySpringDampVector(UPARAM(ref) FVector& InOutX, UPARAM(ref) FVector& InOutV, UPARAM(ref) FVector& InOutVi, const FVector& TargetX, float MaxSpeed, float DeltaTime,  float SmoothingTime = 0.2f);
 
    UE_EXPERIMENTAL(5.7, "SpringMath is experimental")
    UFUNCTION(BlueprintCallable, meta=(Category="Math|Spring|Experimental"))
    static ENGINE_API void VelocitySpringDampVector2D(UPARAM(ref) FVector2D& InOutX, UPARAM(ref) FVector2D& InOutV, UPARAM(ref) FVector2D& InOutVi, const FVector2D& TargetX, float MaxSpeed, float DeltaTime,  float SmoothingTime = 0.2f);
 
    // Damper //
 
    UE_EXPERIMENTAL(5.7, "SpringMath is experimental")
    UFUNCTION(BlueprintPure, meta=(Category="Math|Spring|Experimental"))
    static ENGINE_API float DampFloat(float Value, float Target, float DeltaTime, float SmoothingTime = 0.2f);
 
    UE_EXPERIMENTAL(5.7, "SpringMath is experimental")
    UFUNCTION(BlueprintPure, meta = (Category = "Math|Spring|Experimental"))
    static ENGINE_API float DampAngle(float Angle, float TargetAngle, float DeltaTime, float SmoothingTime = 0.2f);
 
    UE_EXPERIMENTAL(5.7, "SpringMath is experimental")
    UFUNCTION(BlueprintPure, meta=(Category="Math|Spring|Experimental"))
    static ENGINE_API FVector DampVector(const FVector& Value, const FVector& Target, float DeltaTime, float SmoothingTime = 0.2f);
 
    UE_EXPERIMENTAL(5.7, "SpringMath is experimental")
    UFUNCTION(BlueprintPure, meta=(Category="Math|Spring|Experimental"))
    static ENGINE_API FVector2D DampVector2D(const FVector2D& Value, const FVector2D& Target, float DeltaTime, float SmoothingTime = 0.2f);
 
    UE_EXPERIMENTAL(5.7, "SpringMath is experimental")
    UFUNCTION(BlueprintPure, meta=(Category="Math|Spring|Experimental"))
    static ENGINE_API FQuat DampQuat(const FQuat& Rotation, const FQuat& TargetRotation, float DeltaTime, float SmoothingTime = 0.2f);
 
    UE_EXPERIMENTAL(5.7, "SpringMath is experimental")
    UFUNCTION(BlueprintPure, meta=(Category="Math|Spring|Experimental"))
    static ENGINE_API FRotator DampRotator(const FRotator& Rotation, const FRotator& TargetRotation, float DeltaTime, float SmoothingTime = 0.2f);
 
    UE_EXPERIMENTAL(5.7, "SpringMath is experimental")
    UFUNCTION(BlueprintCallable, meta=(Category="Math|Spring|Experimental"))
    static ENGINE_API void SpringCharacterUpdate(UPARAM(ref) FVector& InOutPosition, UPARAM(ref) FVector& InOutVelocity, UPARAM(ref) FVector& InOutAcceleration, const FVector& TargetVelocity, float DeltaTime, float SmoothingTime = 0.2f);
 
    UE_EXPERIMENTAL(5.7, "SpringMath is experimental")
    UFUNCTION(BlueprintCallable, meta=(Category="Math|Spring|Experimental"))
    static ENGINE_API void VelocitySpringCharacterUpdate(UPARAM(ref) FVector& InOutPosition, UPARAM(ref) FVector& InOutVelocity, UPARAM(ref) FVector& InOutVelocityIntermediate, UPARAM(ref) FVector& InOutAcceleration, const FVector& TargetVelocity, float DeltaTime, float SmoothingTime = 0.2f, float MaxAcceleration = 1.0f);
 
    // Conversion Methods
 
    UFUNCTION(BlueprintPure, meta=(Category="Math|Spring|Experimental"))
    static ENGINE_API float ConvertSmoothingTimeToStrength(float SmoothingTime);
 
    UFUNCTION(BlueprintPure, meta=(Category="Math|Spring|Experimental"))
    static ENGINE_API float ConvertStrengthToSmoothingTime(float Strength);
 
    UFUNCTION(BlueprintPure, meta=(Category="Math|Spring|Experimental"))
    static ENGINE_API float ConvertHalfLifeToSmoothingTime(float HalfLife);
 
    UFUNCTION(BlueprintPure, meta=(Category="Math|Spring|Experimental"))
    static ENGINE_API float ConvertSmoothingTimeToHalfLife(float SmoothingTime);
};