`unreal.RigUnit_HierarchyInstantiateFromPhysicsAsset`¶

class unreal.RigUnit_HierarchyInstantiateFromPhysicsAsset(execute_pin: RigVMExecutePin = [], solver: RigPhysicsBodySolverSettings = [], physics_asset: PhysicsAsset = Ellipsis, constraint_profile_name: Name = 'None', bones_to_use: None = [], enable_joints: bool = False, enable_drives: bool = False, add_sim_space_control: bool = False, add_parent_space_control: bool = False, sim_space_control_data: PhysicsControlData = Ellipsis, parent_space_control_data: PhysicsControlData = Ellipsis, physics_body_component_keys: None = [], physics_joint_component_keys: None = [], sim_space_control_component_keys: None = [], parent_space_control_component_keys: None = [])¶

Bases: RigUnit_PhysicsBaseMutable

Creates multiple physics components based on the supplied physics asset. Note that the resulting simulation bodies may not precisely match the physics asset.

C++ Source:

Plugin: PhysicsControl
Module: ControlRigPhysics
File: RigPhysicsExecution.h

Editor Properties: (see get_editor_property/set_editor_property)

add_parent_space_control (bool): [Read-Write]
add_sim_space_control (bool): [Read-Write]
bones_to_use (Array[RigElementKey]): [Read-Write] If this is empty, then all bodies in the physics asset that match a bone in the hierarchy will be created. Otherwise only bodies that relate to the specified bones will be created.
constraint_profile_name (Name): [Read-Write] Name of the constraint profile to use. If empty (or invalid), the default profile will be used
enable_drives (bool): [Read-Write] Whether to enable the drives authored in the physics asset. Note that if you are creating parent space controls, you may not want the drives
enable_joints (bool): [Read-Write] Whether to enable the joints authored in the physics asset. Note that you can’t have drives without joints.
execute_pin (RigVMExecutePin): [Read-Write] * This property is used to chain multiple mutable units together
parent_space_control_component_keys (Array[RigComponentKey]): [Read-Write]
parent_space_control_data (PhysicsControlData): [Read-Write] Data for the parent space control
physics_asset (PhysicsAsset): [Read-Write]
physics_body_component_keys (Array[RigComponentKey]): [Read-Write]
physics_joint_component_keys (Array[RigComponentKey]): [Read-Write]
sim_space_control_component_keys (Array[RigComponentKey]): [Read-Write]
sim_space_control_data (PhysicsControlData): [Read-Write] Data for the simulation space control
solver (RigPhysicsBodySolverSettings): [Read-Write]

property add_parent_space_control: bool¶

[Read-Write]

Type:: (bool)

property add_sim_space_control: bool¶

[Read-Write]

Type:: (bool)

property bones_to_use: None¶

[Read-Write] If this is empty, then all bodies in the physics asset that match a bone in the hierarchy will be created. Otherwise only bodies that relate to the specified bones will be created.

Type:: (Array[RigElementKey])

property constraint_profile_name: Name¶

[Read-Write] Name of the constraint profile to use. If empty (or invalid), the default profile will be used

Type:: (Name)

property enable_drives: bool¶

[Read-Write] Whether to enable the drives authored in the physics asset. Note that if you are creating parent space controls, you may not want the drives