UE::MovieScene::FPiecewiseCurve Struct Reference

#include <MovieScenePiecewiseCurve.h>

Public Member Functions
MOVIESCENE_API FPiecewiseCurve	Integral () const
MOVIESCENE_API FPiecewiseCurve	Derivative () const
MOVIESCENE_API void	Offset (double Amount)
MOVIESCENE_API Interpolation::FCachedInterpolation	GetInterpolationForTime (FFrameTime Time) const
MOVIESCENE_API bool	Evaluate (FFrameTime Time, double &OutResult) const
MOVIESCENE_API TOptional< FFrameTime >	InverseEvaluate (double Value, FFrameTime TimeHint, EInverseEvaluateFlags Flags) const
MOVIESCENE_API bool	InverseEvaluateBetween (double Value, FFrameTime StartTime, FFrameTime EndTime, const TFunctionRef< bool(FFrameTime)> &Visitor) const

Public Attributes
TArray< Interpolation::FCachedInterpolation >	Values

Detailed Description

A piecewise curve represented as an array of interpolations.

Member Function Documentation

Derivative()

FPiecewiseCurve UE::MovieScene::FPiecewiseCurve::Derivative

(

)

const

Compute the integral of this curve (ie, the slope of this curve), returning the result as another piecewise curve

Evaluate()

bool UE::MovieScene::FPiecewiseCurve::Evaluate	(	FFrameTime	Time,
		double &	OutResult
	)		const

Evaluate this curve at the specified time

Parameters

Time	The time (x-value) to evaluate at
OutResult	Value to receieve the evaluated result

Returns

true if the curve was evaluated successfully and OutResult was written to, false otherwise.

GetInterpolationForTime()

Interpolation::FCachedInterpolation UE::MovieScene::FPiecewiseCurve::GetInterpolationForTime

(

FFrameTime

Time

)

const

Get the interpolation for a specific time

Parameters

Time	The time (x-value) to retrieve an interpolation for

Integral()

FPiecewiseCurve UE::MovieScene::FPiecewiseCurve::Integral

(

)

const

Compute the integral of this curve (ie, the cumulative area under this curve), returning the result as another piecewise curve

InverseEvaluate()

TOptional< FFrameTime > UE::MovieScene::FPiecewiseCurve::InverseEvaluate	(	double	Value,
		FFrameTime	TimeHint,
		EInverseEvaluateFlags	Flags
	)		const

Solve this curve for a given (y). Where more than one solution exists, TimeHint will be used to find the solution closest to the hint.

Parameters

Value	The result to solve for
TimeHint	Predicate time to use for locating the most relevant solution
Flags	Flag structure used to control how to solve the curve

Returns

The solution if one exists, false otherwise

InverseEvaluateBetween()

bool UE::MovieScene::FPiecewiseCurve::InverseEvaluateBetween	(	double	Value,
		FFrameTime	StartTime,
		FFrameTime	EndTime,
		const TFunctionRef< bool(FFrameTime)> &	Visitor
	)		const

Solve this curve for a given (y), only considering solutions that lie within a certain range.

Parameters

Value	The result to solve for
StartTime	Start time before which solutions will not be considered
EndTime	End time after which solutions will not be considered
Visitor	Callback that is invoked for each solution. Returning true allows the algorithm to continue, false will terminate the algorithm.

Returns

False if any invocation of Visitor returned false, true otherwise.

Offset()

void UE::MovieScene::FPiecewiseCurve::Offset

(

double

Amount

)

Offset this curve in the (y) direction by a certain amount. The resulting state of this curve, f(x), is g(x) = f(x) + c

Parameters

Amount

The constant offset to apply to this curve

Member Data Documentation

Values

TArray<Interpolation::FCachedInterpolation> UE::MovieScene::FPiecewiseCurve::Values

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/MovieScene/Public/Channels/MovieScenePiecewiseCurve.h
• Engine/Source/Runtime/MovieScene/Private/Channels/MovieScenePiecewiseCurve.cpp