`unreal.MotionExtractorUtilityLibrary`¶

class unreal.MotionExtractorUtilityLibrary(outer: Optional[Object] = None, name: Union[Name, str] = 'None')¶

Motion Extractor Utility Library

C++ Source:

classmethod generate_curve_name(bone_name, motion_type, axis) → Name¶

Generates a curve name based on input settings.

Parameters:

bone_name (Name) – The name of the bone
motion_type (MotionExtractor_MotionType) – What type of motion this curve represents (translation, rotation, speed, etc.)
axis (MotionExtractor_Axis) – Which axis/axes the motion for this curve was extracted from

Return type:

Name

classmethod get_desired_value(bone_transform, last_bone_transform, delta_time, motion_type, axis) → float¶

Returns the desired value from the extracted poses based on input settings.

Parameters:

bone_transform (Transform) – Current frame’s bone transform
last_bone_transform (Transform) – Last frame’s bone transform. Unused when not calculating speeds.
delta_time (float) – Time step used between current and last bone transforms. Unused when not calculating speeds.
motion_type (MotionExtractor_MotionType) – What type of motion to extract (translation, rotation, speed, etc.)
axis (MotionExtractor_Axis) – Which axis/axes to extract motion from

Return type:

float

classmethod get_moving_ranges_from_root_motion(anim_sequence, stop_speed_threshold=10.000000, sample_rate=120.000000) → Array[Vector2D]¶

Returns the ranges (X/Start to Y/End) in the specified animation sequence where the animation is considered moving.

Parameters:

anim_sequence (AnimSequence) – Anim sequence to check
stop_speed_threshold (float) – Root motion speed over which the animation is considered moving.
sample_rate (float) – Sample rate of the animation. It’s recommended to use high values if the animation has very sudden direction changes.

Return type:

Array[Vector2D]

classmethod get_stopped_ranges_from_root_motion(anim_sequence, stop_speed_threshold=10.000000, sample_rate=120.000000) → Array[Vector2D]¶

Returns the ranges (X/Start to Y/End) in the specified animation sequence where the animation is considered stopped.

Parameters:

anim_sequence (AnimSequence) – Anim sequence to check
stop_speed_threshold (float) – Root motion speed under which the animation is considered stopped.
sample_rate (float) – Sample rate of the animation. It’s recommended to use high values if the animation has very sudden direction changes.

Return type:

Array[Vector2D]

unreal.MotionExtractorUtilityLibrary¶