BoneReference.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "BoneIndices.h"
#include "BoneReference.generated.h"
 
struct FBoneContainer;
class USkeleton;
 
USTRUCT()
struct FBoneReference
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(EditAnywhere, Category = BoneReference)
    FName BoneName;
 
    int32 BoneIndex:31;
 
    uint32 bUseSkeletonIndex:1;
 
    FCompactPoseBoneIndex CachedCompactPoseIndex;
 
    FBoneReference()
        : BoneName(NAME_None)
        , BoneIndex(INDEX_NONE)
        , bUseSkeletonIndex(false)
        , CachedCompactPoseIndex(INDEX_NONE)
    {
    }
 
    FBoneReference(const FName& InBoneName)
        : BoneName(InBoneName)
        , BoneIndex(INDEX_NONE)
        , bUseSkeletonIndex(false)
        , CachedCompactPoseIndex(INDEX_NONE)
    {
    }
 
    bool operator==(const FBoneReference& Other) const
    {
        return BoneName == Other.BoneName;
    }
 
    bool operator!=(const FBoneReference& Other) const
    {
        return BoneName != Other.BoneName;
    }
 
    ENGINE_API bool Initialize(const FBoneContainer& RequiredBones);
 
    // only used by blendspace 'PerBoneBlend'. This is skeleton indices since the input is skeleton
    // @note, if you use this function, it won't work with GetCompactPoseIndex, GetMeshPoseIndex;
    // it triggers ensure in those functions
    ENGINE_API bool Initialize(const USkeleton* Skeleton);
 
    void Reset()
    {
        BoneName = NAME_None;
        InvalidateCachedBoneIndex();
    }
 
    bool HasValidSetup() const
    {
        return (BoneIndex != INDEX_NONE);
    }
 
    ENGINE_API bool IsValidToEvaluate(const FBoneContainer& RequiredBones) const;
    bool IsValidToEvaluate() const
    {
        return (!bUseSkeletonIndex && CachedCompactPoseIndex != INDEX_NONE);
    }
 
    void InvalidateCachedBoneIndex()
    {
        BoneIndex = INDEX_NONE;
        CachedCompactPoseIndex = FCompactPoseBoneIndex(INDEX_NONE);
    }
 
    ENGINE_API FSkeletonPoseBoneIndex GetSkeletonPoseIndex(const FBoneContainer& RequiredBones) const;
    
    ENGINE_API FMeshPoseBoneIndex GetMeshPoseIndex(const FBoneContainer& RequiredBones) const;
 
    ENGINE_API FCompactPoseBoneIndex GetCompactPoseIndex(const FBoneContainer& RequiredBones) const;
 
    // need this because of BoneReference being used in CurveMetaData and that is in SmartName
    ENGINE_API friend FArchive& operator<<(FArchive& Ar, FBoneReference& B);
 
    ENGINE_API bool Serialize(FArchive& Ar);
};