Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > AnimGraphRuntime > CommonAnimationLibrary::RetargetSingleLocation

Light Theme

Dark Theme

CommonAnimationLibrary::RetargetSingleLocation

This function performs retargeting of translation using an easing function.

Windows

MacOS

Linux

References

Module	AnimGraphRuntime
Header	/Engine/Source/Runtime/AnimGraphRuntime/Public/CommonAnimationLibrary.h
Include	#include "CommonAnimationLibrary.h"
Source	/Engine/Source/Runtime/AnimGraphRuntime/Private/CommonAnimationLibrary.cpp

Syntax

namespace CommonAnimationLibrary
{
    FVector CommonAnimationLibrary::RetargetSingleLocation
    (
        FVector Location,
        const FTransform & Source,
        const FTransform & Target,
        const FRuntimeFloatCurve & CustomCurve,
        EEasingFuncType EasingType,
        bool bFlipEasing,
        float EasingWeight,
        FVector Axis,
        float SourceMinimum,
        float SourceMaximum,
        float TargetMinimum,
        float TargetMaximum
    )
}

Remarks

This function performs retargeting of translation using an easing function. For this a range of motion needs to be defined given a direction and the constraints.

Parameters

Parameter	Description
Location	The input location to be retargeted
Source	The transform to be used as the frame of reference
Target	The transform to be used as the target space
Axis	The direction to use for the range measurement. Defaults to (1.0, 0.0, 0.0)
SourceMinimum	The minimum of the source range
SourceMaximum	The maximum of the source range
TargetMinimum	The minimum of the target range
TargetMaximum	The maximum of the target range
EasingType	The type of easing to apply
CustomCurve	The curve to use if the easing type is "Custom"
bFlipEasing	If set to true the easing is flipping around
EasingWeight	The amount of easing to use against linear (0.0 to 1.0)

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss