1. Epic GamesDeveloper
  3. UControlRigSequencerEditorLibrary

UControlRigSequencerEditorLibrary

This is a set of helper functions to access various parts of the Sequencer and Control Rig API via Python and Blueprints.

API > API/Plugins > API/Plugins/ControlRigEditor

This is a set of helper functions to access various parts of the Sequencer and Control Rig API via Python and Blueprints.

   
Name UControlRigSequencerEditorLibrary
Type class
Header File /Engine/Plugins/Animation/ControlRig/Source/ControlRigEditor/Public/ControlRigSequencerEditorLibrary.h
Include Path #include "ControlRigSequencerEditorLibrary.h"

Syntax

UCLASS (MinimalAPI, Meta=(Transient, ScriptName="ControlRigSequencerLibrary"))  
class UControlRigSequencerEditorLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static int32 AddAnimLayerFromSelection()

 Add anim layer from objects selected in Sequencer ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig | Animation Layers"

static UTickableConstraint * AddConstraint ( UWorld* World,
ETransformConstraintType InType,
UTransformableHandle* InChild,
UTransformableHandle* InParent,
const bool bMaintainOffset
)

 Add a constraint possibly adding to sequencer also if one is open. ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool BakeConstraint ( UWorld* World,
UTickableConstraint* Constraint,
const TArray< FFrameNumber >& Frames,
EMovieSceneTimeUnit TimeUnit
)

 Bake the constraint to keys based on the passed in frames. ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool BakeConstraints ( UWorld* World,
TArray< UTickableConstraint* >& InConstraints,
const FBakingAnimationKeySettings& InSettings
)

 Bake the constraint to keys based on the passed in settings. ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool BakeControlRigSpace ( ULevelSequence* InSequence,
UControlRig* InControlRig,
const TArray< FName >& InControlNames,
FRigSpacePickerBakeSettings InSettings,
EMovieSceneTimeUnit TimeUnit
)

 Bake specified Control Rig Controls to a specified Space based upon the current settings ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool BakeToControlRig ( UWorld* World,
ULevelSequence* LevelSequence,
UClass* ControlRigClass,
UAnimSeqExportOption* ExportOptions,
bool bReduceKeys,
float Tolerance,
const FMovieSceneBindingProxy& Binding,
bool bResetControls
)

 Bake the current animation in the binding to a Control Rig track ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool BlendValuesOnSelected ( ULevelSequence* LevelSequence,
EAnimToolBlendOperation BlendOperation,
float BlendValue
)

 Peform specified blend operation based upon selected keys in the curve editor or selected control rig controls ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool CollapseControlRigAnimLayers ( ULevelSequence* InSequence,
UMovieSceneControlRigParameterTrack* InTrack,
bool bKeyReduce,
float Tolerance
)

 Collapse and bake all sections and layers on a control rig track to just one section. ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool CollapseControlRigAnimLayersWithSettings ( ULevelSequence* InSequence,
UMovieSceneControlRigParameterTrack* InTrack,
const FBakingAnimationKeySettings& InSettings
)

 Collapse and bake all sections and layers on a control rig track to just one section using passed in settings. ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool Compensate ( UTickableConstraint* InConstraint,
FFrameNumber InTime,
EMovieSceneTimeUnit TimeUnit
)

 Compensate constraint at the specfied time ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool CompensateAll ( UTickableConstraint* InConstraint
)

 Compensate constraint at all keys ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool ControlRigCopyVectorParameterCurvesToTransform ( UMovieSceneControlRigParameterTrack* InTrack,
const FName& InControlName,
ERigControlType InType
)

 Copy the internal parameter curves from vector control rig curves to transform curves, this is needed if a vector type is changed to transform type You would run this script first, resave, and then on next reload the curves should now show up on correct curves in the transform control ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool DeleteAnimLayer ( int32 Index
)

 Delete anim layer at specified index ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig | Animation Layers"

static bool DeleteConstraintKey ( UTickableConstraint* Constraint,
UMovieSceneSection* ConstraintSection,
FFrameNumber InTime,
EMovieSceneTimeUnit TimeUnit
)

 Delete the Key for the Constraint at the specified time. ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool DeleteControlRigSpace ( ULevelSequence* InSequence,
UControlRig* InControlRig,
FName InControlName,
FFrameNumber InTime,
EMovieSceneTimeUnit TimeUnit
)

 Delete the Control Rig Space Key for the Control at the specified time. ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static int32 DuplicateAnimLayer ( int32 Index
)

 Duplicate anim layer at specified index ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig | Animation Layers"

static bool ExportAnimSequenceFromSequencer ( UAnimSequence* AnimSequence,
UAnimSeqExportOption* ExportOption,
const FMovieSceneBindingProxy& Binding,
bool bCreateLink
)

 Export Passed in Binding as an Anim Sequence, using open Level Sequence in Sequencer. ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Animation"

static bool ExportFBXFromControlRigSection ( ULevelSequence* Sequence,
const UMovieSceneControlRigParameterSection* Section,
const UMovieSceneUserExportFBXControlRigSettings* ExportFBXControlRigSettings
)

 Exports an FBX from the given control rig section. ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | FBX"

static TArray< UMovieSceneTrack * > FindOrCreateControlRigComponentTrack ( UWorld* World,
ULevelSequence* LevelSequence,
const FMovieSceneBindingProxy& InBinding
)

 Find or create a Control Rig Component ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static UMovieSceneTrack * FindOrCreateControlRigTrack ( UWorld* World,
ULevelSequence* LevelSequence,
const UClass* ControlRigClass,
const FMovieSceneBindingProxy& InBinding,
bool bIsLayeredControlRig
)

 Find or create a Control Rig track of a specific class based upon the binding ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static FTransform GetActorWorldTransform ( ULevelSequence* LevelSequence,
AActor* Actor,
FFrameNumber Frame,
EMovieSceneTimeUnit TimeUnit
)

 Get Actors World Transform at a specific time ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static TArray< FTransform > GetActorWorldTransforms ( ULevelSequence* LevelSequence,
AActor* Actor,
const TArray< FFrameNumber >& Frames,
EMovieSceneTimeUnit TimeUnit
)

 Get Actors World Transforms at specific times ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static int32 GetAnimLayerIndex ( UAnimLayer* AnimLayer
)

 Helper function to get the index in the anim layer array from the anim layer ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig | Animation Layers"

static TArray< UAnimLayer * > GetAnimLayers ( bool bAddIfDoesNotExist
)

 Get the animation layer objects, will create it bAddIfDoesNotExist is set to true ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig | Animation Layers"

static bool GetConstraintKeys ( UTickableConstraint* InConstraint,
UMovieSceneSection* ConstraintSection,
TArray< bool >& OutBools,
TArray< FFrameNumber >& OutFrames,
EMovieSceneTimeUnit TimeUnit
)

 Get the constraint keys for the specified constraint ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static TArray< UTickableConstraint * > GetConstraintsForHandle ( UWorld* InWorld,
const UTransformableHandle* InChild
)

 Get all constraints for this object, which is described by a transformable handle ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static int32 GetControlRigPriorityOrder ( UMovieSceneTrack* InSection
)

 Get Control Rig prirority order ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static TArray< FControlRigSequencerBindingProxy > GetControlRigs ( ULevelSequence* LevelSequence
)

 Get all of the control rigs and their bindings in the level sequence ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static FTransform GetControlRigWorldTransform ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
FFrameNumber Frame,
EMovieSceneTimeUnit TimeUnit
)

 Get ControlRig Control's World Transform at a specific time ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static TArray< FTransform > GetControlRigWorldTransforms ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
const TArray< FFrameNumber >& Frames,
EMovieSceneTimeUnit TimeUnit
)

 Get ControlRig Control's World Transforms at specific times ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool GetControlsMask ( UMovieSceneSection* InSection,
FName ControlName
)

 Get the controls mask for the given ControlName ControlRigSequencerEditorLibrary.h
  • BlueprintPure
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static FRigElementKey GetDefaultParentKey()

 Get the default parent key, can be used a parent space. ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static EControlRigFKRigExecuteMode GetFKControlRigApplyMode ( UControlRig* InControlRig
)

 Get FKControlRig Apply Mode. ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool GetLocalControlRigBool ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
