Files
UnrealEngineUWP/Engine/Source/Developer/MeshUtilities/Public/MeshUtilities.h
mickael gilabert bc8fecbdbc Added mesh distance field downsampling capability during serialization time (compressed and not compressed)
Added DownSampleMeshDistanceFieldDivider target platform variable

#rb daniel.wright
#rnx

#ROBOMERGE-OWNER: ryan.vance
#ROBOMERGE-AUTHOR: mickael.gilabert
#ROBOMERGE-SOURCE: CL 6442105 via CL 6444722 via CL 6444741
#ROBOMERGE-BOT: DEVVR (Main -> Dev-VR)

[CL 6507762 by mickael gilabert in Dev-VR branch]
2019-05-15 15:30:40 -04:00

353 lines
15 KiB
C++

// Copyright 1998-2019 Epic Games, Inc. All Rights Reserved.
#pragma once
#include "CoreMinimal.h"
#include "Misc/Guid.h"
#include "Modules/ModuleInterface.h"
#include "Components.h"
#include "Engine/MeshMerging.h"
#include "SkelImport.h"
#include "MeshBuild.h"
#include "IMeshMergeUtilities.h"
#include "Animation/SkinWeightProfile.h"
class UMeshComponent;
class USkeletalMesh;
class UStaticMesh;
class UStaticMeshComponent;
struct FFlattenMaterial;
struct FRawMesh;
struct FStaticMeshLODResources;
typedef FIntPoint FMeshIdAndLOD;
struct FFlattenMaterial;
struct FReferenceSkeleton;
struct FStaticMeshLODResources;
class UMeshComponent;
class UStaticMesh;
namespace ETangentOptions
{
enum Type
{
None = 0,
BlendOverlappingNormals = 0x1,
IgnoreDegenerateTriangles = 0x2,
UseMikkTSpace = 0x4,
};
};
/**
* Contains the vertices that are most dominated by that bone. Vertices are in Bone space.
* Not used at runtime, but useful for fitting physics assets etc.
*/
struct FBoneVertInfo
{
// Invariant: Arrays should be same length!
TArray<FVector> Positions;
TArray<FVector> Normals;
};
struct FOverlappingCorners;
class IMeshUtilities : public IModuleInterface
{
public:
/************************************************************************/
/* DEPRECATED FUNCTIONALITY */
/************************************************************************/
/**
* Harvest static mesh components from input actors
* and merge into signle mesh grouping them by unique materials
*
* @param SourceActors List of actors to merge
* @param InSettings Settings to use
* @param InOuter Outer if required
* @param InBasePackageName Destination package name for a generated assets. Used if Outer is null.
* @param UseLOD -1 if you'd like to build for all LODs. If you specify, that LOD mesh for source meshes will be used to merge the mesh
* This is used by hierarchical building LODs
* @param OutAssetsToSync Merged mesh assets
* @param OutMergedActorLocation World position of merged mesh
*/
virtual void MergeActors(
const TArray<AActor*>& SourceActors,
const FMeshMergingSettings& InSettings,
UPackage* InOuter,
const FString& InBasePackageName,
TArray<UObject*>& OutAssetsToSync,
FVector& OutMergedActorLocation,
bool bSilent=false) const = 0;
/**
* MergeStaticMeshComponents
*
* @param ComponentsToMerge - Components to merge
* @param World - World in which the component reside
* @param InSettings - Settings to use
* @param InOuter - Outer if required
* @param InBasePackageName - Destination package name for a generated assets. Used if Outer is null.
* @param UseLOD -1 if you'd like to build for all LODs. If you specify, that LOD mesh for source meshes will be used to merge the mesh
* This is used by hierarchical building LODs
* @param OutAssetsToSync Merged mesh assets
* @param OutMergedActorLocation World position of merged mesh
* @param ViewDistance Distance for LOD determination
* @param bSilent Non-verbose flag
* @return void
*/
virtual void MergeStaticMeshComponents(
const TArray<UStaticMeshComponent*>& ComponentsToMerge,
UWorld* World,
const FMeshMergingSettings& InSettings,
UPackage* InOuter,
const FString& InBasePackageName,
TArray<UObject*>& OutAssetsToSync,
FVector& OutMergedActorLocation,
const float ScreenAreaSize,
bool bSilent /*= false*/) const = 0;
/**
* Creates a (proxy)-mesh combining the static mesh components from the given list of actors (at the moment this requires having Simplygon)
*
* @param InActors - List of Actors to merge
* @param InMeshProxySettings - Merge settings
* @param InOuter - Package for a generated assets, if NULL new packages will be created for each asset
* @param InProxyBasePackageName - Will be used for naming generated assets, in case InOuter is not specified ProxyBasePackageName will be used as long package name for creating new packages
* @param InGuid - Guid identifying the data used for this proxy job
* @param InProxyCreatedDelegate - Delegate callback for when the proxy is finished
* @param bAllowAsync - Flag whether or not this call could be run async (SimplygonSwarm)
*/
virtual void CreateProxyMesh(const TArray<class AActor*>& InActors, const struct FMeshProxySettings& InMeshProxySettings, UPackage* InOuter, const FString& InProxyBasePackageName, const FGuid InGuid, FCreateProxyDelegate InProxyCreatedDelegate, const bool bAllowAsync = false, const float ScreenAreaSize = 1.0f) = 0;
/**
* FlattenMaterialsWithMeshData
*
* @param InMaterials - List of unique materials used by InSourceMeshes
* @param InSourceMeshes - List of raw meshes used to flatten the materials with (vertex data)
* @param InMaterialIndexMap - Map used for mapping the raw meshes to the correct materials
* @param InMeshShouldBakeVertexData - Array of flags to determine whether or not a mesh requires to have its vertex data baked down
* @param InMaterialProxySettings - Settings for creating the flattened material
* @param OutFlattenedMaterials - List of flattened materials (one for each mesh)
*/
virtual void FlattenMaterialsWithMeshData(TArray<UMaterialInterface*>& InMaterials, TArray<struct FRawMeshExt>& InSourceMeshes, TMap<FMeshIdAndLOD, TArray<int32>>& InMaterialIndexMap, TArray<bool>& InMeshShouldBakeVertexData, const FMaterialProxySettings &InMaterialProxySettings, TArray<FFlattenMaterial> &OutFlattenedMaterials) const = 0;
/**
* Calculates (new) non-overlapping UV coordinates for the given Raw Mesh
*
* @param RawMesh - Raw Mesh to generate UV coordinates for
* @param TextureResolution - Texture resolution to take into account while generating the UVs
* @param bMergeIdenticalMaterials - Whether faces with identical materials can be treated as one in the resulting set of unique UVs
* @param OutTexCoords - New set of UV coordinates
* @return bool - whether or not generating the UVs succeeded
*/
virtual bool GenerateUniqueUVsForStaticMesh(const FRawMesh& RawMesh, int32 TextureResolution, TArray<FVector2D>& OutTexCoords) const = 0;
virtual bool GenerateUniqueUVsForStaticMesh(const FRawMesh& RawMesh, int32 TextureResolution, bool bMergeIdenticalMaterials, TArray<FVector2D>& OutTexCoords) const = 0;
/** Returns the mesh reduction plugin if available. */
virtual IMeshReduction* GetStaticMeshReductionInterface() = 0;
/** Returns the mesh reduction plugin if available. */
virtual IMeshReduction* GetSkeletalMeshReductionInterface() = 0;
/** Returns the mesh merging plugin if available. */
virtual IMeshMerging* GetMeshMergingInterface() = 0;
public:
/** Returns a string uniquely identifying this version of mesh utilities. */
virtual const FString& GetVersionString() const = 0;
/**
* Builds a renderable static mesh using the provided source models and the LOD groups settings.
* @returns true if the renderable mesh was built successfully.
*/
virtual bool BuildStaticMesh(
class FStaticMeshRenderData& OutRenderData,
UStaticMesh* StaticMesh,
const class FStaticMeshLODGroup& LODGroup
) = 0;
virtual void BuildStaticMeshVertexAndIndexBuffers(
TArray<FStaticMeshBuildVertex>& OutVertices,
TArray<TArray<uint32> >& OutPerSectionIndices,
TArray<int32>& OutWedgeMap,
const FRawMesh& RawMesh,
const FOverlappingCorners& OverlappingCorners,
const TMap<uint32, uint32>& MaterialToSectionMapping,
float ComparisonThreshold,
FVector BuildScale,
int32 ImportVersion
) = 0;
/**
* Builds a static mesh using the provided source models and the LOD groups settings, and replaces
* the RawMeshes with the reduced meshes. Does not modify renderable data.
* @returns true if the meshes were built successfully.
*/
virtual bool GenerateStaticMeshLODs(
UStaticMesh* StaticMesh,
const class FStaticMeshLODGroup& LODGroup
) = 0;
/** Builds a signed distance field volume for the given LODModel. */
virtual void GenerateSignedDistanceFieldVolumeData(
FString MeshName,
const FStaticMeshLODResources& LODModel,
class FQueuedThreadPool& ThreadPool,
const TArray<EBlendMode>& MaterialBlendModes,
const FBoxSphereBounds& Bounds,
float DistanceFieldResolutionScale,
bool bGenerateAsIfTwoSided,
class FDistanceFieldVolumeData& OutData) = 0;
/**
* Down sample distance field volume.
* Method overwrites data of DistanceFieldData.
* If input is compressed, it will be decompressed, downsampled and recompressed
*/
virtual void DownSampleDistanceFieldVolumeData(
class FDistanceFieldVolumeData& DistanceFieldData,
float Divider) = 0;
/** Helper structure for skeletal mesh import options */
struct MeshBuildOptions
{
MeshBuildOptions()
: bRemoveDegenerateTriangles(false)
, bComputeNormals(true)
, bComputeTangents(true)
, bUseMikkTSpace(false)
{
}
bool bRemoveDegenerateTriangles;
bool bComputeNormals;
bool bComputeTangents;
bool bUseMikkTSpace;
FOverlappingThresholds OverlappingThresholds;
};
/**
* Create all render specific data for a skeletal mesh LOD model
* @returns true if the mesh was built successfully.
*/
virtual bool BuildSkeletalMesh(
FSkeletalMeshLODModel& LODModel,
const FReferenceSkeleton& RefSkeleton,
const TArray<SkeletalMeshImportData::FVertInfluence>& Influences,
const TArray<SkeletalMeshImportData::FMeshWedge>& Wedges,
const TArray<SkeletalMeshImportData::FMeshFace>& Faces,
const TArray<FVector>& Points,
const TArray<int32>& PointToOriginalMap,
const MeshBuildOptions& BuildOptions = MeshBuildOptions(),
TArray<FText> * OutWarningMessages = NULL,
TArray<FName> * OutWarningNames = NULL
) = 0;
/** Cache optimize the index buffer. */
virtual void CacheOptimizeIndexBuffer(TArray<uint16>& Indices) = 0;
/** Cache optimize the index buffer. */
virtual void CacheOptimizeIndexBuffer(TArray<uint32>& Indices) = 0;
/** Build adjacency information for the skeletal mesh used for tessellation. */
virtual void BuildSkeletalAdjacencyIndexBuffer(
const TArray<struct FSoftSkinVertex>& VertexBuffer,
const uint32 TexCoordCount,
const TArray<uint32>& Indices,
TArray<uint32>& OutPnAenIndices
) = 0;
/**
* Calculate the verts associated weighted to each bone of the skeleton.
* The vertices returned are in the local space of the bone.
*
* @param SkeletalMesh The target skeletal mesh.
* @param Infos The output array of vertices associated with each bone.
* @param bOnlyDominant Controls whether a vertex is added to the info for a bone if it is most controlled by that bone, or if that bone has ANY influence on that vert.
*/
virtual void CalcBoneVertInfos( USkeletalMesh* SkeletalMesh, TArray<FBoneVertInfo>& Infos, bool bOnlyDominant) = 0;
/**
* Convert a set of mesh components in their current pose to a static mesh.
* @param InMeshComponents The mesh components we want to convert
* @param InRootTransform The transform of the root of the mesh we want to output
* @param InPackageName The package name to create the static mesh in. If this is empty then a dialog will be displayed to pick the mesh.
* @return a new static mesh (specified by the user)
*/
virtual UStaticMesh* ConvertMeshesToStaticMesh(const TArray<UMeshComponent*>& InMeshComponents, const FTransform& InRootTransform = FTransform::Identity, const FString& InPackageName = FString()) = 0;
/**
* Calculates UV coordinates bounds for the given Skeletal Mesh
*
* @param InRawMesh - Skeletal Mesh to calculate the bounds for
* @param OutBounds - Out texture bounds (min-max)
*/
virtual void CalculateTextureCoordinateBoundsForSkeletalMesh(const FSkeletalMeshLODModel& LODModel, TArray<FBox2D>& OutBounds) const = 0;
/** Calculates (new) non-overlapping UV coordinates for the given Skeletal Mesh
*
* @param LODModel - Skeletal Mesh to generate UV coordinates for
* @param TextureResolution - Texture resolution to take into account while generating the UVs
* @param OutTexCoords - New set of UV coordinates
* @return bool - whether or not generating the UVs succeeded
*/
virtual bool GenerateUniqueUVsForSkeletalMesh(const FSkeletalMeshLODModel& LODModel, int32 TextureResolution, TArray<FVector2D>& OutTexCoords) const = 0;
/**
* Remove Bones based on LODInfo setting
*
* @param SkeletalMesh Mesh that needs bones to be removed
* @param LODIndex Desired LOD to remove bones [ 0 based ]
* @param BoneNamesToRemove List of bone names to remove
*
* @return true if success
*/
virtual bool RemoveBonesFromMesh(USkeletalMesh* SkeletalMesh, int32 LODIndex, const TArray<FName>* BoneNamesToRemove) const = 0;
/**
* Calculates Tangents and Normals for a given set of vertex data
*
* @param InVertices Vertices that make up the mesh
* @param InIndices Indices for the Vertex array
* @param InUVs Texture coordinates (per-index based)
* @param InSmoothingGroupIndices Smoothing group index (per-face based)
* @param InTangentOptions Flags for Tangent calculation
* @param OutTangentX Array to hold calculated Tangents
* @param OutTangentY Array to hold calculated Bitangents
* @param OutNormals Array to hold calculated normals (if already contains normals will use those instead for the tangent calculation)
*/
virtual void CalculateTangents(const TArray<FVector>& InVertices, const TArray<uint32>& InIndices, const TArray<FVector2D>& InUVs, const TArray<uint32>& InSmoothingGroupIndices, const uint32 InTangentOptions, TArray<FVector>& OutTangentX, TArray<FVector>& OutTangentY, TArray<FVector>& OutNormals) const = 0;
/**
* Calculates Normals for a given set of vertex data
*
* @param InVertices Vertices that make up the mesh
* @param InIndices Indices for the Vertex array
* @param InUVs Texture coordinates (per-index based)
* @param InSmoothingGroupIndices Smoothing group index (per-face based)
* @param InTangentOptions Flags for Tangent calculation
* @param OutNormals Array to hold calculated normals
*/
virtual void CalculateNormals(const TArray<FVector>& InVertices, const TArray<uint32>& InIndices, const TArray<FVector2D>& InUVs, const TArray<uint32>& InSmoothingGroupIndices, const uint32 InTangentOptions, TArray<FVector>& OutNormals) const = 0;
/**
* Calculates the overlapping corners for a given set of vertex data
*
* @param InVertices Vertices that make up the mesh
* @param InIndices Indices for the Vertex array
* @param bIgnoreDegenerateTriangles Indicates if we should skip degenerate triangles
* @param OutOverlappingCorners Container to hold the overlapping corners. For a vertex, lists all the overlapping vertices.
*/
virtual void CalculateOverlappingCorners(const TArray<FVector>& InVertices, const TArray<uint32>& InIndices, bool bIgnoreDegenerateTriangles, FOverlappingCorners& OutOverlappingCorners) const = 0;
virtual void RecomputeTangentsAndNormalsForRawMesh(bool bRecomputeTangents, bool bRecomputeNormals, const FMeshBuildSettings& InBuildSettings, FRawMesh &OutRawMesh) const = 0;
virtual void RecomputeTangentsAndNormalsForRawMesh(bool bRecomputeTangents, bool bRecomputeNormals, const FMeshBuildSettings& InBuildSettings, const FOverlappingCorners& InOverlappingCorners, FRawMesh &OutRawMesh) const = 0;
virtual void FindOverlappingCorners(FOverlappingCorners& OutOverlappingCorners, const TArray<FVector>& InVertices, const TArray<uint32>& InIndices, float ComparisonThreshold) const = 0;
/** Used to generate runtime skin weight data from Editor-only data */
virtual void GenerateRuntimeSkinWeightData(const FSkeletalMeshLODModel* ImportedModel, const TArray<FRawSkinWeight>& InRawSkinWeights, FRuntimeSkinWeightProfileData& InOutSkinWeightOverrideData) const = 0;
};