CollectionVertexBoneWeightsFacade.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
#include "Containers/UnrealString.h"
#include "Containers/Array.h"
#include "GeometryCollection/GeometryCollection.h"
#include "GeometryCollection/Facades/CollectionSelectionFacade.h"
#include "GeometryCollection/ManagedArrayCollection.h"
#include "GeometryCollection/ManagedArrayAccessor.h"
 
namespace GeometryCollection::Facades
{
 
    class FVertexBoneWeightsFacade
    {
    public:
 
        // Attributes
        static CHAOS_API const FName BoneIndicesAttributeName;
        static CHAOS_API const FName BoneWeightsAttributeName;
        static CHAOS_API const FName KinematicWeightAttributeName;
        static CHAOS_API const FName GeometryLODAttributeName;
        static CHAOS_API const FName SkeletalMeshAttributeName;
        
        CHAOS_API FVertexBoneWeightsFacade(FManagedArrayCollection& InSelf, const bool bInternalWeights = true);
        CHAOS_API FVertexBoneWeightsFacade(const FManagedArrayCollection& InSelf, const bool bInternalWeights = true);
 
        CHAOS_API void DefineSchema();
 
        bool IsConst() const { return Collection == nullptr; }
 
        CHAOS_API bool IsValid() const;
 
        CHAOS_API bool HasValidBoneIndicesAndWeights() const;
 
        CHAOS_API void AddBoneWeightsFromKinematicBindings();
 
        CHAOS_API void AddBoneWeight(int32 VertexIndex, int32 BoneIndex, float BoneWeight);
 
        CHAOS_API void ModifyBoneWeight(int32 VertexIndex, const TArray<int32>& VertexBoneIndices, const TArray<float>& VertexBoneWeights);
 
        CHAOS_API void ModifyKinematicWeight(int32 VertexIndex, const float KinematicWeight);
 
        CHAOS_API void SetVertexKinematic(int32 VertexIndex, bool Value = true);
 
        CHAOS_API void SetVertexArrayKinematic(const TArray<int32>& VertexIndices, bool Value = true);
        
        CHAOS_API bool IsKinematicVertex(int32 VertexIndex) const;
        
        CHAOS_API void ModifyGeometryBinding(const int32 GeometryIndex, const TObjectPtr<UObject>& SkeletalMesh, const int32 GeometryLOD);
 
        CHAOS_API void NormalizeBoneWeights();
 
        int32 NumVertices() const { return ConstCollection.NumElements(FGeometryCollection::VerticesGroup); };
        
        int32 NumBones() const { return ConstCollection.NumElements(FGeometryCollection::TransformGroup); };
        
        int32 NumGeometry() const { return ConstCollection.NumElements(FGeometryCollection::GeometryGroup); };
 
        CHAOS_API const TManagedArray< TArray<int32> >* FindBoneIndices()  const;
        CHAOS_API const TManagedArray< TArray<int32> >& GetBoneIndices() const;
 
        CHAOS_API const TManagedArray< TArray<float> >* FindBoneWeights()  const;
        CHAOS_API const TManagedArray< TArray<float> >& GetBoneWeights() const;
 
        const TManagedArray<float>* FindKinematicWeights()  const { return KinematicWeightAttribute.Find(); }
        const TManagedArray<float>& GetKinematicWeights() const { return KinematicWeightAttribute.Get(); }
 
        const TManagedArray<TObjectPtr<UObject>>* FindSkeletalMeshes()  const { return SkeletalMeshAttribute.Find(); }
        const TManagedArray<TObjectPtr<UObject>>& GetSkeletalMeshes() const { return SkeletalMeshAttribute.Get(); }
        
        const TManagedArray<int32>* FindGeomketryLODs()  const { return GeometryLODAttribute.Find(); }
        const TManagedArray<int32>& GetGeometryLODs() const { return GeometryLODAttribute.Get(); }
        
        const FManagedArrayCollection& GetManagedArrayCollection() const {return ConstCollection;}
 
    private:
 
        static const FName DeprecatedBoneIndicesAttributeName;
        static const FName DeprecatedKinematicFlagAttributeName;
        
        const FManagedArrayCollection& ConstCollection;
        FManagedArrayCollection* Collection = nullptr;
 
        TManagedArrayAccessor<TArray<int32>> BoneIndicesAttribute;
 
        TManagedArrayAccessor<TArray<float>> BoneWeightsAttribute;
 
        TManagedArrayAccessor<float> KinematicWeightAttribute;
        
        TManagedArrayAccessor<int32> GeometryLODAttribute;
 
        TManagedArrayAccessor<TObjectPtr<UObject>> SkeletalMeshAttribute;
 
        const bool bInternalWeights = true;
    };
 
}