UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
SkeletalMesh.h File Reference

Go to the source code of this file.

Classes

struct  FBoneMirrorInfo
 
struct  FBoneMirrorExport
 
struct  FSkeletalMeshClothBuildParams
 
struct  FClothPhysicsProperties_Legacy
 
struct  FClothingAssetData_Legacy
 
struct  FScopedSkeletalMeshRenderData
 
class  USkeletalMesh
 
struct  FSkeletalMeshBuildParameters
 

Macros

#define UE_API   ENGINE_API
 

Typedefs

using instead = FSkinnedAssetCompilationContext
 

Enumerations

enum class  ESkeletalMeshAsyncProperties : uint64 {
  None = 0 , Materials = 1 << 0 , Skeleton = 1 << 1 , RefSkeleton = 1 << 2 ,
  RetargetBasePose = 1 << 3 , RefBasesInvMatrix = 1 << 4 , MeshClothingAssets = 1 << 5 , SourceModels = 1 << 6 ,
  HasActiveClothingAssets = 1 << 7 , LODSettings = 1 << 8 , HasVertexColors = 1 << 9 , VertexColorGuid = 1 << 10 ,
  MorphTargets = 1 << 11 , SkeletalMeshRenderData = 1 << 12 , MeshEditorDataObject = 1 << 13 , NeverStream = 1 << 14 ,
  OverrideLODStreamingSettings = 1 << 15 , SupportLODStreaming = 1 << 16 , MaxNumStreamedLODs = 1 << 17 , MaxNumOptionalLODs = 1 << 18 ,
  ImportedModel = 1 << 19 , SkinWeightProfiles = 1 << 21 , CachedComposedRefPoseMatrices = 1 << 22 , SamplingInfo = 1 << 23 ,
  NodeMappingData = 1 << 24 , ShadowPhysicsAsset = 1 << 25 , SkelMirrorTable = 1 << 26 , MinLod = 1 << 27 ,
  DisableBelowMinLodStripping = 1 << 28 , SkelMirrorAxis = 1 << 29 , SkelMirrorFlipAxis = 1 << 30 , DefaultAnimationRig = 1llu << 31 ,
  NegativeBoundsExtension = 1llu << 32 , PositiveBoundsExtension = 1llu << 33 , ExtendedBounds = 1llu << 34 , EnablePerPolyCollision = 1llu << 36 ,
  BodySetup = 1llu << 37 , MorphTargetIndexMap = 1llu << 38 , FloorOffset = 1llu << 39 , ImportedBounds = 1llu << 40 ,
  PhysicsAsset = 1llu << 41 , AssetImportData = 1llu << 42 , ThumbnailInfo = 1llu << 43 , HasCustomDefaultEditorCamera = 1llu << 44 ,
  DefaultEditorCameraLocation = 1llu << 45 , DefaultEditorCameraRotation = 1llu << 46 , RequiresLODScreenSizeConversion = 1llu << 47 , PostProcessAnimBlueprint = 1llu << 48 ,
  DefaultEditorCameraLookAt = 1llu << 49 , PreviewAttachedAssetContainer = 1llu << 50 , DefaultEditorCameraOrthoZoom = 1llu << 51 , RequiresLODHysteresisConversion = 1llu << 52 ,
  bSupportRayTracing = 1llu << 53 , RayTracingMinLOD = 1llu << 54 , ClothLODBiasMode = 1llu << 55 , DefaultMeshDeformer = 1llu << 56 ,
  OverlayMaterial = 1llu << 57 , OverlayMaterialMaxDrawDistance = 1llu << 58 , TargetMeshDeformers = 1llu << 59 , All = MAX_uint64
}
 
enum class  EClothLODBiasMode : uint8 { MappingsToSameLOD , MappingsToMinLOD , MappingsToAnyLOD }
 

Functions

 ENUM_CLASS_FLAGS (ESkeletalMeshAsyncProperties)
 
struct UE_DEPRECATED (5.0, "FBoneMirrorInfo is deprecated. Please use UMirrorDataTable for mirroring support.") FBoneMirrorInfo
 
struct UE_DEPRECATED (5.0, "FBoneMirrorExport is deprecated. Please use UMirrorDataTable for mirroring support.") FBoneMirrorExport
 
ENGINE_API void RefreshSkelMeshOnPhysicsAssetChange (const USkeletalMesh *InSkeletalMesh)
 
ENGINE_API FVector GetSkeletalMeshRefVertLocation (const USkeletalMesh *Mesh, const FSkeletalMeshLODRenderData &LODData, const FSkinWeightVertexBuffer &SkinWeightVertexBuffer, const int32 VertIndex)
 
