UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
Chaos::Softs::FEmbeddedSpringFacade Class Referencefinal

#include <CollectionEmbeddedSpringConstraintFacade.h>

+ Inheritance diagram for Chaos::Softs::FEmbeddedSpringFacade:

Public Member Functions

 FEmbeddedSpringFacade (FManagedArrayCollection &InCollection, const FName &InVerticesGroup=FGeometryCollection::VerticesGroup)
 
 FEmbeddedSpringFacade (const FManagedArrayCollection &InCollection, const FName &InVerticesGroup=FGeometryCollection::VerticesGroup)
 
CHAOS_API void Append (const FEmbeddedSpringFacade &Other, int32 VertexOffset)
 
int32 GetNumSpringConstraints () const
 
CHAOS_API void SetNumSpringConstraints (int32 Num)
 
CHAOS_API FEmbeddedSpringConstraintFacade GetSpringConstraint (int32 ConstraintIndex)
 
CHAOS_API FEmbeddedSpringConstraintFacade GetSpringConstraintConst (int32 ConstraintIndex) const
 
CHAOS_API int32 AddSpringConstraint ()
 
FEmbeddedSpringConstraintFacade AddGetSpringConstraint ()
 
CHAOS_API void RemoveSpringConstraints (const TArray< int32 > &SortedDeletionList)
 
CHAOS_API uint32 CalculateTypeHash (uint32 PreviousHash=0) const
 
CHAOS_API void CleanupAndCompactInvalidSprings ()
 
- Public Member Functions inherited from Chaos::Softs::FEmbeddedSpringBaseFacade
CHAOS_API FEmbeddedSpringBaseFacade (FManagedArrayCollection &InCollection, const FName &InVerticesGroup=FGeometryCollection::VerticesGroup)
 
CHAOS_API FEmbeddedSpringBaseFacade (const FManagedArrayCollection &InCollection, const FName &InVerticesGroup=FGeometryCollection::VerticesGroup)
 
CHAOS_API bool IsValid () const
 
CHAOS_API void DefineSchema ()
 
- Public Member Functions inherited from GeometryCollection::Facades::FPositionTargetFacade
CHAOS_API FPositionTargetFacade (FManagedArrayCollection &InCollection, const FName &InVerticesGroup=FGeometryCollection::VerticesGroup)
 
CHAOS_API FPositionTargetFacade (const FManagedArrayCollection &InCollection, const FName &InVerticesGroup=FGeometryCollection::VerticesGroup)
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS FPositionTargetFacade (FPositionTargetFacade &&)=default
 
PRAGMA_ENABLE_DEPRECATION_WARNINGS CHAOS_API void DefineSchema ()
 
bool IsConst () const
 
CHAOS_API bool IsValid () const
 
CHAOS_API int32 AddPositionTarget (const FPositionTargetsData &InputData)
 
CHAOS_API FPositionTargetsData GetPositionTarget (const int32 DataIndex) const
 
int32 NumPositionTargets () const
 
CHAOS_API int32 RemoveInvalidPositionTarget ()
 
CHAOS_API int32 RemovePositionTargetBetween (TFunctionRef< bool(const int32 VertexIdx)> IsVertexGroup1, TFunctionRef< bool(const int32 VertexIdx)> IsVertexGroup2)
 

Additional Inherited Members

- Public Types inherited from GeometryCollection::Facades::FPositionTargetFacade
typedef GeometryCollection::Facades::FSelectionFacade::FSelectionKey FBindingKey
 
- Static Public Attributes inherited from Chaos::Softs::FEmbeddedSpringBaseFacade
static CHAOS_API const FName SpringLength
 
static CHAOS_API const FName CompressionStiffness
 
static CHAOS_API const FName SpringConstraintGroupName
 
static CHAOS_API const FName ConstraintStart
 
static CHAOS_API const FName ConstraintEnd
 
static CHAOS_API const FName ConstraintEndPointNumIndices
 
static CHAOS_API const FName ConstraintName
 
- Static Public Attributes inherited from GeometryCollection::Facades::FPositionTargetFacade
static CHAOS_API const FName GroupName
 
static CHAOS_API const FName TargetIndex
 
static CHAOS_API const FName SourceIndex
 
static CHAOS_API const FName Stiffness
 
static CHAOS_API const FName Damping
 
static CHAOS_API const FName SourceName
 
static CHAOS_API const FName TargetName
 
static CHAOS_API const FName TargetWeights
 
static CHAOS_API const FName SourceWeights
 
static CHAOS_API const FName IsAnisotropic
 
static CHAOS_API const FName IsZeroRestLength
 
- Protected Attributes inherited from Chaos::Softs::FEmbeddedSpringBaseFacade
TManagedArrayAccessor< float > SpringLengthAttribute
 
TManagedArrayAccessor< float > CompressionStiffnessAttribute
 
TManagedArrayAccessor< int32 > ConstraintStartAttribute
 
TManagedArrayAccessor< int32 > ConstraintEndAttribute
 
TManagedArrayAccessor< FUintVector2 > ConstraintEndPointNumIndicesAttribute
 
TManagedArrayAccessor< FString > ConstraintNameAttribute
 
- Protected Attributes inherited from GeometryCollection::Facades::FPositionTargetFacade
const FManagedArrayCollection & ConstCollection
 
FManagedArrayCollection * Collection = nullptr
 
const FName VerticesGroup
 
TManagedArrayAccessor< TArray< int32 > > TargetIndexAttribute
 
TManagedArrayAccessor< TArray< int32 > > SourceIndexAttribute
 
TManagedArrayAccessor< float > StiffnessAttribute
 
TManagedArrayAccessor< float > DampingAttribute
 
TManagedArrayAccessor< TArray< float > > TargetWeightsAttribute
 
TManagedArrayAccessor< TArray< float > > SourceWeightsAttribute
 
TManagedArrayAccessor< bool > IsAnisotropicAttribute
 
TManagedArrayAccessor< bool > IsZeroRestLengthAttribute
 

Detailed Description

Facade for managing all FEmbeddedSpringConstraintFacade within a collection

Constructor & Destructor Documentation

◆ FEmbeddedSpringFacade() [1/2]

Chaos::Softs::FEmbeddedSpringFacade::FEmbeddedSpringFacade ( FManagedArrayCollection &  InCollection,
const FName &  InVerticesGroup = FGeometryCollection::VerticesGroup 
)
inline

◆ FEmbeddedSpringFacade() [2/2]

Chaos::Softs::FEmbeddedSpringFacade::FEmbeddedSpringFacade ( const FManagedArrayCollection &  InCollection,
const FName &  InVerticesGroup = FGeometryCollection::VerticesGroup 
)
inline

Member Function Documentation

◆ AddGetSpringConstraint()

FEmbeddedSpringConstraintFacade Chaos::Softs::FEmbeddedSpringFacade::AddGetSpringConstraint ( )
inline

◆ AddSpringConstraint()

int32 Chaos::Softs::FEmbeddedSpringFacade::AddSpringConstraint ( )

◆ Append()

void Chaos::Softs::FEmbeddedSpringFacade::Append ( const FEmbeddedSpringFacade &  Other,
int32  VertexOffset 
)

Append contents of another facade to this one.

◆ CalculateTypeHash()

uint32 Chaos::Softs::FEmbeddedSpringFacade::CalculateTypeHash ( uint32  PreviousHash = 0) const

◆ CleanupAndCompactInvalidSprings()

void Chaos::Softs::FEmbeddedSpringFacade::CleanupAndCompactInvalidSprings ( )

Remove springs with invalid vertices.

◆ GetNumSpringConstraints()

int32 Chaos::Softs::FEmbeddedSpringFacade::GetNumSpringConstraints ( ) const
inline

Constraints (lists of springs) management

◆ GetSpringConstraint()

FEmbeddedSpringConstraintFacade Chaos::Softs::FEmbeddedSpringFacade::GetSpringConstraint ( int32  ConstraintIndex)

◆ GetSpringConstraintConst()

FEmbeddedSpringConstraintFacade Chaos::Softs::FEmbeddedSpringFacade::GetSpringConstraintConst ( int32  ConstraintIndex) const

◆ RemoveSpringConstraints()

void Chaos::Softs::FEmbeddedSpringFacade::RemoveSpringConstraints ( const TArray< int32 > &  SortedDeletionList)

◆ SetNumSpringConstraints()

void Chaos::Softs::FEmbeddedSpringFacade::SetNumSpringConstraints ( int32  Num)
The documentation for this class was generated from the following files: