UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
GeometryCollection::Facades::FTetrahedralSkeletalBindings Class Reference

#include <CollectionTetrahedralSkeletalBindingsFacade.h>

Public Member Functions

CHAOS_API FTetrahedralSkeletalBindings (FManagedArrayCollection &InSelf)
 
CHAOS_API FTetrahedralSkeletalBindings (const FManagedArrayCollection &InSelf)
 
virtual CHAOS_API ~FTetrahedralSkeletalBindings ()
 
CHAOS_API void DefineSchema ()
 
bool IsConst () const
 
CHAOS_API bool IsValid () const
 
CHAOS_API void SetBindings (const FString &InMeshGroupIndex, const TArray< int32 > &InTetrahedronIndex, const TArray< FVector4f > &WeightsIn, const TArray< int32 > &InSkeletalIndex)
 
CHAOS_API bool CalculateBindings (const FString &InKey, const TArray< FVector3f > &InVertices, TArray< FVector > &OutPosition, TArray< bool > *OutInfluence=nullptr) const
 

Static Public Member Functions

static CHAOS_API FString GenerateMeshGroupName (const int32 TetMeshIdx, const FName &SkeletalMeshName, const int32 LOD=INDEX_NONE)
 

Static Public Attributes

static CHAOS_API const FName MeshBindingsGroupName = "SkeletalBindings"
 
static CHAOS_API const FName MeshBindingsIdGroupName = "SkeletalBindingsId"
 
static CHAOS_API const FName MeshIdAttributeName = "MeshId"
 
static CHAOS_API const FName MeshIndexAttributeName = "MeshIdIndex"
 
static CHAOS_API const FName TetrahedronIndexAttributeName = "TetrahedronIndex"
 
static CHAOS_API const FName WeightsAttributeName = "Weights"
 
static CHAOS_API const FName SkeletalIndexAttributeName = "SkeletalIndex"
 

Detailed Description

FTetrahedralSkeletalBindings

Interface for storing and retrieving bindings of transforms of a SkeletalMesh to tetrahedral meshes. All bindings are stored in a single group, and a lookup table is aviable to match bindings to specifi meshs by name.

Constructor & Destructor Documentation

◆ FTetrahedralSkeletalBindings() [1/2]

GeometryCollection::Facades::FTetrahedralSkeletalBindings::FTetrahedralSkeletalBindings ( FManagedArrayCollection &  InSelf)

FSelectionFacade Constuctor

Parameters
VertixDependencyGroup: GroupName the index attribute is dependent on.

◆ FTetrahedralSkeletalBindings() [2/2]

GeometryCollection::Facades::FTetrahedralSkeletalBindings::FTetrahedralSkeletalBindings ( const FManagedArrayCollection &  InSelf)

◆ ~FTetrahedralSkeletalBindings()

GeometryCollection::Facades::FTetrahedralSkeletalBindings::~FTetrahedralSkeletalBindings ( )
virtual

Member Function Documentation

◆ CalculateBindings()

bool GeometryCollection::Facades::FTetrahedralSkeletalBindings::CalculateBindings ( const FString &  InKey,
const TArray< FVector3f > &  InVertices,
TArray< FVector > &  OutPosition,
TArray< bool > *  OutInfluence = nullptr 
) const

Returns false if bindings data was not found, or there was another error; true otherwise.

◆ DefineSchema()

void GeometryCollection::Facades::FTetrahedralSkeletalBindings::DefineSchema ( )

Create the facade schema.

◆ GenerateMeshGroupName()

FString GeometryCollection::Facades::FTetrahedralSkeletalBindings::GenerateMeshGroupName ( const int32  TetMeshIdx,
const FName &  SkeletalMeshName,
const int32  LOD = INDEX_NONE 
)
static

◆ IsConst()

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

Returns true if the facade is operating on a read-only geometry collection.

◆ IsValid()

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

Returns true if the Facade defined on the collection, and is initialized to a valid bindings group.

◆ SetBindings()

void GeometryCollection::Facades::FTetrahedralSkeletalBindings::SetBindings ( const FString &  InMeshGroupIndex,
const TArray< int32 > &  InTetrahedronIndex,
const TArray< FVector4f > &  WeightsIn,
const TArray< int32 > &  InSkeletalIndex 
)

Member Data Documentation

◆ MeshBindingsGroupName

const FName GeometryCollection::Facades::FTetrahedralSkeletalBindings::MeshBindingsGroupName = "SkeletalBindings"
static

◆ MeshBindingsIdGroupName

const FName GeometryCollection::Facades::FTetrahedralSkeletalBindings::MeshBindingsIdGroupName = "SkeletalBindingsId"
static

◆ MeshIdAttributeName

const FName GeometryCollection::Facades::FTetrahedralSkeletalBindings::MeshIdAttributeName = "MeshId"
static

◆ MeshIndexAttributeName

const FName GeometryCollection::Facades::FTetrahedralSkeletalBindings::MeshIndexAttributeName = "MeshIdIndex"
static

◆ SkeletalIndexAttributeName

const FName GeometryCollection::Facades::FTetrahedralSkeletalBindings::SkeletalIndexAttributeName = "SkeletalIndex"
static

◆ TetrahedronIndexAttributeName

const FName GeometryCollection::Facades::FTetrahedralSkeletalBindings::TetrahedronIndexAttributeName = "TetrahedronIndex"
static

◆ WeightsAttributeName

const FName GeometryCollection::Facades::FTetrahedralSkeletalBindings::WeightsAttributeName = "Weights"
static
The documentation for this class was generated from the following files: