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

#include <CollectionEmbeddedSpringConstraintFacade.h>

+ Inheritance diagram for Chaos::Softs::FEmbeddedSpringBaseFacade:

Public Member Functions

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)
 

Static Public Attributes

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

TManagedArrayAccessor< floatSpringLengthAttribute
 
TManagedArrayAccessor< floatCompressionStiffnessAttribute
 
TManagedArrayAccessor< int32ConstraintStartAttribute
 
TManagedArrayAccessor< int32ConstraintEndAttribute
 
TManagedArrayAccessor< FUintVector2ConstraintEndPointNumIndicesAttribute
 
TManagedArrayAccessor< FString > ConstraintNameAttribute
 
- Protected Attributes inherited from GeometryCollection::Facades::FPositionTargetFacade
const FManagedArrayCollectionConstCollection
 
FManagedArrayCollectionCollection = nullptr
 
const FName VerticesGroup
 
TManagedArrayAccessor< TArray< int32 > > TargetIndexAttribute
 
TManagedArrayAccessor< TArray< int32 > > SourceIndexAttribute
 
TManagedArrayAccessor< floatStiffnessAttribute
 
TManagedArrayAccessor< floatDampingAttribute
 
TManagedArrayAccessor< TArray< float > > TargetWeightsAttribute
 
TManagedArrayAccessor< TArray< float > > SourceWeightsAttribute
 
TManagedArrayAccessor< boolIsAnisotropicAttribute
 
TManagedArrayAccessor< boolIsZeroRestLengthAttribute
 

Additional Inherited Members

- Public Types inherited from GeometryCollection::Facades::FPositionTargetFacade
typedef GeometryCollection::Facades::FSelectionFacade::FSelectionKey FBindingKey
 

Detailed Description

Base class for non-zero length springs.

Constructor & Destructor Documentation

◆ FEmbeddedSpringBaseFacade() [1/2]

Chaos::Softs::FEmbeddedSpringBaseFacade::FEmbeddedSpringBaseFacade ( FManagedArrayCollection InCollection,
const FName InVerticesGroup = FGeometryCollection::VerticesGroup 
)

◆ FEmbeddedSpringBaseFacade() [2/2]

Chaos::Softs::FEmbeddedSpringBaseFacade::FEmbeddedSpringBaseFacade ( const FManagedArrayCollection InCollection,
const FName InVerticesGroup = FGeometryCollection::VerticesGroup 
)

Member Function Documentation

◆ DefineSchema()

void Chaos::Softs::FEmbeddedSpringBaseFacade::DefineSchema ( )

◆ IsValid()

bool Chaos::Softs::FEmbeddedSpringBaseFacade::IsValid ( ) const

Member Data Documentation

◆ CompressionStiffness

const FName Chaos::Softs::FEmbeddedSpringBaseFacade::CompressionStiffness
static

◆ CompressionStiffnessAttribute

TManagedArrayAccessor<float> Chaos::Softs::FEmbeddedSpringBaseFacade::CompressionStiffnessAttribute
protected

◆ ConstraintEnd

const FName Chaos::Softs::FEmbeddedSpringBaseFacade::ConstraintEnd
static

◆ ConstraintEndAttribute

TManagedArrayAccessor<int32> Chaos::Softs::FEmbeddedSpringBaseFacade::ConstraintEndAttribute
protected

◆ ConstraintEndPointNumIndices

const FName Chaos::Softs::FEmbeddedSpringBaseFacade::ConstraintEndPointNumIndices
static

◆ ConstraintEndPointNumIndicesAttribute

TManagedArrayAccessor<FUintVector2> Chaos::Softs::FEmbeddedSpringBaseFacade::ConstraintEndPointNumIndicesAttribute
protected

◆ ConstraintName

const FName Chaos::Softs::FEmbeddedSpringBaseFacade::ConstraintName
static

◆ ConstraintNameAttribute

TManagedArrayAccessor<FString> Chaos::Softs::FEmbeddedSpringBaseFacade::ConstraintNameAttribute
protected

◆ ConstraintStart

const FName Chaos::Softs::FEmbeddedSpringBaseFacade::ConstraintStart
static

◆ ConstraintStartAttribute

TManagedArrayAccessor<int32> Chaos::Softs::FEmbeddedSpringBaseFacade::ConstraintStartAttribute
protected

◆ SpringConstraintGroupName

const FName Chaos::Softs::FEmbeddedSpringBaseFacade::SpringConstraintGroupName
static

◆ SpringLength

const FName Chaos::Softs::FEmbeddedSpringBaseFacade::SpringLength
static

◆ SpringLengthAttribute

TManagedArrayAccessor<float> Chaos::Softs::FEmbeddedSpringBaseFacade::SpringLengthAttribute
protected

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