1. Epic GamesDeveloper
  3. FLODUtilities

FLODUtilities

API > API/Developer > API/Developer/SkeletalMeshUtilitiesCommon

   
Name FLODUtilities
Type class
Header File /Engine/Source/Developer/SkeletalMeshUtilitiesCommon/Public/LODUtilities.h
Include Path #include "LODUtilities.h"

Syntax

class FLODUtilities

Constructors

Name Remarks Include Path Unreal Specifiers

FLODUtilities()

   LODUtilities.h  

Structs

Name Remarks
FMorphTargetLodBackupData  
FMorphTargetUpdateRequest  
FSkeletalMeshMatchImportedMaterialsParameters Structure to pass all the needed parameters to do match the material when importing a skeletal mesh LOD.

Functions

Static

Name Remarks Include Path Unreal Specifiers

static void AdjustImportDataFaceMaterialIndex ( const TArray< FSkeletalMaterial >& Materials,
TArray< SkeletalMeshImportData::FMaterial >& RawMeshMaterials,
TArray< SkeletalMeshImportData::FMeshFace >& LODFaces,
int32 LODIndex
)

 Before building skeletalmesh base LOD (LOD index 0) using MeshUtilities.BuildSkeletalMesh, we want to adjust the imported faces material index to point on the correct sk material. LODUtilities.h  

static void ApplyMorphTargetsToLOD ( USkeletalMesh* SkeletalMesh,
int32 SourceLOD,
int32 DestinationLOD,
const FInlineReductionDataParameter& InlineApplyMorphTargetParameter
)

 Remap the morph targets of the base LOD onto the desired LOD. LODUtilities.h  

static void BackupCustomImportedMorphTargetData ( USkeletalMesh* SkeletalMesh,
TMap< FString, TArray< FMorphTargetLodBackupData > >& BackupImportedMorphTargetData
)

 Backup all the custom imported morph targets. LODUtilities.h  

static void BuildMorphTargets ( USkeletalMesh* SkeletalMesh,
const FMeshDescription& SkeletalMeshModel,
FSkeletalMeshImportData& ImportData,
int32 LODIndex,
bool ShouldImportNormals,
bool ShouldImportTangents,
bool bUseMikkTSpace,
const FOverlappingThresholds& Thresholds
)

 Same as above but use normals from the source mesh description to build up the morph targets. LODUtilities.h  

static void BuildMorphTargets ( USkeletalMesh* SkeletalMesh,
FSkeletalMeshImportData& ImportData,
int32 LODIndex,
bool ShouldImportNormals,
bool ShouldImportTangents,
bool bUseMikkTSpace,
const FOverlappingThresholds& Thresholds
)

 Build the morph targets for the specified LOD. LODUtilities.h  

static void ClearGeneratedMorphTarget ( USkeletalMesh* SkeletalMesh,
int32 DesiredLOD
)

 Clear generated morphtargets for the given LODs LODUtilities.h  

static void GenerateImportedSkinWeightProfileData ( FSkeletalMeshLODModel& LODModelDest,
FImportedSkinWeightProfileData& ImportedProfileData,
int32 BoneInfluenceLimit,
const ITargetPlatform* TargetPlatform
)

 Generate the editor-only data stored for a skin weight profile (relies on bone indices) LODUtilities.h  
When any skeletalmesh LOD get imported or re-imported, we want to have common code to set all materials data. LODUtilities.h  

static void ProcessImportMeshInfluences ( const int32 VertexCount,
TArray< SkeletalMeshImportData::FRawBoneInfluence >& Influences,
const FString& MeshName
)

 Process and update the vertex Influences using the predefined wedges LODUtilities.h  

static void RefreshLODChange ( const USkeletalMesh* SkeletalMesh
)

 Refresh LOD Change LODUtilities.h  

static void RegenerateAllImportSkinWeightProfileData ( FSkeletalMeshLODModel& LODModelDest,
int32 BoneInfluenceLimit,
const ITargetPlatform* TargetPlatform
)

 Re-generate all (editor-only) skin weight profile, used whenever we rebuild the skeletal mesh data which could change the chunking and bone indices LODUtilities.h  

static void RegenerateDependentLODs ( USkeletalMesh* SkeletalMesh,
int32 LODIndex,
const ITargetPlatform* TargetPlatform
)

 Regenerate LOD that are dependent of LODIndex LODUtilities.h  

static bool RegenerateLOD ( USkeletalMesh* SkeletalMesh,
const ITargetPlatform* TargetPlatform,
int32 NewLODCount,
bool bRegenerateEvenIfImported,
bool bGenerateBaseLOD
)

 Regenerate LODs of the mesh LODUtilities.h  

static void RemoveLOD ( FSkeletalMeshUpdateContext& UpdateContext,
int32 DesiredLOD
)

 Removes a particular LOD from the SkeletalMesh. LODUtilities.h  

static void RemoveLODs ( FSkeletalMeshUpdateContext& UpdateContext,
const TArray< int32 >& DesiredLODs
)

 Removes the specified LODs from the SkeletalMesh. LODUtilities.h  

static void RemoveUnusedMaterialSlot ( USkeletalMesh* SkeletalMesh
)

 Remove any material slot that is not used by any LODs LODUtilities.h  

static void ReorderMaterialSlotToBaseLod ( USkeletalMesh* SkeletalMesh
)

 Reorder the material slot array to follow the base LOD section order. LODUtilities.h  

static void RestoreClothingFromBackup ( USkeletalMesh* SkeletalMesh,
TArray< ClothingAssetUtils::FClothingAssetMeshBinding >& ClothingBindings,
const int32 LODIndex
)

   LODUtilities.h  

static void RestoreClothingFromBackup ( USkeletalMesh* SkeletalMesh,
TArray< ClothingAssetUtils::FClothingAssetMeshBinding >& ClothingBindings
)

   LODUtilities.h  

static bool RestoreCustomImportedMorphTargetData ( USkeletalMesh* SkeletalMesh,
const int32 LodIndex,
FMeshDescription& LodMeshDescription,
const TMap< FString, TArray< FMorphTargetLodBackupData > >& BackupImportedMorphTargetData
)

 Restore the custom imported morph target in the mesh description. LODUtilities.h  

static bool SetCustomLOD ( USkeletalMesh* DestinationSkeletalMesh,
USkeletalMesh* SourceSkeletalMesh,
const int32 LodIndex,
const FString& SourceDataFilename
)

 Add or change the LOD data specified by LodIndex with the content of the sourceSkeletalMesh. LODUtilities.h  

static void SimplifySkeletalMeshLOD ( FSkeletalMeshUpdateContext& UpdateContext,
int32 DesiredLOD,
const ITargetPlatform* TargetPlatform,
bool bRestoreClothing,
std::atomic< bool >* OutNeedsPackageDirtied
)

 Simplifies the static mesh based upon various user settings for DesiredLOD. LODUtilities.h  

static void SimplifySkeletalMeshLOD ( USkeletalMesh* SkeletalMesh,
int32 DesiredLOD,
const ITargetPlatform* TargetPlatform,
bool bRestoreClothing,
TArray< FMorphTargetUpdateRequest >& OutMorphRequests,
std::atomic< bool >* OutNeedsPackageDirtied
)

 Simplifies the static mesh based upon various user settings for DesiredLOD This is private function that gets called by SimplifySkeletalMesh LODUtilities.h  

static bool StripLODGeometry ( USkeletalMesh* SkeletalMesh,
const int32 LODIndex,
UTexture2D* TextureMask,
const float Threshold
)

 This function will strip all triangle in the specified LOD that don't have any UV area pointing on a black pixel in the TextureMask. LODUtilities.h  

static void UnbindClothingAndBackup ( USkeletalMesh* SkeletalMesh,
TArray< ClothingAssetUtils::FClothingAssetMeshBinding >& ClothingBindings
)

   LODUtilities.h  

static void UnbindClothingAndBackup ( USkeletalMesh* SkeletalMesh,
TArray< ClothingAssetUtils::FClothingAssetMeshBinding >& ClothingBindings,
const int32 LODIndex
)

   LODUtilities.h  

static bool UpdateAlternateSkinWeights ( USkeletalMesh* SkeletalMeshDest,
const FName& ProfileNameDest,
USkeletalMesh* SkeletalMeshSrc,
int32 LODIndexDest,
int32 LODIndexSrc,
FOverlappingThresholds OverlappingThresholds,
bool ShouldImportNormals,
bool ShouldImportTangents,
bool bUseMikkTSpace,
bool bComputeWeightedNormals
)

   LODUtilities.h  

static bool UpdateAlternateSkinWeights ( USkeletalMesh* SkeletalMeshDest,
const FName& ProfileNameDest,
int32 LODIndexDest,
const IMeshUtilities::MeshBuildOptions& Options
)

 This function apply the skinning weights from the saved imported skinning weight data to the destination skeletal mesh. LODUtilities.h  

static bool UpdateAlternateSkinWeights ( USkeletalMesh* SkeletalMeshDest,
const FName& ProfileNameDest,
USkeletalMesh* SkeletalMeshSrc,
int32 LODIndexDest,
int32 LODIndexSrc,
const IMeshUtilities::MeshBuildOptions& Options
)

 This function apply the skinning weights from asource skeletal mesh to the destination skeletal mesh. LODUtilities.h  

static bool UpdateAlternateSkinWeights ( FSkeletalMeshLODModel& LODModelDest,
FSkeletalMeshImportData& ImportDataDest,
USkeletalMesh* SkeletalMeshDest,
const FReferenceSkeleton& RefSkeleton,
const FName& ProfileNameDest,
int32 LODIndexDest,
const IMeshUtilities::MeshBuildOptions& Options
)

   LODUtilities.h  

static bool UpdateAlternateSkinWeights ( USkeletalMesh* SkeletalMeshDest,
const FName& ProfileNameDest,
int32 LODIndexDest,
FOverlappingThresholds OverlappingThresholds,
bool ShouldImportNormals,
bool ShouldImportTangents,
bool bUseMikkTSpace,
bool bComputeWeightedNormals
)

   LODUtilities.h  

static bool UpdateAlternateSkinWeights ( FSkeletalMeshLODModel& LODModelDest,
FSkeletalMeshImportData& ImportDataDest,
USkeletalMesh* SkeletalMeshDest,
const FReferenceSkeleton& RefSkeleton,
const FName& ProfileNameDest,
int32 LODIndexDest,
FOverlappingThresholds OverlappingThresholds,
bool ShouldImportNormals,
bool ShouldImportTangents,
bool bUseMikkTSpace,
bool bComputeWeightedNormals
)

   LODUtilities.h  

static bool UpdateLODInfoVertexAttributes ( USkeletalMesh* InSkeletalMesh,
int32 InSourceLODIndex,
int32 InTargetLODIndex,
bool bInCopyAttributeValues
)

 Build the vertex attributes LODUtilities.h  

Deprecated Functions

Name Remarks Include Path Unreal Specifiers

static bool RestoreSkeletalMeshLODImportedData_DEPRECATED ( USkeletalMesh* SkeletalMesh,
int32 LodIndex
)

 Restore the LOD imported model to the last imported data. LODUtilities.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page