UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Protected Attributes | List of all members
FRK4SpringInterpolator< T > Struct Template Reference

#include <SpringInterpolator.h>

Public Member Functions

 FRK4SpringInterpolator (float InSpringStiffness=1.f, float InDampeningRatio=1.f)
 
void SetDefaultSpringConstants (const float &InSpringStiffness, const float &InDampeningRatio=1.f)
 
void SetSpringConstants (const float &InSpringStiffness, const float &InDampeningRatio=1.f)
 
float GetDefaultStiffnessConstant () const
 
bool IsInMotion () const
 
T GetPosition () const
 
void SetPosition (const T &NewPosition)
 
void OffsetPosition (const T &Offset)
 
T GetLastDeltaPosition () const
 
T GetVelocity () const
 
void SetVelocity (const T &NewVelocity)
 
void OffsetVelocity (const T &Offset)
 
bool IsPositionEqualTo (const T &OtherPosition) const
 
bool IsVelocityZero () const
 
void Reset (const T &DefaultPosition=T(0.f))
 
T Update (const T &InTargetPosition, const float &InDeltaTime)
 
T Update (const T &InNewPosition, const T &InTargetPosition, const float &InDeltaTime)
 

Protected Attributes

float StiffnessConstant
 
float DampeningRatio
 
bool bIsInitialized
 
bool bIsInMotion
 
float TimeRemaining
 
FRK4SpringConstants SpringConstants
 
T LastPosition
 
RK4Integrator::FRK4State< T > State
 

Constructor & Destructor Documentation

◆ FRK4SpringInterpolator()

template<typename T >
FRK4SpringInterpolator< T >::FRK4SpringInterpolator ( float  InSpringStiffness = 1.f,
float  InDampeningRatio = 1.f 
)
inline

Member Function Documentation

◆ GetDefaultStiffnessConstant()

template<typename T >
float FRK4SpringInterpolator< T >::GetDefaultStiffnessConstant ( ) const
inline

◆ GetLastDeltaPosition()

template<typename T >
T FRK4SpringInterpolator< T >::GetLastDeltaPosition ( ) const
inline

◆ GetPosition()

template<typename T >
T FRK4SpringInterpolator< T >::GetPosition ( ) const
inline

◆ GetVelocity()

template<typename T >
T FRK4SpringInterpolator< T >::GetVelocity ( ) const
inline

◆ IsInMotion()

template<typename T >
bool FRK4SpringInterpolator< T >::IsInMotion ( ) const
inline

◆ IsPositionEqualTo()

template<typename T >
bool FRK4SpringInterpolator< T >::IsPositionEqualTo ( const T &  OtherPosition) const
inline

◆ IsVelocityZero()

template<typename T >
bool FRK4SpringInterpolator< T >::IsVelocityZero ( ) const
inline

◆ OffsetPosition()

template<typename T >
void FRK4SpringInterpolator< T >::OffsetPosition ( const T &  Offset)
inline

◆ OffsetVelocity()

template<typename T >
void FRK4SpringInterpolator< T >::OffsetVelocity ( const T &  Offset)
inline

◆ Reset()

template<typename T >
void FRK4SpringInterpolator< T >::Reset ( const T &  DefaultPosition = T(0.f))
inline

◆ SetDefaultSpringConstants()

template<typename T >
void FRK4SpringInterpolator< T >::SetDefaultSpringConstants ( const float &  InSpringStiffness,
const float &  InDampeningRatio = 1.f 
)
inline
Parameters
InDampeningRatio0 = Undamped, <1 = Underdamped, 1 = Critically damped, >1 = Overdamped

◆ SetPosition()

template<typename T >
void FRK4SpringInterpolator< T >::SetPosition ( const T &  NewPosition)
inline

◆ SetSpringConstants()

template<typename T >
void FRK4SpringInterpolator< T >::SetSpringConstants ( const float &  InSpringStiffness,
const float &  InDampeningRatio = 1.f 
)
inline
Parameters
InDampeningRatio0 = Undamped, <1 = Underdamped, 1 = Critically damped, >1 = Overdamped

◆ SetVelocity()

template<typename T >
void FRK4SpringInterpolator< T >::SetVelocity ( const T &  NewVelocity)
inline

◆ Update() [1/2]

template<typename T >
T FRK4SpringInterpolator< T >::Update ( const T &  InNewPosition,
const T &  InTargetPosition,
const float &  InDeltaTime 
)
inline

◆ Update() [2/2]

template<typename T >
T FRK4SpringInterpolator< T >::Update ( const T &  InTargetPosition,
const float &  InDeltaTime 
)
inline

Member Data Documentation

◆ bIsInitialized

template<typename T >
bool FRK4SpringInterpolator< T >::bIsInitialized
protected

◆ bIsInMotion

template<typename T >
bool FRK4SpringInterpolator< T >::bIsInMotion
protected

◆ DampeningRatio

template<typename T >
float FRK4SpringInterpolator< T >::DampeningRatio
protected

◆ LastPosition

template<typename T >
T FRK4SpringInterpolator< T >::LastPosition
protected

◆ SpringConstants

template<typename T >
FRK4SpringConstants FRK4SpringInterpolator< T >::SpringConstants
protected

◆ State

template<typename T >
RK4Integrator::FRK4State<T> FRK4SpringInterpolator< T >::State
protected

◆ StiffnessConstant

template<typename T >
float FRK4SpringInterpolator< T >::StiffnessConstant
protected

◆ TimeRemaining

template<typename T >
float FRK4SpringInterpolator< T >::TimeRemaining
protected
The documentation for this struct was generated from the following file: