Navigation
API > API/Plugins > API/Plugins/PhysicsControl
This is the record for a control. It stores the "original" data, which will normally stay fixed. In addition, it will also store some updates to these original data which will determine how the actual controls get used.
| Name | FRigidBodyControlRecord |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/PhysicsControl/Source/PhysicsControl/Public/RigidBodyControlData.h |
| Include Path | #include "RigidBodyControlData.h" |
Syntax
struct FRigidBodyControlRecord
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigidBodyControlRecord
(
const FPhysicsControl& InControl, |
RigidBodyControlData.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ChildBodyIndex | int32 | Cached child body index - needs to be updated whenever the bone name changes. | RigidBodyControlData.h | |
| Control | FPhysicsControl | The configuration data. | RigidBodyControlData.h | |
| ControlData | FPhysicsControlData | This is the currently active control data. | RigidBodyControlData.h | |
| ControlMultiplier | FPhysicsControlMultiplier | This is the currently active control multiplier. | RigidBodyControlData.h | |
| ControlTarget | FRigidBodyControlTarget | Contains any control target that has been set. | RigidBodyControlData.h | |
| ExpectedUpdateCounter | FGraphTraversalCounter | Update counter set when the control was last updated. | RigidBodyControlData.h | |
| JointHandle | ImmediatePhysics::FJointHandle * | The low-level physics representation. | RigidBodyControlData.h | |
| ParentBodyIndex | int32 | Cached parent body index - needs to be updated whenever the bone name changes. | RigidBodyControlData.h | |
| PreviousTargetTM | UE::PhysicsControl::FPosQuat | The previous control target. | RigidBodyControlData.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FVector GetControlPoint
(
const ImmediatePhysics::FActorHandle* ChildActorHandle |
Returns the control point, which may be custom or automatic (centre of mass) | RigidBodyControlData.h | |
bool IsEnabled() |
Note that this is only correct when called during or after the update has been done. | RigidBodyControlData.h | |
void ResetCurrent
(
bool bResetTarget |
RigidBodyControlData.h |