unreal.ControlRigSequencerLibrary

class unreal.ControlRigSequencerLibrary(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

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

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRigEditor

  • File: ControlRigSequencerEditorLibrary.h

classmethod add_constraint(world, type, child, parent, maintain_offset) → TickableConstraint

Add a constraint possibly adding to sequencer also if one is open.

Parameters:

  • world (World) – The active world

  • type (TransformConstraintType) – Type of constraint to create

  • child (TransformableHandle) – The handle to the transormable to be constrainted

  • parent (TransformableHandle) – The handle to the parent of the constraint

  • maintain_offset (bool) – Whether to maintain offset between child and parent when setting the constraint

Returns:

Returns the constraint if created all nullptr if not

Return type:

TickableConstraint

classmethod bake_constraint(world, constraint, frames, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → bool

Bake the constraint to keys based on the passed in frames. This will use the open sequencer to bake. See ConstraintsScriptingLibrary to get the list of available constraints

Parameters:

  • world (World) – The active world

  • constraint (TickableConstraint) – The Constraint to bake. After baking it will be keyed to be inactive of the range of frames that are baked

  • frames (Array[FrameNumber]) – The frames to bake, if the array is empty it will use the active time ranges of the constraint to determine where it should bake

  • time_unit (MovieSceneTimeUnit) – Unit for all frame and time values, either in display rate or tick resolution

Returns:

Returns True if successful, False otherwise

Return type:

bool

classmethod bake_constraints(world, settings) → Array[TickableConstraint] or None

Bake the constraint to keys based on the passed in settings. This will use the open sequencer to bake. See ConstraintsScriptingLibrary to get the list of available constraints

Parameters:
Returns:

Returns True if successful, False otherwise

constraints (Array[TickableConstraint]): The Constraints tobake. After baking they will be keyed to be inactive of the range of frames that are baked

Return type:

Array[TickableConstraint] or None

classmethod bake_control_rig_space(sequence, control_rig, control_names, settings, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → bool

Bake specified Control Rig Controls to a specified Space based upon the current settings

Parameters:
Return type:

bool

classmethod bake_to_control_rig(world, level_sequence, control_rig_class, export_options, reduce_keys, tolerance, binding, reset_controls=True) → bool

Bake the current animation in the binding to a Control Rig track

Parameters:

  • world (World) – The active world

  • level_sequence (LevelSequence) – The LevelSequence we are baking

  • control_rig_class (type(Class)) – The class of the Control Rig

  • export_options (AnimSeqExportOption) – Export options for creating an animation sequence

  • reduce_keys (bool) –

  • tolerance (float) – If reducing keys, tolerance about which keys will be removed, smaller tolerance, more keys usually.

  • binding (MovieSceneBindingProxy) – The binding upon which to bake

  • reset_controls (bool) – If true will reset all controls to initial value on every frame

Returns:

returns True if successful, False otherwise

Return type:

bool

classmethod blend_values_on_selected(level_sequence, blend_operation, blend_value) → bool

Peform specified blend operation based upon selected keys in the curve editor or selected control rig controls

Parameters:

  • level_sequence (LevelSequence) – The LevelSequence that’s loaded in the editor

  • blend_operation (AnimToolBlendOperation) –

  • blend_value (float) – The blend value to use, range from -1(blend to previous) to 1(blend to next)

Return type:

bool

classmethod collapse_control_rig_anim_layers(sequence, track, key_reduce=False, tolerance=0.001000) → bool

  • Collapse and bake all sections and layers on a control rig track to just one section.

Parameters:

  • sequence (LevelSequence) – Sequence that has track to collapse *

  • track (MovieSceneControlRigParameterTrack) – Track for layers to collapse *

  • key_reduce (bool) – If true do key reduction based upon Tolerance, if false don’t *

  • tolerance (float) – If reducing keys, tolerance about which keys will be removed, smaller tolerance, more keys usually.

Return type:

bool

classmethod collapse_control_rig_anim_layers_with_settings(sequence, track, settings) → bool

  • Collapse and bake all sections and layers on a control rig track to just one section using passed in settings.

Parameters:
Return type:

bool

classmethod compensate(constraint, time, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → bool

Compensate constraint at the specfied time

Parameters:
Returns:

Returns true if it can compensate

Return type:

bool

classmethod compensate_all(constraint) → bool

Compensate constraint at all keys

Parameters:

constraint (TickableConstraint) – The constraint to compensate

Returns:

Returns true if it can compensate

Return type:

bool

classmethod delete_constraint_key(constraint, constraint_section, time, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → bool

Delete the Key for the Constraint at the specified time.

Parameters:
Returns:

Will return false if function fails, for example if there is no key at this time it will fail.

Return type:

bool

classmethod delete_control_rig_space(sequence, control_rig, control_name, time, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → bool

Delete the Control Rig Space Key for the Control at the specified time. This will delete any attached Control Rig keys at this time and will perform any needed compensation to the new space.

Parameters:

  • sequence (LevelSequence) – Sequence to set the space

  • control_rig (ControlRig) – ControlRig with the Control

  • control_name (Name) – The name of the Control

  • time (FrameNumber) – Time to delete the space.

  • time_unit (MovieSceneTimeUnit) – Unit for the InTime, either in display rate or tick resolution

Returns:

Will return false if function fails, for example if there is no key at this time it will fail.

Return type:

bool

classmethod export_fbx_from_control_rig_section(sequence, section, export_fbx_control_rig_settings) → bool

Exports an FBX from the given control rig section.

Parameters:
Return type:

bool

classmethod find_or_create_control_rig_component_track(world, level_sequence, binding) → Array[MovieSceneTrack]

Find or create a Control Rig Component

Parameters:

  • world (World) – The world used to spawn into temporarily if binding is a spawnable

  • level_sequence (LevelSequence) – The LevelSequence to find or create

  • binding (MovieSceneBindingProxy) – The binding (actor or component binding) to find or create the Control Rig tracks

Returns:

returns Find array of component Control Rigs that were found or created

Return type:

Array[MovieSceneTrack]

classmethod find_or_create_control_rig_track(world, level_sequence, control_rig_class, binding, is_layered_control_rig=False) → MovieSceneTrack

Find or create a Control Rig track of a specific class based upon the binding

Parameters:

  • world (World) – The world used to spawn into temporarily if binding is a spawnable

  • level_sequence (LevelSequence) – The LevelSequence to find or create

  • control_rig_class (type(Class)) – The class of the Control Rig

  • binding (MovieSceneBindingProxy) – The binding (actor or component binding) to find or create the Control Rig track

  • is_layered_control_rig (bool) –

Returns:

returns Return the found or created track

Return type:

MovieSceneTrack

classmethod get_actor_world_transform(level_sequence, actor, frame, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → Transform

Get Actors World Transform at a specific time

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get transform for

  • actor (Actor) – The actor

  • frame (FrameNumber) – Time to get the transform

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

Returns:

Returns World Transform

Return type:

Transform

classmethod get_actor_world_transforms(level_sequence, actor, frames, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → Array[Transform]

Get Actors World Transforms at specific times

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get transform for

  • actor (Actor) – The actor

  • frames (Array[FrameNumber]) – Times to get the transform

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

Returns:

Returns World Transforms

Return type:

Array[Transform]

classmethod get_constraint_keys(constraint, constraint_section, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → (out_bools=Array[bool], out_frames=Array[FrameNumber]) or None

Get the constraint keys for the specified constraint

Parameters:
Returns:

Returns true if we got the keys from this constraint

out_bools (Array[bool]): Array of whether or not it’s active at the specified times

out_frames (Array[FrameNumber]): The Times for the keys

Return type:

tuple or None

classmethod get_constraints_for_handle(world, child) → Array[TickableConstraint]

Get all constraints for this object, which is described by a transformable handle

Parameters:
Returns:

Returns array of Constraints this handle is constrained to.

Return type:

Array[TickableConstraint]

classmethod get_control_rig_priority_order(section) → int32

Get Control Rig prirority order

Parameters:

section (MovieSceneTrack) –

Return type:

int32

classmethod get_control_rig_world_transform(level_sequence, control_rig, control_name, frame, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → Transform

Get ControlRig Control’s World Transform at a specific time

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get transform for

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control

  • frame (FrameNumber) – Time to get the transform

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

Returns:

Returns World Transform

Return type:

Transform

classmethod get_control_rig_world_transforms(level_sequence, control_rig, control_name, frames, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → Array[Transform]

Get ControlRig Control’s World Transforms at specific times

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get transform for

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control

  • frames (Array[FrameNumber]) – Times to get the transform

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

Returns:

Returns World Transforms

Return type:

Array[Transform]

classmethod get_control_rigs(level_sequence) → Array[ControlRigSequencerBindingProxy]

Get all of the control rigs and their bindings in the level sequence

Parameters:

level_sequence (LevelSequence) – The movie scene sequence to look for Control Rigs

Returns:

returns list of Control Rigs in the level sequence.

Return type:

Array[ControlRigSequencerBindingProxy]

classmethod get_controls_mask(section, control_name) → bool

Get the controls mask for the given ControlName

Parameters:
Return type:

bool

classmethod get_default_parent_key() → RigElementKey

  • Get the default parent key, can be used a parent space.

Return type:

RigElementKey

classmethod get_fk_control_rig_apply_mode(control_rig) → ControlRigFKRigExecuteMode

Get FKControlRig Apply Mode.

Parameters:

control_rig (ControlRig) – Rig to test

Returns:

The EControlRigFKRigExecuteMode mode it is in, either Replace,Additive or Direct

Return type:

ControlRigFKRigExecuteMode

classmethod get_local_control_rig_bool(level_sequence, control_rig, control_name, frame, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → bool

Get ControlRig Control’s bool value at a specific time

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get value for

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a bool control

  • frame (FrameNumber) – Time to get the value

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

Returns:

Returns Value at that time

Return type:

bool

classmethod get_local_control_rig_bools(level_sequence, control_rig, control_name, frames, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → Array[bool]

Get ControlRig Control’s bool values at specific times

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get value for

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a bool control

  • frames (Array[FrameNumber]) – Times to get the values

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

Returns:

Returns Values at those times

Return type:

Array[bool]

classmethod get_local_control_rig_euler_transform(level_sequence, control_rig, control_name, frame, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → EulerTransform

Get ControlRig Control’s EulerTransform value at a specific time

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get value for

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a EulerTransfom control

  • frame (FrameNumber) – Time to get the value

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

Returns:

Returns Value at that time

Return type:

EulerTransform

classmethod get_local_control_rig_euler_transforms(level_sequence, control_rig, control_name, frames, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → Array[EulerTransform]

Get ControlRig Control’s EulerTransform values at specific times

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get value for

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a EulerTransform control

  • frames (Array[FrameNumber]) – Times to get the values

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

Returns:

Returns Values at those times

Return type:

Array[EulerTransform]

classmethod get_local_control_rig_float(level_sequence, control_rig, control_name, frame, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → float

Get ControlRig Control’s float value at a specific time

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get value for

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a float control

  • frame (FrameNumber) – Time to get the value

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

Returns:

Returns Value at that time

Return type:

float

classmethod get_local_control_rig_floats(level_sequence, control_rig, control_name, frames, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → Array[float]

Get ControlRig Control’s float values at specific times

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get value for

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a float control

  • frames (Array[FrameNumber]) – Times to get the values

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

Returns:

Returns Values at those times

Return type:

Array[float]

classmethod get_local_control_rig_int(level_sequence, control_rig, control_name, frame, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → int32

Get ControlRig Control’s integer value at a specific time

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get value for

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a integer control

  • frame (FrameNumber) – Time to get the value

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

Returns:

Returns Value at that time

Return type:

int32

classmethod get_local_control_rig_ints(level_sequence, control_rig, control_name, frames, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → Array[int32]

Get ControlRig Control’s integer values at specific times

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get value for

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a intteger control

  • frames (Array[FrameNumber]) – Times to get the values

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

Returns:

Returns Values at those times

Return type:

Array[int32]

classmethod get_local_control_rig_position(level_sequence, control_rig, control_name, frame, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → Vector

Get ControlRig Control’s Position value at a specific time

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get value for

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a Position control

  • frame (FrameNumber) – Time to get the value

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

Returns:

Returns Value at that time

Return type:

Vector

classmethod get_local_control_rig_positions(level_sequence, control_rig, control_name, frames, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → Array[Vector]

Get ControlRig Control’s Position values at specific times

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get value for

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a Position control

  • frames (Array[FrameNumber]) – Times to get the values

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

Returns:

Returns Values at those times

Return type:

Array[Vector]

classmethod get_local_control_rig_rotator(level_sequence, control_rig, control_name, frame, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → Rotator

Get ControlRig Control’s Rotator value at a specific time

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get value for

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a Rotator control

  • frame (FrameNumber) – Time to get the value

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

Returns:

Returns Value at that time

Return type:

Rotator

classmethod get_local_control_rig_rotators(level_sequence, control_rig, control_name, frames, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → Array[Rotator]

Get ControlRig Control’s Rotator values at specific times

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get value for

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a Rotator control

  • frames (Array[FrameNumber]) – Times to get the values

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

Returns:

Returns Values at those times

Return type:

Array[Rotator]

classmethod get_local_control_rig_scale(level_sequence, control_rig, control_name, frame, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → Vector

Get ControlRig Control’s Scale value at a specific time

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get value for

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a Scale control

  • frame (FrameNumber) – Time to get the value

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

Returns:

Returns Value at that time

Return type:

Vector

classmethod get_local_control_rig_scales(level_sequence, control_rig, control_name, frames, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → Array[Vector]

Get ControlRig Control’s Scale values at specific times

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get value for

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a Scale control

  • frames (Array[FrameNumber]) – Times to get the values

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

Returns:

Returns Values at those times

Return type:

Array[Vector]

classmethod get_local_control_rig_transform(level_sequence, control_rig, control_name, frame, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → Transform

Get ControlRig Control’s Transform value at a specific time

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get value for

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a Transform control

  • frame (FrameNumber) – Time to get the value

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

Returns:

Returns Value at that time

Return type:

Transform

classmethod get_local_control_rig_transform_no_scale(level_sequence, control_rig, control_name, frame, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → TransformNoScale

Get ControlRig Control’s TransformNoScale value at a specific time

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get value for

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a TransformNoScale control

  • frame (FrameNumber) – Time to get the value

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

Returns:

Returns Value at that time

Return type:

TransformNoScale

classmethod get_local_control_rig_transform_no_scales(level_sequence, control_rig, control_name, frames, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → Array[TransformNoScale]

Get ControlRig Control’s TransformNoScale values at specific times

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get value for

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a TransformNoScale control

  • frames (Array[FrameNumber]) – Times to get the values

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

Returns:

Returns Values at those times

Return type:

Array[TransformNoScale]

classmethod get_local_control_rig_transforms(level_sequence, control_rig, control_name, frames, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → Array[Transform]

Get ControlRig Control’s Transform values at specific times

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get value for

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a Transform control

  • frames (Array[FrameNumber]) – Times to get the values

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

Returns:

Returns Values at those times

Return type:

Array[Transform]

classmethod get_local_control_rig_vector2_ds(level_sequence, control_rig, control_name, frames, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → Array[Vector2D]

Get ControlRig Control’s Vector2D values at specific times

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get value for

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a Vector2D control

  • frames (Array[FrameNumber]) – Times to get the values

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

Returns:

Returns Values at those times

Return type:

Array[Vector2D]

classmethod get_local_control_rig_vector2d(level_sequence, control_rig, control_name, frame, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → Vector2D

Get ControlRig Control’s Vector2D value at a specific time

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get value for

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a Vector2D control

  • frame (FrameNumber) – Time to get the value

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

Returns:

Returns Value at that time

Return type:

Vector2D

classmethod get_skeletal_mesh_component_world_transform(level_sequence, skeletal_mesh_component, frame, time_unit=MovieSceneTimeUnit.DISPLAY_RATE, reference_name='None') → Transform

Get SkeletalMeshComponent World Transform at a specific time

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get transform for

  • skeletal_mesh_component (SkeletalMeshComponent) – The SkeletalMeshComponent

  • frame (FrameNumber) – Time to get the transform

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

  • reference_name (Name) – Optional name of the referencer

Returns:

Returns World Transform

Return type:

Transform

classmethod get_skeletal_mesh_component_world_transforms(level_sequence, skeletal_mesh_component, frames, time_unit=MovieSceneTimeUnit.DISPLAY_RATE, reference_name='None') → Array[Transform]

Get SkeletalMeshComponents World Transforms at specific times

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to get transform for

  • skeletal_mesh_component (SkeletalMeshComponent) – The SkeletalMeshComponent

  • frames (Array[FrameNumber]) – Times to get the transform

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

  • reference_name (Name) – Optional name of the referencer

Returns:

Returns World Transforms

Return type:

Array[Transform]

classmethod get_visible_control_rigs() → Array[ControlRig]

Get all of the visible control rigs in the level

Returns:

returns list of visible Control Rigs

Return type:

Array[ControlRig]

classmethod get_world_space_reference_key() → RigElementKey

  • Get the default world space key, can be used a world space.

Return type:

RigElementKey

classmethod hide_all_controls(section) → None

Hides all of the controls for the given section

Parameters:

section (MovieSceneSection) –

classmethod import_fbx_to_control_rig_track(world, sequence, track, section, selected_control_rig_names, import_fbx_control_rig_settings, import_filename) → bool

  • Import FBX onto a control rig with the specified track and section

Parameters:
Return type:

bool

classmethod is_fk_control_rig(control_rig) → bool

Whether or not the control rig is an FK Control Rig.

Parameters:

control_rig (ControlRig) – Rig to test to see if FK Control Rig

Return type:

bool

classmethod is_layered_control_rig(control_rig) → bool

Whether or not the control rig is an Layered Control Rig.

Parameters:

control_rig (ControlRig) – Rig to test to see if Layered Control Rig

Return type:

bool

classmethod load_anim_sequence_into_control_rig_section(movie_scene_section, anim_sequence, skel_mesh_comp, start_frame, time_unit=MovieSceneTimeUnit.DISPLAY_RATE, key_reduce=False, tolerance=0.001000, interpolation=MovieSceneKeyInterpolation.SMART_AUTO, reset_controls=True) → bool

Load anim sequence into this control rig section

Parameters:

  • movie_scene_section (MovieSceneSection) – The MovieSceneSectionto load into

  • anim_sequence (AnimSequence) – The Sequence to load

  • skel_mesh_comp (SkeletalMeshComponent) –

  • start_frame (FrameNumber) – Frame to insert the animation

  • time_unit (MovieSceneTimeUnit) – Unit for all frame and time values, either in display rate or tick resolution

  • key_reduce (bool) – If true do key reduction based upon Tolerance, if false don’t

  • tolerance (float) – If reducing keys, tolerance about which keys will be removed, smaller tolerance, more keys usually.

  • interpolation (MovieSceneKeyInterpolation) – The key interpolation type to set the keys, defaults to EMovieSceneKeyInterpolation::SmartAuto

  • reset_controls (bool) – If true will reset all controls to initial value on every frame

Returns:

returns True if successful, False otherwise

Return type:

bool

classmethod move_constraint_key(constraint, constraint_section, time, new_time, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → bool

Move the constraint active key in the current open Sequencer

Parameters:
Returns:

Will return false if function fails, for example if there is no key at this time it will fail, or if the new time is invalid it could fail also

Return type:

bool

classmethod move_control_rig_space(sequence, control_rig, control_name, time, new_time, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → bool

Move the Control Rig Space Key for the Control at the specified time to the new time. This will also move any Control Rig keys at this space switch boundary.

Parameters:

  • sequence (LevelSequence) – Sequence to set the space

  • control_rig (ControlRig) – ControlRig with the Control

  • control_name (Name) – The name of the Control

  • time (FrameNumber) – Original time of the space key

  • new_time (FrameNumber) – New time for the space key

  • time_unit (MovieSceneTimeUnit) – Unit for the time params, either in display rate or tick resolution

Returns:

Will return false if function fails, for example if there is no key at this time it will fail, or if the new time is invalid it could fail also

Return type:

bool

classmethod rename_control_rig_control_channels(sequence, control_rig, old_control_names, new_control_names) → bool

Rename the Control Rig Channels in Sequencer to the specified new control names, which should be present on the Control Rig

Parameters:

  • sequence (LevelSequence) – Sequence to rename controls

  • control_rig (ControlRig) – ControlRig to rename controls

  • old_control_names (Array[Name]) – The name of the old Control Rig Control Channels to change. Will be replaced by the corresponding name in the InNewControlNames array

  • new_control_names (Array[Name]) – The name of the new Control Rig Channels

Returns:

Return true if the function succeeds, false if it doesn’t which can happen if the name arrays don’t match in size or any of the new Control Names aren’t valid

Return type:

bool

classmethod set_constraint_active_key(constraint, active, frame, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → bool

Set the constraint active key in the current open Sequencer

Parameters:
Returns:

Returns true if we set the constraint to be the passed in value, false if not. We may not do so if the value is the same.

Return type:

bool

classmethod set_control_rig_apply_mode(control_rig, apply_mode) → bool

Set the FK Control Rig to apply mode

Parameters:
Returns:

returns True if the mode was set, may not be set if the Control Rig doesn’t support these modes currently only FKControlRig’s do.

Return type:

bool

classmethod set_control_rig_layered_mode(track, set_is_layered) → bool

  • Convert the control rig track into absolute or layered rig

Parameters:
Return type:

bool

classmethod set_control_rig_priority_order(section, priority_order) → None

Set Control Rig priority order

Parameters:
classmethod set_control_rig_space(sequence, control_rig, control_name, space_key, time, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → bool

  • Set the a key for the Control Rig Space for the Control at the specified time. If space is the same as the current no key witll be set.

Parameters:

  • sequence (LevelSequence) – Sequence to set the space *

  • control_rig (ControlRig) – ControlRig with the Control *

  • control_name (Name) – The name of the Control *

  • space_key (RigElementKey) – The new space for the Control *

  • time (FrameNumber) – Time to change the space. *

  • time_unit (MovieSceneTimeUnit) – Unit for the InTime, either in display rate or tick resolution

Return type:

bool

classmethod set_control_rig_world_transform(level_sequence, control_rig, control_name, frame, world_transform, time_unit=MovieSceneTimeUnit.DISPLAY_RATE, set_key=True) → None

Set ControlRig Control’s World Transform at a specific time

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to set transforms for. Must be loaded in Level Editor.

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control

  • frame (FrameNumber) – Time to set the transform

  • world_transform (Transform) – World Transform to set

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

  • set_key (bool) – Whether or not to set a key.

classmethod set_control_rig_world_transforms(level_sequence, control_rig, control_name, frames, world_transforms, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → None

Set ControlRig Control’s World Transforms at a specific times.

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to set transforms for. Must be loaded in Level Editor.

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control

  • frames (Array[FrameNumber]) – Times to set the transform

  • world_transforms (Array[Transform]) –

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

classmethod set_controls_mask(section, control_names, visible) → None

Set the controls mask for the given ControlNames

Parameters:
classmethod set_local_control_rig_bool(level_sequence, control_rig, control_name, frame, value, time_unit=MovieSceneTimeUnit.DISPLAY_RATE, set_key=True) → None

Set ControlRig Control’s bool value at specific time

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to set value on

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a bool control

  • frame (FrameNumber) – Time to set the value

  • value (bool) – The value to set

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

  • set_key (bool) – If True set a key, if not just set the value

classmethod set_local_control_rig_bools(level_sequence, control_rig, control_name, frames, values, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → None

Set ControlRig Control’s bool values at specific times

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to set value on

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a bool control

  • frames (Array[FrameNumber]) – Times to set the values

  • values (Array[bool]) – The values to set at those times

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

classmethod set_local_control_rig_euler_transform(level_sequence, control_rig, control_name, frame, value, time_unit=MovieSceneTimeUnit.DISPLAY_RATE, set_key=True) → None

Set ControlRig Control’s EulerTransform value at specific time

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to set value on

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a EulerTransform control

  • frame (FrameNumber) – Time to set the value

  • value (EulerTransform) – The value to set

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

  • set_key (bool) – If True set a key, if not just set the value

classmethod set_local_control_rig_euler_transforms(level_sequence, control_rig, control_name, frames, values, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → None

Set ControlRig Control’s EulerTransform values at specific times

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to set value on

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a EulerTransform control

  • frames (Array[FrameNumber]) – Times to set the values

  • values (Array[EulerTransform]) – The values to set at those times

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

classmethod set_local_control_rig_float(level_sequence, control_rig, control_name, frame, value, time_unit=MovieSceneTimeUnit.DISPLAY_RATE, set_key=True) → None

Set ControlRig Control’s float value at specific time

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to set value on

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a float control

  • frame (FrameNumber) – Time to set the value

  • value (float) – The value to set

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

  • set_key (bool) – If True set a key, if not just set the value

classmethod set_local_control_rig_floats(level_sequence, control_rig, control_name, frames, values, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → None

Set ControlRig Control’s float values at specific times

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to set value on

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a float control

  • frames (Array[FrameNumber]) – Times to set the values

  • values (Array[float]) – The values to set at those times

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

classmethod set_local_control_rig_int(level_sequence, control_rig, control_name, frame, value, time_unit=MovieSceneTimeUnit.DISPLAY_RATE, set_key=True) → None

Set ControlRig Control’s int value at specific time

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to set value on

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a int control

  • frame (FrameNumber) – Time to set the value

  • value (int32) – The value to set

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

  • set_key (bool) – If True set a key, if not just set the value

classmethod set_local_control_rig_ints(level_sequence, control_rig, control_name, frames, values, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → None

Set ControlRig Control’s int values at specific times

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to set value on

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a int control

  • frames (Array[FrameNumber]) – Times to set the values

  • values (Array[int32]) – The values to set at those times

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

classmethod set_local_control_rig_position(level_sequence, control_rig, control_name, frame, value, time_unit=MovieSceneTimeUnit.DISPLAY_RATE, set_key=True) → None

Set ControlRig Control’s Position value at specific time

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to set value on

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a Position control

  • frame (FrameNumber) – Time to set the value

  • value (Vector) – The value to set

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

  • set_key (bool) – If True set a key, if not just set the value

classmethod set_local_control_rig_positions(level_sequence, control_rig, control_name, frames, values, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → None

Set ControlRig Control’s Position values at specific times

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to set value on

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a Position control

  • frames (Array[FrameNumber]) – Times to set the values

  • values (Array[Vector]) – The values to set at those times

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

classmethod set_local_control_rig_rotator(level_sequence, control_rig, control_name, frame, value, time_unit=MovieSceneTimeUnit.DISPLAY_RATE, set_key=True) → None

Set ControlRig Control’s Rotator value at specific time

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to set value on

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a Rotator control

  • frame (FrameNumber) – Time to set the value

  • value (Rotator) – The value to set

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

  • set_key (bool) – If True set a key, if not just set the value

classmethod set_local_control_rig_rotators(level_sequence, control_rig, control_name, frames, values, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → None

Set ControlRig Control’s Rotator values at specific times

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to set value on

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a Rotator control

  • frames (Array[FrameNumber]) – Times to set the values

  • values (Array[Rotator]) – The values to set at those times

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

classmethod set_local_control_rig_scale(level_sequence, control_rig, control_name, frame, value, time_unit=MovieSceneTimeUnit.DISPLAY_RATE, set_key=True) → None

Set ControlRig Control’s Scale value at specific time

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to set value on

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a Scale control

  • frame (FrameNumber) – Time to set the value

  • value (Vector) – The value to set

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

  • set_key (bool) – If True set a key, if not just set the value

classmethod set_local_control_rig_scales(level_sequence, control_rig, control_name, frames, values, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → None

Set ControlRig Control’s Scale values at specific times

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to set value on

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a Scale control

  • frames (Array[FrameNumber]) – Times to set the values

  • values (Array[Vector]) – The values to set at those times

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

classmethod set_local_control_rig_transform(level_sequence, control_rig, control_name, frame, value, time_unit=MovieSceneTimeUnit.DISPLAY_RATE, set_key=True) → None

Set ControlRig Control’s Transform value at specific time

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to set value on

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a Transform control

  • frame (FrameNumber) – Time to set the value

  • value (Transform) – The value to set

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

  • set_key (bool) – If True set a key, if not just set the value

classmethod set_local_control_rig_transform_no_scale(level_sequence, control_rig, control_name, frame, value, time_unit=MovieSceneTimeUnit.DISPLAY_RATE, set_key=True) → None

Set ControlRig Control’s TransformNoScale value at specific time

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to set value on

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a TransformNoScale control

  • frame (FrameNumber) – Time to set the value

  • value (TransformNoScale) – The value to set

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

  • set_key (bool) – If True set a key, if not just set the value

classmethod set_local_control_rig_transform_no_scales(level_sequence, control_rig, control_name, frames, values, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → None

Set ControlRig Control’s TransformNoScale values at specific times

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to set value on

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a TransformNoScale control

  • frames (Array[FrameNumber]) – Times to set the values

  • values (Array[TransformNoScale]) – The values to set at those times

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

classmethod set_local_control_rig_transforms(level_sequence, control_rig, control_name, frames, values, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → None

Set ControlRig Control’s Transform values at specific times

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to set value on

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a Transform control

  • frames (Array[FrameNumber]) – Times to set the values

  • values (Array[Transform]) – The values to set at those times

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

classmethod set_local_control_rig_vector2_ds(level_sequence, control_rig, control_name, frames, values, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → None

Set ControlRig Control’s Vector2D values at specific times

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to set value on

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a Vector2D control

  • frames (Array[FrameNumber]) – Times to set the values

  • values (Array[Vector2D]) – The values to set at those times

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

classmethod set_local_control_rig_vector2d(level_sequence, control_rig, control_name, frame, value, time_unit=MovieSceneTimeUnit.DISPLAY_RATE, set_key=True) → None

Set ControlRig Control’s Vector2D value at specific time

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to set value on

  • control_rig (ControlRig) – The ControlRig

  • control_name (Name) – Name of the Control, should be a Vector2D control

  • frame (FrameNumber) – Time to set the value

  • value (Vector2D) – The value to set

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

  • set_key (bool) – If True set a key, if not just set the value

classmethod show_all_controls(section) → None

Shows all of the controls for the given section

Parameters:

section (MovieSceneSection) –

classmethod snap_control_rig(level_sequence, start_frame, end_frame, children_to_snap, parent_to_snap, snap_settings, time_unit=MovieSceneTimeUnit.DISPLAY_RATE) → bool

Peform a Snap operation to snap the children to the parent.

Parameters:

  • level_sequence (LevelSequence) – Active Sequence to snap

  • start_frame (FrameNumber) – Beginning of the snap

  • end_frame (FrameNumber) – End of the snap

  • children_to_snap (ControlRigSnapperSelection) – The children objects that snap and get keys set onto. They need to live in an active Sequencer in the level editor

  • parent_to_snap (ControlRigSnapperSelection) – The parent object to snap relative to. If animated, it needs to live in an active Sequencer in the level editor

  • snap_settings (ControlRigSnapSettings) – Settings to use

  • time_unit (MovieSceneTimeUnit) – Unit for frame values, either in display rate or tick resolution

Return type:

bool

classmethod tween_control_rig(level_sequence, control_rig, tween_value) → bool

Peform a Tween operation on the current active sequencer time(must be visible).

Parameters:

  • level_sequence (LevelSequence) – The LevelSequence that’s loaded in the editor

  • control_rig (ControlRig) – The Control Rig to tween.

  • tween_value (float) – The tween value to use, range from -1(blend to previous) to 1(blend to next)

Return type:

bool