Navigation
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 (Meta=(Transient, ScriptName="ControlRigSequencerLibrary"))
class UControlRigSequencerEditorLibrary : public UBlueprintFunctionLibrary
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UBlueprintFunctionLibrary → UControlRigSequencerEditorLibrary
Functions
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static int32 AddAnimLayerFromSelection() |
Add anim layer from objects selected in Sequencer | ControlRigSequencerEditorLibrary.h |
|
static UTickableConstraint * AddConstraint
(
UWorld* World, |
Add a constraint possibly adding to sequencer also if one is open. | ControlRigSequencerEditorLibrary.h |
|
static bool BakeConstraint
(
UWorld* World, |
Bake the constraint to keys based on the passed in frames. | ControlRigSequencerEditorLibrary.h |
|
static bool BakeConstraints
(
UWorld* World, |
Bake the constraint to keys based on the passed in settings. | ControlRigSequencerEditorLibrary.h |
|
static bool BakeControlRigSpace
(
ULevelSequence* InSequence, |
Bake specified Control Rig Controls to a specified Space based upon the current settings | ControlRigSequencerEditorLibrary.h |
|
static bool BakeToControlRig
(
UWorld* World, |
Bake the current animation in the binding to a Control Rig track | ControlRigSequencerEditorLibrary.h |
|
static bool BlendValuesOnSelected
(
ULevelSequence* LevelSequence, |
Peform specified blend operation based upon selected keys in the curve editor or selected control rig controls | ControlRigSequencerEditorLibrary.h |
|
static bool CollapseControlRigAnimLayers
(
ULevelSequence* InSequence, |
Collapse and bake all sections and layers on a control rig track to just one section. | ControlRigSequencerEditorLibrary.h |
|
static bool CollapseControlRigAnimLayersWithSettings
(
ULevelSequence* InSequence, |
Collapse and bake all sections and layers on a control rig track to just one section using passed in settings. | ControlRigSequencerEditorLibrary.h |
|
static bool Compensate
(
UTickableConstraint* InConstraint, |
Compensate constraint at the specfied time | ControlRigSequencerEditorLibrary.h |
|
static bool CompensateAll
(
UTickableConstraint* InConstraint |
Compensate constraint at all keys | ControlRigSequencerEditorLibrary.h |
|
static bool DeleteAnimLayer
(
int32 Index |
Delete anim layer at specified index | ControlRigSequencerEditorLibrary.h |
|
static bool DeleteConstraintKey
(
UTickableConstraint* Constraint, |
Delete the Key for the Constraint at the specified time. | ControlRigSequencerEditorLibrary.h |
|
static bool DeleteControlRigSpace
(
ULevelSequence* InSequence, |
Delete the Control Rig Space Key for the Control at the specified time. | ControlRigSequencerEditorLibrary.h |
|
static int32 DuplicateAnimLayer
(
int32 Index |
Duplicate anim layer at specified index | ControlRigSequencerEditorLibrary.h |
|
static bool ExportAnimSequenceFromSequencer
(
UAnimSequence* AnimSequence, |
Export Passed in Binding as an Anim Sequence, using open Level Sequence in Sequencer. | ControlRigSequencerEditorLibrary.h |
|
static bool ExportFBXFromControlRigSection
(
ULevelSequence* Sequence, |
Exports an FBX from the given control rig section. | ControlRigSequencerEditorLibrary.h |
|
static TArray< UMovieSceneTrack * > FindOrCreateControlRigComponentTrack
(
UWorld* World, |
Find or create a Control Rig Component | ControlRigSequencerEditorLibrary.h |
|
static UMovieSceneTrack * FindOrCreateControlRigTrack
(
UWorld* World, |
Find or create a Control Rig track of a specific class based upon the binding | ControlRigSequencerEditorLibrary.h |
|
static FTransform GetActorWorldTransform
(
ULevelSequence* LevelSequence, |
Get Actors World Transform at a specific time | ControlRigSequencerEditorLibrary.h |
|
static TArray< FTransform > GetActorWorldTransforms
(
ULevelSequence* LevelSequence, |
Get Actors World Transforms at specific times | ControlRigSequencerEditorLibrary.h |
|
static int32 GetAnimLayerIndex
(
UAnimLayer* AnimLayer |
Helper function to get the index in the anim layer array from the anim layer | ControlRigSequencerEditorLibrary.h |
|
static TArray< UAnimLayer * > GetAnimLayers() |
Get the animation layer objects | ControlRigSequencerEditorLibrary.h |
|
static bool GetConstraintKeys
(
UTickableConstraint* InConstraint, |
Get the constraint keys for the specified constraint | ControlRigSequencerEditorLibrary.h |
|
static TArray< UTickableConstraint * > GetConstraintsForHandle
(
UWorld* InWorld, |
Get all constraints for this object, which is described by a transformable handle | ControlRigSequencerEditorLibrary.h |
|
static int32 GetControlRigPriorityOrder
(
UMovieSceneTrack* InSection |
Get Control Rig prirority order | ControlRigSequencerEditorLibrary.h |
|
static TArray< FControlRigSequencerBindingProxy > GetControlRigs
(
ULevelSequence* LevelSequence |
Get all of the control rigs and their bindings in the level sequence | ControlRigSequencerEditorLibrary.h |
|
static FTransform GetControlRigWorldTransform
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's World Transform at a specific time | ControlRigSequencerEditorLibrary.h |
|
static TArray< FTransform > GetControlRigWorldTransforms
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's World Transforms at specific times | ControlRigSequencerEditorLibrary.h |
|
static bool GetControlsMask
(
UMovieSceneSection* InSection, |
Get the controls mask for the given ControlName | ControlRigSequencerEditorLibrary.h |
|
static FRigElementKey GetDefaultParentKey() |
Get the default parent key, can be used a parent space. | ControlRigSequencerEditorLibrary.h |
|
static EControlRigFKRigExecuteMode GetFKControlRigApplyMode
(
UControlRig* InControlRig |
Get FKControlRig Apply Mode. | ControlRigSequencerEditorLibrary.h |
|
static bool GetLocalControlRigBool
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's bool value at a specific time | ControlRigSequencerEditorLibrary.h |
|
static TArray< bool > GetLocalControlRigBools
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's bool values at specific times | ControlRigSequencerEditorLibrary.h |
|
static FEulerTransform GetLocalControlRigEulerTransform
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's EulerTransform value at a specific time | ControlRigSequencerEditorLibrary.h |
|
static TArray< FEulerTransform > GetLocalControlRigEulerTransforms
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's EulerTransform values at specific times | ControlRigSequencerEditorLibrary.h |
|
static float GetLocalControlRigFloat
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's float value at a specific time | ControlRigSequencerEditorLibrary.h |
|
static TArray< float > GetLocalControlRigFloats
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's float values at specific times | ControlRigSequencerEditorLibrary.h |
|
static int32 GetLocalControlRigInt
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's integer value at a specific time | ControlRigSequencerEditorLibrary.h |
|
static TArray< int32 > GetLocalControlRigInts
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's integer values at specific times | ControlRigSequencerEditorLibrary.h |
|
static FVector GetLocalControlRigPosition
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's Position value at a specific time | ControlRigSequencerEditorLibrary.h |
|
static TArray< FVector > GetLocalControlRigPositions
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's Position values at specific times | ControlRigSequencerEditorLibrary.h |
|
static FRotator GetLocalControlRigRotator
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's Rotator value at a specific time | ControlRigSequencerEditorLibrary.h |
|
static TArray< FRotator > GetLocalControlRigRotators
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's Rotator values at specific times | ControlRigSequencerEditorLibrary.h |
|
static FVector GetLocalControlRigScale
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's Scale value at a specific time | ControlRigSequencerEditorLibrary.h |
|
static TArray< FVector > GetLocalControlRigScales
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's Scale values at specific times | ControlRigSequencerEditorLibrary.h |
|
static FTransform GetLocalControlRigTransform
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's Transform value at a specific time | ControlRigSequencerEditorLibrary.h |
|
static FTransformNoScale GetLocalControlRigTransformNoScale
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's TransformNoScale value at a specific time | ControlRigSequencerEditorLibrary.h |
|
static TArray< FTransformNoScale > GetLocalControlRigTransformNoScales
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's TransformNoScale values at specific times | ControlRigSequencerEditorLibrary.h |
|
static TArray< FTransform > GetLocalControlRigTransforms
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's Transform values at specific times | ControlRigSequencerEditorLibrary.h |
|
static FVector2D GetLocalControlRigVector2D
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's Vector2D value at a specific time | ControlRigSequencerEditorLibrary.h |
|
static TArray< FVector2D > GetLocalControlRigVector2Ds
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's Vector2D values at specific times | ControlRigSequencerEditorLibrary.h |
|
static FTransform GetSkeletalMeshComponentWorldTransform
(
ULevelSequence* LevelSequence, |
Get SkeletalMeshComponent World Transform at a specific time | ControlRigSequencerEditorLibrary.h |
|
static TArray< FTransform > GetSkeletalMeshComponentWorldTransforms
(
ULevelSequence* LevelSequence, |
Get SkeletalMeshComponents World Transforms at specific times | ControlRigSequencerEditorLibrary.h |
|
static TArray< UControlRig * > GetVisibleControlRigs() |
Get all of the visible control rigs in the level | ControlRigSequencerEditorLibrary.h |
|
static FRigElementKey GetWorldSpaceReferenceKey() |
Get the default world space key, can be used a world space. | ControlRigSequencerEditorLibrary.h |
|
static void HideAllControls
(
UMovieSceneSection* InSection |
Hides all of the controls for the given section | ControlRigSequencerEditorLibrary.h |
|
static bool ImportFBXToControlRigTrack
(
UWorld* World, |
Import FBX onto a control rig with the specified track and section | ControlRigSequencerEditorLibrary.h |
|
static bool IsFKControlRig
(
UControlRig* InControlRig |
Whether or not the control rig is an FK Control Rig. | ControlRigSequencerEditorLibrary.h |
|
static bool IsLayeredControlRig
(
UControlRig* InControlRig |
Whether or not the control rig is an Layered Control Rig. | ControlRigSequencerEditorLibrary.h |
|
static bool LoadAnimSequenceIntoControlRigSection
(
UMovieSceneSection* MovieSceneSection, |
ControlRigSequencerEditorLibrary.h |
|
|
static bool LoadAnimSequenceIntoControlRigSectionWithRange
(
UMovieSceneSection* MovieSceneSection, |
Load anim sequence into this control rig section | ControlRigSequencerEditorLibrary.h |
|
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 |
|
|
static bool MergeAnimLayersWithSettings
(
const TArray< int32 >& Indices, |
Merge specified anim layers into one layer. Will merge onto the anim layer with the lowest index | ControlRigSequencerEditorLibrary.h |
|
static bool MoveConstraintKey
(
UTickableConstraint* Constraint, |
Move the constraint active key in the current open Sequencer | ControlRigSequencerEditorLibrary.h |
|
static bool MoveControlRigSpace
(
ULevelSequence* InSequence, |
Move the Control Rig Space Key for the Control at the specified time to the new time. | ControlRigSequencerEditorLibrary.h |
|
| Rename the Control Rig Channels in Sequencer to the specified new control names, which should be present on the Control Rig | ControlRigSequencerEditorLibrary.h |
|
|
static bool SetConstraintActiveKey
(
UTickableConstraint* InConstraint, |
Set the constraint active key in the current open Sequencer | ControlRigSequencerEditorLibrary.h |
|
static bool SetControlRigApplyMode
(
UControlRig* InControlRig, |
Set the FK Control Rig to apply mode | ControlRigSequencerEditorLibrary.h |
|
static bool SetControlRigLayeredMode
(
UMovieSceneControlRigParameterTrack* InTrack, |
Convert the control rig track into absolute or layered rig | ControlRigSequencerEditorLibrary.h |
|
static void SetControlRigPriorityOrder
(
UMovieSceneTrack* InSection, |
Set Control Rig priority order | ControlRigSequencerEditorLibrary.h |
|
static bool SetControlRigSpace
(
ULevelSequence* InSequence, |
Set the a key for the Control Rig Space for the Control at the specified time. | ControlRigSequencerEditorLibrary.h |
|
static void SetControlRigWorldTransform
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's World Transform at a specific time | ControlRigSequencerEditorLibrary.h |
|
static void SetControlRigWorldTransforms
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's World Transforms at a specific times. | ControlRigSequencerEditorLibrary.h |
|
static void SetControlsMask
(
UMovieSceneSection* InSection, |
Set the controls mask for the given ControlNames | ControlRigSequencerEditorLibrary.h |
|
static void SetLocalControlRigBool
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's bool value at specific time | ControlRigSequencerEditorLibrary.h |
|
static void SetLocalControlRigBools
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's bool values at specific times | ControlRigSequencerEditorLibrary.h |
|
static void SetLocalControlRigEulerTransform
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's EulerTransform value at specific time | ControlRigSequencerEditorLibrary.h |
|
static void SetLocalControlRigEulerTransforms
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's EulerTransform values at specific times | ControlRigSequencerEditorLibrary.h |
|
static void SetLocalControlRigFloat
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's float value at specific time | ControlRigSequencerEditorLibrary.h |
|
static void SetLocalControlRigFloats
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's float values at specific times | ControlRigSequencerEditorLibrary.h |
|
static void SetLocalControlRigInt
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's int value at specific time | ControlRigSequencerEditorLibrary.h |
|
static void SetLocalControlRigInts
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's int values at specific times | ControlRigSequencerEditorLibrary.h |
|
static void SetLocalControlRigPosition
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's Position value at specific time | ControlRigSequencerEditorLibrary.h |
|
static void SetLocalControlRigPositions
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's Position values at specific times | ControlRigSequencerEditorLibrary.h |
|
static void SetLocalControlRigRotator
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's Rotator value at specific time | ControlRigSequencerEditorLibrary.h |
|
static void SetLocalControlRigRotators
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's Rotator values at specific times | ControlRigSequencerEditorLibrary.h |
|
static void SetLocalControlRigScale
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's Scale value at specific time | ControlRigSequencerEditorLibrary.h |
|
static void SetLocalControlRigScales
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's Scale values at specific times | ControlRigSequencerEditorLibrary.h |
|
static void SetLocalControlRigTransform
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's Transform value at specific time | ControlRigSequencerEditorLibrary.h |
|
static void SetLocalControlRigTransformNoScale
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's TransformNoScale value at specific time | ControlRigSequencerEditorLibrary.h |
|
static void SetLocalControlRigTransformNoScales
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's TransformNoScale values at specific times | ControlRigSequencerEditorLibrary.h |
|
static void SetLocalControlRigTransforms
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's Transform values at specific times | ControlRigSequencerEditorLibrary.h |
|
static void SetLocalControlRigVector2D
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's Vector2D value at specific time | ControlRigSequencerEditorLibrary.h |
|
static void SetLocalControlRigVector2Ds
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's Vector2D values at specific times | ControlRigSequencerEditorLibrary.h |
|
static void ShowAllControls
(
UMovieSceneSection* InSection |
Shows all of the controls for the given section | ControlRigSequencerEditorLibrary.h |
|
static bool SmartReduce
(
FSmartReduceParams& ReduceParams, |
Peform new Smart Reduce filter over the specified control rig section in the current open level sequence. | ControlRigSequencerEditorLibrary.h |
|
static bool SnapControlRig
(
ULevelSequence* LevelSequence, |
Peform a Snap operation to snap the children to the parent. | ControlRigSequencerEditorLibrary.h |
|
static bool SpaceCompensate
(
UControlRig* InControlRig, |
Perform compensation for any spaces at the specified time for the specified control rig | ControlRigSequencerEditorLibrary.h |
|
static bool SpaceCompensateAll
(
UControlRig* InControlRig |
Perform compensation for all spaces for the specified control rig | ControlRigSequencerEditorLibrary.h | |
static bool TweenControlRig
(
ULevelSequence* LevelSequence, |
Peform a Tween operation on the current active sequencer time(must be visible). | ControlRigSequencerEditorLibrary.h |
|