Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > FSkeletalMeshSceneProxy

Light Theme

Dark Theme

FSkeletalMeshSceneProxy

A skeletal mesh component scene proxy.

Windows

MacOS

Linux

Inheritance Hierarchy

FPrimitiveSceneProxy

FSkeletalMeshSceneProxy

FDebugSkelMeshSceneProxy

References

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

Syntax

class FSkeletalMeshSceneProxy : public FPrimitiveSceneProxy

Remarks

A skeletal mesh component scene proxy.

Variables

	Name	Description
uint8: 1	bCanHighlightSelectedSections
uint8: 1	bDrawDebugSkeleton
uint8: 1	bForceWireframe	Data copied for rendering
uint8: 1	bIsCPUSkinned
bool	bMaterialsNeedMorphUsage_GameThread
uint8: 1	bRenderStatic
TOptional< FLin...	DebugDrawColor	The color we draw this component in if drawing debug bones
TEnumAsByte< ER...	FeatureLevel
TArray< FLODSec...	LODSections	Array of section elements for each LOD
FMaterialReleva...	MaterialRelevance
TSet< UMaterial...	MaterialsInUse_GameThread	Set of materials used by this scene proxy, safe to access from the game thread.
FSkeletalMeshOb...	MeshObject
AActor *	Owner
UPhysicsAsset &...	PhysicsAssetForDebug
FBoxSphereBound...	PreSkinnedLocalBounds	The primitive's pre-skinned local space bounds.
TArray< uint16 ...	ShadowCapsuleBoneIndices
TArray< TPair< ...	ShadowCapsuleData	BoneIndex->capsule pairs used for rendering sphere/capsule shadows Note that these are in refpose component space, NOT bone space.
const USkeletal...	SkeletalMeshForDebug	The points to the skeletal mesh and physics assets are purely for debug purposes.
FSkeletalMeshRe...	SkeletalMeshRenderData
float	StreamingDistanceMultiplier	The component streaming distance multiplier

Constructors

	Name	Description
	FSkeletalMeshSceneProxy ( const USkinnedMeshComponent* C..., FSkeletalMeshRenderData* InSke... )	Constructor.

Functions

	Name	Description
void	DebugDrawPhysicsAsset ( int32 ViewIndex, FMeshElementCollector& Collector, const FEngineShowFlags& EngineShow... )	Render physics asset for debug display
void	DebugDrawSkeleton ( int32 ViewIndex, FMeshElementCollector& Collector, const FEngineShowFlags& EngineShow... )	Render the bones of the skeleton for debug display
uint32	GetAllocatedSize()
uint8	GetCurrentFirstLODIdx_Internal()	Only call on render thread timeline
int32	GetCurrentLODIndex()	Util for getting LOD index currently used by this SceneProxy.
void	GetDynamicElementsSection ( const TArray< const FSceneView*..., const FSceneViewFamily& ViewFamily, uint32 VisibilityMap, const FSkeletalMeshLODRenderData& ..., const int32 LODIndex, const int32 SectionIndex, bool bSectionSelected, const FSectionElementInfo& Section..., bool bInSelectable, FMeshElementCollector& Collector )
bool	GetMaterialTextureScales ( int32 LODIndex, int32 SectionIndex, const FMaterialRenderProxy* Ma..., FVector4* OneOverScales, FIntVector4* UVChannelIndices )
void	GetMeshElementsConditionallySelectable ( const TArray< const FSceneView*..., const FSceneViewFamily& ViewFamily, bool bInSelectable, uint32 VisibilityMap, FMeshElementCollector& Collector )
const TArray...	GetMeshObjectReferenceToLocalMatrices()
const TIndir...	GetSkeletalMeshRenderDataLOD()
const TArray...	GetSortedShadowBoneIndices()	Returns a pre-sorted list of shadow capsules's bone indicies
bool	GetWorldMatrices ( FMatrix& OutLocalToWorld, FMatrix& OutWorldToLocal )	Returns the world transform to use for drawing. Returns the world transform to use for drawing.
void	UpdateMorphMaterialUsage_GameThread ( TArray< UMaterialInterface* > ... )	Updates morph material usage for materials referenced by each LOD entry

Overridden from FPrimitiveSceneProxy

	Name	Description
bool	CanBeOccluded()
HHitProxy &#...	CreateHitProxies ( UPrimitiveComponent* Component, TArray< TRefCountPtr< HHitProxy > >... )	Creates the hit proxies are used when DrawDynamicElements is called. Called in the game thread.
void	DrawStaticElements ( FStaticPrimitiveDrawInterface*... )	Draws the primitive's static elements.
uint8	GetCurrentFirstLODIdx_RenderThread()
void	GetDynamicMeshElements ( const TArray< const FSceneView*..., const FSceneViewFamily& ViewFamily, uint32 VisibilityMap, FMeshElementCollector& Collector )	Gathers the primitive's dynamic mesh elements.
uint32	GetMemoryFootprint()	Every derived class should override these functions
bool	GetMeshUVDensities ( int32 LODIndex, int32 SectionIndex, FVector4& WorldUVDensities )	Get mesh UV density for a LOD-section.
void	GetPreSkinnedLocalBounds ( FBoxSphereBounds& OutBounds )	Return the bounds for the pre-skinned primitive in local space
bool	GetPrimitiveDistance ( int32 LODIndex, int32 SectionIndex, const FVector& ViewOrigin, float& PrimitiveDistance )	Get primitive distance to view origin for a given LOD-section.
void	GetShadowShapes ( TArray< FCapsuleShape >& CapsuleSh... )	Gathers shadow shapes from this proxy.
SIZE_T	GetTypeHash()	Return a type (or subtype) specific hash for sorting purposes
FPrimitiveVi...	GetViewRelevance ( const FSceneView* View )	Relevance is always dynamic for skel meshes unless they are disabled
bool	HasDynamicIndirectShadowCasterRepresentation()
bool	IsUsingDistanceCullFade()
void	OnTransformChanged()	Called to notify the proxy when its transform has been updated.

Classes

	Name	Description
	FLODSectionElements	Section elements for a particular LOD
	FSectionElementInfo	Info for section element in an LOD

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss