1. Epic GamesDeveloper
  3. FSkeletalMeshObject

FSkeletalMeshObject

Interface for mesh rendering data

Unreal Engine C++ API Reference > Runtime > Engine

Inheritance Hierarchy

References

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

Syntax

class FSkeletalMeshObject : public FDeferredCleanupInterface

Remarks

Interface for mesh rendering data

Variables

  Type Name Description
Public variable bool bHasBeenUpdatedAtLeastOnce This is set to true when we have sent our Mesh data to the rendering thread at least once as it needs to have have a datastructure created there for each MeshObject
Protected variable bool bUsePerBoneMotionBlur If true, per-bone motion blur is enabled for this object.
Protected variable uint32 ComponentId Component ID to which belong this mesh object
Public variable FName DebugName  
Protected variable ERHIFeatureLevel::Type FeatureLevel Feature level to render for.
Protected variable uint32 LastFrameNumber Used to keep track of the first call to UpdateMinDesiredLODLevel each frame.
Public variable TArray< FSkelMeshObjectLODInfo > LODInfo  
Public variable int32 MaterialIndexPreview  
Public variable float MaxDistanceFactor High (best) DistanceFactor that was desired for rendering this SkeletalMesh last frame.
Public variable int32 MinDesiredLODLevel Lowest (best) LOD that was desired for rendering this SkeletalMesh last frame.
Public variable int32 SectionIndexPreview Index of the section to preview...
Public variable int32 SelectedEditorMaterial The Material currently selected. need to remember this index for reimporting cloth
Public variable int32 SelectedEditorSection The section currently selected in the Editor. Used for highlighting
Public variable TArray< FCapsuleShape3f > ShadowCapsuleShapes  
Protected variable TArray< FSkeletalMeshLODInfo > SkeletalMeshLODInfo Per-LOD info.
Protected variable FSkeletalMeshRenderData * SkeletalMeshRenderData The skeletal mesh resource with which to render.
Protected variable FGPUSkinCacheEntry * SkinCacheEntry  
Protected variable FGPUSkinCacheEntry * SkinCacheEntryForRayTracing  
Protected variable TStatId StatId Used for dynamic stats
Public variable float WorkingMaxDistanceFactor This frames max distance factor.
Public variable int32 WorkingMinDesiredLODLevel This frames min desired LOD level.
Protected variable FVector WorldScale  

Constructors

  Type Name Description
Public function  

FSkeletalMeshObject ( USkinnedMeshComponent* InMeshComponent,
FSkeletalMeshRenderData* InSkelMeshRenderData,
ERHIFeatureLevel::Type FeatureLevel
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const void

CacheVertices ( int32 LODIndex,
bool bForce
)

 Re-skin cached vertices for an LOD and update the vertex buffer.
Public function Virtual Const void

DrawVertexElements ( FPrimitiveDrawInterface* PDI,
const FMatrix& ToWorldSpace,
bool bDrawNormals,
bool bDrawTangents,
bool bDrawBinormals
)

 Draw Normals/Tangents based on skinned vertex data
Public function Virtual void

EnableOverlayRendering ( bool bEnabled,
const TArray< int32 >* InBonesOfInterest,
const TArray< UMorphTarget* >* MorphTargetOfInterest
)

 Enable blend weight rendering in the editor
Public function Const FName

GetAssetPathName ( int32 LODIndex
)

 Helper function to return the asset path name, optionally joined with the LOD index if LODIndex > -1.
Public function Virtual Const bool

GetCachedGeometry ( FCachedGeometry& OutCachedGeometry
)

 If we are caching geometry deformation through skin-cache/mesh-deformers or other, then this returns the currently cached geoemtry.
Public function Static FColorVertexBuffer * Get the color buffer either from the component LOD info or the skeletal mesh LOD render data
Public function Const uint32 Return the ID of the component to which the skeletal mesh object belongs to.
Public function Const TArray< FTransform > * Get the array of component-space bone transforms.
Public function Const FName  
Public function Const ERHIFeatureLevel::Type Returns the feature level this FSkeletalMeshObject was created with
Public function Const int32

GetLOD ()

 Get the LOD to render this mesh at.
Public function Const const TArray< FMatrix44f > & Get the array of refpose->local matrices Not safe to hold this reference between frames, because it exists in dynamic data passed from main thread.
Public function Const const TArray< FSkelMeshRenderSection > &

GetRenderSections ( int32 InLODIndex
)

 List of sections to be rendered based on instance weight usage.
Public function void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

 Returns the size of memory allocated by render data
Public function Const float

GetScreenSize ( int32 LODIndex
)

 Returns the display factor for the given LOD level
Public function Const FSkeletalMeshRenderData & Get the skeletal mesh resource for which this mesh object was created.
Public function Const FColor

GetSkinCacheVisualizationDebugColor ( const FName& GPUSkinCacheVisualizationMode,
uint32 SectionIndex
)

  
Public function Const const FVertexFactory *

GetSkinVertexFactory ( const FSceneView* View,
int32 LODIndex,
int32 ChunkIdx,
ESkinVertexFactoryMode VFMode
)

  
Public function Static FSkinWeightVertexBuffer * Get the weight buffer either from the component LOD info or the skeletal mesh LOD render data
Public function Const TStatId  
Public function Virtual Const const FSkinBatchVertexFactoryUserData *

GetVertexFactoryUserData ( const int32 LODIndex,
int32 ChunkIdx,
ESkinVertexFactoryMode VFMode
)

  
Public function Const bool Return true if this does have valid dynamic data to render
Public function void

InitLODInfos ( const USkinnedMeshComponent* InMeshComponent
)

 Initialize the array of LODInfo based on the settings of the current skel mesh component
Public function void

InitResources ( USkinnedMeshComponent* InMeshComponent
)

 Initialize rendering resources for each LOD
Public function Const bool Returns true if this mesh performs skinning on the CPU.
Public function Const bool

IsMaterialHidden ( int32 InLODIndex,
int32 MaterialIdx
)

 Determine if the material section entry for an LOD is hidden or not
Public function Virtual void

PreGDMECallback ( FGPUSkinCache* GPUSkinCache,
uint32 FrameNumber
)

 Called by FSkeletalMeshObject prior to GDME.
Public function Virtual void

RefreshClothingTransforms ( const FMatrix& InNewLocalToWorld,
uint32 FrameNumber
)

 Called to notify clothing data that component transform has changed
Public function void Release rendering resources for each LOD
Public function void

SetHiddenMaterials ( int32 InLODIndex,
const TArray< bool >& HiddenMaterials
)

 Update the hidden material section flags for an LOD entry
Public function Virtual void

SetTransform ( const FMatrix& InNewLocalToWorld,
uint32 FrameNumber
)

 Called when that component transform has changed
Public function Const bool  
Public function void

Update ( int32 LODIndex,
USkinnedMeshComponent* InMeshComponent,
const FMorphTargetWeightMap& InActiveMorphTargets,
const TArray< float >& MorphTargetWeights,
EPreviousBoneTransformUpdateMode PreviousBoneTransformUpdateMode,
const FExternalMorphWeightData& InExternalMorphWeightData
)

 Called by the game thread for any dynamic data updates for this skel mesh object
Public function void

UpdateMinDesiredLODLevel ( const FSceneView* View,
const FBoxSphereBounds& Bounds,
int32 FrameNumber,
uint8 CurFirstLODIdx
)

 Given a set of views, update the MinDesiredLODLevel member to indicate the minimum (ie best) LOD we would like to use to render this mesh.
Public function void Will force re-evaluating which Skin Weight buffer should be used for skinning, determined by checking for any override weights or a skin weight profile being set.

Classes

  Type Name Description
Public struct FSkelMeshObjectLODInfo Setup for rendering a specific LOD entry of the component  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page