FVertexBoneWeightsFacade | Unreal Engine 5.5 Documentation

API > API/Runtime > API/Runtime/Chaos > API/Runtime/Chaos/GeometryCollection > API/Runtime/Chaos/GeometryCollection/Facades

References


Module	Chaos
Header	/Engine/Source/Runtime/Experimental/Chaos/Public/GeometryCollection/Facades/CollectionVertexBoneWeightsFacade.h
Include	#include "GeometryCollection/Facades/CollectionVertexBoneWeightsFacade.h"

Syntax

class FVertexBoneWeightsFacade

Remarks

FVertexBoneWeightsFacade

Defines common API for storing a vertex weights bound to a bone. This mapping is from the the vertex to the bone index. Kinematic array specifies whether vertices are considered kinematic. Non-kinematic vertices can also have associated bone indices and weights.

Then arrays can be accessed later by: const TManagedArray< TArray >* BoneIndices = FVertexBoneWeightsFacade::GetBoneIndices(this); const TManagedArray< TArray >* BoneWeights = FVertexBoneWeightsFacade::GetBoneWeights(this);

The following attributes are created on the collection:

FindAttribute>(FVertexSetInterface::IndexAttribute, FGeometryCollection::VerticesGroup);
FindAttribute>(FVertexSetInterface::WeightAttribute, FGeometryCollection::VerticesGroup);

Constructors

	Type	Name	Description
		FVertexBoneWeightsFacade ( FManagedArrayCollection& InSelf )	FVertexBoneWeightsFacade Constuctor
		FVertexBoneWeightsFacade ( const FManagedArrayCollection& InSelf )

Functions

Type	Name	Description
void	AddBoneWeight ( int32 VertexIndex, int32 BoneIndex, float BoneWeight )	Add single bone/weight to vertex
void	AddBoneWeightsFromKinematicBindings ()	Add bone weight based on the kinematic bindings.
void	DefineSchema ()	Define the facade
const TManagedArray< TArray< int32 > > *	FindBoneIndices ()	Return the vertex bone indices from the collection. Null if not initialized.
const TManagedArray< TArray< float > > *	FindBoneWeights ()	Return the vertex bone weights from the collection. Null if not initialized.
const TManagedArray< TArray< int32 > > &	GetBoneIndices ()
const TManagedArray< TArray< float > > &	GetBoneWeights ()
bool	IsConst ()	Is the Facade const
bool	IsKinematicVertex ( int32 VertexIndex )	Return if the vertex is kinematic Pre 5.5 we did not have per-vertex kinematic attribute.
bool	IsValid ()	Is the Facade defined on the collection?
void	ModifyBoneWeight ( int32 VertexIndex, TArray< int32 > VertexBoneIndex, TArray< float > VertexBoneWeight )	Modify bone weight based on the kinematic bindings.
int32	NumVertices ()	Return number of vertices
void	SetVertexArrayKinematic ( const TArray< int32 >& VertexIndices )
void	SetVertexKinematic ( int32 VertexIndex )	Set vertex to be kinematic

Constants

Name	Description
BoneIndexAttributeName	Attributes.
BoneWeightAttributeName
KinematicAttributeName