UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
UE::MovieScene::Interpolation::FCachedInterpolation Struct Reference

#include <MovieSceneInterpolation.h>

Public Member Functions

MOVIESCENE_API FCachedInterpolation ()
 
MOVIESCENE_API FCachedInterpolation (const FCachedInterpolationRange &InRange, const FConstantValue &Constant)
 
MOVIESCENE_API FCachedInterpolation (const FCachedInterpolationRange &InRange, const FLinearInterpolation &Linear)
 
MOVIESCENE_API FCachedInterpolation (const FCachedInterpolationRange &InRange, const FQuadraticInterpolation &Quadratic)
 
MOVIESCENE_API FCachedInterpolation (const FCachedInterpolationRange &InRange, const FCubicInterpolation &Cubic)
 
MOVIESCENE_API FCachedInterpolation (const FCachedInterpolationRange &InRange, const FQuarticInterpolation &Quartic)
 
MOVIESCENE_API FCachedInterpolation (const FCachedInterpolationRange &InRange, const FCubicBezierInterpolation &CubicBezier)
 
MOVIESCENE_API FCachedInterpolation (const FCachedInterpolationRange &InRange, const FWeightedCubicInterpolation &WeightedCubic)
 
MOVIESCENE_API bool IsValid () const
 
MOVIESCENE_API bool IsCacheValidForTime (FFrameNumber FrameNumber) const
 
MOVIESCENE_API FCachedInterpolationRange GetRange () const
 
MOVIESCENE_API bool Evaluate (FFrameTime FrameTime, double &OutResult) const
 
MOVIESCENE_API TOptional< FCachedInterpolation > ComputeIntegral (double ConstantOffset=0.0) const
 
MOVIESCENE_API TOptional< FCachedInterpolation > ComputeDerivative () const
 
MOVIESCENE_API int32 InverseEvaluate (double InValue, TInterpSolutions< FFrameTime, 4 > OutResults) const
 
MOVIESCENE_API FInterpolationExtents ComputeExtents (FFrameTime From, FFrameTime To) const
 
MOVIESCENE_API FInterpolationExtents ComputeExtents () const
 
MOVIESCENE_API void Offset (double Amount)
 

Detailed Description

Variant structure that wraps an interpolation and the range within which it is valid. ~96 bytes

Constructor & Destructor Documentation

◆ FCachedInterpolation() [1/8]

UE::MovieScene::Interpolation::FCachedInterpolation::FCachedInterpolation ( )

Default construction to an invalid state. Calling Evaluate will always return false

◆ FCachedInterpolation() [2/8]

UE::MovieScene::Interpolation::FCachedInterpolation::FCachedInterpolation ( const FCachedInterpolationRange &  InRange,
const FConstantValue &  Constant 
)

Construction as a constant value

◆ FCachedInterpolation() [3/8]

UE::MovieScene::Interpolation::FCachedInterpolation::FCachedInterpolation ( const FCachedInterpolationRange &  InRange,
const FLinearInterpolation &  Linear 
)

Construction as a linear interpolation

◆ FCachedInterpolation() [4/8]

UE::MovieScene::Interpolation::FCachedInterpolation::FCachedInterpolation ( const FCachedInterpolationRange &  InRange,
const FQuadraticInterpolation &  Quadratic 
)

Construction as a quadratic interpolation

◆ FCachedInterpolation() [5/8]

UE::MovieScene::Interpolation::FCachedInterpolation::FCachedInterpolation ( const FCachedInterpolationRange &  InRange,
const FCubicInterpolation &  Cubic 
)

Construction as a cubic interpolation

◆ FCachedInterpolation() [6/8]

UE::MovieScene::Interpolation::FCachedInterpolation::FCachedInterpolation ( const FCachedInterpolationRange &  InRange,
const FQuarticInterpolation &  Quartic 
)

Construction as a quartic interpolation

◆ FCachedInterpolation() [7/8]

UE::MovieScene::Interpolation::FCachedInterpolation::FCachedInterpolation ( const FCachedInterpolationRange &  InRange,
const FCubicBezierInterpolation &  CubicBezier 
)

Construction as a cubic interpolation

◆ FCachedInterpolation() [8/8]

UE::MovieScene::Interpolation::FCachedInterpolation::FCachedInterpolation ( const FCachedInterpolationRange &  InRange,
const FWeightedCubicInterpolation &  WeightedCubic 
)

Construction as a weighted cubic interpolation

Member Function Documentation

◆ ComputeDerivative()

TOptional< FCachedInterpolation > UE::MovieScene::Interpolation::FCachedInterpolation::ComputeDerivative ( ) const

◆ ComputeExtents() [1/2]

FInterpolationExtents UE::MovieScene::Interpolation::FCachedInterpolation::ComputeExtents ( ) const

◆ ComputeExtents() [2/2]

FInterpolationExtents UE::MovieScene::Interpolation::FCachedInterpolation::ComputeExtents ( FFrameTime  From,
FFrameTime  To 
) const

◆ ComputeIntegral()

TOptional< FCachedInterpolation > UE::MovieScene::Interpolation::FCachedInterpolation::ComputeIntegral ( double  ConstantOffset = 0.0) const

◆ Evaluate()

bool UE::MovieScene::Interpolation::FCachedInterpolation::Evaluate ( FFrameTime  FrameTime,
double &  OutResult 
) const

Evaluate this interpolation for the specified frame time

Parameters
FrameTimeThe time to evaluate at
OutResultReference to recieve the resulting value. Only written to if this function returns true.
Returns
true if this interpolation evaluated successfully (and the result written to OutResult), false otherwise.

◆ GetRange()

FCachedInterpolationRange UE::MovieScene::Interpolation::FCachedInterpolation::GetRange ( ) const

Retrieve the range that this interpolation applies to

◆ InverseEvaluate()

int32 UE::MovieScene::Interpolation::FCachedInterpolation::InverseEvaluate ( double  InValue,
TInterpSolutions< FFrameTime, 4 >  OutResults 
) const

◆ IsCacheValidForTime()

bool UE::MovieScene::Interpolation::FCachedInterpolation::IsCacheValidForTime ( FFrameNumber  FrameNumber) const

Check whether this cache is still valid for the specified frame number.

Returns
true if this interpolation is relevant to the frame, or false if it should be re-generated

◆ IsValid()

bool UE::MovieScene::Interpolation::FCachedInterpolation::IsValid ( ) const

Check whether this cache is valid (ie, has a valid range and interpolation)

◆ Offset()

void UE::MovieScene::Interpolation::FCachedInterpolation::Offset ( double  Amount)
The documentation for this struct was generated from the following files: