1. Epic GamesDeveloper
  3. TweeningUtilsEditor

TweeningUtilsEditor

API > API/Plugins

   
Name TweeningUtilsEditor
Type Editor
Part of Plugins Tweening Utils
Location /Engine/Plugins/Animation/TweeningUtils/Source/TweeningUtilsEditor/
Module Build Rules TweeningUtilsEditor.Build.cs

Classes

Name Remarks
FCurveTimeOffsetTweenModel Recomputes all keys output values such that the curve is effectively shifted to left and right without modifying the keys' input values.
FCycleFunctionController Cycles through functions on a tween model.
FMouseSlidingController Generic controller that allows you to move the mouse while a command is pressed.
FTweeningUtilsCommands  
FTweenModel Implements the logic of tweening some values: it could be curves, it could be control rig models.
FTweenModelArray Backed by an array of tween models and their UI info.
FTweenMouseSlidingController Specialization that sends blend values to a tween model based on how far the mouse is moved.
FTweenToolbarController Binds together a STweenView and FTweenModel in the context of adding the controls to a toolbar widget.
STweenSlider The slider ranges from -1 to 1.
STweenView It bridges the STweenSlider, which acts as the view, and the model, FTweenModel, by interchanging data between them.
TCurveTweenModel Tweens the curves of the curve editor's selection.
TTangentFlatteningTweenProxy This class squishes the curves based on how much the tween function squishes the keys vertically.
TTransactionalTweenModelProxy Starts a transaction in StartBlendOperation, stops it in StopBlendOperation.
UTweeningToolsUserSettings  

Structs

Name Remarks
FBlendRangesData Stores all key positions as they were before the blend, and all the chains of keys that are supposed to be blended.
FContiguousKeyMapping Information for blending a map of curves and the keys in it to blend.
FContiguousKeys Unbroken chain of keys.
FTweenControllers Holds functionality that may be reused across modules to add tweening widgets to a toolbar.
FTweenModelDisplayInfo Information about how a FTweenModel can be displayed in the UI.
FTweenModelUIEntry An association between a tween model and its UI display info.
FTweenPointStyle  
FTweenSliderStyle Style for STweenSlider

Interfaces

Name Remarks
ITweenModelContainer This acts as the source of FTweenModels displayed in UI, e.g. by FTweenToolbarController.

Typedefs

Name Type Remarks Include Path
TEditorTweenModel TTransactionalTweenModelProxy< TTangentFlatteningTweenProxy< TUnderlyingModel > > Extends TUnderlyingModel with commonly expected shared functionality: Math/Models/EditorTweenModel.h

Enums

Public

Name Remarks
UE::TweeningUtilsEditor::EBlendFunction Util enum which is useful for UI code to abstract functions.
UE::TweeningUtilsEditor::EBreakBehavior The following just contains some utils that is common in UI code.
UE::TweeningUtilsEditor::ETweenScaleMode Affects how blend values, which are normalized to the range -1.0 to 1.0, are interpreted.

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool UE::TweeningUtilsEditor::BlendCurve_ByKeyRange ( const FCurveEditor& InCurveEditor,
const FContiguousKeyMapping& InKeySelection,
TCallback&& InBlendRangeCallback
)

 Generic helper function that invokes InBlendRangeCallback for each unbroken sub-range of keys in each curve. Math/CurveBlending.h  

bool UE::TweeningUtilsEditor::BlendCurves_BySingleKey ( const FCurveEditor& InCurveEditor,
const FContiguousKeyMapping& InKeySelection,
TCallback&& InBlendKeyCallback
)

 Blends the specified keys by using a InBlendKeyCallback, which returns the new key value each key should have. Math/CurveBlending.h  

void UE::TweeningUtilsEditor::ForEachBlendFunction ( TCallback&& InCallback
)

 Iterates through all blend function types. Math/Abstraction/KeyBlendingAbstraction.h  

void UE::TweeningUtilsEditor::ForEachBlendFunctionBreakable ( TCallback&& InCallback
)

 Iterates through all blend function types with the ability to break. Math/Abstraction/KeyBlendingAbstraction.h  

void UE::TweeningUtilsEditor::ForEachCurveTweenable ( TCallback&& InCallback
)

 Invokes InCallback for each EBlendFunction that TCurveTweener can be instantiated with. Math/Abstraction/TweenRangeTemplates.h  

int32 UE::TweeningUtilsEditor::NumBlendFunctionsSupportingTweenRange()

   Math/Abstraction/TweenRangeTemplates.h  

bool UE::TweeningUtilsEditor::SupportsTweenRange ( EBlendFunction BlendFunction
)

   Math/Abstraction/TweenRangeTemplates.h  

double UE::TweeningUtilsEditor::TweenRange ( double InBlendValue,
const FBlendRangesData& AllBlendedKeys,
const FContiguousKeys& CurrentBlendRange,
int32 InCurrentKeyIndex
)

 Interface for applying "simple" blend function to range of keys. Math/Abstraction/TweenRangeTemplates.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page