1. Epic GamesDeveloper
  3. FSkeletalMeshLODModel

FSkeletalMeshLODModel

All data to define a certain LOD model for a skeletal mesh.

Unreal Engine C++ API Reference > Runtime > Engine > Rendering

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/Rendering/SkeletalMeshLODModel.h
Include #include "Rendering/SkeletalMeshLODModel.h"

Syntax

class FSkeletalMeshLODModel

Remarks

All data to define a certain LOD model for a skeletal mesh.

Variables

  Type Name Description
Public variable TArray< FBoneIndexType > ActiveBoneIndices Bone hierarchy subset active for this LOD.
Public variable bool bIsBuildDataAvailable  
Public variable bool bIsRawSkeletalMeshBulkDataEmpty  
Public variable FString BuildStringID Temporary build String ID We use this string to store the LOD model data so we can know if the LOD need to be rebuild This GUID is set when we Cache the render data (build function)
Public variable TArray< FSkelMeshImportedMeshInfo > ImportedMeshInfos The information about individual meshes.
Public variable TArray< uint32 > IndexBuffer Index buffer, covering all sections
Public variable int32 MaxImportVertex The max index in MeshToImportVertexMap, ie. the number of imported (raw) verts.
Public variable TArray< int32 > MeshToImportVertexMap Mapping from final mesh vertex index to raw import vertex index.
Public variable uint32 NumTexCoords The number of unique texture coordinate sets in this lod
Public variable uint32 NumVertices  
Public variable FString RawSkeletalMeshBulkDataID This ID is use to create the DDC key, it must be set when we save the FRawSkeletalMeshBulkData.
Public variable TArray< FBoneIndexType > RequiredBones Bones that should be updated when rendering this LOD.
Public variable TArray< FSkelMeshSection > Sections Sections.
Public variable TMap< FName, FImportedSkinWeightProfileData > SkinWeightProfiles Set of skin weight profile, identified by a FName which matches FSkinWeightProfileInfo.Name in the owning Skeletal Mesh
Public variable TMap< int32, FSkelMeshSourceSectionUserData > UserSectionsData When user change section data in the UI, we store it here to be able to regenerate the changes Note: the key (int32) is the original imported section data, because of BONE chunk the size of this array is not the same as the Sections array.
Public variable TMap< FName, FSkeletalMeshModelVertexAttribute > VertexAttributes Set of vertex attributes identified by an FName

Constructors

  Type Name Description
Public function   Constructor (default)

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Static void Copy one structure to the other, make sure all bulk data is unlock and the data can be read before copying.
Public function Static FSkeletalMeshLODModel * Create a new FSkeletalMeshLODModel on the heap.
Public function Static void  
Public function Const bool  
Public function void

Empty ()

 Empty the skeletal mesh LOD model.
Public function Const int32 Find a mesh info by a mesh name. Returns INDEX_NONE when not found.
Public function Const void

GetClothMappingData ( TArray< FMeshToMeshVertData >& MappingData,
TArray< FClothBufferIndexMapping >& OutClothIndexMapping
)

 Fill array with APEX cloth mapping data.
Public function Const FString Build a derive data key with the user section data (UserSectionsData) and the original bulk data
Public function Const int32  
Public function Const void

GetMeshDescription ( FMeshDescription& MeshDescription,
const USkeletalMesh* Owner
)

 Fills in a representation of this model into the given mesh description object.
Public function Const void Similar to GetVertices but ignores vertices from clothing sections to avoid getting duplicate vertices from clothing sections if not needed
Public function Const int32  
Public function Const const TArray< uint32 > & Accessor for the RawPointIndice which is editor only data: array of the original point (wedge) indices for each of the vertices in a FSkeletalMeshLODModel
Public function TArray< uint32 > & Accessor for the RawPointIndice which is editor only data: array of the original point (wedge) indices for each of the vertices in a FSkeletalMeshLODModel
Public function Const void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

  
Public function Const void

GetSectionFromVertexIndex ( int32 InVertIndex,
int32& OutSectionIndex,
int32& OutVertIndex
)

 Utility for finding the section that a particular vertex is in.
Public function Const void Fill array with vertex position and tangent data from skel mesh chunks.
Public function Const bool  
Public function Const int32  
Public function void

Serialize ( FArchive& Ar,
UObject* Owner,
int32 Idx
)

 Special serialize function passing the owning UObject along as required by FUnytpedBulkData serialization.
Public function void

SyncronizeUserSectionsDataArray ( bool bResetNonUsedSection
)

 Make sure user section data is present for every original sections
Public function void

UpdateChunkedSectionInfo ( const FString& SkeletalMeshName
)

 This function will update the chunked information for each section.

Deprecated Functions

  Type Name Description
Public function FRawSkeletalMeshBulkData & Please do not access this function anymore. This data is not use anymore.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page