SkeletalMeshSourceModel.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "MeshDescription.h"
#include "MeshDescriptionBaseBulkData.h"
#include "SkinnedAssetCommon.h"
 
#include "SkeletalMeshSourceModel.generated.h"
 
class FRawSkeletalMeshBulkData;
class USkeletalMesh;
class USkeletalMeshDescription;
struct FMeshDescription;
 
UCLASS(MinimalAPI)
class USkeletalMeshDescriptionBulkData : public UMeshDescriptionBaseBulkData
{
    GENERATED_BODY()
public:
    ENGINE_API USkeletalMeshDescriptionBulkData();
 
    void Initialize();
};
 
 
USTRUCT()
struct FSkeletalMeshSourceModel :
    public FSkeletalMeshLODInfo
{
    GENERATED_BODY()
 
    friend class USkeletalMesh;
    
    ENGINE_API FSkeletalMeshSourceModel();
 
    // No copying allowed.
    FSkeletalMeshSourceModel(const FSkeletalMeshSourceModel&) = delete;
    FSkeletalMeshSourceModel& operator=(const FSkeletalMeshSourceModel&) = delete;
 
    // Moving is permitted.
    FSkeletalMeshSourceModel(FSkeletalMeshSourceModel&&);
    FSkeletalMeshSourceModel& operator=(FSkeletalMeshSourceModel&&);
 
    void Initialize(USkeletalMesh* InOwner);
    
#if WITH_EDITOR
    ENGINE_API bool HasMeshDescription() const;
 
    ENGINE_API FMeshDescription* CreateMeshDescription();
 
    ENGINE_API FMeshDescription* GetMeshDescription() const;
 
    ENGINE_API void CommitMeshDescription(bool bInUseHashAsGuid);
    
    ENGINE_API bool CloneMeshDescription(FMeshDescription& OutMeshDescription) const;
 
    ENGINE_API void ClearMeshDescription();
 
    ENGINE_API void ClearAllMeshData();
 
    ENGINE_API const FMeshDescriptionBulkData* GetMeshDescriptionBulkData() const;
#endif
 
    int32 GetTriangleCountFast() const
    {
        return TriangleCount;
    }
 
    int32 GetVertexCountFast() const
    {
        return VertexCount;
    }
 
    const FBoxSphereBounds& GetBoundsFast() const
    {
        return Bounds;
    }
 
    TConstArrayView<FName> GetSkinWeightProfileNames() const;
 
    TConstArrayView<FName> GetMorphTargetNames() const;
 
    TOptional<FGuid> GetVertexColorGuid() const;
    
private:
#if WITH_EDITOR
    USkeletalMesh* GetOwner() const;
    
    void EnsureRawMeshBulkDataIsConvertedToNew();
    
    bool LoadMeshDescriptionFromBulkData(FMeshDescription& OutMeshDescription) const;
 
    static void UpgradeMorphTargets(FMeshDescription& InOutMeshDescription);
 
    void ConvertRawMeshToMeshDescriptionBulkData();
 
    void UpdateCachedMeshStatistics(const FMeshDescription* InMeshDescription);
 
    void UpdateCachedMeshStatisticsFromBulkIfNeeded();
    
    void UpdateBonesDataIfNeeded(FMeshDescription& InOutMeshDescription) const;
    
#endif
 
    UPROPERTY()
    int32 TriangleCount = 0;
    
    UPROPERTY()
    int32 VertexCount = 0;
 
    UPROPERTY()
    FBoxSphereBounds Bounds;
 
    // List of all alternate skin weight profiles stored on the mesh,
    // NOTE: The default value is single-entry array with NAME_None to mark
    // that this value has not been initialized yet / TOptional does not work
    // with containers. 
    UPROPERTY()
    TArray<FName> CachedSkinWeightProfileNames{ NAME_None };
 
    // List of all morph targets stored on the mesh.
    UPROPERTY()
    TArray<FName> CachedMorphTargetNames{ NAME_None };
    
    UPROPERTY()
    TOptional<bool> CachedHasVertexColors;
 
    UPROPERTY()
    FGuid CachedVertexColorGuid;
    
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    TObjectPtr<USkeletalMeshDescriptionBulkData> MeshDescriptionBulkData;
 
    // Accessor mutex for the bulk data, since it can be accessed from any thread. 
    mutable FCriticalSection MeshDescriptionBulkDataMutex;
#endif
 
#if WITH_EDITOR
    TSharedPtr<FRawSkeletalMeshBulkData> RawMeshBulkData;
    int32 RawMeshBulkDataLODIndex = INDEX_NONE;
#endif
};
 
 
template<> struct TStructOpsTypeTraits<FSkeletalMeshSourceModel> :
    TStructOpsTypeTraitsBase2<FSkeletalMeshSourceModel>
{
    enum { WithCopy = false };
};