FIKRigSkeleton

Choose your operating system:

Windows

macOS

Linux

References

Module

IKRig

Header

/Engine/Plugins/Animation/IKRig/Source/IKRig/Public/IKRigSkeleton.h

Include

#include "IKRigSkeleton.h"

Syntax

USTRUCT()
struct FIKRigSkeleton

Variables

Name Description

Public variable UProperty Category visibleanywhere

TArray< FName >

 

BoneNames

Names of bones. Used to match hierarchy with runtime skeleton.

Public variable UProperty Category visibleanywhere

TArray< FTransf...

 

CurrentPoseGlobal

The current GLOBAL space pose of each bone.

Public variable UProperty Category visibleanywhere

TArray< FTransf...

 

CurrentPoseLocal

The current LOCAL space pose of each bone.

Public variable UProperty Category visibleanywhere

TArray< FName >

 

ExcludedBones

Sparse array of bones that are to be excluded from any solvers (parented around, treated as FK children).

Public variable UProperty Category visibleanywhere

TArray< int32 >

 

ParentIndices

Same length as BoneNames, stores index of parent for each bone.

Public variable UProperty Category visibleanywhere

TArray< FTransf...

 

RefPoseGlobal

The initial/reference GLOBAL space pose of each bone.

Functions

Name Description

Public function Static

void

 

ConvertLocalPoseToGlobal

(
    const TArray< int32 >& InParentInd...,
    const TArray< FTransform >& InLoca...,
    TArray< FTransform >& OutGlobalPos...
)

Public function Const

int32

 

GetBoneIndexFromName

(
    const FName InName
)

Public function Const

const FName ...

 

GetBoneNameFromIndex

(
    const int32 BoneIndex
)

Public function Const

int32

 

GetCachedEndOfBranchIndex

(
    const int32 InBoneIndex
)

Public function Const

void

 

GetChainsInList

(
    const TArray< int32 >& SelectedBon...,
    TArray< FIKRigSkeletonChain >& Out...
)

Public function Const

int32

 

GetChildIndices

(
    const int32 ParentBoneIndex,
    TArray< int32 >& Children
)

Public function Const

int32

 

GetParentIndex

(
    const int32 BoneIndex
)

Public function Const

int32

 

GetParentIndexThatIsNotExcluded

(
    const int32 BoneIndex
)

Public function Const

bool

 

IsBoneExcluded

(
    const int32 BoneIndex
)

Public function Const

bool

 

IsBoneInDirectLineage

(
    const FName& Child,
    const FName& PotentialParent
)

Public function Static

void

 

NormalizeRotations

(
    TArray< FTransform >& Transforms
)

Public function

void

 

PropagateGlobalPoseBelowBone

(
    const int32 BoneIndex
)

Public function

void

 

Reset()

Public function

void

 

SetInputSkeleton

(
    const FReferenceSkeleton& RefSkele...,
    const TArray< FName >& InExcludedB...
)

Public function

void

 

SetInputSkeleton

(
    const FIKRigInputSkeleton& InputSk...,
    const TArray< FName >& InExcludedB...
)

Public function

void

 

UpdateAllGlobalTransformFromLocal()

Public function

void

 

UpdateAllLocalTransformFromGlobal()

Public function

void

 

UpdateGlobalTransformFromLocal

(
    const int32 BoneIndex
)

Public function

void

 

UpdateLocalTransformFromGlobal

(
    const int32 BoneIndex
)