unreal.MotionExtractorModifier

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

Bases: AnimationModifier

Extracts motion from a bone in the animation and bakes it into a curve

C++ Source:

  • Plugin: AnimationModifierLibrary

  • Module: AnimationModifierLibrary

  • File: MotionExtractorModifier.h

Editor Properties: (see get_editor_property/set_editor_property)

  • absolute_value (bool): [Read-Write] Whether to convert the final value to absolute (positive)

  • axis (MotionExtractor_Axis): [Read-Write] Axis to get the value from

  • bone_name (Name): [Read-Write] Bone we are going to generate the curve from

  • custom_curve_name (Name): [Read-Write] Custom name for the curve we are going to generate.

  • math_operation (MotionExtractor_MathOperation): [Read-Write] Optional math operation to apply on the extracted value before add it to the generated curve

  • modifier (float): [Read-Write] Right operand for the math operation selected

  • motion_type (MotionExtractor_MotionType): [Read-Write] Type of motion to extract

  • normalize (bool): [Read-Write] Whether we want a normalized value (0 - 1)

  • reapply_post_owner_change (bool): [Read-Write] If this is set to true then the animation modifier will call it’s reapply function after any change made to the owning asset.

  • relative_to_bone_name (Name): [Read-Write] Bone which we’ll use as the reference frame to generate this curve from. Space must be RelativeToBone to use this.

  • relative_to_first_frame (bool): [Read-Write] Whether to extract the bone transforms relative to the first frame in the animation

  • remove_curve_on_revert (bool): [Read-Write] Whether we want to remove the curve when we revert or re-apply modifier

    Disabling this allows you to modify settings and create a new curve each time you re-apply the modifier Enabling this is the preferred setting when using a modifier that’s applied in bulk and you may want to remove/rename curves

  • sample_rate (int32): [Read-Write] Rate used to sample the animation

  • space (MotionExtractor_Space): [Read-Write] Reference frame/space to use when extracting the bone pose.

  • use_custom_curve_name (bool): [Read-Write] Whether we want to specify a custom name for the curve. If false, the name of the curve will be auto generated based on the data we are going to extract

property absolute_value: bool

[Read-Write] Whether to convert the final value to absolute (positive)

Type:

(bool)

property axis: MotionExtractor_Axis

[Read-Write] Axis to get the value from

Type:

(MotionExtractor_Axis)

property bone_name: Name

[Read-Write] Bone we are going to generate the curve from

Type:

(Name)

property custom_curve_name: Name

[Read-Write] Custom name for the curve we are going to generate.

Type:

(Name)

property math_operation: MotionExtractor_MathOperation

[Read-Write] Optional math operation to apply on the extracted value before add it to the generated curve

Type:

(MotionExtractor_MathOperation)

property modifier: float

[Read-Write] Right operand for the math operation selected

Type:

(float)

property motion_type: MotionExtractor_MotionType

[Read-Write] Type of motion to extract

Type:

(MotionExtractor_MotionType)

property normalize: bool

[Read-Write] Whether we want a normalized value (0 - 1)

Type:

(bool)

property relative_to_bone_name: Name

[Read-Write] Bone which we’ll use as the reference frame to generate this curve from. Space must be RelativeToBone to use this.

Type:

(Name)

property relative_to_first_frame: bool

[Read-Write] Whether to extract the bone transforms relative to the first frame in the animation

Type:

(bool)

property remove_curve_on_revert: bool

[Read-Write] Whether we want to remove the curve when we revert or re-apply modifier Disabling this allows you to modify settings and create a new curve each time you re-apply the modifier Enabling this is the preferred setting when using a modifier that’s applied in bulk and you may want to remove/rename curves

Type:

(bool)

property space: MotionExtractor_Space

[Read-Write] Reference frame/space to use when extracting the bone pose.

Type:

(MotionExtractor_Space)

property use_custom_curve_name: bool

[Read-Write] Whether we want to specify a custom name for the curve. If false, the name of the curve will be auto generated based on the data we are going to extract

Type:

(bool)