Navigation
API > API/Plugins > API/Plugins/ControlRigPhysics
A component that can be added to a joint/element that defines how a physical body can be "attached" to it. The body supports dynamic movement, collision, and a physics joint with this body's parent in the hierarchy.
| Name | FRigPhysicsBodyComponent |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/PhysicsControl/Source/ControlRigPhysics/Public/RigPhysicsBodyComponent.h |
| Include Path | #include "RigPhysicsBodyComponent.h" |
Syntax
USTRUCT (BlueprintType )
struct FRigPhysicsBodyComponent : public FRigBaseComponent
Inheritance Hierarchy
- FRigBaseComponent → FRigPhysicsBodyComponent
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BodyData | FPhysicsControlModifierData | RigPhysicsBodyComponent.h |
|
|
| Collision | FRigPhysicsCollision | RigPhysicsBodyComponent.h |
|
|
| Dynamics | FRigPhysicsDynamics | RigPhysicsBodyComponent.h |
|
|
| KinematicTarget | FTransform | The target for when this body is kinematic. | RigPhysicsBodyComponent.h |
|
| KinematicTargetSpace | ERigPhysicsKinematicTargetSpace | RigPhysicsBodyComponent.h |
|
|
| NoCollisionBodies | TArray< FRigComponentKey > | A list of body components with which we should not collide. The solver component can also be included. | RigPhysicsBodyComponent.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AutoCalculateCollision
(
URigHierarchy* InHierarchy, |
Removes any existing collision, and replaces it with a shape calculated from the joint positions (if possible). | RigPhysicsBodyComponent.h | |
virtual bool CanBeAddedTo
(
const FRigElementKey& InElementKey, |
RigPhysicsBodyComponent.h | ||
DECLARE_RIG_COMPONENT_METHODS
(
FRigPhysicsBodyComponent |
RigPhysicsBodyComponent.h | ||
virtual FName GetDefaultComponentName() |
RigPhysicsBodyComponent.h | ||
virtual const FSlateIcon & GetIconForUI() |
RigPhysicsBodyComponent.h | ||
virtual void Load
(
FArchive& Ar |
RigPhysicsBodyComponent.h | ||
virtual void OnAddedToHierarchy
(
URigHierarchy* InHierarchy, |
RigPhysicsBodyComponent.h | ||
virtual void OnRigHierarchyKeyChanged
(
const FRigHierarchyKey& InOldKey, |
RigPhysicsBodyComponent.h | ||
virtual void Save
(
FArchive& Ar |
RigPhysicsBodyComponent.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FName GetDefaultName() |
RigPhysicsBodyComponent.h |