KismetAnimationLibrary.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include "Components/SceneComponent.h"
#include "Curves/CurveFloat.h"
#include "KismetAnimationTypes.h"
#include "KismetAnimationLibrary.generated.h"
 
class USkeletalMeshComponent;
 
UCLASS(meta=(ScriptName="AnimGraphLibrary", BlueprintThreadSafe, DocumentationPolicy="Strict"), MinimalAPI)
class UKismetAnimationLibrary : public UBlueprintFunctionLibrary
{
    GENERATED_UCLASS_BODY()
 
    
    UFUNCTION(BlueprintPure, Category = "Animation|Utilities", meta = (DisplayName = "Two Bone IK Function", ScriptName = "TwoBoneIK", bAllowStretching = "false", StartStretchRatio = "1.0", MaxStretchScale = "1.2"))
    static ANIMGRAPHRUNTIME_API void K2_TwoBoneIK(
        const FVector& RootPos, 
        const FVector& JointPos, 
        const FVector& EndPos, 
        const FVector& JointTarget, 
        const FVector& Effector, 
        FVector& OutJointPos, 
        FVector& OutEndPos, 
        bool bAllowStretching, 
        float StartStretchRatio,
        float MaxStretchScale
    );
 
    UFUNCTION(BlueprintPure, Category = "Animation|Utilities", meta = (DisplayName = "Look At Function", ScriptName = "LookAt", bUseUpVector = "false"))
    static ANIMGRAPHRUNTIME_API FTransform K2_LookAt(
        const FTransform& CurrentTransform, 
        const FVector& TargetPosition, 
        FVector LookAtVector, 
        bool bUseUpVector, 
        FVector UpVector, 
        float ClampConeInDegree
    );
 
    UFUNCTION(BlueprintPure, Category = "Animation|Utilities", meta = (NotBlueprintThreadSafe, DisplayName = "Get Distance Between Two Sockets", ScriptName = "DistanceBetweenSockets", bRemapRange= "false"))
    static ANIMGRAPHRUNTIME_API float K2_DistanceBetweenTwoSocketsAndMapRange(
        const USkeletalMeshComponent* Component, 
        const FName SocketOrBoneNameA, 
        ERelativeTransformSpace SocketSpaceA, 
        const FName SocketOrBoneNameB, 
        ERelativeTransformSpace SocketSpaceB, 
        bool bRemapRange, 
        float InRangeMin,
        float InRangeMax,
        float OutRangeMin,
        float OutRangeMax);
 
    UFUNCTION(BlueprintPure, Category = "Animation|Utilities", meta = (NotBlueprintThreadSafe, DisplayName = "Get Direction Between Sockets", ScriptName = "DirectionBetweenSockets"))
    static ANIMGRAPHRUNTIME_API FVector K2_DirectionBetweenSockets(const USkeletalMeshComponent* Component, const FName SocketOrBoneNameFrom, const FName SocketOrBoneNameTo);
 
    UFUNCTION(BlueprintPure, Category = "Animation|Utilities", meta = (DisplayName = "Make Perlin Noise Vector and Remap", ScriptName = "MakeVectorFromPerlinNoise", RangeOutMinX = "-1.f", RangeOutMaxX = "1.f", RangeOutMinY = "-1.f", RangeOutMaxY = "1.f", RangeOutMinZ = "-1.f", RangeOutMaxZ = "1.f"))
    static ANIMGRAPHRUNTIME_API FVector K2_MakePerlinNoiseVectorAndRemap(
        float X,
        float Y,
        float Z,
        float RangeOutMinX,
        float RangeOutMaxX,
        float RangeOutMinY,
        float RangeOutMaxY,
        float RangeOutMinZ,
        float RangeOutMaxZ
    );
 
    UFUNCTION(BlueprintPure, Category = "Animation|Utilities", meta = (DisplayName = "Make Perlin Noise and Remap", ScriptName = "MakeFloatFromPerlinNoise", RangeOutMinX = "-1.f", RangeOutMaxX = "1.f", RangeOutMinY = "-1.f", RangeOutMaxY = "1.f", RangeOutMinZ = "-1.f", RangeOutMaxZ = "1.f"))
    static ANIMGRAPHRUNTIME_API float K2_MakePerlinNoiseAndRemap(
        float Value,
        float RangeOutMin,
        float RangeOutMax
    );
 
    UFUNCTION(BlueprintCallable, Category = "Animation|Utilities", meta = (DisplayName = "Calculate Velocity From Position History", ScriptName = "CalculateVelocityFromPositionHistory", NumberOfSamples = "16", VelocityMin = "0.f", VelocityMax = "128.f"))
    static ANIMGRAPHRUNTIME_API float K2_CalculateVelocityFromPositionHistory(
        float DeltaSeconds,
        FVector Position,
        UPARAM(ref) FPositionHistory& History,
        int32 NumberOfSamples,
        float VelocityMin,
        float VelocityMax
    );
 
    UFUNCTION(BlueprintCallable, Category = "Animation|Utilities", meta = (NotBlueprintThreadSafe, DisplayName = "Calculate Velocity From Sockets", ScriptName = "CalculateVelocityFromSockets", NumberOfSamples = "16", VelocityMin = "0.f", VelocityMax = "128.f"))
    static ANIMGRAPHRUNTIME_API float K2_CalculateVelocityFromSockets(
        float DeltaSeconds,
        USkeletalMeshComponent * Component,
        const FName SocketOrBoneName,
        const FName ReferenceSocketOrBone,
        ERelativeTransformSpace SocketSpace,
        FVector OffsetInBoneSpace, 
        UPARAM(ref) FPositionHistory& History, 
        int32 NumberOfSamples,
        float VelocityMin,
        float VelocityMax,
        EEasingFuncType EasingType,
        const FRuntimeFloatCurve& CustomCurve
        );
 
    UFUNCTION(BlueprintCallable, Category = "Animation|Utilities", meta = (DisplayName = "Start Profiling Timer"))
    static ANIMGRAPHRUNTIME_API void K2_StartProfilingTimer();
 
    UFUNCTION(BlueprintCallable, Category = "Animation|Utilities", meta = (DisplayName = "End Profiling Timer"))
    static ANIMGRAPHRUNTIME_API float K2_EndProfilingTimer(bool bLog = true, const FString& LogPrefix = "");
 
    UFUNCTION(BlueprintPure, Category="Animation|Utilities")
    static ANIMGRAPHRUNTIME_API float CalculateDirection(const FVector& Velocity, const FRotator& BaseRotation);
};