Navigation
API > API/Plugins > API/Plugins/ControlRigPhysics
A component that can be added to hierarchy elements (joints) to add the data required to control the simulation of them
| Name | FRigPhysicsControlComponent |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/ControlRigPhysics/Source/ControlRigPhysics/Public/RigPhysicsControlComponent.h |
| Include Path | #include "RigPhysicsControlComponent.h" |
Syntax
USTRUCT (BlueprintType )
struct FRigPhysicsControlComponent : public FRigBaseComponent
Inheritance Hierarchy
- FRigBaseComponent → FRigPhysicsControlComponent
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bUseParentBodyAsDefault | bool | If true, and if the parent body component key is not set, the parent body takes a default value, obtained by searching upwards in the hierarchy until a bone with a suitable physics body is found (if there is no body found, then the control will be inactive). | RigPhysicsControlComponent.h |
|
| ChildBodyComponentKey | FRigComponentKey | The body being controlled. | RigPhysicsControlComponent.h |
|
| ControlData | FPhysicsControlData | Describes the initial strength etc of the new control. | RigPhysicsControlComponent.h |
|
| ControlMultiplier | FPhysicsControlMultiplier | This is the currently active control multiplier. | RigPhysicsControlComponent.h |
|
| ControlTarget | FPhysicsControlTarget | Describes the initial target for the new control. | RigPhysicsControlComponent.h |
|
| DirtyFlags | ERigPhysicsControlComponentDirtyFlags | Flags indicating what has been changed and needs to be set in the physics representation. | RigPhysicsControlComponent.h | |
| ParentBodyComponentKey | FRigComponentKey | The body that controls the body being controlled. | RigPhysicsControlComponent.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
DECLARE_RIG_COMPONENT_METHODS
(
FRigPhysicsControlComponent |
RigPhysicsControlComponent.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanBeAddedTo
(
const FRigElementKey& InElementKey, |
RigPhysicsControlComponent.h | ||
virtual FName GetDefaultComponentName() |
RigPhysicsControlComponent.h | ||
virtual void Load
(
FArchive& Ar |
RigPhysicsControlComponent.h | ||
virtual void OnRigHierarchyKeyChanged
(
const FRigHierarchyKey& InOldKey, |
RigPhysicsControlComponent.h | ||
virtual void Save
(
FArchive& A |
RigPhysicsControlComponent.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FName GetDefaultName() |
RigPhysicsControlComponent.h |