Navigation
API > API/Plugins > API/Plugins/ControlRigEditor
Inheritance Hierarchy
- UBlueprintFunctionLibrary
- UControlRigSequencerEditorLibrary
References
| Module | ControlRigEditor |
| Header | /Engine/Plugins/Animation/ControlRig/Source/ControlRigEditor/Public/ControlRigSequencerEditorLibrary.h |
| Include | #include "ControlRigSequencerEditorLibrary.h" |
Syntax
UCLASS (Meta=(Transient, ScriptName="ControlRigSequencerLibrary"))
class UControlRigSequencerEditorLibrary : public UBlueprintFunctionLibrary
Remarks
This is a set of helper functions to access various parts of the Sequencer and Control Rig API via Python and Blueprints.
Functions
| Type | Name | Description | |
|---|---|---|---|
| UTickableConstraint * | AddConstraint
(
UWorld* World, |
Add a constraint possibly adding to sequencer also if one is open. | |
| bool | BakeConstraint
(
UWorld* World, |
Bake the constraint to keys based on the passed in frames. | |
| bool | BakeConstraints
(
UWorld* World, |
Bake the constraint to keys based on the passed in settings. | |
| bool | BakeControlRigSpace
(
ULevelSequence* InSequence, |
Bake specified Control Rig Controls to a specified Space based upon the current settings | |
| bool | BakeToControlRig
(
UWorld* World, |
Bake the current animation in the binding to a Control Rig track | |
| bool | BlendValuesOnSelected
(
ULevelSequence* LevelSequence, |
Peform specified blend operation based upon selected keys in the curve editor or selected control rig controls | |
| bool | CollapseControlRigAnimLayers
(
ULevelSequence* InSequence, |
Collapse and bake all sections and layers on a control rig track to just one section. | |
| bool | CollapseControlRigAnimLayersWithSettings
(
ULevelSequence* InSequence, |
Collapse and bake all sections and layers on a control rig track to just one section using passed in settings. | |
| bool | Compensate
(
UTickableConstraint* InConstraint, |
Compensate constraint at the specfied time | |
| bool | CompensateAll
(
UTickableConstraint* InConstraint |
Compensate constraint at all keys | |
| bool | DeleteConstraintKey
(
UTickableConstraint* Constraint, |
Delete the Key for the Constraint at the specified time. | |
| bool | DeleteControlRigSpace
(
ULevelSequence* InSequence, |
Delete the Control Rig Space Key for the Control at the specified time. | |
| bool | ExportFBXFromControlRigSection
(
ULevelSequence* Sequence, |
Exports an FBX from the given control rig section. | |
| TArray< UMovieSceneTrack * > | FindOrCreateControlRigComponentTrack
(
UWorld* World, |
Find or create a Control Rig Component | |
| UMovieSceneTrack * | FindOrCreateControlRigTrack
(
UWorld* World, |
Find or create a Control Rig track of a specific class based upon the binding | |
| FTransform | GetActorWorldTransform
(
ULevelSequence* LevelSequence, |
Get Actors World Transform at a specific time | |
| TArray< FTransform > | GetActorWorldTransforms
(
ULevelSequence* LevelSequence, |
Get Actors World Transforms at specific times | |
| bool | GetConstraintKeys
(
UTickableConstraint* InConstraint, |
Get the constraint keys for the specified constraint | |
| TArray< UTickableConstraint * > | GetConstraintsForHandle
(
UWorld* InWorld, |
Get all constraints for this object, which is described by a transformable handle | |
| int32 | GetControlRigPriorityOrder
(
UMovieSceneTrack* InSection |
Get Control Rig prirority order | |
| TArray< FControlRigSequencerBindingProxy > | GetControlRigs
(
ULevelSequence* LevelSequence |
Get all of the control rigs and their bindings in the level sequence | |
| FTransform | GetControlRigWorldTransform
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's World Transform at a specific time | |
| TArray< FTransform > | GetControlRigWorldTransforms
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's World Transforms at specific times | |
| bool | GetControlsMask
(
UMovieSceneSection* InSection, |
Get the controls mask for the given ControlName | |
| FRigElementKey | Get the default parent key, can be used a parent space. | ||
| EControlRigFKRigExecuteMode | GetFKControlRigApplyMode
(
UControlRig* InControlRig |
Get FKControlRig Apply Mode. | |
| bool | GetLocalControlRigBool
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's bool value at a specific time | |
| TArray< bool > | GetLocalControlRigBools
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's bool values at specific times | |
| FEulerTransform | GetLocalControlRigEulerTransform
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's EulerTransform value at a specific time | |
| TArray< FEulerTransform > | GetLocalControlRigEulerTransforms
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's EulerTransform values at specific times | |
| float | GetLocalControlRigFloat
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's float value at a specific time | |
| TArray< float > | GetLocalControlRigFloats
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's float values at specific times | |
| int32 | GetLocalControlRigInt
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's integer value at a specific time | |
| TArray< int32 > | GetLocalControlRigInts
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's integer values at specific times | |
| FVector | GetLocalControlRigPosition
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's Position value at a specific time | |
| TArray< FVector > | GetLocalControlRigPositions
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's Position values at specific times | |
| FRotator | GetLocalControlRigRotator
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's Rotator value at a specific time | |
| TArray< FRotator > | GetLocalControlRigRotators
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's Rotator values at specific times | |
| FVector | GetLocalControlRigScale
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's Scale value at a specific time | |
| TArray< FVector > | GetLocalControlRigScales
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's Scale values at specific times | |
| FTransform | GetLocalControlRigTransform
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's Transform value at a specific time | |
| FTransformNoScale | GetLocalControlRigTransformNoScale
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's TransformNoScale value at a specific time | |
| TArray< FTransformNoScale > | GetLocalControlRigTransformNoScales
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's TransformNoScale values at specific times | |
| TArray< FTransform > | GetLocalControlRigTransforms
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's Transform values at specific times | |
| FVector2D | GetLocalControlRigVector2D
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's Vector2D value at a specific time | |
| TArray< FVector2D > | GetLocalControlRigVector2Ds
(
ULevelSequence* LevelSequence, |
Get ControlRig Control's Vector2D values at specific times | |
| FTransform | GetSkeletalMeshComponentWorldTransform
(
ULevelSequence* LevelSequence, |
Get SkeletalMeshComponent World Transform at a specific time | |
| TArray< FTransform > | GetSkeletalMeshComponentWorldTransforms
(
ULevelSequence* LevelSequence, |
Get SkeletalMeshComponents World Transforms at specific times | |
| TArray< UControlRig * > | Get all of the visible control rigs in the level | ||
| FRigElementKey | Get the default world space key, can be used a world space. | ||
| void | HideAllControls
(
UMovieSceneSection* InSection |
Hides all of the controls for the given section | |
| bool | ImportFBXToControlRigTrack
(
UWorld* World, |
Import FBX onto a control rig with the specified track and section | |
| bool | IsFKControlRig
(
UControlRig* InControlRig |
Whether or not the control rig is an FK Control Rig. | |
| bool | IsLayeredControlRig
(
UControlRig* InControlRig |
Whether or not the control rig is an Layered Control Rig. | |
| bool | LoadAnimSequenceIntoControlRigSection
(
UMovieSceneSection* MovieSceneSection, |
Load anim sequence into this control rig section | |
| bool | MoveConstraintKey
(
UTickableConstraint* Constraint, |
Move the constraint active key in the current open Sequencer | |
| bool | MoveControlRigSpace
(
ULevelSequence* InSequence, |
Move the Control Rig Space Key for the Control at the specified time to the new time. | |
| bool | RenameControlRigControlChannels
(
ULevelSequence* InSequence, |
Rename the Control Rig Channels in Sequencer to the specified new control names, which should be present on the Control Rig | |
| bool | SetConstraintActiveKey
(
UTickableConstraint* InConstraint, |
Set the constraint active key in the current open Sequencer | |
| bool | SetControlRigApplyMode
(
UControlRig* InControlRig, |
Set the FK Control Rig to apply mode | |
| bool | SetControlRigLayeredMode
(
UMovieSceneControlRigParameterTrack* InTrack, |
Convert the control rig track into absolute or layered rig | |
| void | SetControlRigPriorityOrder
(
UMovieSceneTrack* InSection, |
Set Control Rig priority order | |
| bool | SetControlRigSpace
(
ULevelSequence* InSequence, |
Set the a key for the Control Rig Space for the Control at the specified time. | |
| void | SetControlRigWorldTransform
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's World Transform at a specific time | |
| void | SetControlRigWorldTransforms
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's World Transforms at a specific times. | |
| void | SetControlsMask
(
UMovieSceneSection* InSection, |
Set the controls mask for the given ControlNames | |
| void | SetLocalControlRigBool
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's bool value at specific time | |
| void | SetLocalControlRigBools
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's bool values at specific times | |
| void | SetLocalControlRigEulerTransform
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's EulerTransform value at specific time | |
| void | SetLocalControlRigEulerTransforms
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's EulerTransform values at specific times | |
| void | SetLocalControlRigFloat
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's float value at specific time | |
| void | SetLocalControlRigFloats
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's float values at specific times | |
| void | SetLocalControlRigInt
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's int value at specific time | |
| void | SetLocalControlRigInts
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's int values at specific times | |
| void | SetLocalControlRigPosition
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's Position value at specific time | |
| void | SetLocalControlRigPositions
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's Position values at specific times | |
| void | SetLocalControlRigRotator
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's Rotator value at specific time | |
| void | SetLocalControlRigRotators
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's Rotator values at specific times | |
| void | SetLocalControlRigScale
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's Scale value at specific time | |
| void | SetLocalControlRigScales
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's Scale values at specific times | |
| void | SetLocalControlRigTransform
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's Transform value at specific time | |
| void | SetLocalControlRigTransformNoScale
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's TransformNoScale value at specific time | |
| void | SetLocalControlRigTransformNoScales
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's TransformNoScale values at specific times | |
| void | SetLocalControlRigTransforms
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's Transform values at specific times | |
| void | SetLocalControlRigVector2D
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's Vector2D value at specific time | |
| void | SetLocalControlRigVector2Ds
(
ULevelSequence* LevelSequence, |
Set ControlRig Control's Vector2D values at specific times | |
| void | ShowAllControls
(
UMovieSceneSection* InSection |
Shows all of the controls for the given section | |
| bool | SnapControlRig
(
ULevelSequence* LevelSequence, |
Peform a Snap operation to snap the children to the parent. | |
| bool | TweenControlRig
(
ULevelSequence* LevelSequence, |
Peform a Tween operation on the current active sequencer time(must be visible). |