ENGINE_API void GetSkeletalMeshRefTangentBasis (const USkeletalMesh *Mesh, const FSkeletalMeshLODRenderData &LODData, const FSkinWeightVertexBuffer &SkinWeightVertexBuffer, const int32 VertIndex, FVector3f &OutTangentX, FVector3f &OutTangentY, FVector3f &OutTangentZ)
 

Macro Definition Documentation

◆ UE_API

#define UE_API   ENGINE_API

Contains the shared data that is used by all SkeletalMeshComponents (instances).

Typedef Documentation

◆ instead

Enumeration Type Documentation

◆ EClothLODBiasMode

enum class EClothLODBiasMode : uint8
strong

Strategy used for storing additional cloth deformer mappings depending on the desired use of the RaytracingMinLOD value and of the LODBias console variable.

Enumerator
MappingsToSameLOD 
MappingsToMinLOD 
MappingsToAnyLOD 

◆ ESkeletalMeshAsyncProperties

Enumerator
None 
Materials 
Skeleton 
RefSkeleton 
RetargetBasePose 
RefBasesInvMatrix 
MeshClothingAssets 
SourceModels 
HasActiveClothingAssets 
LODSettings 
HasVertexColors 
VertexColorGuid 
MorphTargets 
SkeletalMeshRenderData 
MeshEditorDataObject 
NeverStream 
OverrideLODStreamingSettings 
SupportLODStreaming 
MaxNumStreamedLODs 
MaxNumOptionalLODs 
ImportedModel 
SkinWeightProfiles 
CachedComposedRefPoseMatrices 
SamplingInfo 
NodeMappingData 
ShadowPhysicsAsset 
SkelMirrorTable 
MinLod 
DisableBelowMinLodStripping 
SkelMirrorAxis 
SkelMirrorFlipAxis 
DefaultAnimationRig 
NegativeBoundsExtension 
PositiveBoundsExtension 
ExtendedBounds 
EnablePerPolyCollision 
BodySetup 
MorphTargetIndexMap 
FloorOffset 
ImportedBounds 
PhysicsAsset 
AssetImportData 
ThumbnailInfo 
HasCustomDefaultEditorCamera 
DefaultEditorCameraLocation 
DefaultEditorCameraRotation 
RequiresLODScreenSizeConversion 
PostProcessAnimBlueprint 
DefaultEditorCameraLookAt 
PreviewAttachedAssetContainer 
DefaultEditorCameraOrthoZoom 
RequiresLODHysteresisConversion 
bSupportRayTracing 
RayTracingMinLOD 
ClothLODBiasMode 
DefaultMeshDeformer 
OverlayMaterial 
OverlayMaterialMaxDrawDistance 
TargetMeshDeformers 
All 

Function Documentation

◆ ENUM_CLASS_FLAGS()

ENUM_CLASS_FLAGS ( ESkeletalMeshAsyncProperties  )

◆ GetSkeletalMeshRefTangentBasis()

ENGINE_API void GetSkeletalMeshRefTangentBasis ( const USkeletalMesh Mesh,
const FSkeletalMeshLODRenderData LODData,
const FSkinWeightVertexBuffer SkinWeightVertexBuffer,
const int32  VertIndex,
FVector3f OutTangentX,
FVector3f OutTangentY,
FVector3f OutTangentZ 
)

◆ GetSkeletalMeshRefVertLocation()

ENGINE_API FVector GetSkeletalMeshRefVertLocation ( const USkeletalMesh Mesh,
const FSkeletalMeshLODRenderData LODData,
const FSkinWeightVertexBuffer SkinWeightVertexBuffer,
const int32  VertIndex 
)

◆ RefreshSkelMeshOnPhysicsAssetChange()

ENGINE_API void RefreshSkelMeshOnPhysicsAssetChange ( const USkeletalMesh InSkeletalMesh)

Refresh Physics Asset Change

Physics Asset has been changed, so it will need to recreate physics state to reflect it Utilities functions to propagate new Physics Asset for InSkeletalMesh

Parameters
InSkeletalMeshSkeletalMesh that physics asset has been changed for

◆ UE_DEPRECATED() [1/2]

struct UE_DEPRECATED ( 5.  0,
"FBoneMirrorExport is deprecated. Please use UMirrorDataTable for mirroring support."   
)

◆ UE_DEPRECATED() [2/2]

struct UE_DEPRECATED ( 5.  0,
"FBoneMirrorInfo is deprecated. Please use UMirrorDataTable for mirroring support."   
)