Navigation
API > API/Plugins > API/Plugins/ControlRigDynamics
A component that can be added to a joint/element that defines a constraint between two particles.
| Name | FRigDynamicsConstraintComponent |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/ControlRigDynamics/Source/ControlRigDynamics/Public/RigDynamicsConstraintComponent.h |
| Include Path | #include "RigDynamicsConstraintComponent.h" |
Syntax
USTRUCT (BlueprintType )
struct FRigDynamicsConstraintComponent : public FRigBaseComponent
Inheritance Hierarchy
- FRigBaseComponent → FRigDynamicsConstraintComponent
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bAccelerationMode | bool | For soft constraints: When true, Strength is a mass-independent natural frequency. | RigDynamicsConstraintComponent.h |
|
| ChildComponentKey | FRigComponentKey | The child particle for the constraint. | RigDynamicsConstraintComponent.h |
|
| ConstraintType | ERigParticleSimulationConstraintType | If the constraint is marked as "hard", then the system will try as hard as possible to enforce it. | RigDynamicsConstraintComponent.h |
|
| DampingRatio | float | DampingRatio for the constraint. | RigDynamicsConstraintComponent.h |
|
| ExtraDamping | float | Additional damping for the constraint. | RigDynamicsConstraintComponent.h |
|
| ExtraLength | float | This will be added on to the target length after the automatic/multiplication. | RigDynamicsConstraintComponent.h |
|
| LengthMultiplier | float | The target length will be calculated automatically, multiplied by this. | RigDynamicsConstraintComponent.h |
|
| Strength | float | The strength which we drive towards the target length. | RigDynamicsConstraintComponent.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
DECLARE_RIG_COMPONENT_METHODS
(
FRigDynamicsConstraintComponent |
The parent particle for the constraint. | RigDynamicsConstraintComponent.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FName GetDefaultComponentName() |
RigDynamicsConstraintComponent.h | ||
virtual void Load
(
FArchive& Ar |
RigDynamicsConstraintComponent.h | ||
virtual void Save
(
FArchive& Ar |
RigDynamicsConstraintComponent.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Serialize
(
FArchive& Ar |
RigDynamicsConstraintComponent.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FName GetDefaultName() |
RigDynamicsConstraintComponent.h |