Navigation
API > API/Plugins > API/Plugins/GameplayCameras
A value interpolator is a stand-alone object that can interpolate a given value towards a given target value. Various sub-classes of this base class should implement various interpolation algorithms.
| Name | TCameraValueInterpolator |
| Type | class |
| Header File | /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Core/CameraValueInterpolator.h |
| Include Path | #include "Core/CameraValueInterpolator.h" |
Syntax
template<typename ValueType>
class TCameraValueInterpolator
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TCameraValueInterpolator
(
const UCameraValueInterpolator* InParameters |
Creates a new value interpolator given a piece of data containing user-defined settings. | Core/CameraValueInterpolator.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~TCameraValueInterpolator() |
Destructor | Core/CameraValueInterpolator.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ValueTypeParam | typename TCallTraits< ValueType >::ParamType | Core/CameraValueInterpolator.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ValueType GetCurrentValue() |
Gets the current value. | Core/CameraValueInterpolator.h | |
const TInterpolatorClass * GetParametersAs() |
Gets the parameters class and casts it to the given sub-class. | Core/CameraValueInterpolator.h | |
ValueType GetTargetValue() |
Gets the target value. | Core/CameraValueInterpolator.h | |
bool IsFinished () |
Returns whether the interpolation has ended. | Core/CameraValueInterpolator.h | |
void Reset
(
ValueTypeParam NewCurrentValue, |
Resets the current and target values. | Core/CameraValueInterpolator.h | |
ValueType Run
(
const FCameraValueInterpolationParams& Params, |
Evaluates the interpolator, advancing the current value towards the target. | Core/CameraValueInterpolator.h | |
void Serialize
(
const FCameraValueInterpolatorSerializeParams& Params, |
Serializes the value interpolator to/from the given archive. | Core/CameraValueInterpolator.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnReset
(
ValueTypeParam OldCurrentValue, |
Called when the current and/or target values are forcibly changed. | Core/CameraValueInterpolator.h | |
virtual void OnRun
(
const FCameraValueInterpolationParams& Params, |
Evaluates the interpolator, advancing the current value towards the target. | Core/CameraValueInterpolator.h | |
virtual void OnSerialize
(
const FCameraValueInterpolatorSerializeParams& Params, |
Serializes the value interpolator to/from the given archive. | Core/CameraValueInterpolator.h |