CommonAnimationLibrary Namespace Reference

Functions
ANIMGRAPHRUNTIME_API float	ScalarEasing (float Value, const FRuntimeFloatCurve &CustomCurve, EEasingFuncType EasingType=EEasingFuncType::Linear, bool bFlip=false, float Weight=1.f)
ANIMGRAPHRUNTIME_API FVector	RetargetSingleLocation (FVector Location, const FTransform &Source, const FTransform &Target, const FRuntimeFloatCurve &CustomCurve, EEasingFuncType EasingType=EEasingFuncType::Linear, bool bFlipEasing=false, float EasingWeight=1.f, FVector Axis=FVector(1.f, 0.f, 0.f), float SourceMinimum=-1.f, float SourceMaximum=1.f, float TargetMinimum=-1.f, float TargetMaximum=1.f)
ANIMGRAPHRUNTIME_API FQuat	RetargetSingleRotation (const FQuat &Rotation, const FTransform &Source, const FTransform &Target, const FRuntimeFloatCurve &CustomCurve, EEasingFuncType EasingType=EEasingFuncType::Linear, bool bFlipEasing=false, float EasingWeight=1.f, ERotationComponent RotationComponent=ERotationComponent::SwingAngle, FVector TwistAxis=FVector(1.f, 0.f, 0.f), bool bUseAbsoluteAngle=false, float SourceMinimum=0.0f, float SourceMaximum=45.f, float TargetMinimum=0.f, float TargetMaximum=45.f)

Detailed Description

A library of the most common animation functions.

Function Documentation

RetargetSingleLocation()

FVector CommonAnimationLibrary::RetargetSingleLocation	(	FVector	Location,
		const FTransform &	Source,
		const FTransform &	Target,
		const FRuntimeFloatCurve &	CustomCurve,
		EEasingFuncType	EasingType = EEasingFuncType::Linear,
		bool	bFlipEasing = false,
		float	EasingWeight = 1.f,
		FVector	Axis = FVector(1.f, 0.f, 0.f),
		float	SourceMinimum = -1.f,
		float	SourceMaximum = 1.f,
		float	TargetMinimum = -1.f,
		float	TargetMaximum = 1.f
	)

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

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)

RetargetSingleRotation()

FQuat CommonAnimationLibrary::RetargetSingleRotation	(	const FQuat &	Rotation,
		const FTransform &	Source,
		const FTransform &	Target,
		const FRuntimeFloatCurve &	CustomCurve,
		EEasingFuncType	EasingType = EEasingFuncType::Linear,
		bool	bFlipEasing = false,
		float	EasingWeight = 1.f,
		ERotationComponent	RotationComponent = ERotationComponent::SwingAngle,
		FVector	TwistAxis = FVector(1.f, 0.f, 0.f),
		bool	bUseAbsoluteAngle = false,
		float	SourceMinimum = 0.0f,
		float	SourceMaximum = 45.f,
		float	TargetMinimum = 0.f,
		float	TargetMaximum = 45.f
	)

This function performs retargeting of rotation using an easing function. For this a range of motion needs to be defined as a euler angle, swing angle or twist

Parameters

Rotation	The input rotation to be retargeted
Source	The transform to be used as the frame of reference
Target	The transform to be used as the target space
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)
RotationComponent	The component of the rotation to retarget
TwistAxis	The axis to use when extracting swing / twist rotations
bUseAbsoluteAngle	If set to true negative angles will be flipped to positive. This can be used to mirror the rotation.
SourceMinimum	The minimum of the source range in degrees
SourceMaximum	The maximum of the source range in degrees
TargetMinimum	The minimum of the target range in degrees
TargetMaximum	The maximum of the target range in degrees
EasingType	The type of easing to apply

ScalarEasing()

float CommonAnimationLibrary::ScalarEasing	(	float	Value,
		const FRuntimeFloatCurve &	CustomCurve,
		EEasingFuncType	EasingType = EEasingFuncType::Linear,
		bool	bFlip = false,
		float	Weight = 1.f
	)

This function perform easing on a float value using a variety of easing types.

Parameters

Value	The float value to ease
EasingType	The easing function to use
CustomCurve	The curve to use if the easing type is "Custom"
bFlip	If set to true the easing is flipping around
Weight	The amount of easing to use against linear (0.0 to 1.0)