1. Epic GamesDeveloper
  3. FSkeletalMeshSceneProxy

FSkeletalMeshSceneProxy

A skeletal mesh component scene proxy.

Unreal Engine C++ API Reference > Runtime > Engine

Inheritance Hierarchy

References

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

Syntax

class FSkeletalMeshSceneProxy : public FPrimitiveSceneProxy

Remarks

A skeletal mesh component scene proxy.

Variables

  Type Name Description
Protected variable uint8: 1 bCanHighlightSelectedSections  
Protected variable uint8: 1 bDrawDebugSkeleton  
Protected variable uint8: 1 bForceWireframe Data copied for rendering
Protected variable uint8: 1 bIsCPUSkinned  
Protected variable bool bMaterialsNeedMorphUsage_GameThread  
Protected variable uint8: 1 bRenderStatic  
Protected variable TOptional< FLinearColor > DebugDrawColor The color we draw this component in if drawing debug bones
Protected variable TEnumAsByte< ERHIFeatureLevel::Type > FeatureLevel  
Protected variable TArray< FLODSectionElements > LODSections Array of section elements for each LOD
Protected variable FMaterialRelevance MaterialRelevance  
Protected variable TSet< UMaterialInterface * > MaterialsInUse_GameThread Set of materials used by this scene proxy, safe to access from the game thread.
Protected variable FSkeletalMeshObject * MeshObject  
Protected variable UMaterialInterface * OverlayMaterial  
Protected variable float OverlayMaterialMaxDrawDistance  
Protected variable AActor * Owner  
Protected variable UPhysicsAsset * PhysicsAssetForDebug  
Public variable FPoseWatchDynamicData * PoseWatchDynamicData  
Protected variable FBoxSphereBounds PreSkinnedLocalBounds The primitive's pre-skinned local space bounds.
Protected variable TArray< uint16 > ShadowCapsuleBoneIndices  
Protected variable TArray< TPair< int32, FCapsuleShape > > ShadowCapsuleData BoneIndex->capsule pairs used for rendering sphere/capsule shadows Note that these are in refpose component space, NOT bone space.
Protected variable const USkinnedAsset * SkeletalMeshForDebug The points to the skeletal mesh and physics assets are purely for debug purposes.
Protected variable FSkeletalMeshRenderData * SkeletalMeshRenderData  
Protected variable float StreamingDistanceMultiplier The component streaming distance multiplier

Constructors

  Type Name Description
Public function  

FSkeletalMeshSceneProxy ( const USkinnedMeshComponent* Component,
FSkeletalMeshRenderData* InSkelMeshRenderData
)

 Constructor.

Functions

  Type Name Description
Public function Virtual Const void

DebugDrawPhysicsAsset ( int32 ViewIndex,
FMeshElementCollector& Collector,
const FEngineShowFlags& EngineShowFlags
)

 Render physics asset for debug display
Public function Const void

DebugDrawPoseWatchSkeletons ( int32 ViewIndex,
FMeshElementCollector& Collector,
const FEngineShowFlags& EngineShowFlags
)

  
Public function Const void

DebugDrawSkeleton ( int32 ViewIndex,
FMeshElementCollector& Collector,
const FEngineShowFlags& EngineShowFlags
)

 Render the bones of the skeleton for debug display
Public function Const SIZE_T  
Public function Const bool

GetCachedGeometry ( FCachedGeometry& OutCachedGeometry
)

  
Protected function Const uint8 Only call on render thread timeline
Public function int32 Util for getting LOD index currently used by this SceneProxy.
Protected function Const void

GetDynamicElementsSection ( const TArray< const FSceneView* >& Views,
const FSceneViewFamily& ViewFamily,
uint32 VisibilityMap,
const FSkeletalMeshLODRenderData& LODData,
const int32 LODIndex,
const int32 SectionIndex,
bool bSectionSelected,
const FSectionElementInfo& SectionElementInfo,
bool bInSelectable,
FMeshElementCollector& Collector
)

  
Public function Virtual Const bool

GetMaterialTextureScales ( int32 LODIndex,
int32 SectionIndex,
const FMaterialRenderProxy* MaterialRenderProxy,
FVector4f* OneOverScales,
FIntVector4* UVChannelIndices
)

  
Protected function Const void

GetMeshElementsConditionallySelectable ( const TArray< const FSceneView* >& Views,
const FSceneViewFamily& ViewFamily,
bool bInSelectable,
uint32 VisibilityMap,
FMeshElementCollector& Collector
)

  
Public function Const const FSkeletalMeshObject *  
Public function Const const TArray< uint16 > & Returns a pre-sorted list of shadow capsules's bone indicies
Public function Const bool

GetWorldMatrices ( FMatrix& OutLocalToWorld,
FMatrix& OutWorldToLocal
)

 Returns the world transform to use for drawing. Returns the world transform to use for drawing.
Public function void Updates morph material usage for materials referenced by each LOD entry

Overridden from FPrimitiveSceneProxy

  Type Name Description
Public function Virtual Const bool  
Public function Virtual HHitProxy *

CreateHitProxies ( UPrimitiveComponent* Component,
TArray< TRefCountPtr< HHitProxy > >& OutHitProxies
)

 Creates the hit proxies are used when DrawDynamicElements is called. Called in the game thread.
Public function Virtual void Draws the primitive's static elements.
Public function Virtual Const uint8  
Public function Virtual Const void

GetDynamicMeshElements ( const TArray< const FSceneView* >& Views,
const FSceneViewFamily& ViewFamily,
uint32 VisibilityMap,
FMeshElementCollector& Collector
)

 Gathers the primitive's dynamic mesh elements.
Public function Virtual Const uint32 Every derived class should override these functions
Public function Virtual Const bool

GetMeshUVDensities ( int32 LODIndex,
int32 SectionIndex,
FVector4& WorldUVDensities
)

 Get mesh UV density for a LOD-section.
Public function Virtual Const void

GetPreSkinnedLocalBounds ( FBoxSphereBounds& OutBounds
)

 Return the bounds for the pre-skinned primitive in local space
Public function Virtual Const bool

GetPrimitiveDistance ( int32 LODIndex,
int32 SectionIndex,
const FVector& ViewOrigin,
float& PrimitiveDistance
)

 Get primitive distance to view origin for a given LOD-section.
Public function Virtual Const void

GetShadowShapes ( FVector PreViewTranslation,
TArray< FCapsuleShape3f >& OutCapsuleShapes
)

 Gathers shadow shapes from this proxy.
Public function Virtual Const SIZE_T Return a type (or subtype) specific hash for sorting purposes
Public function Virtual Const FPrimitiveViewRelevance

GetViewRelevance ( const FSceneView* View
)

 Relevance is always dynamic for skel meshes unless they are disabled
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual void Called to notify the proxy when its transform has been updated.

Classes

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page