1. Epic GamesDeveloper
  3. FRetargetChainMapping

FRetargetChainMapping

API > API/Plugins > API/Plugins/IKRig

   
Name FRetargetChainMapping
Type struct
Header File /Engine/Plugins/Animation/IKRig/Source/IKRig/Public/Retargeter/IKRetargetChainMapping.h
Include Path #include "Retargeter/IKRetargetChainMapping.h"

Syntax

USTRUCT ()  
struct FRetargetChainMapping

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ChainMap TArray< FRetargetChainPair > Mapping of target to source bone chains by name NOTE: this is an array instead of a TMap because it needs to be sorted by hierarchy Retargeter/IKRetargetChainMapping.h  
SourceIKRig TObjectPtr< const UIKRigDefinition >   Retargeter/IKRetargetChainMapping.h  
TargetIKRig TObjectPtr< const UIKRigDefinition >   Retargeter/IKRetargetChainMapping.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AutoMapChains ( const EAutoMapChainType AutoMapType,
const bool bForceRemap
)

 Automatically map the source and target chains together Retargeter/IKRetargetChainMapping.h  

FRetargetChainPair * FindChainPair ( const FName& InChainName,
ERetargetSourceOrTarget InSourceOrTarget
) const

 Returns the chain pair belonging to the supplied chain or nullptr if not found Retargeter/IKRetargetChainMapping.h  

const FRetargetChainPair * FindChainPairConst ( const FName& InChainName,
ERetargetSourceOrTarget InSourceOrTarget
) const

   Retargeter/IKRetargetChainMapping.h  

FName GetChainMappedTo ( const FName InChainName,
ERetargetSourceOrTarget InSourceOrTarget
) const

 Get the name of the bone chain mapped to this chain. Retargeter/IKRetargetChainMapping.h  

TArray< FName > GetChainNames ( ERetargetSourceOrTarget InSourceOrTarget
) const

 Get the names of all the chains in either the source or target IK Rig Retargeter/IKRetargetChainMapping.h  
Get read-write access to the mapping from target to source chains (by name) Retargeter/IKRetargetChainMapping.h  
  Retargeter/IKRetargetChainMapping.h  

const UIKRigDefinition * GetIKRig ( ERetargetSourceOrTarget SourceOrTarget
)

 Get one of the IK Rigs used in this mapping Retargeter/IKRetargetChainMapping.h  

bool HasAnyChains()

 Returns true if any chains have been loaded, regardless of if they are mapped Retargeter/IKRetargetChainMapping.h  

bool HasChain ( const FName& InChainName,
ERetargetSourceOrTarget InSourceOrTarget
) const

 Check if the chain exists. Retargeter/IKRetargetChainMapping.h  

bool IsReady()

 Returns true if both a source and target IK Rig have been loaded Retargeter/IKRetargetChainMapping.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGS void LoadFromDeprecatedChainSettings ( const TArray< URetargetChainSettings* >& InChainSettings
)

   Retargeter/IKRetargetChainMapping.h  

void ReinitializeWithIKRigs ( const UIKRigDefinition* InSourceIKRig,
const UIKRigDefinition* InTargetIKRig
)

 Cleans the chain mapping to reflect the chains in the provided source/target IK Rigs NOTE: this will maintain existing mappings while removing unused ones and adding missing ones Retargeter/IKRetargetChainMapping.h  

void SetChainMapping ( const FName InTargetChainName,
const FName InSourceChainName
)

 Map target chain to a source chain. Retargeter/IKRetargetChainMapping.h  

void SortMapping()

 Sort mapping hierarchically (root to leaf based on Target IK Rig hierarchy) Retargeter/IKRetargetChainMapping.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page