1. Epic GamesDeveloper
  3. UKismetAnimationLibrary

UKismetAnimationLibrary

A library of the most common animation blueprint functions.

API > API/Runtime > API/Runtime/AnimGraphRuntime

A library of the most common animation blueprint functions.

   
Name UKismetAnimationLibrary
Type class
Header File /Engine/Source/Runtime/AnimGraphRuntime/Public/KismetAnimationLibrary.h
Include Path #include "KismetAnimationLibrary.h"

Syntax

UCLASS (Meta=(ScriptName="AnimGraphLibrary", BlueprintThreadSafe, DocumentationPolicy="Strict"),  
       MinimalAPI)  
class UKismetAnimationLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UKismetAnimationLibrary ( const FObjectInitializer& ObjectInitializer
)

   KismetAnimationLibrary.h  

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static float CalculateDirection ( const FVector& Velocity,
const FRotator& BaseRotation
)

 Returns degree of the angle between Velocity and Rotation forward vector The range of return will be from [-180, 180]. KismetAnimationLibrary.h
  • BlueprintPure
  • Category="Animation|Utilities"

static float K2_CalculateVelocityFromPositionHistory ( float DeltaSeconds,
FVector Position,
UPARAM(ref) FPositionHistory& History,
int32 NumberOfSamples,
float VelocityMin,
float VelocityMax
)

 This function calculates the velocity of a position changing over time. KismetAnimationLibrary.h
  • BlueprintCallable
  • Category="Animation|Utilities"
  • Meta=(DisplayName="Calculate Velocity From Position History", ScriptName="CalculateVelocityFromPositionHistory", NumberOfSamples="16", VelocityMin="0.f", VelocityMax="128.f")

static 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
)

 This function calculates the velocity of an offset position on a bone / socket over time. KismetAnimationLibrary.h
  • BlueprintCallable
  • Category="Animation|Utilities"
  • Meta=(NotBlueprintThreadSafe, DisplayName="Calculate Velocity From Sockets", ScriptName="CalculateVelocityFromSockets", NumberOfSamples="16", VelocityMin="0.f", VelocityMax="128.f")

static FVector K2_DirectionBetweenSockets ( const USkeletalMeshComponent* Component,
const FName SocketOrBoneNameFrom,
const FName SocketOrBoneNameTo
)

 Computes the direction between two bones / sockets. KismetAnimationLibrary.h
  • BlueprintPure
  • Category="Animation|Utilities"
  • Meta=(NotBlueprintThreadSafe, DisplayName="Get Direction Between Sockets", ScriptName="DirectionBetweenSockets")

static 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
)

 Computes the distance between two bones / sockets and can remap the range. KismetAnimationLibrary.h
  • BlueprintPure
  • Category="Animation|Utilities"
  • Meta=(NotBlueprintThreadSafe, DisplayName="Get Distance Between Two Sockets", ScriptName="DistanceBetweenSockets", bRemapRange="false")

static float K2_EndProfilingTimer ( bool bLog,
const FString& LogPrefix
)

 This function ends measuring a profiling bracket and optionally logs the result KismetAnimationLibrary.h
  • BlueprintCallable
  • Category="Animation|Utilities"
  • Meta=(DisplayName="End Profiling Timer")

static FTransform K2_LookAt ( const FTransform& CurrentTransform,
const FVector& TargetPosition,
FVector LookAtVector,
bool bUseUpVector,
FVector UpVector,
float ClampConeInDegree
)

 Computes the transform which is "looking" at target position with a local axis. KismetAnimationLibrary.h
  • BlueprintPure
  • Category="Animation|Utilities"
  • Meta=(DisplayName="Look At Function", ScriptName="LookAt", bUseUpVector="false")

static float K2_MakePerlinNoiseAndRemap ( float Value,
float RangeOutMin,
float RangeOutMax
)

 This function creates perlin noise for a single float and then range map to RangeOut KismetAnimationLibrary.h
  • 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 FVector K2_MakePerlinNoiseVectorAndRemap ( float X,
float Y,
float Z,
float RangeOutMinX,
float RangeOutMaxX,
float RangeOutMinY,
float RangeOutMaxY,
float RangeOutMinZ,
float RangeOutMaxZ
)

 This function creates perlin noise from input X, Y, Z, and then range map to RangeOut, and out put to OutX, OutY, OutZ KismetAnimationLibrary.h
  • 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 void K2_StartProfilingTimer()

 This function starts measuring the time for a profiling bracket KismetAnimationLibrary.h
  • BlueprintCallable
  • Category="Animation|Utilities"
  • Meta=(DisplayName="Start Profiling Timer")

static 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
)

 Computes the transform for two bones using inverse kinematics. KismetAnimationLibrary.h
  • BlueprintPure
  • Category="Animation|Utilities"
  • Meta=(DisplayName="Two Bone IK Function", ScriptName="TwoBoneIK", bAllowStretching="false", StartStretchRatio="1.0", MaxStretchScale="1.2")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page