unreal.DistanceCurveModifier

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

Bases: unreal.AnimationModifier

Extracts traveling distance information from root motion and bakes it to a curve. A negative value indicates distance remaining to a stop or pivot point. A positive value indicates distance traveled from a start point or from the beginning of the clip.

C++ Source:

  • Plugin: AnimationLocomotionLibrary

  • Module: AnimationLocomotionLibraryEditor

  • File: DistanceCurveModifier.h

Editor Properties: (see get_editor_property/set_editor_property)

  • axis (DistanceCurve_Axis): [Read-Write] Axis: Axes to calculate the distance value from.

  • curve_name (Name): [Read-Write] Curve Name: Name for the generated curve.

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

  • stop_at_end (bool): [Read-Write] Stop at End: Root motion is considered to be stopped at the clip’s end

  • stop_speed_threshold (float): [Read-Write] Stop Speed Threshold: Root motion speed must be below this threshold to be considered stopped.

property axis

[Read-Write] Axis: Axes to calculate the distance value from.

Type

(DistanceCurve_Axis)

property curve_name

[Read-Write] Curve Name: Name for the generated curve.

Type

(Name)

property stop_at_end

[Read-Write] Stop at End: Root motion is considered to be stopped at the clip’s end

Type

(bool)

property stop_speed_threshold

[Read-Write] Stop Speed Threshold: Root motion speed must be below this threshold to be considered stopped.

Type

(float)