unreal.ControlRigSequencerLibrary

class unreal.ControlRigSequencerLibrary(outer=None, name='None')

Bases: unreal.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 bake_control_rig_space(sequence, control_rig, control_names, settings, time_unit=SequenceTimeUnit.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) 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 (SequencerBindingProxy) – The binding upon which to bake

Returns

returns True if successful, False otherwise

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 delete_control_rig_space(sequence, control_rig, control_name, time, time_unit=SequenceTimeUnit.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 (SequenceTimeUnit) – 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 find_or_create_control_rig_component_track(world, level_sequence, binding)

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 (SequencerBindingProxy) – 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) 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 (SequencerBindingProxy) – The binding (actor or component binding) to find or create the Control Rig track

Returns

returns Return the found or created track

Return type

MovieSceneTrack

classmethod get_actor_world_transform(level_sequence, actor, frame, time_unit=SequenceTimeUnit.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 (SequenceTimeUnit) – 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=SequenceTimeUnit.DISPLAY_RATE)

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 (SequenceTimeUnit) – Unit for frame values, either in display rate or tick resolution

Returns

Returns World Transforms

Return type

Array(Transform)

classmethod get_control_rig_world_transform(level_sequence, control_rig, control_name, frame, time_unit=SequenceTimeUnit.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 (SequenceTimeUnit) – 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=SequenceTimeUnit.DISPLAY_RATE)

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 (SequenceTimeUnit) – 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)

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_default_parent_key() RigElementKey
  • Get the default parent key, can be used a parent space.

Return type

RigElementKey

classmethod get_local_control_rig_bool(level_sequence, control_rig, control_name, frame, time_unit=SequenceTimeUnit.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 (SequenceTimeUnit) – 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=SequenceTimeUnit.DISPLAY_RATE)

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 (SequenceTimeUnit) – 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=SequenceTimeUnit.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 (SequenceTimeUnit) – 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=SequenceTimeUnit.DISPLAY_RATE)

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 (SequenceTimeUnit) – 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=SequenceTimeUnit.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 (SequenceTimeUnit) – 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=SequenceTimeUnit.DISPLAY_RATE)

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 (SequenceTimeUnit) – 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=SequenceTimeUnit.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 (SequenceTimeUnit) – 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=SequenceTimeUnit.DISPLAY_RATE)

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 (SequenceTimeUnit) – 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=SequenceTimeUnit.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 (SequenceTimeUnit) – 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=SequenceTimeUnit.DISPLAY_RATE)

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 (SequenceTimeUnit) – 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=SequenceTimeUnit.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 (SequenceTimeUnit) – 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=SequenceTimeUnit.DISPLAY_RATE)

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 (SequenceTimeUnit) – 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=SequenceTimeUnit.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 (SequenceTimeUnit) – 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=SequenceTimeUnit.DISPLAY_RATE)

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 (SequenceTimeUnit) – 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=SequenceTimeUnit.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 (SequenceTimeUnit) – 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=SequenceTimeUnit.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 (SequenceTimeUnit) – 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=SequenceTimeUnit.DISPLAY_RATE)

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 (SequenceTimeUnit) – 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=SequenceTimeUnit.DISPLAY_RATE)

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 (SequenceTimeUnit) – 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=SequenceTimeUnit.DISPLAY_RATE)

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 (SequenceTimeUnit) – 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=SequenceTimeUnit.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 (SequenceTimeUnit) – 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=SequenceTimeUnit.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 (SequenceTimeUnit) – 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=SequenceTimeUnit.DISPLAY_RATE, reference_name='None')

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 (SequenceTimeUnit) – 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()

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 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 load_anim_sequence_into_control_rig_section(movie_scene_section, anim_sequence, skel_mesh_comp, start_frame, time_unit=SequenceTimeUnit.DISPLAY_RATE, key_reduce=False, tolerance=0.001000) 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 (SequenceTimeUnit) – 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.

Returns

returns True if successful, False otherwise

Return type

bool

classmethod move_control_rig_space(sequence, control_rig, control_name, time, new_time, time_unit=SequenceTimeUnit.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 (SequenceTimeUnit) – 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

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_control_rig_space(sequence, control_rig, control_name, space_key, time, time_unit=SequenceTimeUnit.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 (SequenceTimeUnit) – 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=SequenceTimeUnit.DISPLAY_RATE, set_key=True) None

Set ControlRig Control’s World Transform at a specific time oaram: WorldTransform World Transform to set

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) –

  • time_unit (SequenceTimeUnit) – 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=SequenceTimeUnit.DISPLAY_RATE) None

Set ControlRig Control’s World Transforms at a specific times. oaram: WorldTransform World Transform to set

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 (SequenceTimeUnit) – Unit for frame values, either in display rate or tick resolution

classmethod set_local_control_rig_bool(level_sequence, control_rig, control_name, frame, value, time_unit=SequenceTimeUnit.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) – to set

  • time_unit (SequenceTimeUnit) – 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=SequenceTimeUnit.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)) – to set at those times

  • time_unit (SequenceTimeUnit) – 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=SequenceTimeUnit.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) – to set

  • time_unit (SequenceTimeUnit) – 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=SequenceTimeUnit.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)) – to set at those times

  • time_unit (SequenceTimeUnit) – 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=SequenceTimeUnit.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) – to set

  • time_unit (SequenceTimeUnit) – 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=SequenceTimeUnit.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)) – to set at those times

  • time_unit (SequenceTimeUnit) – 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=SequenceTimeUnit.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) – to set

  • time_unit (SequenceTimeUnit) – 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=SequenceTimeUnit.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)) – to set at those times

  • time_unit (SequenceTimeUnit) – 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=SequenceTimeUnit.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) – to set

  • time_unit (SequenceTimeUnit) – 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=SequenceTimeUnit.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)) – to set at those times

  • time_unit (SequenceTimeUnit) – 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=SequenceTimeUnit.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) – to set

  • time_unit (SequenceTimeUnit) – 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=SequenceTimeUnit.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)) – to set at those times

  • time_unit (SequenceTimeUnit) – 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=SequenceTimeUnit.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) – to set

  • time_unit (SequenceTimeUnit) – 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=SequenceTimeUnit.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)) – to set at those times

  • time_unit (SequenceTimeUnit) – 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=SequenceTimeUnit.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) – to set

  • time_unit (SequenceTimeUnit) – 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=SequenceTimeUnit.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) – to set

  • time_unit (SequenceTimeUnit) – 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=SequenceTimeUnit.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)) – to set at those times

  • time_unit (SequenceTimeUnit) – 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=SequenceTimeUnit.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)) – to set at those times

  • time_unit (SequenceTimeUnit) – 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=SequenceTimeUnit.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)) – to set at those times

  • time_unit (SequenceTimeUnit) – 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=SequenceTimeUnit.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) – to set

  • time_unit (SequenceTimeUnit) – 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 snap_control_rig(level_sequence, start_frame, end_frame, children_to_snap, parent_to_snap, snap_settings, time_unit=SequenceTimeUnit.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 (SequenceTimeUnit) – 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