unreal.RigUnit_AddPhysicsComponents

class unreal.RigUnit_AddPhysicsComponents(execute_pin: RigVMExecutePin = [], owner: RigElementKey = Ellipsis, add_joint: bool = False, add_sim_space_control: bool = False, add_parent_space_control: bool = False, physics_body_component_key: RigComponentKey = Ellipsis, physics_joint_component_key: RigComponentKey = Ellipsis, sim_space_control_component_key: RigComponentKey = Ellipsis, parent_space_control_component_key: RigComponentKey = Ellipsis, solver: RigPhysicsBodySolverSettings = [], dynamics: RigPhysicsDynamics = [], collision: RigPhysicsCollision = [], body_data: PhysicsControlModifierData = Ellipsis, joint_data: RigPhysicsJointData = [], drive_data: RigPhysicsDriveData = [], sim_space_control_data: PhysicsControlData = Ellipsis, parent_space_control_data: PhysicsControlData = Ellipsis)

Bases: RigUnit_PhysicsBaseMutable

Adds a set of physics components including the body, joint and controls. 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: RigPhysicsExecution.h

Editor Properties: (see get_editor_property/set_editor_property)

  • add_joint (bool): [Read-Write] Whether to add a Physics Joint

  • add_parent_space_control (bool): [Read-Write] Whether to add a parent-space Physics Control

  • add_sim_space_control (bool): [Read-Write] Whether to add a simulation-space Physics Control

  • body_data (PhysicsControlModifierData): [Read-Write] The runtime modifiable data of the new physics body

  • collision (RigPhysicsCollision): [Read-Write] The collision properties of the new physics body

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

  • dynamics (RigPhysicsDynamics): [Read-Write] The dynamics properties of the new physics body

  • 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_space_control_component_key (RigComponentKey): [Read-Write] The component key of the parent-space Physics Control, if created

  • parent_space_control_data (PhysicsControlData): [Read-Write] Data for the parent space control

  • physics_body_component_key (RigComponentKey): [Read-Write] The component key of the Physics Body

  • physics_joint_component_key (RigComponentKey): [Read-Write] The component key of the Physics Joint, if created

  • sim_space_control_component_key (RigComponentKey): [Read-Write] The component key of the simulation-space Physics Control, if created

  • sim_space_control_data (PhysicsControlData): [Read-Write] Data for the simulation space control

  • solver (RigPhysicsBodySolverSettings): [Read-Write] The solver to relate this new physics element to

property add_joint: bool

[Read-Write] Whether to add a Physics Joint

Type:

(bool)

property add_parent_space_control: bool

[Read-Write] Whether to add a parent-space Physics Control

Type:

(bool)

property add_sim_space_control: bool

[Read-Write] Whether to add a simulation-space Physics Control

Type:

(bool)

property body_data: PhysicsControlModifierData

[Read-Write] The runtime modifiable data of the new physics body

Type:

(PhysicsControlModifierData)

property collision: RigPhysicsCollision

[Read-Write] The collision properties of the new physics body

Type:

(RigPhysicsCollision)

property drive_data: RigPhysicsDriveData

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

Type:

(RigPhysicsDriveData)

property dynamics: RigPhysicsDynamics

[Read-Write] The dynamics properties of the new physics body

Type:

(RigPhysicsDynamics)

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_space_control_component_key: RigComponentKey

[Read-Only] The component key of the parent-space Physics Control, if created

Type:

(RigComponentKey)

property parent_space_control_data: PhysicsControlData

[Read-Write] Data for the parent space control

Type:

(PhysicsControlData)

property physics_body_component_key: RigComponentKey

[Read-Only] The component key of the Physics Body

Type:

(RigComponentKey)

property physics_joint_component_key: RigComponentKey

[Read-Only] The component key of the Physics Joint, if created

Type:

(RigComponentKey)

property sim_space_control_component_key: RigComponentKey

[Read-Only] The component key of the simulation-space Physics Control, if created

Type:

(RigComponentKey)

property sim_space_control_data: PhysicsControlData

[Read-Write] Data for the simulation space control

Type:

(PhysicsControlData)

property solver: RigPhysicsBodySolverSettings

[Read-Write] The solver to relate this new physics element to

Type:

(RigPhysicsBodySolverSettings)