Navigation
API > API/Runtime > API/Runtime/Chaos
User-facing api for accessing the proxy of a strained cluster. Provides const access to the proxy and limited read/write access to its internal strain data.
| Name | FStrainedProxyModifier |
| Type | class |
| Header File | /Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/StrainModification.h |
| Include Path | #include "Chaos/StrainModification.h" |
Syntax
class FStrainedProxyModifier
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FStrainedProxyModifier
(
const FStrainedProxyModifier& Other |
Chaos/StrainModification.h | ||
FStrainedProxyModifier
(
FRigidClustering& InRigidClustering, |
Chaos/StrainModification.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ProxyAndRoot | FStrainedProxyAndRoot | Chaos/StrainModification.h | ||
| RestChildren | const TSet< int32 > * | Chaos/StrainModification.h | ||
| RigidClustering | FRigidClustering & | Chaos/StrainModification.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AdjustStrainForBreak
(
const float FatigueThresholdPercent, |
Adjust strain for all the strained children above the fatigue threshold so that their strain is large enough to break | Chaos/StrainModification.h | |
void ClearStrains() |
Clear strains for all strained cluster children. | Chaos/StrainModification.h | |
float GetMaxBreakStrainRatio
(
const float FatigueThresholdPercent, |
Go through the children and find the one with the largest ratio of applied strain vs internal strain and return this ratio | Chaos/StrainModification.h | |
int32 GetNumBreakingStrains
(
bool bDoubleCount, |
Get the number of breaking strains amongst the level-1 strainables If DoubleCount is true, then add N for each strain which is strong enough to break a connection N times. | Chaos/StrainModification.h | |
int32 GetNumRestBreakables() |
Get the number of level-1 strainable entities (number of rest-children in the per-particle strain model, or number of rest-connections in the edge/area model). | Chaos/StrainModification.h | |
const Chaos::FPBDRigidParticleHandle * GetOriginalRootHandle() |
Get the original root handle from the geometry collection proxy. | Chaos/StrainModification.h | |
const Chaos::FPBDRigidParticleHandle * GetParticleHandle() |
Get the physics handle for the strained parent cluster or the strained particle directly if it's part of partial destruction. | Chaos/StrainModification.h | |
const IPhysicsProxyBase * GetProxy() |
Get the proxy that owns the strained cluster or clusters. | Chaos/StrainModification.h | |
const Chaos::FPBDRigidParticleHandle * GetRootHandle() |
Get the physics handle for the strained parent cluster | Chaos/StrainModification.h | |
float GetStrainUsedForBreakRatio
(
const float FatigueThresholdPercent, |
A helper debug method to pair w/ GetMaxBreakStrainRatio, where it will return the Max Applied Strain used for the Max Break Strain. | Chaos/StrainModification.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const TSet< int32 > * InitRestChildren
(
FGeometryCollectionPhysicsProxy* Proxy |
Chaos/StrainModification.h |