Navigation
API > API/Runtime > API/Runtime/Chaos
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.
| Name | FPBDIsland |
| Type | class |
| Header File | /Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/Island/IslandManager.h |
| Include Path | #include "Chaos/Island/IslandManager.h" |
Syntax
class FPBDIsland
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FPBDIsland() |
Chaos/Island/IslandManager.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FPBDIsland() |
Chaos/Island/IslandManager.h |
Classes
| Name | Remarks |
|---|---|
| FFlags |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ArrayIndex | int32 | Index into FPBDIslandManager::Islands. | Chaos/Island/IslandManager.h | |
| ContainerEdges | TConstraintTypeArray< TArray< FPBDIslandConstraint * > > | All edges in the island for each constraint type. | Chaos/Island/IslandManager.h | |
| DisableCounter | int32 | When DisableCounter hits a threshold the island particle will be disabled. | Chaos/Island/IslandManager.h | |
| Flags | FFlags | Chaos/Island/IslandManager.h | ||
| Iterations | FIterationSettings | Chaos/Island/IslandManager.h | ||
| MergeSet | FPBDIslandMergeSet * | When edges are added, islands merge. The MergeSet tracks which islands are merging together. | Chaos/Island/IslandManager.h | |
| MergeSetIslandIndex | int32 | Index into FPBDIslandMergeSet::Islands. | Chaos/Island/IslandManager.h | |
| Nodes | TArray< FPBDIslandParticle * > | Nodes for dynamic particles in the Island (does not include kinematics) | Chaos/Island/IslandManager.h | |
| NumEdges | int32 | Total number of edges in ContainerEdges[0..N]. | Chaos/Island/IslandManager.h | |
| ResimFrame | int32 | Chaos/Island/IslandManager.h | ||
| SleepCounter | int32 | When SleepCounter hits a threshold the island will sleep. | Chaos/Island/IslandManager.h | |
| SleepTypeSwitchCounter | int32 | When SleepTypeSwitchCounter hits a threshold, the island sleep type (partial or full) will change if CVars::bChaosSolverPartialIslandSleep == true. | Chaos/Island/IslandManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const int32 GetArrayIndex() |
TPoolBackedItemAdapter for FPBDIslandManager::Islands. | Chaos/Island/IslandManager.h | |
TArrayView< FPBDIslandConstraint * > GetConstraints
(
const int32 ContainerId |
Chaos/Island/IslandManager.h | ||
int32 GetIslandId () |
An integer ID for an island. | Chaos/Island/IslandManager.h | |
FIterationSettings GetIterationSettings() |
Get the iterations settings for this group of islands | Chaos/Island/IslandManager.h | |
const FPBDIslandParticle * GetNode
(
const int32 NodeIndex |
Chaos/Island/IslandManager.h | ||
int32 GetNumConstraints() |
Chaos/Island/IslandManager.h | ||
int32 GetNumContainerConstraints
(
const int32 ContainerId |
Chaos/Island/IslandManager.h | ||
int32 GetNumParticles() |
Chaos/Island/IslandManager.h | ||
TArrayView< FPBDIslandParticle * > GetParticles() |
Chaos/Island/IslandManager.h | ||
int32 GetResimFrame() |
Chaos/Island/IslandManager.h | ||
int32 GetSleepCounter() |
Chaos/Island/IslandManager.h | ||
bool IsPartialSleepEnabled() |
Chaos/Island/IslandManager.h | ||
bool IsSleepAllowed() |
Chaos/Island/IslandManager.h | ||
bool IsSleeping() |
Chaos/Island/IslandManager.h | ||
bool IsUsingCache() |
Chaos/Island/IslandManager.h | ||
bool NeedsResim() |
Chaos/Island/IslandManager.h | ||
void Reuse() |
Chaos/Island/IslandManager.h | ||
void SetArrayIndex
(
const int32 InIndex |
Chaos/Island/IslandManager.h | ||
void SetIsUsingCache
(
const bool bInIsUsingCache |
Chaos/Island/IslandManager.h | ||
void SetIterationSettings
(
const FIterationSettings& InIterations |
Set the iterations settings for this group of islands | Chaos/Island/IslandManager.h | |
void SetNeedsResim
(
const bool bInNeedsResim |
Chaos/Island/IslandManager.h | ||
void SetResimFrame
(
const int32 InResimFrame |
Chaos/Island/IslandManager.h | ||
void SetSleepCounter
(
const int32 InSleepCounter |
Chaos/Island/IslandManager.h | ||
void Trash() |
Chaos/Island/IslandManager.h |