1. Epic GamesDeveloper
  3. USkinnedMeshComponent

USkinnedMeshComponent

Skinned mesh component that supports bone skinned mesh rendering.

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Components

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Components/SkinnedMeshComponent.h
Include #include "Components/SkinnedMeshComponent.h"

Syntax

UCLASS (HideCategories=Object, Config=Engine, EditInlineNew, Abstract, MinimalAPI)  
class USkinnedMeshComponent :  
    public UMeshComponent ,  
    public ILODSyncInterface

Remarks

Skinned mesh component that supports bone skinned mesh rendering. This class does not support animation.

Variables

  Type Name Description
Public variable FMorphTargetWeightMap ActiveMorphTargets Array indicating all active morph targets.
Public variable FAnimUpdateRateParameters * AnimUpdateRateParams Animation Update Rate optimization parameters.
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly bool bAlwaysUseMeshDeformer If true, and if no mesh deformer is set from here or the SkeletalMesh, fall back to the default deformer specified in the project settings, unless DefaultMode is set to "Never" in project settings
Protected variable uint8: 1 bBoneVisibilityDirty Whether we have updated bone visibility this tick
Protected variable UProperty Transient uint8: 1 bCachedLocalBoundsUpToDate True when CachedLocalBounds is up to date.
Protected variable UProperty Transient uint8: 1 bCachedWorldSpaceBoundsUpToDate  
Public variable UProperty Transient uint8: 1 bCanHighlightSelectedSections Whether or not we can highlight selected sections - this should really only be done in the editor
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly uint8: 1 bCastCapsuleDirectShadow Whether to use the capsule representation (when present) from a skeletal mesh's ShadowPhysicsAsset for direct shadowing from lights.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly uint8: 1 bCastCapsuleIndirectShadow Whether to use the capsule representation (when present) from a skeletal mesh's ShadowPhysicsAsset for shadowing indirect lighting (from lightmaps or skylight).
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite uint8: 1 bComponentUseFixedSkelBounds Misc.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite uint8: 1 bConsiderAllBodiesForBounds If true, when updating bounds from a PhysicsAsset, consider all BodySetups, not just those flagged with bConsiderForBounds.
Public variable UProperty Transient uint8: 1 bCPUSkinning Whether or not to CPU skin this component, requires render data refresh after changing
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite uint8: 1 bDisableMorphTarget Disable Morphtarget for this component.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay uint8: 1 bDisplayBones Draw the skeleton hierarchy for this skel mesh.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite uint8: 1 bDisplayDebugUpdateRateOptimizations Enable on screen debugging of update rate optimization.
Protected variable uint8: 1 bDoubleBufferedComponentSpaceTransforms Are we using double buffered ComponentSpaceTransforms
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite uint8: 1 bEnableUpdateRateOptimizations Update Rate.
Protected variable uint8: 1 bExternalEvaluationRateLimited External flag indicating that we may not be evaluated every frame
Protected variable uint8: 1 bExternalInterpolate Non URO-based interpolation flag
Protected variable uint8: 1 bExternalTickRateControlled Whether we are externally controlling tick rate
Protected variable uint8: 1 bExternalUpdate Non URO-based update flag
Protected variable UProperty Transient uint8: 1 bFollowerShouldTickPose If false, Follower components ShouldTickPose function will return false (default)
Public variable UProperty uint8: 1 bForceWireframe Forces the mesh to draw in wireframe mode.
Protected variable uint8: 1 bHasValidBoneTransform Used to cache previous bone transform or not
Public variable UProperty uint8: 1 bHideSkin Don't bother rendering the skin.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly uint8: 1 bIgnoreLeaderPoseComponentLOD Flag that when set will ensure UpdateLODStatus will not take the LeaderPoseComponent's current LOD in consideration when determining the correct LOD level (this requires LeaderPoseComponent's LOD to always be >= determined LOD otherwise bone transforms could be missing
Public variable uint8: 1 bIgnoreMasterPoseComponentLOD  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly uint8: 1 bIncludeComponentLocationIntoBounds If true, the Location of this Component will be included into its bounds calculation (this can be useful when using SMU_OnlyTickPoseWhenRendered on a character that moves away from the root and no bones are left near the origin of the component)
Protected variable uint8: 1 bMipLevelCallbackRegistered Whether mip callbacks have been registered and need to be removed on destroy
Protected variable uint8: 1 bNeedToFlipSpaceBaseBuffers Track whether we still need to flip to recently modified buffer
Protected variable TArray< uint8 >[2] BoneVisibilityStates Array of bone visibilities (containing one of the values in EBoneVisibilityStatus for each bone).
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly uint8: 1 bOverrideMinLod Whether we should use the min lod specified in MinLodModel for this component instead of the min lod in the mesh
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly uint8: 1 bPerBoneMotionBlur If true, use per-bone motion blur on this skeletal mesh (requires additional rendering, can be disabled to save performance).
Public variable UProperty Transient uint8: 1 bRecentlyRendered True if mesh has been recently rendered, false otherwise
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly uint8: 1 bRenderStatic If true, render as static in reference pose.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly bool bSetMeshDeformer If true, MeshDeformer will be used. If false, use the default mesh deformer on the SkeletalMesh.
Protected variable uint8: 1 bSkinWeightProfilePending Whether or not a Skin Weight profile is currently pending load and creation for this component
Protected variable uint8: 1 bSkinWeightProfileSet Whether or not a Skin Weight profile is currently set for this component
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite uint8: 1 bSyncAttachParentLOD If true, this component uses its parents LOD when attached if available ForcedLOD can override this change.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite uint8: 1 bUseBoundsFromLeaderPoseComponent When true, we will just using the bounds from our LeaderPoseComponent.
Public variable uint8: 1 bUseBoundsFromMasterPoseComponent  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite uint8: 1 bUseScreenRenderStateForUpdate If set, use the screen render flag instead of the default render flag when processing offscreen-rendering optimizations (such as VisibilityBasedAnimTickOption) that look to reduce animation work when the mesh is not rendered.
Protected variable ERHIFeatureLevel::Type CachedSceneFeatureLevel Cache the scene feature level
Protected variable UProperty Transient FBoxSphereBounds CachedWorldOrLocalSpaceBounds Bounds cached, so they're computed just once, either in local or worldspace depending on cvar 'a.CacheLocalSpaceBounds'.
Protected variable UProperty Transient FMatrix CachedWorldToLocalTransform  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly float CapsuleIndirectShadowMinVisibility Controls how dark the capsule indirect shadow can be.
Protected variable uint32 CurrentBoneTransformFrame Stores GFrameCounter when CurrentBoneTransformRevisionNumber was updated, to make sure it's updated once per frame
Protected variable uint32 CurrentBoneTransformRevisionNumber Current bone transform revision number
Protected variable int32 CurrentEditableComponentTransforms The index for the ComponentSpaceTransforms buffer we can currently write to
Protected variable int32 CurrentReadComponentTransforms The index for the ComponentSpaceTransforms buffer we can currently read from
Protected variable FName[2] CurrentSkinWeightProfileLayers Name of currently set up Skin Weight layers, all set to NAME_None for no override
Public variable TOptional< FLinearColor > DebugDrawColor Debug draw color
Protected variable float ExternalDeltaTime Non-URO-based delta time used to tick the pose
Protected variable float ExternalInterpolationAlpha Non-URO-based interpolation alpha
Public variable TArray< FExternalMorphSets > ExternalMorphSets External GPU based morph target buffers, for each LOD.
Public variable TArray< FExternalMorphWeightData > ExternalMorphWeightData The external morph target set weight data, for each LOD.
Protected variable uint8 ExternalTickRate Record of the tick rate we are using when externally controlled
Protected variable TArray< TWeakObjectPtr< USkinnedMeshComponent > > FollowerPoseComponents If set, this component has follower pose components that are associated with this Note this is weak object ptr, so it will go away unless you have other strong reference
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly int32 ForcedLodModel Level of detail. If 0, auto-select LOD level. if >0, force to (ForcedLodModel-1).
Protected variable float LastStreamerUpdateBoundsRadius The bounds radius at the point we last notified the streamer of a bounds radius change
Protected variable TArray< int32 > LeaderBoneMap Mapping between bone indices in this component and the parent one.
Protected variable int32 LeaderBoneMapCacheCount Incremented every time the leader bone map changes.
Public variable UProperty Category BlueprintReadOnly TWeakObjectPtr< USkinnedMeshComponent > LeaderPoseComponent LeaderPoseComponent.
Public variable UProperty Transient TArray< struct FSkelMeshComponentLODInfo > LODInfo LOD array info. Each index will correspond to the LOD index
Public variable TWeakObjectPtr< USkinnedMeshComponent > MasterPoseComponent  
Public variable float MaxDistanceFactor High (best) DistanceFactor that was desired for rendering this USkeletalMesh last frame.
Public variable uint8 & MeshComponentUpdateFlag  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly TObjectPtr< UMeshDeformer > MeshDeformer The mesh deformer to use.
Protected variable UProperty Transient FMeshDeformerInstanceSet MeshDeformerInstances Object containing state for the bound MeshDeformer.
Protected variable UProperty Category, Meta BlueprintReadOnly instanced, visibleanywhere TObjectPtr< UMeshDeformerInstanceSettings > MeshDeformerInstanceSettings Object containing instance settings for the bound MeshDeformer.
Public variable FSkeletalMeshObject * MeshObject Object responsible for sending bone transforms, morph target state etc. to render thread.
Public variable FSkeletalMeshObject *(*)(void *UserData, USkinnedMeshComponent *InMeshComponent, FSk... MeshObjectFactory Supports user-defined FSkeletalMeshObjects
Public variable void * MeshObjectFactoryUserData Passed into MeshObjectFactory
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly int32 MinLodModel This is the min LOD that this component will use.
Protected variable TMap< int32, FMissingLeaderBoneCacheEntry > MissingLeaderBoneMap Map of missing bone indices->transforms so that calls to GetBoneTransform() succeed when bones are not present in a leader mesh when using leader-pose.
Public variable TArray< float > MorphTargetWeights Array of weights for all morph targets.
Public variable FOnAnimUpdateRateParamsCreated OnAnimUpdateRateParamsCreated Animation update rate control.
Public variable FOnTickPose OnTickPose Invoked at the beginning of TickPose before doing the bulk of the tick work
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly TObjectPtr< class UPhysicsAsset > PhysicsAssetOverride Physics. PhysicsAsset is set in SkeletalMesh by default, but you can override with this value
Public variable int32 PredictedLODLevel Best LOD that was 'predicted' by UpdateSkelPose.
Protected variable uint32 PreviousBoneTransformRevisionNumber Cache previous bone transform revision number to help compute CurrentBoneTransformRevisionNumber
Protected variable TArray< uint8 > PreviousBoneVisibilityStates Array of bone visibilities (containing one of the values in EBoneVisibilityStatus for each bone).
Protected variable TArray< FTransform > PreviousComponentSpaceTransformsArray Array of previous bone transforms Note these are only used if we are NOT double-buffering bone transforms
Public variable FSkeletalMeshObject * PreviousMeshObject Previous copy of MeshObject set during recreate of the render state
Protected variable TSharedPtr< FSkelMeshRefPoseOverride > RefPoseOverride Information for current ref pose override, if present
Public variable UProperty Category, EditAnywhere, Meta blueprintgetter, setter TObjectPtr< class USkeletalMesh > SkeletalMesh The skeletal mesh used by this component.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TArray< ESkinCacheUsage > SkinCacheUsage How this Component's LOD uses the skin cache feature.
Protected variable TSortedMap< FName, FName, FDefaultAllocator, FNameFastLess > SocketOverrideLookup Mapping for socket overrides, key is the Source socket name and the value is the override socket name
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite float StreamingDistanceMultiplier Allows adjusting the desired streaming distance of streaming textures that uses UV 0.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Interp BlueprintReadWrite Config EVisibilityBasedAnimTickOption VisibilityBasedAnimTickOption This is tick animation frequency option based on this component rendered or not or using montage You can change this default value in the INI file Mostly related with performance

Constructors

  Type Name Description
Public function  

USkinnedMeshComponent ( const FObjectInitializer& ObjectInitializer
)

  
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Register an external set of GPU compressed morph targets.
Protected function Virtual void Add a follower component to the FollowerPoseComponents array
Protected function Virtual void

AddSlavePoseComponent ( USkinnedMeshComponent* SkinnedMeshComponent
)

  
Public function void

AddSocketOverride ( FName SourceSocketName,
FName OverrideSocketName,
bool bWarnHasOverrided
)

  
Protected function Virtual bool Allocate Transform Data array including SpaceBases, BoneVisibilityStates
Public function Static void Helpers allowing us to cache feature level
Public function Const UFunction BlueprintCallable, Category bool

BoneIsChildOf ( FName BoneName,
FName ParentBoneName
)

 Tests if BoneName is child of (or equal to) ParentBoneName.
Public function Const void

CacheRefToLocalMatrices ( TArray< FMatrix44f >& OutRefToLocal
)

 Caches the RefToLocal matrices.
Protected function Const FBoxSphereBounds

CalcMeshBound ( const FVector3f& RootOffset,
bool UsePhysicsAsset,
const FTransform& Transform
)

 Update Mesh Bound information based on input
Public function UFunction BlueprintCallable, Category void Clear the skin Weight Profile from all layers on this component.
Public function void Clear all externally registered morph target buffers.
Public function void This update renderer with new revision number twice so to clear bone velocity for motion blur or temporal AA
Public function Virtual void Clear any applied ref pose override
Public function UFunction BlueprintCallable, Category void Clear any applied skin weight override
Public function UFunction BlueprintCallable, Category void Clear the skin weight profile from the given layer on this component, in case it is set.
Public function UFunction BlueprintCallable, Category void Clear any applied vertex color override
Public function Const int32 Compute SkeletalMesh MinLOD that will be used by this component
Public function Static void

ComputeSkinnedPositions ( USkinnedMeshComponent* Component,
TArray< FVector3f >& OutPositions,
TArray< FMatrix44f >& CachedRefToLocals,
const FSkeletalMeshLODRenderData& LODData,
const FSkinWeightVertexBuffer& SkinWeightBuffer
)

 CPU evaluation of the positions of all vertices (returned in component space)
Protected function Virtual void  
Protected function Virtual void Parallel Tick Pose In the case where we do not want to refresh bone transforms (and would therefore not normally kick off a parallel eval task) we perform this 'mini tick' that kicks off the task.
Public function void Manually enable/disable animation evaluation rate limiting
Public function void

EnableExternalInterpolation ( bool bInEnable
)

 Enable non-URO-based interpolation
Public function void

EnableExternalTickRateControl ( bool bInEnable
)

 Set whether we have our tick rate externally controlled non-URO-based interpolation
Public function void

EnableExternalUpdate ( bool bInEnable
)

 Set us to tick this frame for non-URO-based interpolation
Public function Virtual void Finalize bone transform of this current tick After this function, any query to bone transform should be latest of the data
Public function Const FName

FindClosestBone ( FVector TestLocation,
FVector* BoneLocation,
float IgnoreScale,
bool bRequirePhysicsAsset
)

 Finds the closest bone to the given location
Public function Const UFunction BlueprintCallable, Category, Meta FName

FindClosestBone_K2 ( FVector TestLocation,
FVector& BoneLocation,
float IgnoreScale,
bool bRequirePhysicsAsset
)

 Finds the closest bone to the given location
Public function Virtual Const UMorphTarget *

FindMorphTarget ( FName MorphTargetName
)

 Find a named MorphTarget from the current SkeletalMesh
Protected function void Flip the editable space base buffer
Public function void Forcibly update the renderer with a new revision number to assign the current bone velocity for motion blur or temporal AA
Protected function Const FMeshDeformerSet Get the currently active MeshDeformer.
Public function Virtual Const void

GetAdditionalRequiredBonesForLeader ( int32 LODIndex,
TArray< FBoneIndexType >& InOutRequiredBones
)

 Override this function to add any additional required bones from followers to functions such as USkeletalMeshComponent::ComputeRequiredBones().
Public function Const UFunction BlueprintCallable, Category bool Returns whether the component is set to always use a mesh deformer if one can be found in the project settings
Public function Const const USkinnedMeshComponent *  
Public function Const FVector

GetBoneAxis ( FName BoneName,
EAxis::Type Axis
)

 Finds a vector pointing along the given axis of the given bone
Public function Const UFunction BlueprintCallable, Category int32

GetBoneIndex ( FName BoneName
)

 Find the index of bone by name.
Public function Const FVector Get Bone Location
Public function Const FMatrix

GetBoneMatrix ( int32 BoneIndex
)

 Get Bone Matrix from index
Public function Const UFunction BlueprintCallable, Category FName

GetBoneName ( int32 BoneIndex
)

 Get Bone Name from index
Public function void

GetBoneNames ( TArray< FName >& BoneNames
)

 Fills the given array with the names of all the bones in this component's current SkeletalMesh
Public function Const FQuat Get Bone Rotation in Quaternion
Public function Const FTransform

GetBoneTransform ( int32 BoneIndex,
const FTransform& LocalToWorld
)

 Get world space bone transform from bone index, also specifying the component transform to use
Public function Const UFunction BlueprintCallable, Category, Meta FTransform

GetBoneTransform ( FName InBoneName,
ERelativeTransformSpace TransformSpace
)

 Get world-space bone transform.
Public function Const FTransform

GetBoneTransform ( int32 BoneIndex
)

 Get Bone Transform from index
Public function Const uint32  
Public function Const const TArray< uint8 > & Access BoneVisibilityStates for reading
Public function Const FBoxSphereBounds  
Public function Const const TArray< FTransform > & Access ComponentSpaceTransforms for reading
Public function Const void  
Public function Const void

GetCPUSkinnedVertices ( TArray< struct FFinalSkinVertex >& OutVertices,
int32 InLODIndex
)

 Get CPU skinned vertices for the specified LOD level.
Public function Const bool Getter for bCPUSkinning member variable May return a different value from ShouldCPUSkin()
Public function Const uint32  
Public function Const void

GetCurrentRefToLocalMatrices ( TArray< FMatrix44f >& OutRefToLocals,
int32 InLodIdx,
const TArray< FBoneIndexType >* ExtraRequiredBoneIndices
)

 Return the skinning matrices used for rendering.
Public function Const UFunction BlueprintCallable, Category TArray< FName > Return the names of the skin weight profiles for all the layers
Public function Const UFunction BlueprintCallable, Category FName Return the name of the skin weight profile that is currently set on the given layer, otherwise returns 'None'
Public function Const const TOptional< FLinearColor > & Get debug draw color
Public function Const UFunction BlueprintCallable, Category FTransform

GetDeltaTransformFromRefPose ( FName BoneName,
FName BaseName
)

 Get delta transform from reference pose based on BaseNode.
Public function TArray< uint8 > & Get Access to the current editable bone visibility states
Public function Const const TArray< uint8 > &  
Public function TArray< FTransform > & Get Access to the current editable space bases
Public function Const const TArray< FTransform > &  
Public function Const const FExternalMorphSets & Get the external morph sets for a given LOD.
Public function FExternalMorphSets &  
Public function Const const TArray< FExternalMorphSets > & Get the array of external morph target sets. It is an array, one entry for each LOD.
Public function FExternalMorphWeightData & Get the weights for a given external morph target set at a specific LOD.
Public function Const const FExternalMorphWeightData & Get the weights in read-only mode for a given external morph target set at a specific LOD.
Public function Const uint8 Get the external tick rate
Public function Const const TArray< TWeakObjectPtr< USkinnedMeshComponent > > & Return current active list of follower components
Public function Const UFunction BlueprintCallable, Category int32 Get ForcedLodModel of the mesh component.
Public function Const bool  
Public function Const const TArray< int32 > &  
Public function Virtual Const int32 Get the LOD Bias of this component
Public function Const const TArray< int32 > &  
Public function Const int32 Return value of MaterialIndexPreview
Public function Const UFunction BlueprintPure, Category UMeshDeformerInstance *  
Public function Const UMeshDeformerInstance * Gets the MeshDeformer for the given LOD.
Public function Const int32 Max LOD at which to update or apply the MeshDeformer.
Public function Virtual Const const Nanite::FResources *  
Public function Const UFunction BlueprintCallable, Category int32 Returns the number of bones in the skeleton.
Public function Const int32 Get current number of component space transorms
Public function Const UFunction BlueprintCallable, Category int32 Get the number of LODs on this component
Public function Const UFunction BlueprintCallable, Category FName

GetParentBone ( FName BoneName
)

 Get Parent Bone of the input bone
Public function Const UPhysicsAsset * Return PhysicsAsset for this SkeletalMeshComponent It will return SkeletalMesh's PhysicsAsset unless PhysicsAssetOverride is set for this component
Public function Static void

GetPhysicsRequiredBones ( const USkinnedAsset* SkinnedAsset,
const UPhysicsAsset* PhysicsAsset,
TArray< FBoneIndexType >& OutRequiredBones
)

 Animation required bones Get the bones used by the physics asset (if any), as these have to be updated even if LODed out.
Public function Const UFunction BlueprintPure, Category int32 Get predicted LOD level.
Public function Const void Get the pre-skinning local space bounds for this component.
Public function Const uint32  
Public function Const const TArray< uint8 > & Const getters for previous transform idea
Public function Const const TArray< FTransform > &  
Public function Virtual Const const TSharedPtr< FSkelMeshRefPoseOverride > & Accessor for RefPoseOverride
Public function Const UFunction BlueprintPure, Category FVector

GetRefPosePosition ( int32 BoneIndex
)

 Gets the local-space position of a bone in the reference pose.
Public function Const UFunction BlueprintPure, Category FTransform

GetRefPoseTransform ( int32 BoneIndex
)

 Gets the local-space transform of a bone in the reference pose.
Public function Const int32 Return value of SectionIndexPreview
Public function Const int32 Return value of SelectedEditorMaterial
Public function Const int32 Return value of SelectedEditorSection
Public function Const FSkeletalMeshRenderData * Gets the skeletal mesh resource used for rendering the component.
Public function Const UFunction BlueprintPure, Category USkinnedAsset * Get the SkinnedAsset rendered for this mesh.
Public function Static FVector3f

GetSkinnedVertexPosition ( USkinnedMeshComponent* Component,
int32 VertexIndex,
const FSkeletalMeshLODRenderData& LODDatal,
FSkinWeightVertexBuffer& SkinWeightBuffer
)

 Simple, CPU evaluation of a vertex's skinned position (returned in component space)
Public function Static FVector3f

GetSkinnedVertexPosition ( USkinnedMeshComponent* Component,
int32 VertexIndex,
const FSkeletalMeshLODRenderData& LODData,
FSkinWeightVertexBuffer& SkinWeightBuffer,
TArray< FMatrix44f >& CachedRefToLocals
)

 Simple, CPU evaluation of a vertex's skinned position (returned in component space)
Public function Const FSkinWeightVertexBuffer *

GetSkinWeightBuffer ( int32 LODIndex
)

 Returns skin weight vertex buffer to use for specific LOD (will look at override)
Public function Const const TArray< TWeakObjectPtr< USkinnedMeshComponent > > &  
Public function Const UFunction BlueprintCallable, Category FName

GetSocketBoneName ( FName InSocketName
)

 Returns bone name linked to a given named socket on the skeletal mesh component.
Public function Const USkeletalMeshSocket const *

GetSocketByName ( FName InSocketName
)

  
Public function Const USkeletalMeshSocket const *

GetSocketInfoByName ( FName InSocketName,
FTransform& OutTransform,
int32& OutBoneIndex
)

  
Public function Static void

GetSocketRequiredBones ( const USkinnedAsset* SkinnedAsset,
TArray< FBoneIndexType >& OutRequiredBones,
TArray< FBoneIndexType >& NeededBonesForFillComponentSpaceTransforms
)

 Get the bones that are used by sockets.
Public function Const UFunction BlueprintCallable, Category bool

GetTwistAndSwingAngleOfDeltaRotationFromRefPose ( FName BoneName,
float& OutTwistAngle,
float& OutSwingAngle
)

 Get Twist and Swing Angle in Degree of Delta Rotation from Reference Pose in Local space
Public function Virtual void

GetUpdateClothSimulationData_AnyThread ( TMap< int32, FClothSimulData >& OutClothSimulData,
FMatrix& OutLocalToWorld,
float& OutClothBlendWeight
)

 Override this function to pass on cloth simulation data (or any deformable using the cloth pipeline) to the skeletal renderer.
Public function Const int32

GetValidMinLOD ( const int32 InMinLODIndex
)

 Validate the min LOD value of the mesh component by iterating over render data to make sure we get something usable.
Public function Const FColor

GetVertexColor ( int32 VertexIndex
)

 Returns color of the vertex.
Public function Const FVector2D

GetVertexUV ( int32 VertexIndex,
uint32 UVChannel
)

 Returns texture coordinates of the vertex.
Public function Static void  
Public function Static void  
Public function Const bool Do we have a given set of external morph targets?
Public function Const bool  
Public function Virtual Const bool Returns true if the component has valid Nanite render data.
Public function Virtual void

HideBone ( int32 BoneIndex,
EPhysBodyOp PhysBodyOption
)

 Hides the specified bone. You can also set option for physics body.
Public function UFunction BlueprintCallable, Category void

HideBoneByName ( FName BoneName,
EPhysBodyOp PhysBodyOption
)

 Hides the specified bone with name.
Public function void Initialize the LOD entries for the component
Public function void Invalidate Cached Bounds, when Mesh Component has been updated.
Public function Const bool

IsBoneHidden ( int32 BoneIndex
)

 Determines if the specified bone is hidden.
Public function UFunction BlueprintCallable, Category bool

IsBoneHiddenByName ( FName BoneName
)

 Determines if the specified bone is hidden.
Public function UFunction BlueprintCallable, Category bool

IsMaterialSectionShown ( int32 MaterialID,
int32 LODIndex
)

 Returns whether a specific material section is currently hidden on this component (by using ShowMaterialSection)
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Const bool  
Public function Const bool Check whether a skin weight profile is currently pending load / create
Public function Const bool Check whether we should be interpolating due to external settings
Public function Const bool Check whether we we have our tick rate externally controlled
Public function Const UFunction BlueprintCallable, Category bool Check whether a skin weight profile is currently set on any layer.
Public function Const bool Check whether a given LOD index is valid for the external morph sets.
Public function Static void

MergeInBoneIndexArrays ( TArray< FBoneIndexType >& BaseArray,
const TArray< FBoneIndexType >& InsertArray
)

 Takes sorted array Base and then adds any elements from sorted array Insert which is missing from it, preserving order.
Public function UFunction BlueprintCallable, Category void

OverrideMinLOD ( int32 InNewMinLOD
)

 Override the Min LOD of the mesh component
Public function Virtual void Function to operate on mesh object after its created, but before it's attached.
Public function void Rebuild BoneVisibilityStates array. Mostly refresh information of bones for BVS_HiddenByParent
Public function Virtual void Update functions Refresh Bone Transforms Each class will need to implement this function Ideally this function should be atomic (not relying on Tick or any other update.)
Public function void

RefreshExternalMorphTargetWeights ( bool bZeroOldWeights
)

 Refresh the external morph target weight buffers.
Public function void Refresh Follower Components if exists
Public function void  
Protected function void Recreates update rate params and internal tracker data
Public function Virtual FDelegateHandle

RegisterOnBoneTransformsFinalizedDelegate ( const FOnBoneTransformsFinalizedMultiCast::FDelegate&
)

 Register an OnBoneTransformsFinalized callback which can be called in FinalizeBoneTransform().
Public function void Release any rendering resources owned by this component
Protected function void Removes update rate params and internal tracker data
Public function void  
Public function void Remove a given set of external GPU based morph targets.
Protected function Virtual void Remove a follower component from the FollowerPoseComponents array
Protected function Virtual void  
Public function void

RemoveSocketOverrides ( FName SourceSocketName
)

  
Public function void Resize the morph target sets array to the number of LODs.
Public function UFunction BlueprintCallable, Category void

SetAlwaysUseMeshDeformer ( bool bShouldAlwaysUseMeshDeformer
)

 Always use a MeshDeformer as long as one can be found in the project settings
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

SetCastCapsuleDirectShadow ( bool bNewValue
)

  
Public function UFunction BlueprintCallable, Category void

SetCastCapsuleIndirectShadow ( bool bNewValue
)

  
Public function void

SetComponentSpaceTransformsDoubleBuffering ( bool bInDoubleBufferedComponentSpaceTransforms
)

  
Public function void

SetCPUSkinningEnabled ( bool bEnable,
bool bRecreateRenderStateImmediately
)

 Set whether this component uses CPU skinning Notes:
Public function void

SetDebugDrawColor ( const FLinearColor& InColor
)

 Set debug draw color
Public function void

SetDrawDebugSkeleton ( bool bInDraw
)

 Set whether to draw this mesh's debug skeleton
Public function void

SetExternalDeltaTime ( float InDeltaTime
)

 Set non-URO-based delta time
Public function void

SetExternalInterpolationAlpha ( float InAlpha
)

 Set non-URO-based interpolation alpha
Public function void

SetExternalTickRate ( uint8 InTickRate
)

 Set the external tick rate
Public function UFunction BlueprintCallable, Category void

SetForcedLOD ( int32 InNewForcedLOD
)

 Set ForcedLodModel of the mesh component
Public function void

SetForceUpdateDynamicDataImmediately ( bool bForceUpdateImmediately
)

  
Public function void

SetForceWireframe ( bool InForceWireframe
)

 Sets the value of the bForceWireframe flag and reattaches the component as necessary.
Public function UFunction BlueprintCallable, Category void

SetLeaderPoseComponent ( USkinnedMeshComponent* NewLeaderBoneComponent,
bool bForceUpdate,
bool bInFollowerShouldTickPose
)

 Set LeaderPoseComponent for this component
Public function void

SetMasterPoseComponent ( USkinnedMeshComponent* NewMasterBoneComponent,
bool bForceUpdate
)

  
Public function void

SetMaterialPreview ( int32 InMaterialIndexPreview
)

 Sets the value of the MaterialIndexPreview option.
Public function UFunction BlueprintCallable, Category void

SetMeshDeformer ( UMeshDeformer* InMeshDeformer
)

 Change the MeshDeformer that is used for this Component.
Protected function void

SetMeshDeformer ( bool bInSetMeshDeformer,
UMeshDeformer* InMeshDeformer
)

 Set the MeshDeformer and update the internal MeshDeformerInstance.
Public function UFunction BlueprintCallable, Category, Meta void

SetMinLOD ( int32 InNewMinLOD
)

 Set MinLodModel of the mesh component
Public function Virtual UFunction BlueprintCallable, Category void

SetPhysicsAsset ( UPhysicsAsset* NewPhysicsAsset,
bool bForceReInit
)

 Override the Physics Asset of the mesh.
Protected function Virtual void

SetPredictedLODLevel ( int32 InPredictedLODLevel
)

 Set predicted LOD level.
Public function Virtual void

SetRefPoseOverride ( const TArray< FTransform >& NewRefPoseTransforms
)

 Apply an override for the current mesh ref pose
Public function UFunction BlueprintCallable, Category void

SetRenderStatic ( bool bNewValue
)

 Set whether this skinned mesh should be rendered as static mesh in a reference pose
Public function void

SetSectionPreview ( int32 InSectionIndexPreview
)

 Sets the value of the SectionIndexPreview option.
Public function void

SetSelectedEditorMaterial ( int32 NewSelectedEditorMaterial
)

 Sets the value of the SelectedEditorMaterial option.
Public function void

SetSelectedEditorSection ( int32 NewSelectedEditorSection
)

 Sets the value of the SelectedEditorSection option.
Public function Virtual void

SetSkeletalMesh ( USkeletalMesh* NewMesh,
bool bReinitPose
)

 Change the SkeletalMesh that is rendered for this Component.
Public function void

SetSkinnedAsset ( USkinnedAsset* InSkinnedAsset
)

 Change the SkinnedAsset that is rendered without reinitializing this Component.
Public function Virtual UFunction BlueprintCallable, Category void

SetSkinnedAssetAndUpdate ( USkinnedAsset* NewMesh,
bool bReinitPose
)

 Change the SkinnedAsset that is rendered for this Component.
Public function UFunction BlueprintCallable, Category void

SetSkinWeightOverride ( int32 LODIndex,
const TArray< FSkelMeshSkinWeightInfo >& SkinWeights
)

 Allow override of skin weights on a per-component basis.
Public function UFunction BlueprintCallable, Category bool Set up an override skin weight profile for this component on the given layer.
Protected function bool Set the currently active skin weight profile stack to the given stack.
Public function void

SetVertexColorOverride ( int32 LODIndex,
const TArray< FColor >& VertexColors
)

 Allow override of vertex colors on a per-component basis.
Public function UFunction BlueprintCallable, Category, Meta void

SetVertexColorOverride_LinearColor ( int32 LODIndex,
const TArray< FLinearColor >& VertexColors
)

 Allow override of vertex colors on a per-component basis, taking array of Blueprint-friendly LinearColors.
Public function Virtual bool Function returns whether or not CPU skinning should be applied Allows the editor to override the skinning state for editor tools
Public function Const bool Get whether to draw this mesh's debug skeleton
Public function Virtual bool Function returns whether Nanite should be used to render and skin this mesh.
Public function Virtual Const bool Should tick pose (by calling TickPose) in Tick
Protected function Const bool Return true if it needs update. Return false if not
Public function Virtual Const bool

ShouldUpdateTransform ( bool bLODHasChanged
)

 Should update transform in Tick
Public function Const bool  
Public function UFunction BlueprintCallable, Category void Clear any material visibility modifications made by ShowMaterialSection
Public function UFunction BlueprintCallable, Category void

ShowMaterialSection ( int32 MaterialID,
int32 SectionIndex,
bool bShow,
int32 LODIndex
)

 Allows hiding of a particular material (by ID) on this instance of a SkeletalMesh.
Public function Virtual void

TickPose ( float DeltaTime,
bool bNeedsValidRootMotion
)

 Tick Pose, this function ticks and do whatever it needs to do in this frame, should be called before RefreshBoneTransforms
Public function UFunction BlueprintCallable, Category void

TransformFromBoneSpace ( FName BoneName,
FVector InPosition,
FRotator InRotation,
FVector& OutPosition,
FRotator& OutRotation
)

 Transform a location/rotation in bone relative space to world space.
Public function Const UFunction BlueprintCallable, Category void

TransformToBoneSpace ( FName BoneName,
FVector InPosition,
FRotator InRotation,
FVector& OutPosition,
FRotator& OutRotation
)

 Transform a location/rotation from world space to bone relative space.
Public function Virtual void

UnHideBone ( int32 BoneIndex
)

 Unhides the specified bone.
Public function UFunction BlueprintCallable, Category void

UnHideBoneByName ( FName BoneName
)

 UnHide the specified bone with name.
Public function UFunction BlueprintCallable, Category void

UnloadSkinWeightProfile ( FName InProfileName
)

 Unload a Skin Weight Profile's skin weight buffer (if created)
Public function Virtual void Unregister an OnBoneTransformsFinalized callback.
Public function UFunction BlueprintCallable, Category void Unset any MeshDeformer applied to this Component.
Public function Virtual void Update Follower Component. This gets called when LeaderPoseComponent!=nullptr
Public function void Update LeaderBoneMap for LeaderPoseComponent and this component
Public function Virtual bool Update the PredictedLODLevel and MaxDistanceFactor in the component from its MeshObject.
Protected function bool

UpdateLODStatus_Internal ( int32 InLeaderPoseComponentPredictedLODLevel,
bool bRequestedByLeaderPoseComponent
)

 Helper function for UpdateLODStatus, called with a valid index for InLeaderPoseComponentPredictedLODLevel when updating LOD status for follower components
Public function void  
Public function void Checks/updates material usage on proxy based on current morph target usage
Public function void Queues an update of the Skin Weight Buffer used by the current MeshObject
Public function Virtual void  
Public function Virtual void  

Overridden from UMeshComponent

  Type Name Description
Protected function Virtual Const UMaterialInterface * Get the default overlay material used by a mesh
Protected function Virtual Const float Get the default overlay material max draw distance
Public function Virtual Const bool

GetMaterialStreamingData ( int32 MaterialIndex,
FPrimitiveMaterialInfo& MaterialData
)

 Get the material info for texture streaming. Return whether the data is valid or not.
Public function Virtual bool

PrestreamMeshLODs ( float Seconds
)

 Tell the streaming system to start streaming in all LODs for the mesh.
Public function Virtual void

RegisterLODStreamingCallback ( FLODStreamingCallback&& Callback,
int32 LODIdx,
float TimeoutSecs,
bool bOnStreamIn
)

 Register a one-time callback that will be called when criteria met
Public function Virtual void

RegisterLODStreamingCallback ( FLODStreamingCallback&& CallbackStreamingStart,
FLODStreamingCallback&& CallbackStreamingDone,
float TimeoutStartSecs,
float TimeoutDoneSecs
)

 Register a one-time callback that will be called when streaming starts or ends.

Overridden from UPrimitiveComponent

  Type Name Description
Public function Virtual void Precache all PSOs which can be used by the component
Public function Virtual FPrimitiveSceneProxy * Creates a proxy to represent the primitive to the scene manager in the rendering thread.
Public function Virtual Const UMaterialInterface *

GetMaterial ( int32 ElementIndex
)

 Returns the material used by the element at the specified index
Public function Virtual Const int32

GetMaterialIndex ( FName MaterialSlotName
)

  
Public function Virtual Const TArray< FName >  
Public function Virtual Const int32 Return number of material elements in this primitive
Public function Virtual Const void

GetPrimitiveStats ( FPrimitiveStats& PrimitiveStats
)

  
Public function Virtual Const void Enumerates the streaming textures/meshes used by the primitive.
Public function Virtual Const float  
Public function Virtual Const void

GetUsedMaterials ( TArray< UMaterialInterface* >& OutMaterials,
bool bGetDebugMaterials
)

 Retrieves the materials used in this component
Public function Virtual Const bool

IsMaterialSlotNameValid ( FName MaterialSlotName
)

  

Overridden from USceneComponent

  Type Name Description
Public function Virtual Const FBoxSphereBounds

CalcBounds ( const FTransform& LocalToWorld
)

 Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.
Public function Virtual Const bool

DoesSocketExist ( FName InSocketName
)

 Return true if socket with the given name exists
Public function Virtual bool

GetMaterialPropertyPath ( int32 ElementIndex,
UObject*& OutOwner,
FString& OutPropertyPath,
FProperty*& OutProperty
)

 Returns full material property path and UObject owner property object Path examples: Material property path with array element and inner struct Materials[0].InnerStruct.Material Material property path with array element Materials[0] Simple material property path Materials
Public function Virtual Const FTransform

GetSocketTransform ( FName InSocketName,
ERelativeTransformSpace TransformSpace
)

 Get world-space socket transform.
Public function Virtual Const bool Returns true if this component has any sockets
Public function Virtual Const void Get a list of sockets this component contains
Public function Virtual void Update the Bounds of the component.
Public function Virtual bool

UpdateOverlapsImpl ( const TOverlapArrayView* NewPendingOverlaps,
bool bDoNotifies,
const TOverlapArrayView* OverlapsAtEndLocation
)

 Queries world and updates overlap tracking state for this component.

Overridden from UActorComponent

  Type Name Description
Protected function Virtual Const UObject const * Give a readable name for this component, including asset name if applicable
Protected function Virtual void Used to detach physics objects before simulation begins.
Protected function Virtual void Used to create any rendering thread information for this component
Protected function Virtual void Used to shut down any rendering thread structure for this component
Protected function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Protected function Virtual void Called when a component is unregistered.
Protected function Virtual Const bool Return true if this component requires end of frame recreates to happen from the game thread.
Protected function Virtual void Called to send dynamic data for this component to the rendering thread
Protected function Virtual void

TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

 Function called every frame on this ActorComponent.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

 Called by the editor to query whether a property of this object is allowed to be modified.
Public function Virtual Const FString This function actually does the work for the GetDetailedInfo() and is virtual.
Public function Virtual void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

 Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from IInterface_AsyncCompilation

  Type Name Description
Public function Virtual Const bool Returns whether this component is still being compiled or dependent on other objects being compiled.

Classes

  Type Name Description
Protected struct FMissingLeaderBoneCacheEntry Cached relative transform for follower bones that are missing in the leader  

Enums

  Type Name Description
Private enum EBoneTransformUpdateMethod    

Deprecated Variables

  Type Name Description
Protected variable UProperty Category, Meta BlueprintReadOnly Transient blueprintgetter TObjectPtr< UMeshDeformerInstance > MeshDeformerInstance_DEPRECATED  
Public variable UProperty FColor WireframeColor_DEPRECATED Wireframe color

Deprecated Functions

  Type Name Description
Public function Const UFunction BlueprintPure, Category, Meta displayname USkeletalMesh * Get the SkeletalMesh rendered for this mesh.
Public function void  

See Also

USkeletalMeshComponent

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page