FFrameNumber Frame,
EMovieSceneTimeUnit TimeUnit
)

 Get ControlRig Control's bool value at a specific time ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static TArray< bool > GetLocalControlRigBools ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
const TArray< FFrameNumber >& Frames,
EMovieSceneTimeUnit TimeUnit
)

 Get ControlRig Control's bool values at specific times ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static FEulerTransform GetLocalControlRigEulerTransform ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
FFrameNumber Frame,
EMovieSceneTimeUnit TimeUnit
)

 Get ControlRig Control's EulerTransform value at a specific time ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static TArray< FEulerTransform > GetLocalControlRigEulerTransforms ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
const TArray< FFrameNumber >& Frames,
EMovieSceneTimeUnit TimeUnit
)

 Get ControlRig Control's EulerTransform values at specific times ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static float GetLocalControlRigFloat ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
FFrameNumber Frame,
EMovieSceneTimeUnit TimeUnit
)

 Get ControlRig Control's float value at a specific time ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static TArray< float > GetLocalControlRigFloats ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
const TArray< FFrameNumber >& Frames,
EMovieSceneTimeUnit TimeUnit
)

 Get ControlRig Control's float values at specific times ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static int32 GetLocalControlRigInt ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
FFrameNumber Frame,
EMovieSceneTimeUnit TimeUnit
)

 Get ControlRig Control's integer value at a specific time ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static TArray< int32 > GetLocalControlRigInts ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
const TArray< FFrameNumber >& Frames,
EMovieSceneTimeUnit TimeUnit
)

 Get ControlRig Control's integer values at specific times ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static FVector GetLocalControlRigPosition ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
FFrameNumber Frame,
EMovieSceneTimeUnit TimeUnit
)

 Get ControlRig Control's Position value at a specific time ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static TArray< FVector > GetLocalControlRigPositions ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
const TArray< FFrameNumber >& Frames,
EMovieSceneTimeUnit TimeUnit
)

 Get ControlRig Control's Position values at specific times ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static FRotator GetLocalControlRigRotator ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
FFrameNumber Frame,
EMovieSceneTimeUnit TimeUnit
)

 Get ControlRig Control's Rotator value at a specific time ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static TArray< FRotator > GetLocalControlRigRotators ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
const TArray< FFrameNumber >& Frames,
EMovieSceneTimeUnit TimeUnit
)

 Get ControlRig Control's Rotator values at specific times ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static FVector GetLocalControlRigScale ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
FFrameNumber Frame,
EMovieSceneTimeUnit TimeUnit
)

 Get ControlRig Control's Scale value at a specific time ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static TArray< FVector > GetLocalControlRigScales ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
const TArray< FFrameNumber >& Frames,
EMovieSceneTimeUnit TimeUnit
)

 Get ControlRig Control's Scale values at specific times ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static FTransform GetLocalControlRigTransform ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
FFrameNumber Frame,
EMovieSceneTimeUnit TimeUnit
)

 Get ControlRig Control's Transform value at a specific time ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static FTransformNoScale GetLocalControlRigTransformNoScale ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
FFrameNumber Frame,
EMovieSceneTimeUnit TimeUnit
)

 Get ControlRig Control's TransformNoScale value at a specific time ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static TArray< FTransformNoScale > GetLocalControlRigTransformNoScales ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
const TArray< FFrameNumber >& Frames,
EMovieSceneTimeUnit TimeUnit
)

 Get ControlRig Control's TransformNoScale values at specific times ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static TArray< FTransform > GetLocalControlRigTransforms ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
const TArray< FFrameNumber >& Frames,
EMovieSceneTimeUnit TimeUnit
)

 Get ControlRig Control's Transform values at specific times ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static FVector2D GetLocalControlRigVector2D ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
FFrameNumber Frame,
EMovieSceneTimeUnit TimeUnit
)

 Get ControlRig Control's Vector2D value at a specific time ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static TArray< FVector2D > GetLocalControlRigVector2Ds ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
const TArray< FFrameNumber >& Frames,
EMovieSceneTimeUnit TimeUnit
)

 Get ControlRig Control's Vector2D values at specific times ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static UAIESelectionSets * GetSelectionSets ( bool bAddIfDoesNotExist
)

 Get the selection set objects, will create it bAddIfDoesNotExist is set to true ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig | Selection Sets"

static FTransform GetSkeletalMeshComponentWorldTransform ( ULevelSequence* LevelSequence,
USkeletalMeshComponent* SkeletalMeshComponent,
FFrameNumber Frame,
EMovieSceneTimeUnit TimeUnit,
FName ReferenceName
)

 Get SkeletalMeshComponent World Transform at a specific time ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static TArray< FTransform > GetSkeletalMeshComponentWorldTransforms ( ULevelSequence* LevelSequence,
USkeletalMeshComponent* SkeletalMeshComponent,
const TArray< FFrameNumber >& Frames,
EMovieSceneTimeUnit TimeUnit,
FName ReferenceName
)

 Get SkeletalMeshComponents World Transforms at specific times ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static TArray< UControlRig * > GetVisibleControlRigs()

 Get all of the visible control rigs in the level ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static FRigElementKey GetWorldSpaceReferenceKey()

 Get the default world space key, can be used a world space. ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void HideAllControls ( UMovieSceneSection* InSection
)

 Hides all of the controls for the given section ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool ImportFBXToControlRigTrack ( UWorld* World,
ULevelSequence* InSequence,
UMovieSceneControlRigParameterTrack* InTrack,
UMovieSceneControlRigParameterSection* InSection,
const TArray< FString >& SelectedControlRigNames,
UMovieSceneUserImportFBXControlRigSettings* ImportFBXControlRigSettings,
const FString& ImportFilename
)

 Import FBX onto a control rig with the specified track and section ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | FBX"

static bool IsFKControlRig ( UControlRig* InControlRig
)

 Whether or not the control rig is an FK Control Rig. ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool IsLayeredControlRig ( UControlRig* InControlRig
)

 Whether or not the control rig is an Layered Control Rig. ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool LoadAnimSequenceIntoControlRigSection ( UMovieSceneSection* MovieSceneSection,
UAnimSequence* AnimSequence,
USkeletalMeshComponent* SkelMeshComp,
FFrameNumber InStartFrame,
EMovieSceneTimeUnit TimeUnit,
bool bKeyReduce,
float Tolerance,
EMovieSceneKeyInterpolation Interpolation,
bool bResetControls
)

   ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"
  • Meta=(DeprecatedFunction, DeprecationMessage="Use LoadAnimSequenceIntoControlRigSectionWithRange that takes UseCustomTimeRange")

static bool LoadAnimSequenceIntoControlRigSectionWithRange ( UMovieSceneSection* MovieSceneSection,
UAnimSequence* AnimSequence,
USkeletalMeshComponent* SkelMeshComp,
FFrameNumber InStartFrame,
bool bUseCustomAnimRange,
FFrameNumber AnimStartRange,
FFrameNumber AnimEndRange,
EMovieSceneTimeUnit TimeUnit,
bool bKeyReduce,
float Tolerance,
EMovieSceneKeyInterpolation Interpolation,
bool bResetControls,
bool bOntoSelectedControls
)

 Load anim sequence into this control rig section ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool MarkLayeredModeOnTrackDisplay ( UMovieSceneControlRigParameterTrack* InTrack
)

 Mark the layered mode of a control rig on the color and display name of a track ControlRigSequencerEditorLibrary.h  

static bool MergeAnimLayers ( const TArray< int32 >& Indices
)

   ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig | AnimationLayers"
  • Meta=(DeprecatedFunction, DeprecationMessage="Use MergeAnimLayersWithSettings that takes FMergeAnimLayerSettings")

static bool MergeAnimLayersWithSettings ( const TArray< int32 >& Indices,
const FMergeAnimLayerSettings& MergeAnimLayerSettings
)

 Merge specified anim layers into one layer. Will merge onto the anim layer with the lowest index ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig | Animation Layers"

static bool MoveConstraintKey ( UTickableConstraint* Constraint,
UMovieSceneSection* ConstraintSection,
FFrameNumber InTime,
FFrameNumber InNewTime,
EMovieSceneTimeUnit TimeUnit
)

 Move the constraint active key in the current open Sequencer ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool MoveControlRigSpace ( ULevelSequence* InSequence,
UControlRig* InControlRig,
FName InControlName,
FFrameNumber InTime,
FFrameNumber InNewTime,
EMovieSceneTimeUnit TimeUnit
)

 Move the Control Rig Space Key for the Control at the specified time to the new time. ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool RenameControlRigControlChannels ( ULevelSequence* InSequence,
UControlRig* InControlRig,
const TArray< FName >& InOldControlNames,
const TArray< FName >& InNewControlNames
)

 Rename the Control Rig Channels in Sequencer to the specified new control names, which should be present on the Control Rig ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool SetConstraintActiveKey ( UTickableConstraint* InConstraint,
bool bActive,
FFrameNumber InFrame,
EMovieSceneTimeUnit TimeUnit
)

 Set the constraint active key in the current open Sequencer ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool SetControlRigApplyMode ( UControlRig* InControlRig,
EControlRigFKRigExecuteMode InApplyMode
)

 Set the FK Control Rig to apply mode ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool SetControlRigLayeredMode ( UMovieSceneControlRigParameterTrack* InTrack,
bool bSetIsLayered
)

 Convert the control rig track into absolute or layered rig ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void SetControlRigPriorityOrder ( UMovieSceneTrack* InSection,
int32 PriorityOrder
)

 Set Control Rig priority order ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool SetControlRigSpace ( ULevelSequence* InSequence,
UControlRig* InControlRig,
FName InControlName,
const FRigElementKey& InSpaceKey,
FFrameNumber InTime,
EMovieSceneTimeUnit TimeUnit
)

 Set the a key for the Control Rig Space for the Control at the specified time. ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void SetControlRigWorldTransform ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
FFrameNumber Frame,
const FTransform& WorldTransform,
EMovieSceneTimeUnit TimeUnit,
bool bSetKey
)

 Set ControlRig Control's World Transform at a specific time ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void SetControlRigWorldTransforms ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
const TArray< FFrameNumber >& Frames,
const TArray< FTransform >& WorldTransforms,
EMovieSceneTimeUnit TimeUnit
)

 Set ControlRig Control's World Transforms at a specific times. ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void SetControlsMask ( UMovieSceneSection* InSection,
const TArray< FName >& ControlNames,
bool bVisible
)

 Set the controls mask for the given ControlNames ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void SetInteraction ( bool bIsInteracting
)

 Sets the interaction state of the following SetLocalControlRig* functions (default is False). ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void SetLocalControlRigBool ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
FFrameNumber Frame,
bool Value,
EMovieSceneTimeUnit TimeUnit,
bool bSetKey
)

 Set ControlRig Control's bool value at specific time ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void SetLocalControlRigBools ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
const TArray< FFrameNumber >& Frames,
const TArray< bool > Values,
EMovieSceneTimeUnit TimeUnit
)

 Set ControlRig Control's bool values at specific times ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void SetLocalControlRigEulerTransform ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
FFrameNumber Frame,
FEulerTransform Value,
EMovieSceneTimeUnit TimeUnit,
bool bSetKey
)

 Set ControlRig Control's EulerTransform value at specific time ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void SetLocalControlRigEulerTransforms ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
const TArray< FFrameNumber >& Frames,
const TArray< FEulerTransform > Values,
EMovieSceneTimeUnit TimeUnit
)

 Set ControlRig Control's EulerTransform values at specific times ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void SetLocalControlRigFloat ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
FFrameNumber Frame,
float Value,
EMovieSceneTimeUnit TimeUnit,
bool bSetKey
)

 Set ControlRig Control's float value at specific time ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void SetLocalControlRigFloats ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
const TArray< FFrameNumber >& Frames,
const TArray< float > Values,
EMovieSceneTimeUnit TimeUnit
)

 Set ControlRig Control's float values at specific times ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void SetLocalControlRigInt ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
FFrameNumber Frame,
int32 Value,
EMovieSceneTimeUnit TimeUnit,
bool bSetKey
)

 Set ControlRig Control's int value at specific time ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void SetLocalControlRigInts ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
const TArray< FFrameNumber >& Frames,
const TArray< int32 > Values,
EMovieSceneTimeUnit TimeUnit
)

 Set ControlRig Control's int values at specific times ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void SetLocalControlRigPosition ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
FFrameNumber Frame,
FVector Value,
EMovieSceneTimeUnit TimeUnit,
bool bSetKey
)

 Set ControlRig Control's Position value at specific time ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void SetLocalControlRigPositions ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
const TArray< FFrameNumber >& Frames,
const TArray< FVector > Values,
EMovieSceneTimeUnit TimeUnit
)

 Set ControlRig Control's Position values at specific times ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void SetLocalControlRigRotator ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
FFrameNumber Frame,
FRotator Value,
EMovieSceneTimeUnit TimeUnit,
bool bSetKey
)

 Set ControlRig Control's Rotator value at specific time ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void SetLocalControlRigRotators ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
const TArray< FFrameNumber >& Frames,
const TArray< FRotator > Values,
EMovieSceneTimeUnit TimeUnit
)

 Set ControlRig Control's Rotator values at specific times ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void SetLocalControlRigScale ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
FFrameNumber Frame,
FVector Value,
EMovieSceneTimeUnit TimeUnit,
bool bSetKey
)

 Set ControlRig Control's Scale value at specific time ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void SetLocalControlRigScales ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
const TArray< FFrameNumber >& Frames,
const TArray< FVector > Values,
EMovieSceneTimeUnit TimeUnit
)

 Set ControlRig Control's Scale values at specific times ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void SetLocalControlRigTransform ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
FFrameNumber Frame,
FTransform Value,
EMovieSceneTimeUnit TimeUnit,
bool bSetKey
)

 Set ControlRig Control's Transform value at specific time ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void SetLocalControlRigTransformNoScale ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
FFrameNumber Frame,
FTransformNoScale Value,
EMovieSceneTimeUnit TimeUnit,
bool bSetKey
)

 Set ControlRig Control's TransformNoScale value at specific time ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void SetLocalControlRigTransformNoScales ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
const TArray< FFrameNumber >& Frames,
const TArray< FTransformNoScale > Values,
EMovieSceneTimeUnit TimeUnit
)

 Set ControlRig Control's TransformNoScale values at specific times ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void SetLocalControlRigTransforms ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
const TArray< FFrameNumber >& Frames,
const TArray< FTransform > Values,
EMovieSceneTimeUnit TimeUnit
)

 Set ControlRig Control's Transform values at specific times ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void SetLocalControlRigVector2D ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
FFrameNumber Frame,
FVector2D Value,
EMovieSceneTimeUnit TimeUnit,
bool bSetKey
)

 Set ControlRig Control's Vector2D value at specific time ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void SetLocalControlRigVector2Ds ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
FName ControlName,
const TArray< FFrameNumber >& Frames,
const TArray< FVector2D > Values,
EMovieSceneTimeUnit TimeUnit
)

 Set ControlRig Control's Vector2D values at specific times ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static void ShowAllControls ( UMovieSceneSection* InSection
)

 Shows all of the controls for the given section ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool SmartReduce ( FSmartReduceParams& ReduceParams,
UMovieSceneSection* MovieSceneSection
)

 Peform new Smart Reduce filter over the specified control rig section in the current open level sequence. ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool SnapControlRig ( ULevelSequence* LevelSequence,
FFrameNumber StartFrame,
FFrameNumber EndFrame,
const FControlRigSnapperSelection& ChildrenToSnap,
const FControlRigSnapperSelection& ParentToSnap,
const UControlRigSnapSettings* SnapSettings,
EMovieSceneTimeUnit TimeUnit
)

 Peform a Snap operation to snap the children to the parent. ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool SpaceCompensate ( UControlRig* InControlRig,
FFrameNumber InTime,
EMovieSceneTimeUnit TimeUnit
)

 Perform compensation for any spaces at the specified time for the specified control rig ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

static bool SpaceCompensateAll ( UControlRig* InControlRig
)

 Perform compensation for all spaces for the specified control rig ControlRigSequencerEditorLibrary.h  

static bool TweenControlRig ( ULevelSequence* LevelSequence,
UControlRig* ControlRig,
float TweenValue
)

 Peform a Tween operation on the current active sequencer time(must be visible). ControlRigSequencerEditorLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page