FRigUnit_SpringInterpQuaternionV2 | Unreal Engine 5.5 Documentation

API > API/Plugins > API/Plugins/ControlRig > API/Plugins/ControlRig/Units > API/Plugins/ControlRig/Units/Simulation

Inheritance Hierarchy

FRigVMStruct
FRigVMFunction_SimBase
FRigUnit_SpringInterpQuaternionV2

References


Module	ControlRig
Header	/Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/Simulation/RigUnit_SpringInterp.h
Include	#include "Units/Simulation/RigUnit_SpringInterp.h"

Syntax

USTRUCT (  
        Meta=(DisplayName="Spring Interpolate", Keywords="Alpha,SpringInterpolate,Verlet", Category="Simulation|Springs", TemplateName="SpringInterp", MenuDescSuffix="(Quaternion)"))  
struct FRigUnit_SpringInterpQuaternionV2 : public FRigVMFunction_SimBase

Remarks

Uses a simple spring model to interpolate a quaternion from Current to Target.

Variables

Type	Name	Description
FVector	AngularVelocity	Angular velocity
bool	bInitializeFromTarget	If true, then the initial value will be taken from the target value, and not from the current value.
bool	bUseCurrentInput	If true, then the Current input will be used to initialize the state, and is required to be a variable that holds the current state.
float	CriticalDamping	The amount of damping in the spring.
FQuat	Current	Current position of the spring.
FQuat	Result	New position of the spring after delta time.
FQuat	SimulatedResult
FQuaternionSpringState	SpringState
float	Strength	The spring strength determines how hard it will pull towards the target.
FQuat	Target	Rest/target position of the spring.
float	TargetVelocityAmount	The amount that the velocity should be passed through to the spring.
FVector	Torque	Extra torque to apply (since the moment of inertia is 1, this is also the angular acceleration).