UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
GeometryCollection::Facades::FVolumeConstraintFacade Class Reference

#include <CollectionVolumeConstraintFacade.h>

Public Member Functions

CHAOS_API FVolumeConstraintFacade (FManagedArrayCollection &InCollection)
 
CHAOS_API FVolumeConstraintFacade (const FManagedArrayCollection &InCollection)
 
 FVolumeConstraintFacade (FVolumeConstraintFacade &&)=default
 
CHAOS_API void DefineSchema ()
 
bool IsConst () const
 
CHAOS_API bool IsValid () const
 
CHAOS_API int32 AddVolumeConstraint (const FIntVector4 &NewVolumeIndex, float NewStiffness)
 
CHAOS_API FIntVector4 GetVolumeIndex (const int32 AttributeIndex) const
 
CHAOS_API float GetStiffness (const int32 AttributeIndex) const
 
int32 NumVolumeConstraints () const
 
CHAOS_API int32 RemoveInvalidVolumeConstraint ()
 
CHAOS_API int32 RemoveVolumeConstraintBetween (TFunctionRef< bool(const int32 VertexIdx)> IsVertexGroup1, TFunctionRef< bool(const int32 VertexIdx)> IsVertexGroup2)
 

Static Public Attributes

static CHAOS_API const FName GroupName
 
static CHAOS_API const FName VolumeIndex
 
static CHAOS_API const FName Stiffness
 

Protected Attributes

const FManagedArrayCollectionConstCollection
 
FManagedArrayCollectionCollection = nullptr
 
TManagedArrayAccessor< FIntVector4VolumeIndexAttribute
 
TManagedArrayAccessor< floatStiffnessAttribute
 

Detailed Description

Volume Constraint Facade

Constructor & Destructor Documentation

◆ FVolumeConstraintFacade() [1/3]

GeometryCollection::Facades::FVolumeConstraintFacade::FVolumeConstraintFacade ( FManagedArrayCollection InCollection)

◆ FVolumeConstraintFacade() [2/3]

GeometryCollection::Facades::FVolumeConstraintFacade::FVolumeConstraintFacade ( const FManagedArrayCollection InCollection)

◆ FVolumeConstraintFacade() [3/3]

GeometryCollection::Facades::FVolumeConstraintFacade::FVolumeConstraintFacade ( FVolumeConstraintFacade &&  )
default

Member Function Documentation

◆ AddVolumeConstraint()

int32 GeometryCollection::Facades::FVolumeConstraintFacade::AddVolumeConstraint ( const FIntVector4 NewVolumeIndex,
float  NewStiffness 
)

◆ DefineSchema()

void GeometryCollection::Facades::FVolumeConstraintFacade::DefineSchema ( )

Create the facade attributes.

◆ GetStiffness()

float GeometryCollection::Facades::FVolumeConstraintFacade::GetStiffness ( const int32  AttributeIndex) const

◆ GetVolumeIndex()

FIntVector4 GeometryCollection::Facades::FVolumeConstraintFacade::GetVolumeIndex ( const int32  AttributeIndex) const

◆ IsConst()

bool GeometryCollection::Facades::FVolumeConstraintFacade::IsConst ( ) const
inline

Is the facade defined constant.

◆ IsValid()

bool GeometryCollection::Facades::FVolumeConstraintFacade::IsValid ( ) const

Is the Facade defined on the collection?

◆ NumVolumeConstraints()

int32 GeometryCollection::Facades::FVolumeConstraintFacade::NumVolumeConstraints ( ) const
inline

◆ RemoveInvalidVolumeConstraint()

int32 GeometryCollection::Facades::FVolumeConstraintFacade::RemoveInvalidVolumeConstraint ( )

Remove volume constraint with invalid indices

◆ RemoveVolumeConstraintBetween()

int32 GeometryCollection::Facades::FVolumeConstraintFacade::RemoveVolumeConstraintBetween ( TFunctionRef< bool(const int32 VertexIdx)>  IsVertexGroup1,
TFunctionRef< bool(const int32 VertexIdx)>  IsVertexGroup2 
)

Remove volume constraint between two groups of vertices

Member Data Documentation

◆ Collection

FManagedArrayCollection* GeometryCollection::Facades::FVolumeConstraintFacade::Collection = nullptr
protected

◆ ConstCollection

const FManagedArrayCollection& GeometryCollection::Facades::FVolumeConstraintFacade::ConstCollection
protected

◆ GroupName

const FName GeometryCollection::Facades::FVolumeConstraintFacade::GroupName
static

◆ Stiffness

const FName GeometryCollection::Facades::FVolumeConstraintFacade::Stiffness
static

◆ StiffnessAttribute

TManagedArrayAccessor<float> GeometryCollection::Facades::FVolumeConstraintFacade::StiffnessAttribute
protected

◆ VolumeIndex

const FName GeometryCollection::Facades::FVolumeConstraintFacade::VolumeIndex
static

◆ VolumeIndexAttribute

TManagedArrayAccessor<FIntVector4> GeometryCollection::Facades::FVolumeConstraintFacade::VolumeIndexAttribute
protected

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