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

#include <IslandManager.h>

Public Member Functions

CHAOS_API FPBDIsland ()
 
CHAOS_API ~FPBDIsland ()
 
int32 GetNumParticles () const
 
int32 GetNumConstraints () const
 
int32 GetNumContainerConstraints (const int32 ContainerId) const
 
const FPBDIslandParticleGetNode (const int32 NodeIndex) const
 
bool IsSleeping () const
 
int32 GetSleepCounter () const
 
void SetSleepCounter (const int32 InSleepCounter)
 
bool IsSleepAllowed () const
 
bool NeedsResim () const
 
void SetNeedsResim (const bool bInNeedsResim)
 
int32 GetResimFrame () const
 
void SetResimFrame (const int32 InResimFrame)
 
bool IsUsingCache () const
 
void SetIsUsingCache (const bool bInIsUsingCache)
 
TArrayView< FPBDIslandParticle * > GetParticles ()
 
TArrayView< FPBDIslandConstraint * > GetConstraints (const int32 ContainerId)
 
int32 GetIslandId () const
 
const int32 GetArrayIndex () const
 
void SetArrayIndex (const int32 InIndex)
 
CHAOS_API void Reuse ()
 
CHAOS_API void Trash ()
 
FIterationSettings GetIterationSettings () const
 
void SetIterationSettings (const FIterationSettings &InIterations)
 
bool IsPartialSleepEnabled () const
 

Friends

class FPBDIslandManager
 

Detailed Description

A set of connected constraints and particles. A dynamic particle can only be in one island, and each island explicitly holds an array of its dynamic particles. Kinematic particles may be in multiple islands and we do not hold the set of these. To find kinematic particles used by an island you would need to visit all the constraints.

Constructor & Destructor Documentation

◆ FPBDIsland()

Chaos::Private::FPBDIsland::FPBDIsland ( )

◆ ~FPBDIsland()

Chaos::Private::FPBDIsland::~FPBDIsland ( )

Member Function Documentation

◆ GetArrayIndex()

const int32 Chaos::Private::FPBDIsland::GetArrayIndex ( ) const
inline

◆ GetConstraints()

TArrayView< FPBDIslandConstraint * > Chaos::Private::FPBDIsland::GetConstraints ( const int32  ContainerId)
inline

◆ GetIslandId()

int32 Chaos::Private::FPBDIsland::GetIslandId ( ) const
inline

◆ GetIterationSettings()

FIterationSettings Chaos::Private::FPBDIsland::GetIterationSettings ( ) const
inline

Get the iterations settings for this group of islands

◆ GetNode()

const FPBDIslandParticle * Chaos::Private::FPBDIsland::GetNode ( const int32  NodeIndex) const
inline

◆ GetNumConstraints()

int32 Chaos::Private::FPBDIsland::GetNumConstraints ( ) const
inline

◆ GetNumContainerConstraints()

int32 Chaos::Private::FPBDIsland::GetNumContainerConstraints ( const int32  ContainerId) const
inline

◆ GetNumParticles()

int32 Chaos::Private::FPBDIsland::GetNumParticles ( ) const
inline

◆ GetParticles()

TArrayView< FPBDIslandParticle * > Chaos::Private::FPBDIsland::GetParticles ( )
inline

◆ GetResimFrame()

int32 Chaos::Private::FPBDIsland::GetResimFrame ( ) const
inline

◆ GetSleepCounter()

int32 Chaos::Private::FPBDIsland::GetSleepCounter ( ) const
inline

◆ IsPartialSleepEnabled()

bool Chaos::Private::FPBDIsland::IsPartialSleepEnabled ( ) const

◆ IsSleepAllowed()

bool Chaos::Private::FPBDIsland::IsSleepAllowed ( ) const
inline

◆ IsSleeping()

bool Chaos::Private::FPBDIsland::IsSleeping ( ) const
inline

◆ IsUsingCache()

bool Chaos::Private::FPBDIsland::IsUsingCache ( ) const
inline

◆ NeedsResim()

bool Chaos::Private::FPBDIsland::NeedsResim ( ) const
inline

◆ Reuse()

void Chaos::Private::FPBDIsland::Reuse ( )

◆ SetArrayIndex()

void Chaos::Private::FPBDIsland::SetArrayIndex ( const int32  InIndex)
inline

◆ SetIsUsingCache()

void Chaos::Private::FPBDIsland::SetIsUsingCache ( const bool  bInIsUsingCache)
inline

◆ SetIterationSettings()

void Chaos::Private::FPBDIsland::SetIterationSettings ( const FIterationSettings InIterations)
inline

Set the iterations settings for this group of islands

◆ SetNeedsResim()

void Chaos::Private::FPBDIsland::SetNeedsResim ( const bool  bInNeedsResim)
inline

◆ SetResimFrame()

void Chaos::Private::FPBDIsland::SetResimFrame ( const int32  InResimFrame)
inline

◆ SetSleepCounter()

void Chaos::Private::FPBDIsland::SetSleepCounter ( const int32  InSleepCounter)
inline

◆ Trash()

void Chaos::Private::FPBDIsland::Trash ( )

Friends And Related Symbol Documentation

◆ FPBDIslandManager

friend class FPBDIslandManager
friend

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