Instantiate From Physics Asset | Unreal Engine 5.7 Documentation

This page is not available in the language you have chosen. It will be displayed in English by default. If you would like to view it in a different language, you can try selecting another language.

Description

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

Information

Plugin	ControlRigPhysics
Category	RigPhysics
Tags	Construction,Create,New
Type	FRigUnit_HierarchyInstantiateFromPhysicsAsset

IO

Name	Description	Permitted Types	Default Value
ExecutePin	This property is used to chain multiple mutable units together	Execute Context

Inputs

Name	Description	Permitted Types	Default Value
PhysicsSolverComponentKey	Note that setting the solver component, if known, has the benefit of avoiding the need to search for an automatic solver.	Rig Component Key	(ElementKey=(Type=Bone,Name=""),Name="PhysicsSolver")
bUseAutomaticSolver	If true (and the physics solver is not explicitly set), then this component will be added to any physics solver that exists above it in the hierarchy, if that solver allows automatically adding physics components.	bool	True
PhysicsAsset	The Physics Asset to instantiate from	Physics Asset	None
ConstraintProfileName	Name of the constraint profile to use. If empty (or invalid), the default profile will be used	FName	None
BonesToUse	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.	TArray<FRigElementKey>	()
bEnableJoints	Whether to enable the joints authored in the physics asset. Note that you can't have drives without joints.	bool	True
bEnableDrives	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	bool	True
bAddSimSpaceControl	Whether to create a simulation-space control for each body that was created	bool	False
bAddParentSpaceControl	Whether to create a parent-space control for each body that was created. Note that if this is set to true, then it will be created for the root-most body in the physics asset too. This is often not needed, so make sure it isn't enabled if you don't want it to be.	bool	False
SimSpaceControlData	Data for the simulation space control	Physics Control Data	(bEnabled=True,LinearStrength=0.000000,LinearDampingRatio=1.000000,LinearExtraDamping=0.000000,MaxForce=0.000000,AngularStrength=0.000000,AngularDampingRatio=1.000000,AngularExtraDamping=0.000000,MaxTorque=0.000000,LinearTargetVelocityMultiplier=1.000000,AngularTargetVelocityMultiplier=1.000000,CustomControlPoint=(X=0.000000,Y=0.000000,Z=0.000000),bUseCustomControlPoint=False,bUseSkeletalAnimation=True,bDisableCollision=False,bOnlyControlChildObject=False)
ParentSpaceControlData	Data for the parent space control	Physics Control Data	(bEnabled=True,LinearStrength=0.000000,LinearDampingRatio=1.000000,LinearExtraDamping=0.000000,MaxForce=0.000000,AngularStrength=0.000000,AngularDampingRatio=1.000000,AngularExtraDamping=0.000000,MaxTorque=0.000000,LinearTargetVelocityMultiplier=1.000000,AngularTargetVelocityMultiplier=1.000000,CustomControlPoint=(X=0.000000,Y=0.000000,Z=0.000000),bUseCustomControlPoint=False,bUseSkeletalAnimation=True,bDisableCollision=False,bOnlyControlChildObject=False)

Outputs

Name	Description	Permitted Types
PhysicsBodyComponentKeys	The Physics Body component keys that were created	TArray<FRigComponentKey>
PhysicsJointComponentKeys	The Physics Joint component keys that were created	TArray<FRigComponentKey>
SimSpaceControlComponentKeys	The simulation-space Physics Control component keys that were created	TArray<FRigComponentKey>
ParentSpaceControlComponentKeys	The parent-space Physics Control component keys that were created	TArray<FRigComponentKey>