SkeletalDebugRendering.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Engine/EngineTypes.h"
#include "BoneIndices.h"
 
struct FAnimNodePoseWatch;
class FPrimitiveDrawInterface;
struct FCompactHeapPose;
struct FReferenceSkeleton;
class HHitProxy;
 
namespace EBoneDrawMode
{
    enum Type
    {
        None,
        Selected,
        SelectedAndParents,
        SelectedAndChildren,
        SelectedAndParentsAndChildren,
        All,
        NumDrawModes
    };
};
 
struct FBoneAxisDrawConfig
{
    bool bDraw = false;
    float Thickness = 0.f;
    float Length = 0.f;
};
 
struct FSkelDebugDrawConfig
{
public:
    EBoneDrawMode::Type BoneDrawMode;
    float BoneDrawSize;
    bool bForceDraw;
    bool bAddHitProxy;
    bool bUseMultiColorAsDefaultColor;
    FLinearColor DefaultBoneColor;
    FLinearColor AffectedBoneColor;
    FLinearColor SelectedBoneColor;
    FLinearColor ParentOfSelectedBoneColor;
    FBoneAxisDrawConfig AxisConfig;
};
 
namespace SkeletalDebugRendering
{
    static const int32 NumSphereSides = 10;
    static const int32 NumConeSides = 4;
 
ENGINE_API void DrawWireBone(
    FPrimitiveDrawInterface* PDI,
    const FVector& InStart,
    const FVector& InEnd,
    const FLinearColor& InColor,
    ESceneDepthPriorityGroup InDepthPriority,
    const float SphereRadius = 1.f);
 
ENGINE_API void DrawAxes(
    FPrimitiveDrawInterface* PDI,
    const FTransform& InTransform,
    ESceneDepthPriorityGroup InDepthPriority,
    const float Thickness = 0.f,
    const float AxisLength = 4.f);
 
ENGINE_API  void DrawWireBoneAdvanced(
    FPrimitiveDrawInterface* PDI,
    const FTransform& InBoneTransform,
    const TArray<FVector>& InChildLocations,
    const TArray<FLinearColor>& InChildColors,
    const FLinearColor& InColor,
    ESceneDepthPriorityGroup InDepthPriority,
    const float SphereRadius,
    const FBoneAxisDrawConfig& InAxisConfig);
 
ENGINE_API  void DrawConeConnection(
    FPrimitiveDrawInterface* PDI,
    const FVector& Start,
    const FVector& End,
    const float SphereRadius,
    const FLinearColor& Color);
 
#if WITH_EDITOR
ENGINE_API void DrawBonesFromPoseWatch(
    FPrimitiveDrawInterface* PDI,
    const FAnimNodePoseWatch& PoseWatch,
    const bool bUseWorldTransform);
#endif
 
 
ENGINE_API void DrawBones(
    FPrimitiveDrawInterface* PDI,
    const FVector& ComponentOrigin,
    const TArray<FBoneIndexType>& RequiredBones,
    const FReferenceSkeleton& RefSkeleton,
    const TArray<FTransform>& WorldTransforms,
    const TArray<int32>& InSelectedBones,
    const TArray<FLinearColor>& BoneColors,
    const TArray<TRefCountPtr<HHitProxy>>& HitProxies,
    const FSkelDebugDrawConfig& DrawConfig);
 
/* Alternative signature that allows overriding the drawn bones that're computed from EBoneDrawMode */
ENGINE_API void DrawBones(
    FPrimitiveDrawInterface* PDI,
    const FVector& ComponentOrigin,
    const TArray<FBoneIndexType>& RequiredBones,
    const FReferenceSkeleton& RefSkeleton,
    const TArray<FTransform>& WorldTransforms,
    const TArray<int32>& InSelectedBones,
    const TArray<FLinearColor>& BoneColors,
    const TArray<TRefCountPtr<HHitProxy>>& HitProxies,
    const FSkelDebugDrawConfig& DrawConfig,
    const TBitArray<>& BonesToDrawOverride);
 
 
void DrawBonesInternal(
    FPrimitiveDrawInterface* PDI,
    const FVector& ComponentOrigin,
    const TArray<FBoneIndexType>& RequiredBones,
    const TArray<int32>& ParentIndices,
    const TArray<FTransform>& WorldTransforms,
    const TArray<int32>& InSelectedBones,
    const TArray<FLinearColor>& BoneColors,
    const TArray<TRefCountPtr<HHitProxy>>& HitProxies,
    const FSkelDebugDrawConfig& DrawConfig,
    const TBitArray<>& BonesToDrawOverride);
 
ENGINE_API FLinearColor GetSemiRandomColorForBone(const int32 BoneIndex, float Value=1.0f, float Saturation=0.75f);
ENGINE_API void FillWithMultiColors(TArray<FLinearColor>& BoneColors, const int32 NumBones);
 
ENGINE_API void CalculateBonesToDraw(
    const TArray<int32>& ParentIndices,
    const TArray<int32>& InSelectedBones,
    const EBoneDrawMode::Type BoneDrawMode,
    TBitArray<>& OutBonesToDraw);
}