1. Epic GamesDeveloper
  3. UDebugSkelMeshComponent

UDebugSkelMeshComponent

API > API/Editor > API/Editor/UnrealEd > API/Editor/UnrealEd/Animation

Inheritance Hierarchy

References

   
Module UnrealEd
Header /Engine/Source/Editor/UnrealEd/Classes/Animation/DebugSkelMeshComponent.h
Include #include "Animation/DebugSkelMeshComponent.h"

Syntax

class UDebugSkelMeshComponent : public USkeletalMeshComponent

Variables

  Type Name Description
Public variable TArray< FTransform > AdditiveBasePoses Storage of Additive Base Pose for when bDisplayAdditiveBasePose == true, as they have to be calculated
Public variable TArray< FAnimNotifyErrors > AnimNotifyErrors  
Public variable TArray< FTransform > BakedAnimationPoses Storage of Baked Animation Pose for when bDisplayBakedAnimation == true, as they have to be calculated
Public variable bool bClothCullBackface  
Public variable bool bClothFlipNormal  
Public variable uint32: 1 bDisplayAdditiveBasePose Display additive base bone transform
Public variable uint32: 1 bDisplayBakedAnimation Display baked animation pose
Public variable bool bDisplayBound Display Bound
Public variable uint32: 1 bDisplayNonRetargetedPose Display non retargeted animation pose
Public variable uint32: 1 bDisplayRawAnimation Display raw animation bone transform
Public variable uint32: 1 bDisplaySourceAnimation Display source animation pose
Public variable bool bDisplayVertexColors  
Public variable uint32: 1 bDrawAttributes Attribute visualization
Public variable uint32: 1 bDrawBinormals Vertex binormal viewing
Public variable uint32: 1 bDrawBoneInfluences Bone influences viewing
Public variable uint32: 1 bDrawMesh If true then the skeletal mesh associated with the component is drawn.
Public variable uint32: 1 bDrawMorphTargetVerts Morphtarget viewing
Public variable uint32: 1 bDrawNormals Vertex normal viewing
Public variable uint32: 1 bDrawSockets Socket hit points viewing
Public variable uint32: 1 bDrawTangents Vertex tangent viewing
Public variable bool bIsUsingInGameBounds Does this component use in game bounds or does it use bounds calculated from bones
Public variable bool bIsUsingPreSkinnedBounds Does this component use pre-skinned bounds? This overrides other bounds settings
Public variable uint32: 1 bMeshSocketsVisible Mesh sockets visible?
Public variable float BoneRadiusMultiplier Multiplier for the bone radius rendering
Public variable TArray< int32 > BonesOfInterest Array of bones to render bone weights for
Public variable bool bPauseClothingSimulationWithAnim  
Public variable bool bPerformSingleClothingTick Base skel mesh has support for suspending clothing, but single ticks are more of a debug feature when stepping through an animation So we control that using this flag
Public variable uint32: 1 bRequiredBonesUpToDateDuringTick  
Public variable uint32: 1 bShowBoneNames If true then the bone names associated with the skeletal mesh are displayed
Public variable uint32: 1 bShowClothData  
Public variable uint32: 1 bSkeletonSocketsVisible Skeleton sockets visible?
Public variable bool bTrackAttachedInstanceLOD Should the LOD of the debug mesh component track the LOD of the instance being debugged
Public variable FBoxSphereBounds CachedClothBounds Bounds computed from cloth.
Public variable float ClothMeshOpacity  
Public variable float ConsumeRootMotionPreviousPlaybackTime Playback time last time ConsumeRootmotion was called
Public variable float MaxClothPropertyView  
Public variable float MinClothPropertyView  
Public variable TArray< TObjectPtr< class UMorphTarget > > MorphTargetOfInterests Array of morphtargets to render verts for
Public variable TArray< FTransform > NonRetargetedSpaceBases Storage for non retargeted pose.
Public variable TObjectPtr< class UAnimPreviewInstance > PreviewInstance  
Public variable EProcessRootMotionMode ProcessRootMotionMode Process root motion mode
Public variable TObjectPtr< class UAnimInstance > SavedAnimScriptInstance  
Public variable FGuid SelectedClothingGuidForPainting The currently selected asset guid if we're painting, used to build dynamic mesh to paint sim parameters
Public variable int32 SelectedClothingLodForPainting The currently selected LOD for painting
Public variable int32 SelectedClothingLodMaskForPainting The currently selected mask inside the above LOD to be painted
Public variable ESkeletonDrawMode SkeletonDrawMode Global drawing mode for this skeleton. Depends on context of specific editor using the component.
Public variable TArray< TObjectPtr< class UMaterialInterface > > SkelMaterials Array of materials to restore when not rendering blend weights
Public variable TArray< FVector3f > SkinnedSelectedClothingNormals  
Public variable TArray< FVector3f > SkinnedSelectedClothingPositions  
Public variable TArray< FTransform > SourceAnimationPoses Storage of Source Animation Pose for when bDisplaySourceAnimation == true, as they have to be calculated
Public variable EPersonaTurnTableMode::Type TurnTableMode Current turn table mode
Public variable float TurnTableSpeedScaling Current turn table speed scaling
Public variable TArray< FTransform > UncompressedSpaceBases Non Compressed SpaceBases for when bDisplayRawAnimation == true
Public variable FLinearColor WireframeMeshOverlayColor  

Constructors

  Type Name Description
Public function  

UDebugSkelMeshComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const FBoxSphereBounds

CalcGameBounds ( const FTransform& LocalToWorld
)

 Get the in-game bounds of the skeleton mesh
Public function Virtual Const bool  
Public function Const bool

CanUseProcessRootMotionMode ( EProcessRootMotionMode Mode
)

 Whether the supplied root motion mode can be used for the current asset
Public function bool Test if in-game bounds are as big as preview bounds
Public function void

ConsumeRootMotion ( const FVector& FloorMin,
const FVector& FloorMax
)

 Update components position based on animation root motion
Public function Virtual TObjectPtr< UAnimPreviewInstance > Create the preview instance to use (default UAnimPreviewInstance)
Public function void Force all body instance to not simulate physics regardless of their physic type To get back in a default state call : ResetAllBodiesSimulatePhysics
Public function Const bool Whether the current asset or animation blueprint is using root motion
Public function Virtual void

EnablePreview ( bool bEnable,
UAnimationAsset* PreviewAsset
)

  
Public function Virtual Const const TArray< FBoneIndexType > & Return bone indices to draw
Public function Virtual Const FTransform

GetDrawTransform ( int32 BoneIndex
)

 Returns the transform of the joint
Public function Const const TArray< FGetExtendedViewportText > &  
Public function IClothingSimulation * To normal game/runtime code we don't want to expose a non-const pointer to the simulation, so we can only get one from this editor-only component.
Public function Virtual Const int32  
Public function Const FString  
Public function Const EProcessRootMotionMode Gets process root motion mode
Public function Virtual Const const FReferenceSkeleton & Return RefSkeleton for drawing;
Public function Const FLinearColor Get the wireframe mesh overlay color, which basically controls the color of the wireframe.
Public function Virtual Const bool Return true if currently preview animation asset is on
Public function Const bool Whether we are processing root motion or not
Public function Virtual Const bool  
Public function Const bool Whether the current LOD of the debug mesh is being synced with the attached (preview) mesh instance.
Public function Const bool Does it use in-game bounds or bounds calculated from bones
Public function Const bool Does it use pre-skinned bounds
Public function void  
Public function FDelegateHandle

RegisterExtendedViewportTextDelegate ( const FGetExtendedViewportText& InDelegate
)

 Extended viewport text delegate handling.
Public function FDelegateHandle

RegisterOnDebugForceLODChangedDelegate ( const FOnDebugForceLODChanged& InDelegate
)

  
Public function void Fixes up the disabled flags so clothing is enabled and originals are disabled as ToggleMeshSectionForCloth will make these get out of sync
Public function void Restore all section visibilities to original states for all LODs
Public function Virtual void Define Custom Default pose for this component for preview
Public function void

SetDebugForcedLOD ( int32 InNewForcedLOD
)

 Helper method that sets the forced lod.
Public function void

SetMeshSectionVisibilityForCloth ( FGuid InClothGuid,
bool bVisibility
)

 Find a section using a clothing asset with the given GUID and set its visiblity
Public function void

SetProcessRootMotionMode ( EProcessRootMotionMode Mode
)

 Sets process root motion mode. Note: disabling root motion preview resets transform.
Public function void

SetShowBoneWeight ( bool bNewShowBoneWeight
)

 Update material information depending on color render mode Refresh/replace materials
Public function void

SetShowClothProperty ( bool bState
)

 Sets the flag used to determine whether or not the current active cloth sim mesh should be rendered
Public function void

SetShowMorphTargetVerts ( bool bNewShowMorphTargetVerts
)

 Update material information depending on color render mode Refresh/replace materials
Public function void Set the wireframe mesh overlay color, which basically controls the color of the wireframe.
Public function Virtual void

ShowReferencePose ( bool bRefPose
)

 Reference pose for this component we don't want to use default refpose because you still want to move joint when this mode is on
Public function void

ToggleClothSectionsVisibility ( bool bShowOnlyClothSections
)

 Toggle visibility between cloth sections and non-cloth sections for all LODs if bShowOnlyClothSections is true, shows only cloth sections.
Public function void  
Public function void  
Public function void

UseInGameBounds ( bool bUseInGameBounds
)

 Set to use in-game bounds or bounds calculated from bones
Public function void

UsePreSkinnedBounds ( bool bUsePreSkinnedBounds
)

 Set to use pre-skinned bounds

Overridden from USkeletalMeshComponent

  Type Name Description
Public function Virtual void To avoid clothing reset while modifying properties in Persona
Public function Virtual void

ClearAnimNotifyErrors ( UObject* InSourceNotify
)

 Clears currently stored errors. Call before triggering anim notifies for a particular mesh.
Public function Virtual void

InitAnim ( bool bForceReinit
)

 Animation
Public function Virtual Const bool  
Public function Virtual void  
Public function Virtual void

ReportAnimNotifyError ( const FText& Error,
UObject* InSourceNotify
)

 Subclasses such as DebugSkelMeshComponent keep track of errors in the anim notifies so they can be displayed to the user.
Public function Virtual void

SetAnimClass ( UClass* NewClass
)

 Set the anim instance class.
Protected function Virtual Const bool Overridden to support single clothing ticks.

Overridden from USkinnedMeshComponent

  Type Name Description
Public function Virtual Const int32 Get the LOD Bias of this component
Public function Virtual void Function to operate on mesh object after its created, but before it's attached.
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 Virtual bool Function returns whether or not CPU skinning should be applied Allows the editor to override the skinning state for editor tools

Overridden from UPrimitiveComponent

  Type Name Description
Public function Virtual FPrimitiveSceneProxy * Creates a proxy to represent the primitive to the scene manager in the rendering thread.
Public function Virtual Const void

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

 Retrieves the materials used in this component
Public function Virtual Const bool Engine only draw bounds IF selected

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.

Overridden from UActorComponent

  Type Name Description
Protected function Virtual void Called to send dynamic data for this component to the rendering thread
Public function Virtual void

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

 Function called every frame on this ActorComponent.

Classes

  Type Name Description
Public struct FAnimNotifyErrors TODO - This is a really poor way to post errors to the user. Work out a better way.  

Deprecated Variables

  Type Name Description
Public variable uint32: 1 bPreviewRootMotion_DEPRECATED This variable is no longer used. Use ProcessRootMotionMode instead.

Deprecated Functions

  Type Name Description
Public function Const bool Please use IsProcessingRootMotion or GetProcessRootMotionMode
Public function void

RebuildClothingSectionsFixedVerts ( bool bInvalidateDerivedDataCache
)

 This function is redundant, since it is always called after ApplyParameterMasks and therefore will be removed.
Public function void

SetPreviewRootMotion ( bool bInPreviewRootMotion
)

 Please use SetProcessRootMotionMode
Public function Virtual void

SetSkeletalMesh ( USkeletalMesh* NewMesh,
bool bReinitPose
)

 Use USkeletalMeshComponent::SetSkeletalMesh() or SetSkinnedAssetAndUpdate() instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page