UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FLinearConstraint Struct Reference

#include <ConstraintTypes.h>

+ Inheritance diagram for FLinearConstraint:

Public Member Functions

ENGINE_API FLinearConstraint ()
 
ENGINE_API void UpdateLinearLimit_AssumesLocked (const FPhysicsConstraintHandle &InConstraintRef, float AverageMass, float Scale) const
 
- Public Member Functions inherited from FConstraintBaseParams
ENGINE_API FConstraintBaseParams ()
 

Public Attributes

float Limit
 
TEnumAsByte< enum ELinearConstraintMotionXMotion
 
TEnumAsByte< enum ELinearConstraintMotionYMotion
 
TEnumAsByte< enum ELinearConstraintMotionZMotion
 
- Public Attributes inherited from FConstraintBaseParams
float Stiffness
 
float Damping
 
float Restitution
 
float ContactDistance
 
uint8 bSoftConstraint: 1
 

Detailed Description

Distance constraint

Constructor & Destructor Documentation

◆ FLinearConstraint()

FLinearConstraint::FLinearConstraint ( )

Member Function Documentation

◆ UpdateLinearLimit_AssumesLocked()

void FLinearConstraint::UpdateLinearLimit_AssumesLocked ( const FPhysicsConstraintHandle InConstraintRef,
float  AverageMass,
float  Scale 
) const

Updates physx linear constraint from unreal data.

Member Data Documentation

◆ Limit

float FLinearConstraint::Limit

The distance allowed between the two joint reference frames. Distance applies on all axes enabled (one axis means line, two axes implies circle, three axes implies sphere)

◆ XMotion

TEnumAsByte<enum ELinearConstraintMotion> FLinearConstraint::XMotion

Indicates the linear constraint applied along the X-axis. Free implies no constraint at all. Locked implies no movement along X is allowed. Limited implies the distance in the joint along all active axes must be less than the Distance provided.

◆ YMotion

TEnumAsByte<enum ELinearConstraintMotion> FLinearConstraint::YMotion

Indicates the linear constraint applied along the Y-axis. Free implies no constraint at all. Locked implies no movement along Y is allowed. Limited implies the distance in the joint along all active axes must be less than the Distance provided.

◆ ZMotion

TEnumAsByte<enum ELinearConstraintMotion> FLinearConstraint::ZMotion

Indicates the linear constraint applied along theZX-axis. Free implies no constraint at all. Locked implies no movement along Z is allowed. Limited implies the distance in the joint along all active axes must be less than the Distance provided.


The documentation for this struct was generated from the following files: