1. Epic GamesDeveloper
  3. FRigUnit_SpringInterpVectorV2

FRigUnit_SpringInterpVectorV2

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

API > API/Plugins > API/Plugins/ControlRig

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

   
Name FRigUnit_SpringInterpVectorV2
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", MenuDescSuffix="(Vector)"))  
struct FRigUnit_SpringInterpVectorV2 : public FRigVMFunction_SimBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FRigUnit_SpringInterpVectorV2()

   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 FVector Current position of the spring. Units/Simulation/RigUnit_SpringInterp.h
  • Meta=(Input, EditCondition="bUseCurrentInput")
Force FVector Extra force to apply (since the mass is 1, this is also the acceleration). Units/Simulation/RigUnit_SpringInterp.h
  • Meta=(Input)
Result FVector New position of the spring after delta time. Units/Simulation/RigUnit_SpringInterp.h
  • Meta=(Output)
SimulatedResult FVector   Units/Simulation/RigUnit_SpringInterp.h  
SpringState FVectorSpringState   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 FVector 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 FVector 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  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page