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

#include <ParticleHandle.h>

+ Inheritance diagram for Chaos::FPBDGeometryCollectionParticle:

Public Types

typedef TPBDGeometryCollectionParticleHandle< FReal, 3 > FHandle
 
- Public Types inherited from Chaos::TPBDRigidParticle< FReal, 3 >
typedef TPBDRigidParticleHandle< FReal, d > FHandle
 
using Base = TKinematicGeometryParticle< FReal, d >
 
- Public Types inherited from Chaos::TKinematicGeometryParticle< T, d >
typedef TKinematicGeometryParticleHandle< T, d > FHandle
 
using Base = TGeometryParticle< T, d >
 
- Public Types inherited from Chaos::TGeometryParticle< T, d >
typedef TGeometryParticleHandle< T, d > FHandle
 

Public Member Functions

 FPBDGeometryCollectionParticle (const FPBDRigidParticleParameters &DynamicParams=FPBDRigidParticleParameters())
 
- Public Member Functions inherited from Chaos::TPBDRigidParticle< FReal, 3 >
void Serialize (FChaosArchive &Ar) override
 
int32 CollisionGroup () const
 
void SetCollisionGroup (const int32 InCollisionGroup)
 
bool GravityEnabled () const
 
void SetGravityEnabled (const bool bInEnabled)
 
int32 GravityGroupIndex () const
 
void SetGravityGroupIndex (int32 NewIndex)
 
bool UpdateKinematicFromSimulation () const
 
void SetUpdateKinematicFromSimulation (const bool bUpdateKinematicFromSimulation)
 
bool GyroscopicTorqueEnabled () const
 
void SetGyroscopicTorqueEnabled (const bool bGyroscopicTorqueEnabled)
 
bool OneWayInteraction () const
 
void SetOneWayInteraction (const bool bInEnabled)
 
void AddCollisionConstraintFlag (const ECollisionConstraintFlags Flag)
 
void RemoveCollisionConstraintFlag (const ECollisionConstraintFlags Flag)
 
uint32 CollisionConstraintFlags () const
 
void SetCollisionConstraintFlags (const uint32 Flags)
 
bool CCDEnabled () const
 
void SetCCDEnabled (bool bInEnabled)
 
bool MACDEnabled () const
 
void SetMACDEnabled (bool bInEnabled)
 
bool PartialIslandSleepAllowed () const
 
void SetPartialIslandSleepAllowed (bool bInEnabled)
 
Private::FIterationSettings IterationSettings () const
 
void SetIterationSettings (const Private::FIterationSettings &SolverIterationSettingsIn)
 
void SetPositionSolverIterations (const int32 PositionSolverIterationCount)
 
void SetVelocitySolverIterations (const int32 VelocitySolverIterationCount)
 
void SetProjectionSolverIterations (const int32 ProjectionSolverIterationCount)
 
bool InertiaConditioningEnabled () const
 
void SetInertiaConditioningEnabled (bool bInEnabled)
 
bool Disabled () const
 
void SetDisabled (bool bInDisabled)
 
bool IsInitialized () const
 
void SetInitialized (const bool InInitialized)
 
const TVector< FReal, d > Acceleration () const
 
void SetAcceleration (const FVec3 &Acceleration, bool bInvalidate=true)
 
void AddForce (const TVector< FReal, d > &InF, bool bInvalidate=true)
 
void ClearForces (bool bInvalidate=true)
 
void ApplyDynamicsWeight (const FReal DynamicsWeight)
 
const TVector< FReal, d > AngularAcceleration () const
 
void SetAngularAcceleration (const TVector< FReal, d > &InTorque, bool bInvalidate=true)
 
CHAOS_API void AddTorque (const TVector< FReal, d > &InTorque, bool bInvalidate=true)
 
void ClearTorques (bool bInvalidate=true)
 
const TVector< FReal, d > LinearImpulseVelocity () const
 
void SetLinearImpulseVelocity (const TVector< FReal, d > &InLinearImpulseVelocity, bool bInvalidate=true)
 
const TVector< FReal, d > AngularImpulseVelocity () const
 
void SetAngularImpulseVelocity (const TVector< FReal, d > &InAngularImpulseVelocity, bool bInvalidate=true)
 
void SetDynamics (const FParticleDynamics &InDynamics, bool bInvalidate=true)
 
void ResetSmoothedVelocities ()
 
const TVec3< FRealSingle > & I () const
 
void SetI (const TVec3< FRealSingle > &InI, bool bInvalidate=true)
 
const TVec3< FRealSingle > & InvI () const
 
void SetInvI (const TVec3< FRealSingle > &InInvI, bool bInvalidate=true)
 
FReal M () const
 
void SetM (const FReal &InM, bool bInvalidate=true)
 
FReal InvM () const
 
void SetInvM (const FReal &InInvM, bool bInvalidate=true)
 
const TVector< FReal, d > & CenterOfMass () const
 
void SetCenterOfMass (const TVector< FReal, d > &InCenterOfMass, bool bInvalidate=true)
 
const TRotation< FReal, d > & RotationOfMass () const
 
void SetRotationOfMass (const TRotation< FReal, d > &InRotationOfMass, bool bInvalidate=true)
 
void SetMassProps (const FParticleMassProps &InProps)
 
void SetDynamicMisc (const FParticleDynamicMisc &DynamicMisc)
 
FReal LinearEtherDrag () const
 
void SetLinearEtherDrag (const FReal &InLinearEtherDrag)
 
FReal AngularEtherDrag () const
 
void SetAngularEtherDrag (const FReal &InAngularEtherDrag)
 
FReal MaxLinearSpeedSq () const
 
void SetMaxLinearSpeedSq (const FReal &InLinearSpeed)
 
FReal MaxAngularSpeedSq () const
 
void SetMaxAngularSpeedSq (const FReal &InAngularSpeed)
 
FRealSingle InitialOverlapDepenetrationVelocity () const
 
void SetInitialOverlapDepenetrationVelocity (FRealSingle InVel)
 
FRealSingle SleepThresholdMultiplier () const
 
void SetSleepThresholdMultiplier (FRealSingle Multiplier)
 
int32 Island () const
 
void SetIsland (const int32 InIsland)
 
EObjectStateType ObjectState () const
 
void SetObjectState (const EObjectStateType InState, bool bAllowEvents=false, bool bInvalidate=true)
 
void SetSleepType (ESleepType SleepType, bool bAllowEvents=false, bool bInvalidate=true)
 
ESleepType SleepType () const
 
void ClearEvents ()
 
EWakeEventEntry GetWakeEvent ()
 
FRigidParticleControlFlags ControlFlags () const
 
void SetControlFlags (const FRigidParticleControlFlags &Flags)
 
- Public Member Functions inherited from Chaos::TKinematicGeometryParticle< T, d >
const TVector< T, d > V () const
 
const TVector< T, d > GetV () const
 
void SetV (const TVector< T, d > &InV, bool bInvalidate=true)
 
const TVector< T, d > W () const
 
const TVector< T, d > GetW () const
 
void SetW (const TVector< T, d > &InW, bool bInvalidate=true)
 
const FKinematicTarget KinematicTarget () const
 
void SetKinematicTarget (const FKinematicTarget &KinematicTarget, bool bInvalidate=true)
 
bool IsKinematicTargetDirty () const
 
void ClearKinematicTarget ()
 
const FParticleVelocities & Velocities () const
 
void SetVelocities (const FParticleVelocities &InVelocities, bool bInvalidate=true)
 
EObjectStateType ObjectState () const
 
- Public Member Functions inherited from Chaos::TGeometryParticle< T, d >
virtual ~TGeometryParticle ()
 
 TGeometryParticle (const TGeometryParticle &)=delete
 
TGeometryParticle & operator= (const TGeometryParticle &)=delete
 
virtual bool IsParticleValid () const
 
const TVector< T, d > & X () const
 
const TVector< T, d > & GetX () const
 
void SetX (const TVector< T, d > &InX, bool bInvalidate=true)
 
FUniqueIdx UniqueIdx () const
 
void SetUniqueIdx (const FUniqueIdx UniqueIdx, bool bInvalidate=true)
 
const FParticleID & ParticleID () const
 
void SetParticleID (const FParticleID &ParticleID, bool bInvalidate=true)
 
const TRotation< T, d > R () const
 
const TRotation< T, d > GetR () const
 
void SetR (const TRotation< T, d > &InR, bool bInvalidate=true)
 
const FParticlePositionRotation & XR () const
 
void SetXR (const FParticlePositionRotation &InXR, bool bInvalidate=true)
 
void SetGeometry (Chaos::FImplicitObjectPtr ImplicitObjectPtr)
 
CHAOS_API void MergeGeometry (TArray< Chaos::FImplicitObjectPtr > &&Objects)
 
const FImplicitObjectRef GetGeometry () const
 
void LockGeometry ()
 
void SetGeometry (TUniquePtr< FImplicitObject > &&UniqueGeometry)
 
void SetGeometry (TSharedPtr< FImplicitObject, ESPMode::ThreadSafe > SharedGeometry)
 
void SetGeometry (TSerializablePtr< FImplicitObject > RawGeometry)
 
void MergeGeometry (TArray< TUniquePtr< FImplicitObject > > &&Objects)
 
TSharedPtr< const FImplicitObject, ESPMode::ThreadSafe > SharedGeometryLowLevel () const
 
TSerializablePtr< FImplicitObject > Geometry () const
 
CHAOS_API void RemoveShape (FPerShapeData *InShape, bool bWakeTouching)
 
CHAOS_API void RemoveShapesAtSortedIndices (const TArrayView< const int32 > &InIndices)
 
void * UserData () const
 
void SetUserData (void *InUserData)
 
void UpdateShapeBounds ()
 
void UpdateShapeBounds (const FRigidTransform3 &Transform)
 
void SetShapeSimCollisionEnabled (int32 InShapeIndex, bool bInEnabled)
 
void SetShapeQueryCollisionEnabled (int32 InShapeIndex, bool bInEnabled)
 
void SetShapeCollisionTraceType (int32 InShapeIndex, EChaosCollisionTraceFlag TraceType)
 
void SetShapeSimData (int32 InShapeIndex, const FCollisionFilterData &SimData)
 
const FString & GetDebugName () const
 
void MergeShapesArray (FShapesArray &&InShapesArray)
 
const FShapesArray & ShapesArray () const
 
const FShapeInstanceProxyArray & ShapeInstances () const
 
void SetShapeInstances (FShapeInstanceProxyArray &&InShapes)
 
void MergeShapeInstances (FShapeInstanceProxyArray &&InShapes)
 
void SetIgnoreAnalyticCollisionsImp (FImplicitObject *Implicit, bool bIgnoreAnalyticCollisions)
 
CHAOS_API void SetIgnoreAnalyticCollisions (bool bIgnoreAnalyticCollisions)
 
EObjectStateType ObjectState () const
 
EParticleType ObjectType () const
 
const TKinematicGeometryParticle< T, d > * CastToKinematicParticle () const
 
TKinematicGeometryParticle< T, d > * CastToKinematicParticle ()
 
const TPBDRigidParticle< T, d > * CastToRigidParticle () const
 
TPBDRigidParticle< T, d > * CastToRigidParticle ()
 
FSpatialAccelerationIdx SpatialIdx () const
 
void SetSpatialIdx (FSpatialAccelerationIdx Idx)
 
void SetResimType (EResimType ResimType)
 
EResimType ResimType () const
 
void SetEnabledDuringResim (bool bEnabledDuringResim)
 
bool EnabledDuringResim () const
 
void SetNonFrequentData (const FParticleNonFrequentData &InData)
 
bool IsDirty () const
 
bool IsClean () const
 
bool IsDirty (const EChaosPropertyFlags CheckBits) const
 
void ForceDirty (EChaosPropertyFlags CheckBits)
 
const FDirtyChaosPropertyFlags & DirtyFlags () const
 
void ClearDirtyFlags ()
 
TGeometryParticleHandle< T, d > * Handle () const
 
void SyncRemoteData (FDirtyPropertiesManager &Manager, int32 DataIdx, FDirtyChaosProperties &RemoteData, const TArray< int32 > &ShapeDataIndices, FShapeDirtyData *ShapesRemoteData) const
 
void PrepareBVH ()
 
class IPhysicsProxyBase * GetProxy () const
 
void SetProxy (IPhysicsProxyBase *InProxy)
 
const TSharedPtr< const FImplicitObject, ESPMode::ThreadSafe > & GeometrySharedLowLevel () const
 

Static Public Member Functions

static TUniquePtr< FPBDGeometryCollectionParticle > CreateParticle (const FPBDRigidParticleParameters &DynamicParams=FPBDRigidParticleParameters())
 
- Static Public Member Functions inherited from Chaos::TPBDRigidParticle< FReal, 3 >
static TUniquePtr< TPBDRigidParticle< FReal, d > > CreateParticle (const FPBDRigidParticleParameters &DynamicParams=FPBDRigidParticleParameters())
 
static TPBDRigidParticle< FReal, d > * Cast (TGeometryParticle< FReal, d > *Particle)
 
static const TPBDRigidParticle< FReal, d > * Cast (const TGeometryParticle< FReal, d > *Particle)
 
- Static Public Member Functions inherited from Chaos::TKinematicGeometryParticle< T, d >
static TUniquePtr< TKinematicGeometryParticle< T, d > > CreateParticle (const FKinematicGeometryParticleParameters &Params=FKinematicGeometryParticleParameters())
 
static TKinematicGeometryParticle< T, d > * Cast (TGeometryParticle< T, d > *Particle)
 
static const TKinematicGeometryParticle< T, d > * Cast (const TGeometryParticle< T, d > *Particle)
 
- Static Public Member Functions inherited from Chaos::TGeometryParticle< T, d >
static TUniquePtr< TGeometryParticle< T, d > > CreateParticle (const FGeometryParticleParameters &Params=FGeometryParticleParameters())
 
static TGeometryParticle< T, d > * SerializationFactory (FChaosArchive &Ar, TGeometryParticle< T, d > *Serializable)
 

Public Attributes

EParticleType Type
 
- Public Attributes inherited from Chaos::TPBDRigidParticle< FReal, 3 >
FDirtyChaosPropertyFlags MDirtyFlags
 
- Public Attributes inherited from Chaos::TKinematicGeometryParticle< T, d >
FDirtyChaosPropertyFlags MDirtyFlags
 

Additional Inherited Members

- Static Public Attributes inherited from Chaos::TGeometryParticle< T, d >
static constexpr bool AlwaysSerializable = true
 
- Protected Types inherited from Chaos::TGeometryParticle< T, d >
enum class  EGeometryAccess { Direct , ShallowCopy , DeepCopy }
 
- Protected Member Functions inherited from Chaos::TPBDRigidParticle< FReal, 3 >
 TPBDRigidParticle (const FPBDRigidParticleParameters &DynamicParams=FPBDRigidParticleParameters())
 
virtual void SyncRemoteDataImp (FDirtyPropertiesManager &Manager, int32 DataIdx, const FDirtyChaosProperties &RemoteData) const
 
- Protected Member Functions inherited from Chaos::TKinematicGeometryParticle< T, d >
 TKinematicGeometryParticle (const FKinematicGeometryParticleParameters &KinematicParams=FKinematicGeometryParticleParameters())
 
- Protected Member Functions inherited from Chaos::TGeometryParticle< T, d >
 TGeometryParticle (const FGeometryParticleParameters &StaticParams=FGeometryParticleParameters())
 
template<typename Lambda >
void ModifyGeometry (const Lambda &Func, const bool bDirectAccess=false)
 
template<typename Lambda >
void ModifyGeometry (EGeometryAccess AccessType, const Lambda &Func)
 
void MarkDirty (const EChaosPropertyFlags DirtyBits, bool bInvalidate=true)
 
CHAOS_API void UpdateShapesArray ()
 
void PrepareBVHImpl ()
 
void MarkDirty (const EChaosPropertyFlags DirtyBits, bool bInvalidate)
 
CHAOS_API void MarkDirty (const EChaosPropertyFlags DirtyBits, bool bInvalidate)
 
- Protected Attributes inherited from Chaos::TPBDRigidParticle< FReal, 3 >
class IPhysicsProxyBase * Proxy
 
- Protected Attributes inherited from Chaos::TKinematicGeometryParticle< T, d >
class IPhysicsProxyBase * Proxy
 
- Protected Attributes inherited from Chaos::TGeometryParticle< T, d >
class IPhysicsProxyBase * Proxy
 
EParticleType Type
 
FDirtyChaosPropertyFlags MDirtyFlags
 

Member Typedef Documentation

◆ FHandle

typedef TPBDGeometryCollectionParticleHandle<FReal, 3> Chaos::FPBDGeometryCollectionParticle::FHandle

Constructor & Destructor Documentation

◆ FPBDGeometryCollectionParticle()

Chaos::FPBDGeometryCollectionParticle::FPBDGeometryCollectionParticle ( const FPBDRigidParticleParameters &  DynamicParams = FPBDRigidParticleParameters())
inline

Member Function Documentation

◆ CreateParticle()

static TUniquePtr< FPBDGeometryCollectionParticle > Chaos::FPBDGeometryCollectionParticle::CreateParticle ( const FPBDRigidParticleParameters &  DynamicParams = FPBDRigidParticleParameters())
inlinestatic

Member Data Documentation

◆ Type

EParticleType Chaos::TGeometryParticle< T, d >::Type
The documentation for this class was generated from the following file: