Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Chaos > Chaos > FJointConstraint

Light Theme

Dark Theme

FJointConstraint

Windows

MacOS

Linux

Inheritance Hierarchy

FConstraintBase

FJointConstraint

References

Module	Chaos
Header	/Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/PBDJointConstraintData.h
Include	#include "Chaos/PBDJointConstraintData.h"

Syntax

class FJointConstraint : public Chaos::FConstraintBase

Variables

		Name	Description
	friend	FData
	FData	JointSettings
	FTransformPair	JointTransforms
	FJointConstrain...	MDirtyFlags
	FOutputData	Output
	void *	UserData

Constructors

	Name	Description
	FJointConstraint()

Destructors

	Name	Description
	~FJointConstraint()

Functions

	Name	Description
void	ClearDirtyFlags()
FReal	GetAngularBreakTorque()
FReal	GetAngularDriveDamping()
EJointForceM...	GetAngularDriveForceMode()
FRotation3	GetAngularDrivePositionTarget()
FReal	GetAngularDriveStiffness()
FVec3	GetAngularDriveVelocityTarget()
FVec3	GetAngularLimits()
EJointMotion...	GetAngularMotionTypesX()
EJointMotion...	GetAngularMotionTypesY()
EJointMotion...	GetAngularMotionTypesZ()
FReal	GetAngularPlasticityLimit()
bool	GetAngularSLerpPositionDriveEnabled()
bool	GetAngularSLerpVelocityDriveEnabled()
EJointForceM...	GetAngularSoftForceMode()
bool	GetAngularSwingPositionDriveEnabled()
bool	GetAngularSwingVelocityDriveEnabled()
bool	GetAngularTwistPositionDriveEnabled()
bool	GetAngularTwistVelocityDriveEnabled()
bool	GetCollisionEnabled()
const FData ...	GetJointSettings()
FTransformPa...	GetJointTransforms()
const FTrans...	GetJointTransforms()
FReal	GetLinearBreakForce()
FReal	GetLinearContactDistance()
FReal	GetLinearDriveDamping()
EJointForceM...	GetLinearDriveForceMode()
FVec3	GetLinearDrivePositionTarget()
FReal	GetLinearDriveStiffness()
FVec3	GetLinearDriveVelocityTarget()
FReal	GetLinearLimit()
EJointMotion...	GetLinearMotionTypesX()
EJointMotion...	GetLinearMotionTypesY()
EJointMotion...	GetLinearMotionTypesZ()
FReal	GetLinearPlasticityLimit()
bool	GetLinearPositionDriveXEnabled()
bool	GetLinearPositionDriveYEnabled()
bool	GetLinearPositionDriveZEnabled()
FReal	GetLinearRestitution()
EJointForceM...	GetLinearSoftForceMode()
bool	GetLinearVelocityDriveXEnabled()
bool	GetLinearVelocityDriveYEnabled()
bool	GetLinearVelocityDriveZEnabled()
FOutputData ...	GetOutputData()
FReal	GetParentInvMassScale()
FReal	GetProjectionAngularAlpha()
bool	GetProjectionEnabled()
FReal	GetProjectionLinearAlpha()
FReal	GetSoftLinearDamping()
bool	GetSoftLinearLimitsEnabled()
FReal	GetSoftLinearStiffness()
FReal	GetSoftSwingDamping()
bool	GetSoftSwingLimitsEnabled()
FReal	GetSoftSwingStiffness()
FReal	GetSoftTwistDamping()
bool	GetSoftTwistLimitsEnabled()
FReal	GetSoftTwistStiffness()
FReal	GetStiffness()
FReal	GetSwingContactDistance()
FReal	GetSwingRestitution()
FReal	GetTwistContactDistance()
FReal	GetTwistRestitution()
void *	GetUserData()
bool	IsDirty ( const EJointConstraintFlags CheckBi... )
bool	IsDirty()
void	ReleaseKinematicEndPoint ( FPBDRigidsSolver* Solver )
void	SetAngularBreakTorque ( FReal InValue )	Void SetLinearPlasticityLimit(FReal InLinearPlasticityLimit); FReal GetLinearPlasticityLimit() const
void	SetAngularDriveDamping ( FReal InValue )	Void SetAngularDriveStiffness(FReal InAngularDriveStiffness); FReal GetAngularDriveStiffness() const
void	SetAngularDriveForceMode ( EJointForceMode InValue )	Void SetAngularDriveVelocityTarget(FVec3 InAngularDriveVelocityTarget); FVec3 GetAngularDriveVelocityTarget() const
void	SetAngularDrivePositionTarget ( FRotation3 InValue )	Void SetAngularSwingPositionDriveEnabled(bool InAngularSwingPositionDriveEnabled); bool GetAngularSwingPositionDriveEnabled() const
void	SetAngularDriveStiffness ( FReal InValue )	Void SetAngularMotionTypesZ(EJointMotionType AngularMotionTypesZ); EJointMotionType GetAngularMotionTypesZ() const
void	SetAngularDriveVelocityTarget ( FVec3 InValue )	Void SetAngularSwingVelocityDriveEnabled(bool InAngularSwingVelocityDriveEnabled); bool GetAngularSwingVelocityDriveEnabled() const
void	SetAngularLimits ( FVec3 InValue )	Void SetLinearLimit(FReal InLinearLimit); FReal GetLinearLimit() const
void	SetAngularMotionTypesX ( EJointMotionType InValue )	Void SetAngularDriveForceMode(EJointForceMode InAngularDriveForceMode); EJointForceMode GetAngularDriveForceMode() const
void	SetAngularMotionTypesY ( EJointMotionType InValue )	Void SetAngularMotionTypesX(EJointMotionType InAngularMotionTypesX); EJointMotionType GetAngularMotionTypesX() const
void	SetAngularMotionTypesZ ( EJointMotionType InValue )	Void SetAngularMotionTypesY(EJointMotionType InAngularMotionTypesY); EJointMotionType GetAngularMotionTypesY() const
void	SetAngularPlasticityLimit ( FReal InValue )	Void SetAngularBreakTorque(FReal InAngularBreakTorque); FReal GetAngularBreakTorque() const
void	SetAngularSLerpPositionDriveEnabled ( bool InValue )	Void SetLinearDriveDamping(FReal InLinearDriveStffness); FReal GetLinearDriveDamping() const
void	SetAngularSLerpVelocityDriveEnabled ( bool InValue )	Void SetAngularDrivePositionTarget(FRotation3 InAngularDrivePositionTarget); FRotation3 GetAngularDrivePositionTarget() const
void	SetAngularSoftForceMode ( EJointForceMode InValue )	Void SetLinearSoftForceMode(FRealIn LinearSoftForceMode); EJointForceMode GetLinearSoftForceMode() const
void	SetAngularSwingPositionDriveEnabled ( bool InValue )	Void SetAngularTwistPositionDriveEnabled(bool InAngularTwistPositionDriveEnabled); bool GetAngularTwistPositionDriveEnabled() const
void	SetAngularSwingVelocityDriveEnabled ( bool InValue )	Void SetAngularTwistVelocityDriveEnabled(bool InAngularTwistVelocityDriveEnabled); bool GetAngularTwistVelocityDriveEnabled() const
void	SetAngularTwistPositionDriveEnabled ( bool InValue )	Void SetAngularSLerpPositionDriveEnabled(bool InAngularSLerpPositionDriveEnabled); bool GetAngularSLerpPositionDriveEnabled() const
void	SetAngularTwistVelocityDriveEnabled ( bool InValue )	Void SetAngularSLerpVelocityDriveEnabled(bool InAngularSLerpVelocityDriveEnabled); bool GetAngularSLerpVelocityDriveEnabled() const
void	SetCollisionEnabled ( bool InValue )
void	SetJointTransforms ( const Chaos::FJointConstraint::FTra... )
void	SetKinematicEndPoint ( FSingleParticlePhysicsProxy* I..., FPBDRigidsSolver* Solver )	If we created particle to serve as kinematic endpoint, track so we can release later. This will add particle to solver.
void	SetLinearBreakForce ( FReal InValue )	Void SetParentInvMassScale(FReal InParentInvMassScale); FReal GetParentInvMassScale() const
void	SetLinearContactDistance ( FReal InValue )	Void SetAngularLimits(FVec3 AngularLimits); FVec3 GetAngularLimits() const
void	SetLinearDriveDamping ( FReal InValue )	Void SetLinearDriveStiffness(FReal InLinearDriveStffness); FReal GetLinearDriveStiffness() const
void	SetLinearDriveForceMode ( EJointForceMode InValue )	Void SetLinearDriveVelocityTarget(FVec3 InLinearDriveVelocityTarget); FVec3 GetLinearDriveVelocityTarget() const
void	SetLinearDrivePositionTarget ( FVec3 InValue )	Void SetLinearPositionDriveZEnabled(bool InLinearPositionDriveZEnabled); bool GetLinearPositionDriveZEnabled() const
void	SetLinearDriveStiffness ( FReal InValue )	Void SetLinearMotionTypesZ(EJointMotionType InLinearMotionTypesZ); EJointMotionType GetLinearMotionTypesZ() const
void	SetLinearDriveVelocityTarget ( FVec3 InValue )	Void SetLinearVelocityDriveZEnabled(bool InLinearVelocityDriveZEnabled); bool GetLinearVelocityDriveZEnabled() const
void	SetLinearLimit ( FReal InValue )	Void SetSoftSwingDamping(FReal InSoftSwingDamping); FReal GetSoftSwingDamping() const
void	SetLinearMotionTypesX ( EJointMotionType InValue )	Void SetLinearDriveVelocityTarget(EJointForceMode InEJointForceMode); EJointForceMode GetLinearDriveVelocityTarget() const
void	SetLinearMotionTypesY ( EJointMotionType InValue )	Void SetLinearMotionTypesX(EJointMotionType InLinearMotionTypesX); EJointMotionType GetLinearMotionTypesX() const
void	SetLinearMotionTypesZ ( EJointMotionType InValue )	Void SetLinearMotionTypesY(EJointMotionType InLinearMotionTypesY); EJointMotionType GetLinearMotionTypesY() const
void	SetLinearPlasticityLimit ( FReal InValue )	Void SetLinearBreakForce(FReal InLinearBreakForce); FReal GetLinearBreakForce() const
void	SetLinearPositionDriveEnabled ( TVector< bool, 3 > Enabled )	Void SetUserData(void* InUserData); void* GetUserData() const
void	SetLinearPositionDriveXEnabled ( bool InValue )
void	SetLinearPositionDriveYEnabled ( bool InValue )	Void SetLinearPositionDriveXEnabled(bool InLinearPositionDriveXEnabled); bool GetLinearPositionDriveXEnabled() const
void	SetLinearPositionDriveZEnabled ( bool InValue )	Void SetLinearPositionDriveYEnabled(bool InLinearPositionDriveYEnabled); bool GetLinearPositionDriveYEnabled() const
void	SetLinearRestitution ( FReal InValue )	Void SetAngularSwingContactDistance(FReal InAngularSwingContactDistance); FReal GetAngularSwingContactDistance() const
void	SetLinearSoftForceMode ( EJointForceMode InValue )	Void SetSoftSwingLimitsEnabled(FReal bInSoftSwingLimitsEnabled); bool GetSoftSwingLimitsEnabled() const
void	SetLinearVelocityDriveEnabled ( TVector< bool, 3 > Enabled )	Void SetLinearDrivePositionTarget(FVec3 InLinearDrivePositionTarget); FVec3 GetLinearDrivePositionTarget() const
void	SetLinearVelocityDriveXEnabled ( bool InValue )
void	SetLinearVelocityDriveYEnabled ( bool InValue )	Void SetLinearVelocityDriveXEnabled(bool InLinearVelocityDriveXEnabled); bool GetLinearVelocityDriveXEnabled() const
void	SetLinearVelocityDriveZEnabled ( bool InValue )	Void SetLinearVelocityDriveYEnabled(bool InLinearVelocityDriveYEnabled); bool GetLinearVelocityDriveYEnabled() const
void	SetParentInvMassScale ( FReal InValue )	Void SetProjectionAngularAlpha(FReal InProjectionAngularAlpha); FReal GetProjectionAngularAlpha() const;
void	SetProjectionAngularAlpha ( FReal InValue )	Void SetProjectionLinearAlpha(FReal InProjectionLinearAlpha); FReal GetProjectionLinearAlpha() const;
void	SetProjectionEnabled ( bool InValue )	Void SetCollisionEnabled(bool InValue); bool GetCollisionEnabled() const;
void	SetProjectionLinearAlpha ( FReal InValue )	Void SetProjectionEnabled(bool bInProjectionEnabled); bool GetProjectionEnabled() const;
void	SetSoftLinearDamping ( FReal InValue )	Void SetSoftLinearStiffness(FReal InSoftLinearStiffness); FReal GetSoftLinearStiffness() const
void	SetSoftLinearLimitsEnabled ( bool InValue )	Void SetStiffness(FReal Stiffness); FReal GetStiffness() const
void	SetSoftLinearStiffness ( FReal InValue )	Void SetAngularSoftForceMode(FReal InAngularSoftForceMode); EJointForceMode GetAngularSoftForceMode() const
void	SetSoftSwingDamping ( FReal InValue )	Void SetSoftSwingStiffness(FReal InSoftSwingStiffness); FReal GetSoftSwingStiffness() const
void	SetSoftSwingLimitsEnabled ( bool InValue )	Void SetSoftTwistLimitsEnabled(FReal bInSoftTwistLimitsEnabled); bool GetSoftTwistLimitsEnabled() const
void	SetSoftSwingStiffness ( FReal InValue )	Void SetSoftTwistDamping(FReal InSoftTwistDamping); FReal GetSoftTwistDamping() const
void	SetSoftTwistDamping ( FReal InValue )	Void SetSoftTwistStiffness(FReal InSoftTwistStiffness); FReal GetSoftTwistStiffness() const
void	SetSoftTwistLimitsEnabled ( bool InValue )	Void SetSoftLinearLimitsEnabled(bool bInSoftLinearLimitsEnabled); bool GetSoftLinearLimitsEnabled() const
void	SetSoftTwistStiffness ( FReal InValue )	Void SetSoftLinearDamping(FReal InSoftLinearDamping); FReal GetSoftLinearDamping() const
void	SetStiffness ( FReal InValue )	Void SetAngularDriveDamping(FReal InAngularDriveDamping); FReal GetAngularDriveDamping() const
void	SetSwingContactDistance ( FReal InValue )	Void SetAngularTwistContactDistance(FReal InAngularTwistContactDistance); FReal GetAngularTwistContactDistance() const
void	SetSwingRestitution ( FReal InValue )	Void SetAngularTwistRestitution(FReal InAngularTwistRestitution); FReal GetAngularTwistRestitution() const
void	SetTwistContactDistance ( FReal InValue )	Void SetLinearContactDistance(FReal InLinearContactDistance); FReal GetLinearContactDistance() const
void	SetTwistRestitution ( FReal InValue )	Void SetLinearRestitution(FReal InLinearRestitution); FReal GetLinearRestitution() const
void	SetUserData ( void* InValue )	Void SetAngularPlasticityLimit(FReal InAngularPlasticityLimit); FReal GetAngularPlasticityLimit() const

Classes

	Name	Description
	FOutputData	Void SetAngularSwingRestitution(FReal InAngularSwingRestitution); FReal GetAngularSwingRestitution() const

Typedefs

Name	Description
FData
FHandle
FTransformPair

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss