SkeletalMeshAttributes.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "SkeletalMeshElementTypes.h"
 
#include "Containers/Array.h"
#include "HAL/Platform.h"
#include "MeshAttributeArray.h"
#include "SkinWeightsAttributesRef.h"
#include "StaticMeshAttributes.h"
#include "UObject/NameTypes.h"
#include "UObject/UnrealNames.h"
 
// Forward declarations
template <typename AttributeType> class TArrayAttribute;
struct FMeshDescription;
 
// Add any skeletalmesh specific attributes here
namespace MeshAttribute
{
    namespace Vertex
    {
        // Name of the default skin weights attribute.
        extern SKELETALMESHDESCRIPTION_API const FName SkinWeights;
 
        extern SKELETALMESHDESCRIPTION_API const FName ImportPointIndex;
    }
 
    namespace Bone
    {
        extern SKELETALMESHDESCRIPTION_API const FName Name;
        extern SKELETALMESHDESCRIPTION_API const FName ParentIndex;
        extern SKELETALMESHDESCRIPTION_API const FName Pose;
        extern SKELETALMESHDESCRIPTION_API const FName Color;
    }
 
    namespace SourceGeometryPart
    {
        extern SKELETALMESHDESCRIPTION_API const FName Name;
        extern SKELETALMESHDESCRIPTION_API const FName VertexOffsetAndCount;
    }
}
 
 
class FSkeletalMeshAttributesShared
{
public:
    using FBoneArray = TMeshElementContainer<FBoneID>;
    
    using FBoneNameAttributesRef = TMeshAttributesRef<FBoneID, FName>;
    using FBoneNameAttributesConstRef = TMeshAttributesConstRef<FBoneID, FName>;
    
    using FBoneParentIndexAttributesRef = TMeshAttributesRef<FBoneID, int32>;
    using FBoneParentIndexAttributesConstRef = TMeshAttributesConstRef<FBoneID, int32>;
    
    using FBonePoseAttributesRef = TMeshAttributesRef<FBoneID, FTransform>;
    using FBonePoseAttributesConstRef = TMeshAttributesConstRef<FBoneID, FTransform>;
    
    using FBoneColorAttributesRef = TMeshAttributesRef<FBoneID, FVector4f>;
    using FBoneColorAttributesConstRef = TMeshAttributesConstRef<FBoneID, FVector4f>;
 
    using FSourceGeometryPartArray = TMeshElementContainer<FSourceGeometryPartID>;
    
    using FSourceGeometryPartNameRef = TMeshAttributesRef<FSourceGeometryPartID, FName>;
    using FSourceGeometryPartNameConstRef = TMeshAttributesConstRef<FSourceGeometryPartID, FName>;
    
    using FSourceGeometryPartVertexOffsetAndCountRef = TMeshAttributesRef<FSourceGeometryPartID, TArrayView<int32>>;
    using FSourceGeometryPartVertexOffsetAndCountConstRef = TMeshAttributesConstRef<FSourceGeometryPartID, TArrayView<int32>>;
    
    static SKELETALMESHDESCRIPTION_API FName BonesElementName;
 
    
    static SKELETALMESHDESCRIPTION_API FName SourceGeometryPartElementName;
    
    
    // The name of the default skin weight profile.
    static SKELETALMESHDESCRIPTION_API FName DefaultSkinWeightProfileName;
    
    SKELETALMESHDESCRIPTION_API FSkeletalMeshAttributesShared(const FMeshDescription& InMeshDescription);
 
    //
    // Skin Weights Methods
    //
 
    SKELETALMESHDESCRIPTION_API TArray<FName> GetSkinWeightProfileNames(const bool bInUserDefinedOnly = false) const;
    
    static SKELETALMESHDESCRIPTION_API bool IsValidSkinWeightProfileName(const FName InProfileName);
 
    static SKELETALMESHDESCRIPTION_API bool IsSkinWeightAttribute(const FName InAttributeName);
 
    static SKELETALMESHDESCRIPTION_API FName GetProfileNameFromAttribute(const FName InAttributeName);
 
    SKELETALMESHDESCRIPTION_API FSkinWeightsVertexAttributesConstRef GetVertexSkinWeights(const FName InProfileName = NAME_None) const;
    
    SKELETALMESHDESCRIPTION_API FSkinWeightsVertexAttributesConstRef GetVertexSkinWeightsFromAttributeName(const FName InAttributeName = NAME_None) const;
 
    //
    // Morph Target Methods
    //
 
    SKELETALMESHDESCRIPTION_API TArray<FName> GetMorphTargetNames() const;
    
    static SKELETALMESHDESCRIPTION_API bool IsMorphTargetAttribute(const FName InAttributeName);
 
    static SKELETALMESHDESCRIPTION_API FName GetMorphTargetNameFromAttribute(const FName InAttributeName);
 
    SKELETALMESHDESCRIPTION_API TVertexAttributesConstRef<FVector3f> GetVertexMorphPositionDelta(const FName InMorphTargetName) const;
 
    SKELETALMESHDESCRIPTION_API TVertexInstanceAttributesConstRef<FVector3f> GetVertexInstanceMorphNormalDelta(const FName InMorphTargetName) const;
 
    SKELETALMESHDESCRIPTION_API bool HasMorphTargetPositionsAttribute(const FName InMorphTargetName) const;
 
    SKELETALMESHDESCRIPTION_API bool HasMorphTargetNormalsAttribute(const FName InMorphTargetName) const;
    
    //
    // Bones Methods
    //
 
    SKELETALMESHDESCRIPTION_API bool HasBoneColorAttribute() const;
 
    SKELETALMESHDESCRIPTION_API bool HasBoneNameAttribute() const;
 
    SKELETALMESHDESCRIPTION_API bool HasBonePoseAttribute() const;
 
    SKELETALMESHDESCRIPTION_API bool HasBoneParentIndexAttribute() const;
 
    SKELETALMESHDESCRIPTION_API const FBoneArray& Bones() const;
 
    SKELETALMESHDESCRIPTION_API const TAttributesSet<FBoneID>& BoneAttributes() const;
 
    bool HasBones() const
    {
        return BoneElementsShared != nullptr;
    }
 
    SKELETALMESHDESCRIPTION_API int32 GetNumBones() const;
 
    SKELETALMESHDESCRIPTION_API bool IsBoneValid(const FBoneID BoneID) const;
 
    SKELETALMESHDESCRIPTION_API FBoneNameAttributesConstRef GetBoneNames() const;
 
    SKELETALMESHDESCRIPTION_API FBoneParentIndexAttributesConstRef GetBoneParentIndices() const;
 
    SKELETALMESHDESCRIPTION_API FBonePoseAttributesConstRef GetBonePoses() const;
 
    SKELETALMESHDESCRIPTION_API FBoneColorAttributesConstRef GetBoneColors() const;
 
 
    //
    bool HasSourceGeometryParts() const
    {
        return SourceGeometryPartElementsShared != nullptr;
    }
 
    SKELETALMESHDESCRIPTION_API const FSourceGeometryPartArray& SourceGeometryParts() const;
    
    SKELETALMESHDESCRIPTION_API const TAttributesSet<FSourceGeometryPartID>& SourceGeometryPartAttributes() const;
        
    SKELETALMESHDESCRIPTION_API int32 GetNumSourceGeometryParts() const;
 
    SKELETALMESHDESCRIPTION_API bool IsSourceGeometryPartValid(const FSourceGeometryPartID InSourceGeometryPartID) const;
 
    SKELETALMESHDESCRIPTION_API FSourceGeometryPartNameConstRef GetSourceGeometryPartNames() const;
    
    SKELETALMESHDESCRIPTION_API FSourceGeometryPartVertexOffsetAndCountConstRef GetSourceGeometryPartVertexOffsetAndCounts() const;
    
protected:
    static SKELETALMESHDESCRIPTION_API FName CreateSkinWeightAttributeName(const FName InProfileName);
 
    static SKELETALMESHDESCRIPTION_API FName CreateMorphTargetAttributeName(const FName InMorphTargetName);
    
    const FMeshElementChannels* BoneElementsShared = nullptr;
    const FMeshElementChannels* SourceGeometryPartElementsShared = nullptr;
 
private:
    const FMeshDescription& MeshDescriptionShared;
};
 
 
class FSkeletalMeshAttributes :
    public FStaticMeshAttributes,
    public FSkeletalMeshAttributesShared
{
public:
 
    SKELETALMESHDESCRIPTION_API explicit FSkeletalMeshAttributes(FMeshDescription& InMeshDescription);
 
    SKELETALMESHDESCRIPTION_API virtual void Register(bool bKeepExistingAttribute = false) override;
 
    static bool IsReservedAttributeName(const FName InAttributeName)
    {
        return FStaticMeshAttributes::IsReservedAttributeName(InAttributeName) ||
               IsSkinWeightAttribute(InAttributeName) ||
               IsMorphTargetAttribute(InAttributeName) ||
               InAttributeName == MeshAttribute::Bone::Name ||
               InAttributeName == MeshAttribute::Bone::ParentIndex ||
               InAttributeName == MeshAttribute::Bone::Pose ||
               InAttributeName == MeshAttribute::Bone::Color;
    }
    
    //
    SKELETALMESHDESCRIPTION_API bool RegisterImportPointIndexAttribute();
 
    SKELETALMESHDESCRIPTION_API void UnregisterImportPointIndexAttribute();
    
    //
    // Skin Weights Methods
    //
 
    SKELETALMESHDESCRIPTION_API bool RegisterSkinWeightAttribute(const FName InProfileName);
 
    SKELETALMESHDESCRIPTION_API bool UnregisterSkinWeightAttribute(const FName InProfileName);
 
    SKELETALMESHDESCRIPTION_API FSkinWeightsVertexAttributesRef GetVertexSkinWeights(const FName InProfileName = NAME_None);
 
    SKELETALMESHDESCRIPTION_API FSkinWeightsVertexAttributesRef GetVertexSkinWeightsFromAttributeName(const FName InAttributeName = NAME_None);
 
    //
    // Morph Target Methods
    //
    
    SKELETALMESHDESCRIPTION_API bool RegisterMorphTargetAttribute(const FName InMorphTargetName, const bool bIncludeNormals);
 
    SKELETALMESHDESCRIPTION_API bool UnregisterMorphTargetAttribute(const FName InMorphTargetName);
 
    SKELETALMESHDESCRIPTION_API TVertexAttributesRef<FVector3f> GetVertexMorphPositionDelta(const FName InMorphTargetName);
 
    SKELETALMESHDESCRIPTION_API TVertexInstanceAttributesRef<FVector3f> GetVertexInstanceMorphNormalDelta(const FName InMorphTargetName);
    
    //
    // Bones Methods
    //
 
    SKELETALMESHDESCRIPTION_API void RegisterColorAttribute();
 
    SKELETALMESHDESCRIPTION_API FBoneArray& Bones();
 
    SKELETALMESHDESCRIPTION_API TAttributesSet<FBoneID>& BoneAttributes();
 
    SKELETALMESHDESCRIPTION_API void ReserveNewBones(const int InNumBones);
 
    SKELETALMESHDESCRIPTION_API FBoneID CreateBone();
 
    SKELETALMESHDESCRIPTION_API void CreateBone(const FBoneID BoneID);
 
    SKELETALMESHDESCRIPTION_API void DeleteBone(const FBoneID BoneID);
 
    SKELETALMESHDESCRIPTION_API FBoneNameAttributesRef GetBoneNames();
    
    SKELETALMESHDESCRIPTION_API FBoneParentIndexAttributesRef GetBoneParentIndices();
 
    SKELETALMESHDESCRIPTION_API FBonePoseAttributesRef GetBonePoses();
 
    SKELETALMESHDESCRIPTION_API FBoneColorAttributesRef GetBoneColors();
 
 
    /* Source Geometry Parts */
 
    SKELETALMESHDESCRIPTION_API void RegisterSourceGeometryPartsAttributes();
 
    SKELETALMESHDESCRIPTION_API FSourceGeometryPartArray& SourceGeometryParts();
    
    SKELETALMESHDESCRIPTION_API TAttributesSet<FSourceGeometryPartID>& SourceGeometryPartAttributes();
    
    SKELETALMESHDESCRIPTION_API FSourceGeometryPartID CreateSourceGeometryPart();
 
    SKELETALMESHDESCRIPTION_API void DeleteSourceGeometryPart(FSourceGeometryPartID InSourceGeometryPartID);
 
    SKELETALMESHDESCRIPTION_API FSourceGeometryPartNameRef GetSourceGeometryPartNames();
    
    SKELETALMESHDESCRIPTION_API FSourceGeometryPartVertexOffsetAndCountRef GetSourceGeometryPartVertexOffsetAndCounts();
    
    
    
private:
    FMeshElementChannels* BoneElements = nullptr;
    FMeshElementChannels* SourceGeometryPartElements = nullptr;
};
 
 
class FSkeletalMeshConstAttributes :
    public FStaticMeshConstAttributes,
    public FSkeletalMeshAttributesShared
{
public:
 
    explicit FSkeletalMeshConstAttributes(const FMeshDescription& InMeshDescription) :
        FStaticMeshConstAttributes(InMeshDescription),
        FSkeletalMeshAttributesShared(InMeshDescription)
    {}
 
};