Navigation
API > API/Plugins > API/Plugins/ControlRigPhysics
This represents an "articulation" - a general purpose "character joint" consisting of
- A linear limit (a linear constraint), which is normally used to pin two bones together
- An angular limit (an angular constraint), which is normally used to allow a limited range of rotational movement.
The joint is defined by a parent frame, which is attached to the parent body, and a child frame which is attached to the child body. If the limits are all zero, then these two bodies will be held in a fixed pose. Normally the angular limit will be relaxed to allow rotational movement around the joint position.
Most bodies in a character will have one Physics Joint which connects them to their parent in the hierarchy. However
- The root of the hierarchy will not have an enabled Physics Joint
- There may be times when a body has additional Physics Joints.
| Name | FRigPhysicsJointData |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/ControlRigPhysics/Source/ControlRigPhysics/Public/RigPhysicsData.h |
| Include Path | #include "RigPhysicsData.h" |
Syntax
USTRUCT (BlueprintType )
struct FRigPhysicsJointData
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AngularProjectionAmount | float | The amount of angular projection to reduce joint separation when the angular constraint is locked or has a hard limit. | RigPhysicsData.h |
|
| bAutoCalculateChildOffset | bool | The auto-calculated offset of the child frame is for it to be co-located with the child body. | RigPhysicsData.h |
|
| bAutoCalculateParentOffset | bool | The auto-calculated offset of the parent frame from the parent body places it at the location of the child body relative to the parent body in the initial pose. | RigPhysicsData.h |
|
| bDisableCollision | bool | Disable collisions between the parent and child bodies. | RigPhysicsData.h |
|
| bEnabled | bool | RigPhysicsData.h |
|
|
| ConeConstraint | FConeConstraint | RigPhysicsData.h |
|
|
| ExtraChildOffset | FTransform | The child frame offset applied after any auto-calculation. | RigPhysicsData.h |
|
| ExtraParentOffset | FTransform | The parent frame offset applied after any auto-calculation. | RigPhysicsData.h |
|
| LinearConstraint | FLinearConstraint | RigPhysicsData.h |
|
|
| LinearProjectionAmount | float | The amount of linear projection to reduce joint separation when the linear constraint is locked or has a hard limit. | RigPhysicsData.h |
|
| ParentInverseMassScale | float | As this is reduced to 0, the parent body becomes less affected by the motion of the child body, making the joint behave in one direction. | RigPhysicsData.h |
|
| TwistConstraint | FTwistConstraint | RigPhysicsData.h |
|