Navigation
API > API/Plugins > API/Plugins/ControlRigEditor
FControlRigKeyframer enables the storage and application of controls' keyframe data. It stores keyframe data per control (represented as hash values) that can be applied on demand (on mouse release for example) This struct works in conjunction with FControlRigInteractionScope, and captures data from controls currently interacting (whether via the viewport or any other widget that would need to deffer keyframing.
| Name | FControlRigKeyframer |
| Type | struct |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRigEditor/Public/Sequencer/EditModeAnimationUtil.h |
| Include Path | #include "Sequencer/EditModeAnimationUtil.h" |
Syntax
struct FControlRigKeyframer
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FControlRigKeyframer() |
Sequencer/EditModeAnimationUtil.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| EnableState | EEnableState | Whether the keyframer is enabled or not. | Sequencer/EditModeAnimationUtil.h | |
| KeyframeData | TMap< uint32, FControlKeyframeData > | Storage representing keyframe data per control. | Sequencer/EditModeAnimationUtil.h | |
| OnAnimSettingsChanged | FDelegateHandle | Handle to UAnimationAuthoringSettings::OnSettingsChange delegate. | Sequencer/EditModeAnimationUtil.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Apply
(
const FControlRigInteractionScope& InInteractionScope, |
Does the actual work off adding keyframes to the controls currently interacting. | Sequencer/EditModeAnimationUtil.h | |
void Enable
(
const bool InEnabled |
Resets the data storage and enable/disable the keyframer. | Sequencer/EditModeAnimationUtil.h | |
void Finalize
(
UWorld* InWorld |
Updates whatever needs to once the keyframes have been added (updating constraints is one of them). | Sequencer/EditModeAnimationUtil.h | |
void Initialize() |
Initializes this keyframer and bounds it to the animation authoring settings. | Sequencer/EditModeAnimationUtil.h | |
bool IsEnabled() |
Returns true if enabled. | Sequencer/EditModeAnimationUtil.h | |
void Reset() |
Empties the storage. | Sequencer/EditModeAnimationUtil.h | |
void Store
(
const uint32 InControlHash, |
Stores the keyframe data for a specific control. | Sequencer/EditModeAnimationUtil.h |