UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Types | Public Member Functions | Friends | List of all members
Chaos::FRigidParticleControlFlags Class Reference

Enable/Disable the features on a particle These flags are externally controlled and should not be changed by the solver during the tick. The may be bound directly to settings or game-side object state. These flags should be treated as read-only to the solver. More...

#include <RigidParticleControlFlags.h>

Public Types

using FStorage = uint16
 

Public Member Functions

 FRigidParticleControlFlags ()
 
FStorage GetFlags () const
 
void SetFlags (const FStorage InBits)
 
bool GetGravityEnabled () const
 
FRigidParticleControlFlags & SetGravityEnabled (const bool bEnabled)
 
bool GetUpdateKinematicFromSimulation () const
 
FRigidParticleControlFlags & SetUpdateKinematicFromSimulation (const bool bUpdateKinematicFromSimulation)
 
bool GetGyroscopicTorqueEnabled () const
 
FRigidParticleControlFlags & SetGyroscopicTorqueEnabled (const bool bEnabled)
 
int32 GetGravityGroupIndex () const
 
FRigidParticleControlFlags & SetGravityGroupIndex (const int32 GravityGroupIndex)
 
bool GetCCDEnabled () const
 
FRigidParticleControlFlags & SetCCDEnabled (const bool bEnabled)
 
bool GetMACDEnabled () const
 
FRigidParticleControlFlags & SetMACDEnabled (const bool bEnabled)
 
bool GetPartialIslandSleepAllowed () const
 
FRigidParticleControlFlags & SetPartialIslandSleepAllowed (const bool bEnabled)
 
bool GetOneWayInteractionEnabled () const
 
FRigidParticleControlFlags & SetOneWayInteractionEnabled (const bool bEnabled)
 
bool GetInertiaConditioningEnabled () const
 
FRigidParticleControlFlags & SetInertiaConditioningEnabled (const bool bEnabled)
 
FString ToString () const
 
bool GetMaxDepenetrationVelocityOverrideEnabled () const
 
FRigidParticleControlFlags & SetMaxDepenetrationVelocityOverrideEnabled (const bool bEnabled)
 

Friends

bool operator== (const FRigidParticleControlFlags &L, const FRigidParticleControlFlags &R)
 
bool operator!= (const FRigidParticleControlFlags &L, const FRigidParticleControlFlags &R)
 
FChaosArchive & operator<< (FChaosArchive &Ar, FRigidParticleControlFlags &Data)
 

Detailed Description

Enable/Disable the features on a particle These flags are externally controlled and should not be changed by the solver during the tick. The may be bound directly to settings or game-side object state. These flags should be treated as read-only to the solver.

Member Typedef Documentation

◆ FStorage

using Chaos::FRigidParticleControlFlags::FStorage = uint16

Constructor & Destructor Documentation

◆ FRigidParticleControlFlags()

Chaos::FRigidParticleControlFlags::FRigidParticleControlFlags ( )
inline

Member Function Documentation

◆ GetCCDEnabled()

bool Chaos::FRigidParticleControlFlags::GetCCDEnabled ( ) const
inline

◆ GetFlags()

FStorage Chaos::FRigidParticleControlFlags::GetFlags ( ) const
inline

◆ GetGravityEnabled()

bool Chaos::FRigidParticleControlFlags::GetGravityEnabled ( ) const
inline

◆ GetGravityGroupIndex()

int32 Chaos::FRigidParticleControlFlags::GetGravityGroupIndex ( ) const
inline

◆ GetGyroscopicTorqueEnabled()

bool Chaos::FRigidParticleControlFlags::GetGyroscopicTorqueEnabled ( ) const
inline

◆ GetInertiaConditioningEnabled()

bool Chaos::FRigidParticleControlFlags::GetInertiaConditioningEnabled ( ) const
inline

◆ GetMACDEnabled()

bool Chaos::FRigidParticleControlFlags::GetMACDEnabled ( ) const
inline

◆ GetMaxDepenetrationVelocityOverrideEnabled()

bool Chaos::FRigidParticleControlFlags::GetMaxDepenetrationVelocityOverrideEnabled ( ) const
inline

◆ GetOneWayInteractionEnabled()

bool Chaos::FRigidParticleControlFlags::GetOneWayInteractionEnabled ( ) const
inline

◆ GetPartialIslandSleepAllowed()

bool Chaos::FRigidParticleControlFlags::GetPartialIslandSleepAllowed ( ) const
inline

◆ GetUpdateKinematicFromSimulation()

bool Chaos::FRigidParticleControlFlags::GetUpdateKinematicFromSimulation ( ) const
inline

◆ SetCCDEnabled()

FRigidParticleControlFlags & Chaos::FRigidParticleControlFlags::SetCCDEnabled ( const bool  bEnabled)
inline

◆ SetFlags()

void Chaos::FRigidParticleControlFlags::SetFlags ( const FStorage  InBits)
inline

◆ SetGravityEnabled()

FRigidParticleControlFlags & Chaos::FRigidParticleControlFlags::SetGravityEnabled ( const bool  bEnabled)
inline

◆ SetGravityGroupIndex()

FRigidParticleControlFlags & Chaos::FRigidParticleControlFlags::SetGravityGroupIndex ( const int32  GravityGroupIndex)
inline

◆ SetGyroscopicTorqueEnabled()

FRigidParticleControlFlags & Chaos::FRigidParticleControlFlags::SetGyroscopicTorqueEnabled ( const bool  bEnabled)
inline

◆ SetInertiaConditioningEnabled()

FRigidParticleControlFlags & Chaos::FRigidParticleControlFlags::SetInertiaConditioningEnabled ( const bool  bEnabled)
inline

◆ SetMACDEnabled()

FRigidParticleControlFlags & Chaos::FRigidParticleControlFlags::SetMACDEnabled ( const bool  bEnabled)
inline

◆ SetMaxDepenetrationVelocityOverrideEnabled()

FRigidParticleControlFlags & Chaos::FRigidParticleControlFlags::SetMaxDepenetrationVelocityOverrideEnabled ( const bool  bEnabled)
inline

◆ SetOneWayInteractionEnabled()

FRigidParticleControlFlags & Chaos::FRigidParticleControlFlags::SetOneWayInteractionEnabled ( const bool  bEnabled)
inline

◆ SetPartialIslandSleepAllowed()

FRigidParticleControlFlags & Chaos::FRigidParticleControlFlags::SetPartialIslandSleepAllowed ( const bool  bEnabled)
inline

◆ SetUpdateKinematicFromSimulation()

FRigidParticleControlFlags & Chaos::FRigidParticleControlFlags::SetUpdateKinematicFromSimulation ( const bool  bUpdateKinematicFromSimulation)
inline

◆ ToString()

FString Chaos::FRigidParticleControlFlags::ToString ( ) const

Friends And Related Symbol Documentation

◆ operator!=

bool operator!= ( const FRigidParticleControlFlags &  L,
const FRigidParticleControlFlags &  R 
)
friend

◆ operator<<

FChaosArchive & operator<< ( FChaosArchive &  Ar,
FRigidParticleControlFlags &  Data 
)
friend

◆ operator==

bool operator== ( const FRigidParticleControlFlags &  L,
const FRigidParticleControlFlags &  R 
)
friend

Member Data Documentation

◆ Bits

FStorage Chaos::FRigidParticleControlFlags::Bits

◆ Flags

FFlags Chaos::FRigidParticleControlFlags::Flags
The documentation for this class was generated from the following files: