FRigUnit_SpringInterpV2 | Unreal Engine 5.6 Documentation

API > API/Plugins > API/Plugins/ControlRig

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


Name	FRigUnit_SpringInterpV2
Type	struct
Header File	/Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/Simulation/RigUnit_SpringInterp.h
Include Path	#include "Units/Simulation/RigUnit_SpringInterp.h"

Syntax

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

Inheritance Hierarchy

FRigVMStruct → FRigVMFunction_SimBase → FRigUnit_SpringInterpV2

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FRigUnit_SpringInterpV2()		Units/Simulation/RigUnit_SpringInterp.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
bInitializeFromTarget	bool	If true, then the initial value will be taken from the target value, and not from the current value.	Units/Simulation/RigUnit_SpringInterp.h	Meta=(Input, Constant, EditCondition="bUseCurrentInput")
bUseCurrentInput	bool	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.	Units/Simulation/RigUnit_SpringInterp.h	Meta=(Input, Constant)
CriticalDamping	float	The amount of damping in the spring.	Units/Simulation/RigUnit_SpringInterp.h	Meta=(Input, ClampMin="0")
Current	float	Current position of the spring.	Units/Simulation/RigUnit_SpringInterp.h	Meta=(Input, EditCondition="bUseCurrentInput")
Force	float	Extra force to apply (since the mass is 1, this is also the acceleration).	Units/Simulation/RigUnit_SpringInterp.h	Meta=(Input)
Result	float	New position of the spring after delta time.	Units/Simulation/RigUnit_SpringInterp.h	Meta=(Output)
SimulatedResult	float		Units/Simulation/RigUnit_SpringInterp.h
SpringState	FFloatSpringState		Units/Simulation/RigUnit_SpringInterp.h
Strength	float	The spring strength determines how hard it will pull towards the target.	Units/Simulation/RigUnit_SpringInterp.h	Meta=(Input, ClampMin="0")
Target	float	Rest/target position of the spring.	Units/Simulation/RigUnit_SpringInterp.h	Meta=(Input)
TargetVelocityAmount	float	The amount that the velocity should be passed through to the spring.	Units/Simulation/RigUnit_SpringInterp.h	Meta=(Input, ClampMin="0", ClampMax="1")
Velocity	float	Velocity	Units/Simulation/RigUnit_SpringInterp.h	Meta=(Output)

Functions

Public

Overridden from FRigVMStruct

Name	Remarks	Include Path	Unreal Specifiers
virtual void Execute()		Units/Simulation/RigUnit_SpringInterp.h

Navigation

Syntax

Inheritance Hierarchy

Constructors

Variables

Public

Functions

Public

Overridden from FRigVMStruct