1. Epic GamesDeveloper
  3. FIKRigSkeleton

FIKRigSkeleton

API > API/Plugins > API/Plugins/IKRig > API/Plugins/IKRig/Rig

References

   
Module IKRig
Header /Engine/Plugins/Animation/IKRig/Source/IKRig/Public/Rig/IKRigSkeleton.h
Include #include "Rig/IKRigSkeleton.h"

Syntax

USTRUCT&40;&41;  
struct FIKRigSkeleton

Variables

  Type 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< FTransform > CurrentPoseGlobal The current GLOBAL space pose of each bone.
Public variable UProperty Category visibleanywhere TArray< FTransform > 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< FTransform > RefPoseGlobal The initial/reference GLOBAL space pose of each bone.

Functions

  Type Name Description
Public function Static void

ConvertLocalPoseToGlobal ( const TArray< int32 >& InParentIndices,
const TArray< FTransform >& InLocalPose,
TArray< FTransform >& OutGlobalPose
)

  
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 >& SelectedBones,
TArray< FBoneChain >& OutChains
)

  
Public function Const int32

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

  
Public function Const bool

GetMirroredBoneIndices ( const TArray< int32 >& BoneIndices,
TArray< int32 >& OutMirroredIndices
)

 Given a set of bones, returns a set of indices of bones that are mirrored across X axis (YZ plane) return false if any of the bones do not have a mirrored pair within the MaxDistanceThreshold
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 USkeletalMesh* SkeletalMesh,
const TArray< FName >& InExcludedBones
)

  
Public function void

SetInputSkeleton ( const FIKRigInputSkeleton& InputSkeleton,
const TArray< FName >& InExcludedBones
)

  
Public function void  
Public function void  
Public function void

UpdateGlobalTransformFromLocal ( const int32 BoneIndex
)

  
Public function void

UpdateLocalTransformFromGlobal ( const int32 BoneIndex
)

  
Public function Const bool

ValidateChainAndGetBones ( const FBoneChain& Chain,
TArray< int32 >& OutBoneIndices
)

 Get indices of bones in this chain, ordered from tip to root. returns false if chain is invalid.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page