unreal.RigUnit_MakeArticulationDriveData

class unreal.RigUnit_MakeArticulationDriveData(enable_angular_drive: bool = False, angular_drive_mode: AngularDriveMode = Ellipsis, angular_strength: float = 0.0, angular_damping_ratio: float = 0.0, angular_extra_damping: float = 0.0, skeletal_animation_velocity_multiplier: float = 0.0, drive_data: RigPhysicsDriveData = [])

Bases: RigUnit_PhysicsBase

Helper to simplify creation of drive data for a typical articulation (i.e. no linear drive, but with an angular drive)

C++ Source:

  • Plugin: ControlRigPhysics

  • Module: ControlRigPhysics

  • File: RigPhysicsJointExecution.h

Editor Properties: (see get_editor_property/set_editor_property)

  • angular_damping_ratio (float): [Read-Write] The amount of damping associated with the angular strength. A value of 1 Results in critically damped motion where the control drives as quickly as possible to the target without overshooting. Values > 1 result in more damped motion, and values below 1 result in faster, but more “wobbly” motion.

  • angular_drive_mode (AngularDriveMode): [Read-Write] The type of drive. Note that SLERP drives don’t work if any axis is locked

  • angular_extra_damping (float): [Read-Write] The amount of additional angular damping. This is added to the damping that comes from AngularDampingRatio and can be useful when you want damping even when AngularStrength is zero.

  • angular_strength (float): [Read-Write] The strength used to drive angular motion

  • drive_data (RigPhysicsDriveData): [Read-Write]

  • enable_angular_drive (bool): [Read-Write] Whether to enable the angular drive

  • skeletal_animation_velocity_multiplier (float): [Read-Write] The amount of skeletal animation velocity to use in the targets

property angular_damping_ratio: float

[Read-Write] The amount of damping associated with the angular strength. A value of 1 Results in critically damped motion where the control drives as quickly as possible to the target without overshooting. Values > 1 result in more damped motion, and values below 1 result in faster, but more “wobbly” motion.

Type:

(float)

property angular_drive_mode: AngularDriveMode

[Read-Write] The type of drive. Note that SLERP drives don’t work if any axis is locked

Type:

(AngularDriveMode)

property angular_extra_damping: float

[Read-Write] The amount of additional angular damping. This is added to the damping that comes from AngularDampingRatio and can be useful when you want damping even when AngularStrength is zero.

Type:

(float)

property angular_strength: float

[Read-Write] The strength used to drive angular motion

Type:

(float)

property drive_data: RigPhysicsDriveData

[Read-Only]

Type:

(RigPhysicsDriveData)

property enable_angular_drive: bool

[Read-Write] Whether to enable the angular drive

Type:

(bool)

property skeletal_animation_velocity_multiplier: float

[Read-Write] The amount of skeletal animation velocity to use in the targets

Type:

(float)