UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Chaos::FJointConstraint Class Reference

#include <PBDJointConstraintData.h>

+ Inheritance diagram for Chaos::FJointConstraint:

Classes

struct  FOutputData
 

Public Types

using Base = FConstraintBase
 
- Public Types inherited from Chaos::FConstraintBase
typedef TVector< TGeometryParticleHandle< FReal, 3 > *, 2 > FParticleHandlePair
 

Public Member Functions

CHAOS_API FJointConstraint ()
 
virtual ~FJointConstraint () override
 
const FPBDJointSettingsGetJointSettings () const
 
void SetJointSettings (const FPBDJointSettings &NewSettings)
 
CHAOS_API void SetKinematicEndPoint (FSingleParticlePhysicsProxy *InParticle, FPBDRigidsSolver *Solver)
 
CHAOS_API FSingleParticlePhysicsProxyGetKinematicEndPoint () const
 
CHAOS_API void SetLinearPositionDriveEnabled (TVector< bool, 3 > Enabled)
 
CHAOS_API void SetLinearVelocityDriveEnabled (TVector< bool, 3 > Enabled)
 
FOutputDataGetOutputData ()
 
virtual void SyncRemoteDataImp (FDirtyPropertiesManager &Manager, int32 DataIdx, FDirtyChaosProperties &RemoteData) override
 
CHAOS_API void SetParticleProxies (const FProxyBasePair &InJointParticles)
 
CHAOS_API void SetPhysicsBodies (const FPhysicsObjectPair &InBodies)
 
const FProxyBasePairGetParticleProxies () const
 
const FPhysicsObjectPairGetPhysicsBodies () const
 
- Public Member Functions inherited from Chaos::FConstraintBase
virtual ~FConstraintBase ()
 
CHAOS_API FConstraintBase (EConstraintType InType)
 
EConstraintType GetType () const
 
bool IsType (EConstraintType InType)
 
CHAOS_API bool IsValid () const
 
bool IsDirty () const
 
bool IsDirty (const EChaosPropertyFlags CheckBits) const
 
void ClearDirtyFlags ()
 
const FDirtyChaosPropertyFlagsGetDirtyFlags () const
 
template<typename T = IPhysicsProxyBase>
T * GetProxy ()
 
CHAOS_API void SetProxy (IPhysicsProxyBase *InProxy)
 
void SyncRemoteData (FDirtyPropertiesManager &Manager, int32 DataIdx, FDirtyChaosProperties &RemoteData)
 

Protected Member Functions

CHAOS_API void ReleaseKinematicEndPoint (FPBDRigidsSolver *Solver)
 

Protected Attributes

TChaosProperty< FProxyBasePairProperty, EChaosProperty::JointParticleProxies > JointProxies
 
TChaosProperty< FPhysicsObjectPairProperty, EChaosProperty::JointPhysicsObjects > JointBodies
 
TChaosProperty< FPBDJointSettings, EChaosProperty::JointSettings > JointSettings
 
FOutputData Output
 
- Protected Attributes inherited from Chaos::FConstraintBase
EConstraintType Type
 
class IPhysicsProxyBaseProxy
 
FDirtyChaosPropertyFlags DirtyFlags
 

Friends

class FPBDRigidsSolver
 

Member Typedef Documentation

◆ Base

Constructor & Destructor Documentation

◆ FJointConstraint()

Chaos::FJointConstraint::FJointConstraint ( )

◆ ~FJointConstraint()

virtual Chaos::FJointConstraint::~FJointConstraint ( )
inlineoverridevirtual

Member Function Documentation

◆ GetJointSettings()

const FPBDJointSettings & Chaos::FJointConstraint::GetJointSettings ( ) const
inline

◆ GetKinematicEndPoint()

FSingleParticlePhysicsProxy * Chaos::FJointConstraint::GetKinematicEndPoint ( ) const

◆ GetOutputData()

FOutputData & Chaos::FJointConstraint::GetOutputData ( )
inline

◆ GetParticleProxies()

const FProxyBasePair & Chaos::FJointConstraint::GetParticleProxies ( ) const
inline

◆ GetPhysicsBodies()

const FPhysicsObjectPair & Chaos::FJointConstraint::GetPhysicsBodies ( ) const
inline

◆ ReleaseKinematicEndPoint()

void Chaos::FJointConstraint::ReleaseKinematicEndPoint ( FPBDRigidsSolver Solver)
protected

◆ SetJointSettings()

void Chaos::FJointConstraint::SetJointSettings ( const FPBDJointSettings NewSettings)

◆ SetKinematicEndPoint()

void Chaos::FJointConstraint::SetKinematicEndPoint ( FSingleParticlePhysicsProxy InParticle,
FPBDRigidsSolver Solver 
)

◆ SetLinearPositionDriveEnabled()

void Chaos::FJointConstraint::SetLinearPositionDriveEnabled ( TVector< bool, 3 >  Enabled)

◆ SetLinearVelocityDriveEnabled()

void Chaos::FJointConstraint::SetLinearVelocityDriveEnabled ( TVector< bool, 3 >  Enabled)

◆ SetParticleProxies()

void Chaos::FJointConstraint::SetParticleProxies ( const FProxyBasePair InJointParticles)

◆ SetPhysicsBodies()

void Chaos::FJointConstraint::SetPhysicsBodies ( const FPhysicsObjectPair InBodies)

◆ SyncRemoteDataImp()

virtual void Chaos::FJointConstraint::SyncRemoteDataImp ( FDirtyPropertiesManager Manager,
int32  DataIdx,
FDirtyChaosProperties RemoteData 
)
inlineoverridevirtual

Friends And Related Symbol Documentation

◆ FPBDRigidsSolver

friend class FPBDRigidsSolver
friend

Member Data Documentation

◆ JointBodies

TChaosProperty<FPhysicsObjectPairProperty, EChaosProperty::JointPhysicsObjects> Chaos::FJointConstraint::JointBodies
protected

◆ JointProxies

TChaosProperty<FProxyBasePairProperty, EChaosProperty::JointParticleProxies> Chaos::FJointConstraint::JointProxies
protected

◆ JointSettings

TChaosProperty<FPBDJointSettings, EChaosProperty::JointSettings> Chaos::FJointConstraint::JointSettings
protected

◆ Output

FOutputData Chaos::FJointConstraint::Output
protected

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