Navigation
API > API/Runtime > API/Runtime/Chaos
A handle to a joint constraint held in a joint container (FPBDJointConstraints) by index.
| Name | FPBDJointConstraintHandle |
| Type | class |
| Header File | /Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/PBDJointConstraints.h |
| Include Path | #include "Chaos/PBDJointConstraints.h" |
Syntax
class FPBDJointConstraintHandle : public Chaos::TIndexedContainerConstraintHandle< FPBDJointConstraints >
Inheritance Hierarchy
- FConstraintHandle → FIndexedConstraintHandle → TIndexedContainerConstraintHandle → FPBDJointConstraintHandle
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Chaos/PBDJointConstraints.h | |||
FPBDJointConstraintHandle
(
FConstraintContainer* InConstraintContainer, |
Chaos/PBDJointConstraints.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Base | TIndexedContainerConstraintHandle< FPBDJointConstraints > | Chaos/PBDJointConstraints.h | |
| FConstraintContainer | FPBDJointConstraints | Chaos/PBDJointConstraints.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bAngularPlasticityInitialized | bool | Chaos/PBDJointConstraints.h | ||
| bLinearPlasticityInitialized | bool | Chaos/PBDJointConstraints.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CalculateConstraintSpace
(
FVec3& OutXa, |
Chaos/PBDJointConstraints.h | ||
void ClearConstraintBreaking() |
Chaos/PBDJointConstraints.h | ||
void ClearConstraintViolating() |
Chaos/PBDJointConstraints.h | ||
void ClearDriveTargetChanged() |
Chaos/PBDJointConstraints.h | ||
FVec3 GetAngularImpulse() |
Chaos/PBDJointConstraints.h | ||
float GetAngularViolation() |
Chaos/PBDJointConstraints.h | ||
int32 GetConstraintColor() |
Chaos/PBDJointConstraints.h | ||
int32 GetConstraintIsland() |
Chaos/PBDJointConstraints.h | ||
int32 GetConstraintLevel() |
Chaos/PBDJointConstraints.h | ||
const FPBDJointSettings & GetJointSettings() |
Chaos/PBDJointConstraints.h | ||
FVec3 GetLinearImpulse() |
Chaos/PBDJointConstraints.h | ||
float GetLinearViolation() |
Chaos/PBDJointConstraints.h | ||
const FPBDJointSettings & GetSettings() |
Chaos/PBDJointConstraints.h | ||
bool IsConstraintBreaking() |
Chaos/PBDJointConstraints.h | ||
bool IsConstraintBroken() |
Chaos/PBDJointConstraints.h | ||
bool IsConstraintEnabled() |
Chaos/PBDJointConstraints.h | ||
bool IsConstraintViolating() |
Chaos/PBDJointConstraints.h | ||
bool IsDriveTargetChanged() |
Chaos/PBDJointConstraints.h | ||
bool IsEnabledDuringResim() |
Chaos/PBDJointConstraints.h | ||
bool IsInContainer
(
FPBDConstraintContainer* TestContainer |
Chaos/PBDJointConstraints.h | ||
EResimType ResimType() |
Chaos/PBDJointConstraints.h | ||
void SetAngularDriveDamping
(
const FVec3 Damping |
Chaos/PBDJointConstraints.h | ||
void SetAngularDriveForceMode
(
EJointForceMode ForceMode |
Chaos/PBDJointConstraints.h | ||
void SetAngularDriveMaxTorque
(
const FVec3 MaxTorque |
Chaos/PBDJointConstraints.h | ||
void SetAngularDrivePositionTarget
(
const FQuat Target |
Chaos/PBDJointConstraints.h | ||
void SetAngularDriveStiffness
(
const FVec3 Stiffness |
Chaos/PBDJointConstraints.h | ||
void SetAngularDriveVelocityTarget
(
const FVec3 Target |
Chaos/PBDJointConstraints.h | ||
void SetChildConnectorLocation
(
const FVec3 Location |
Chaos/PBDJointConstraints.h | ||
void SetChildConnectorRotation
(
const FQuat Rotation |
Chaos/PBDJointConstraints.h | ||
void SetCollisionEnabled
(
const bool bCollisionEnabled |
Chaos/PBDJointConstraints.h | ||
void SetConstraintContainer
(
FPBDConstraintContainer* NewConstraintContainer |
Chaos/PBDJointConstraints.h | ||
void SetConstraintEnabled
(
bool bEnabled |
Chaos/PBDJointConstraints.h | ||
void SetDriveParams
(
const FVec3 LinearStiffness, |
This allows the most common drive parameters to be set in one call. | Chaos/PBDJointConstraints.h | |
void SetEnabledDuringResim
(
bool bEnabled |
Chaos/PBDJointConstraints.h | ||
void SetJointState
(
const FPBDJointState& NewState |
Chaos/PBDJointConstraints.h | ||
void SetLinearDriveDamping
(
const FVec3 Damping |
Chaos/PBDJointConstraints.h | ||
void SetLinearDriveForceMode
(
EJointForceMode ForceMode |
Chaos/PBDJointConstraints.h | ||
void SetLinearDriveMaxForce
(
const FVec3 MaxForce |
Chaos/PBDJointConstraints.h | ||
void SetLinearDrivePositionTarget
(
const FVec3 Target |
Chaos/PBDJointConstraints.h | ||
void SetLinearDriveStiffness
(
const FVec3 Stiffness |
Chaos/PBDJointConstraints.h | ||
void SetLinearDriveVelocityTarget
(
const FVec3 Target |
Chaos/PBDJointConstraints.h | ||
void SetParentConnectorLocation
(
const FVec3 Location |
Chaos/PBDJointConstraints.h | ||
void SetParentConnectorRotation
(
const FQuat Rotation |
Chaos/PBDJointConstraints.h | ||
void SetParentInvMassScale
(
const FReal ParentInvMassScale |
Chaos/PBDJointConstraints.h | ||
void SetSettings
(
const FPBDJointSettings& Settings |
Note that this is the "regular" way to change any settings, but note that if it results in a change of state/mode there may be some overhead. | Chaos/PBDJointConstraints.h | |
void SetSyncState
(
ESyncState SyncState |
Chaos/PBDJointConstraints.h | ||
ESyncState SyncState() |
Chaos/PBDJointConstraints.h |
Overridden from FConstraintHandle
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TVec2< FGeometryParticleHandle * > GetConstrainedParticles() |
Chaos/PBDJointConstraints.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const FConstraintHandleTypeID & StaticType() |
Chaos/PBDJointConstraints.h |