unreal.RigMapperEditorSubsystem

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

Bases: EditorSubsystem

URigMapperEditorSubsystem Subsystem to remap animation from/to all kinds of formats using the Rig Mapper API.

C++ Source:

  • Plugin: RigMapper

  • Module: RigMapperEditor

  • File: RigMapperEditorSubsystem.h

classmethod convert_anim_sequence(source, target, definitions) → bool

Remap an anim sequence to another existing one, remapping it using the given definitions The target sequence rate will be unchanged (see SetAnimSequenceRate if required)

Parameters:
Return type:

bool

classmethod convert_anim_sequence_new(source, target_mesh, definitions, new_asset_path, new_asset_name) → AnimSequence

Remap an anim sequence to a new one, remapping it using the given definitions

Parameters:
Return type:

AnimSequence

classmethod convert_anim_sequence_to_control_rig_section(source, target, definitions) → bool

Convert an AnimSequence to an existing Control Rig section, remapping it using the given definitions Control Rig transform/vector2d/float channels are currently supported The target sequence rate will be unchanged

Parameters:
Return type:

bool

classmethod convert_anim_sequence_to_control_rig_section_new(source, target_mesh, definitions, control_rig_class, new_asset_path, new_asset_name) → MovieSceneControlRigParameterSection

Convert an AnimSequence to a Control Rig section in a new Level Sequence, remapping it using the given definitions Control Rig transform/vector2d/float channels are currently supported

Parameters:
Return type:

MovieSceneControlRigParameterSection

classmethod convert_anim_sequence_to_csv(source, output_file, definitions, output_intermediate_csv_files=False) → bool

Export a CSV file from an anim sequence, remapping it using the given definitions

Parameters:
Return type:

bool

classmethod convert_control_rig_section(source, target, definitions) → bool

Convert a Control Rig section to another existing one, remapping it using the given definitions Control Rig transform/vector2d/float channels are currently supported The target sequence rate will be unchanged

Parameters:
Return type:

bool

classmethod convert_control_rig_section_new(source, target_mesh, definitions, control_rig_class, new_asset_path, new_asset_name) → MovieSceneControlRigParameterSection

Convert a Control Rig section to a section in a new Level Sequence, remapping it using the given definitions Control Rig transform/vector2d/float channels are currently supported

Parameters:
Return type:

MovieSceneControlRigParameterSection

classmethod convert_control_rig_section_to_anim_sequence(source, target, definitions) → bool

Convert a Control Rig section to an existing AnimSequence, remapping it using the given definitions The target sequence rate will be unchanged

Parameters:
Return type:

bool

classmethod convert_control_rig_section_to_anim_sequence_new(source, target_mesh, definitions, new_asset_path, new_asset_name) → AnimSequence

Convert a Control Rig section to a new AnimSequence asset, remapping it using the given definitions

Parameters:
Return type:

AnimSequence

classmethod convert_control_rig_section_to_csv(source, output_file, definitions, output_intermediate_csv_files=False) → bool

Export a CSV file from a Control Rig Section, remapping it using the given definitions

Parameters:
Return type:

bool

classmethod convert_csv(input_file, output_file, definitions, output_intermediate_csv_files=False) → bool

Remap a CSV file using the given definitions, and optionally outputting separate files for each definition’s output The following header is expected at the first line of the CSV file: curve_name, frame_number, value

Parameters:
Return type:

bool

classmethod convert_csv_to_anim_sequence(input_file, target, definitions) → bool

Import a CSV file to an existing anim sequence, remapping it using the given definitions The following header is expected at the first line of the CSV file: curve_name, frame_number, value The target sequence rate will be unchanged (see SetAnimSequenceRate if required)

Parameters:
Return type:

bool

classmethod convert_csv_to_anim_sequence_new(input_file, target_mesh, definitions, frame_rate, new_asset_path, new_asset_name) → AnimSequence

Import a CSV file to a new anim sequence asset, remapping it using the given definitions The following header is expected at the first line of the CSV file: curve_name, frame_number, value

Parameters:
Return type:

AnimSequence

classmethod convert_csv_to_control_rig_section(input_file, target, definitions) → bool

Import a CSV file to the given control rig section, remapping it using the given definitions The following header is expected at the first line of the CSV file: curve_name, frame_number, value Control Rig transform/vector2d/float channels are currently supported The target sequence rate will be unchanged

Parameters:
Return type:

bool

classmethod convert_csv_to_control_rig_section_new(input_file, target_mesh, definitions, frame_rate, control_rig_class, new_asset_path, new_asset_name) → MovieSceneControlRigParameterSection

Import a CSV file to a control rig section in a new Level Sqeuence, remapping it using the given definitions The following header is expected at the first line of the CSV file: curve_name, frame_number, value Control Rig transform/vector2d/float channels are currently supported

Parameters:
Return type:

MovieSceneControlRigParameterSection

classmethod get_anim_sequence_rate(anim_sequence) → FrameRate

Get Anim Sequence Rate

Parameters:

anim_sequence (AnimSequence)

Return type:

FrameRate

classmethod get_sections_from_sequence(sequence) → Array[MovieSceneControlRigParameterSection]

Get Sections from Sequence

Parameters:

sequence (LevelSequence)

Return type:

Array[MovieSceneControlRigParameterSection]

classmethod get_sequence_from_section(section) → LevelSequence

Get Sequence from Section

Parameters:

section (MovieSceneControlRigParameterSection)

Return type:

LevelSequence

classmethod set_anim_sequence_rate(anim_sequence, frame_rate, set_import_properties) → None

Set Anim Sequence Rate

Parameters: