unreal.RigUnit_AddPhysicsJoint

class unreal.RigUnit_AddPhysicsJoint(execute_pin: RigVMExecutePin = [], owner: RigElementKey = Ellipsis, physics_joint_component_key: RigComponentKey = Ellipsis, parent_body_component_key: RigComponentKey = Ellipsis, child_body_component_key: RigComponentKey = Ellipsis, joint_data: RigPhysicsJointData = [], drive_data: RigPhysicsDriveData = [])

Bases: RigUnit_PhysicsBaseMutable

Adds a new Physics Joint as a component on the owner element. Note: This node only runs during the construction event (before physics instantiation, after which this data is frozen).

C++ Source:

  • Plugin: ControlRigPhysics

  • Module: ControlRigPhysics

  • File: RigPhysicsJointExecution.h

Editor Properties: (see get_editor_property/set_editor_property)

  • child_body_component_key (RigComponentKey): [Read-Write] The child body of the joint. If unset, then the system will try to find a suitable body amongst the body components under owner.

  • drive_data (RigPhysicsDriveData): [Read-Write] Optional motor/drive associated with the physics joint

  • execute_pin (RigVMExecutePin): [Read-Write] This property is used to chain multiple mutable units together

  • joint_data (RigPhysicsJointData): [Read-Write] The properties of the joint

  • owner (RigElementKey): [Read-Write] The owner of the newly created component (must be set/valid)

  • parent_body_component_key (RigComponentKey): [Read-Write] The parent body of the joint. If unset, then the system will try to find a suitable body by looking for a parent/grandparent of the owner etc that contains a body that is in the same solver as the child body.

  • physics_joint_component_key (RigComponentKey): [Read-Write] The Physics Joint component key that was created

property child_body_component_key: RigComponentKey

[Read-Write] The child body of the joint. If unset, then the system will try to find a suitable body amongst the body components under owner.

Type:

(RigComponentKey)

property drive_data: RigPhysicsDriveData

[Read-Write] Optional motor/drive associated with the physics joint

Type:

(RigPhysicsDriveData)

property joint_data: RigPhysicsJointData

[Read-Write] The properties of the joint

Type:

(RigPhysicsJointData)

property owner: RigElementKey

[Read-Write] The owner of the newly created component (must be set/valid)

Type:

(RigElementKey)

property parent_body_component_key: RigComponentKey

[Read-Write] The parent body of the joint. If unset, then the system will try to find a suitable body by looking for a parent/grandparent of the owner etc that contains a body that is in the same solver as the child body.

Type:

(RigComponentKey)

property physics_joint_component_key: RigComponentKey

[Read-Only] The Physics Joint component key that was created

Type:

(RigComponentKey)