SkeletalMeshSampling.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "WeightedRandomSampler.h"
 
#include "SkeletalMeshSampling.generated.h"
 
class USkeletalMesh;
 
struct FSkeletalMeshAreaWeightedTriangleSampler : public FWeightedRandomSampler
{
    ENGINE_API FSkeletalMeshAreaWeightedTriangleSampler();
    ENGINE_API void Init(USkeletalMesh* InOwner, int32 LODIndex, TArray<int32>* InTriangleIndices);
    ENGINE_API virtual float GetWeights(TArray<float>& OutWeights)override;
 
protected:
    //Data used in initialization of the sampler. Not serialized.
    USkeletalMesh* Owner;
    TArray<int32>* TriangleIndices;
    int32 LODIndex;
};
 
USTRUCT()
struct FSkeletalMeshSamplingRegionBuiltData
{
    GENERATED_USTRUCT_BODY()
 
    
    TArray<int32> TriangleIndices;
 
    TArray<int32> Vertices;
    
    TArray<int32> BoneIndices;
 
    FSkeletalMeshAreaWeightedTriangleSampler AreaWeightedSampler;
 
    ENGINE_API bool Serialize(FArchive& Ar);
 
    friend FArchive& operator<<(FArchive& Ar, FSkeletalMeshSamplingRegionBuiltData& A)
    {
        A.Serialize(Ar);
        return Ar;
    }
};
 
template<> struct TStructOpsTypeTraits<FSkeletalMeshSamplingRegionBuiltData> : public TStructOpsTypeTraitsBase2<FSkeletalMeshSamplingRegionBuiltData>
{
    enum{ WithSerializer = true };
    static constexpr EPropertyObjectReferenceType WithSerializerObjectReferences = EPropertyObjectReferenceType::None;
};
 
USTRUCT()
struct FSkeletalMeshSamplingLODBuiltData
{
    GENERATED_USTRUCT_BODY()
 
    
    FSkeletalMeshAreaWeightedTriangleSampler AreaWeightedTriangleSampler;
 
    ENGINE_API bool Serialize(FArchive& Ar);
 
    friend FArchive& operator<<(FArchive& Ar, FSkeletalMeshSamplingLODBuiltData& A)
    {
        A.Serialize(Ar);
        return Ar;
    }
};
 
template<> struct TStructOpsTypeTraits<FSkeletalMeshSamplingLODBuiltData> : public TStructOpsTypeTraitsBase2<FSkeletalMeshSamplingLODBuiltData>
{
    enum{ WithSerializer = true };
    static constexpr EPropertyObjectReferenceType WithSerializerObjectReferences = EPropertyObjectReferenceType::None;
};
 
USTRUCT()
struct FSkeletalMeshSamplingBuiltData
{
    GENERATED_USTRUCT_BODY()
        
    UPROPERTY()
    TArray<FSkeletalMeshSamplingLODBuiltData> WholeMeshBuiltData;
 
    UPROPERTY()
    TArray<FSkeletalMeshSamplingRegionBuiltData> RegionBuiltData;
};
 
USTRUCT()
struct FSkeletalMeshSamplingRegionBoneFilter
{
    GENERATED_USTRUCT_BODY()
 
    FSkeletalMeshSamplingRegionBoneFilter();
 
    UPROPERTY(EditAnywhere, Category = "Bone Filter")
    FName BoneName;
 
    UPROPERTY(EditAnywhere, Category = "Bone Filter")
    uint32 bIncludeOrExclude : 1;
    
    UPROPERTY(EditAnywhere, Category = "Bone Filter")
    uint32 bApplyToChildren : 1;
};
 
USTRUCT()
struct FSkeletalMeshSamplingRegionMaterialFilter
{
    GENERATED_USTRUCT_BODY()
 
    FSkeletalMeshSamplingRegionMaterialFilter();
 
    UPROPERTY(EditAnywhere, Category = "Material Filter")
    FName MaterialName;
};
 
USTRUCT()
struct FSkeletalMeshSamplingRegion
{
    GENERATED_USTRUCT_BODY()
        
    ENGINE_API FSkeletalMeshSamplingRegion();
 
    UPROPERTY(EditAnywhere, Category = "Region")
    FName Name;
 
    UPROPERTY(EditAnywhere, Category = "Region")
    int32 LODIndex;
 
    UPROPERTY(EditAnywhere, Category = "Region")
    uint32 bSupportUniformlyDistributedSampling : 1;
    
    UPROPERTY(EditAnywhere, Category = "Region")
    TArray<FSkeletalMeshSamplingRegionMaterialFilter> MaterialFilters;
 
    UPROPERTY(EditAnywhere, Category = "Region")
    TArray<FSkeletalMeshSamplingRegionBoneFilter> BoneFilters;
 
//  UPROPERTY()
//  TArray<int32> PaintedTriangles;
 
//  UPROPERTY()
//  TArray<int32> PaintedBones;
    
    ENGINE_API void GetFilteredBones(struct FReferenceSkeleton& RefSkel, TArray<int32>& OutIncludedBoneIndices, TArray<int32>& OutExcludedBoneIndices);
    ENGINE_API bool IsMaterialAllowed(FName MaterialName);
};
 
USTRUCT()
struct FSkeletalMeshSamplingInfo
{
    GENERATED_USTRUCT_BODY()
            
    
    UPROPERTY(EditAnywhere, Category="Sampling")
    TArray<FSkeletalMeshSamplingRegion> Regions;
 
#if WITH_EDITORONLY_DATA
    ENGINE_API void BuildRegions(USkeletalMesh* SkeletalMesh);
    ENGINE_API void BuildWholeMesh(USkeletalMesh* SkeletalMesh);
#endif
 
    ENGINE_API bool IsSamplingEnabled(const USkeletalMesh* OwnerMesh, int32 LODIndex)const;
 
    inline const FSkeletalMeshSamplingLODBuiltData& GetWholeMeshLODBuiltData(int32 LODIndex)const
    {
        return BuiltData.WholeMeshBuiltData[LODIndex];
    }
 
    inline int32 IndexOfRegion(FName RegionName)const
    {
        return Regions.IndexOfByPredicate([&RegionName](const FSkeletalMeshSamplingRegion& CheckRegion)
        {
            return CheckRegion.Name == RegionName;
        });
    }
 
    inline const FSkeletalMeshSamplingRegion& GetRegion(int32 RegionIdx) const
    {
        return Regions[RegionIdx]; 
    }
 
    inline const FSkeletalMeshSamplingRegion* GetRegion(FName RegionName) const
    {
        int32 RegionIndex = IndexOfRegion(RegionName);
        if (RegionIndex != INDEX_NONE)
        {
            return &GetRegion(RegionIndex);
        }
        return nullptr;
    }
 
    inline const FSkeletalMeshSamplingBuiltData& GetBuiltData()const
    {
        return BuiltData;
    }
 
    inline const FSkeletalMeshSamplingRegionBuiltData& GetRegionBuiltData(int32 RegionIndex)const
    {
        return BuiltData.RegionBuiltData[RegionIndex];
    }
 
    inline const FSkeletalMeshSamplingRegionBuiltData* GetRegionBuiltData(FName RegionName)const
    {
        int32 RegionIndex = IndexOfRegion(RegionName);
        if (RegionIndex != INDEX_NONE)
        {
            return &GetRegionBuiltData(RegionIndex);
        }
        return nullptr;
    }
    
private:
 
    UPROPERTY()
    FSkeletalMeshSamplingBuiltData BuiltData;
};