Version: 1.8
LanguageEnglish
  • C#

TRetargeter

class in UnityEngine.Animations

/

Inherits from:Object

/

Implemented in:UnityEngine.AnimationModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

IK-assisted chain retargeter.

This class provides functionality for retargeting animations from a source character to a target character using IK techniques. It facilitates the mapping of bone chains and allows for the adjustment of root translations and rotations during the retargeting process.

See Also: BoneChain,TRig.

Properties

boneChainCountGets the total number of bone chains.
boneChainNamesGets the array of names for all bone chains.
FKRetargetIndicates whether the FK retargeting step is activated.
IKRetargetIndicates whether the IK retargeting step is activated.
isValidIndicates whether the asset is valid.
rootRetargetIndicates whether the root retargeting step is activated.
rootSettingsGets the root settings for retargeting.
rootTranslationGets the root translation offset for retargeting.
rootWeightRGets the weight of rotation applied during the root retargeting step.
rootWeightTGets the weight of translation applied during the root retargeting step.
sourceRootNameGets the root name of source character.
sourceTRigGets the source TRig used for retargeting.
targetRootNameGets the root name of target character.
targetTRigGets the target TRig used for retargeting.

Public Methods

ContainsChecks if a bone chain mapping contains the specified chain name.
GetSettingsGets the settings for the specified bone chain.
GetSourceChainIndexGets the index of the source chain based on the target chain name.
InitializeMappingIfNeededInitializes necessary mappings before retargeting.
SetSettingsSets the settings for the specified bone chain.
SetSourceChainIndexSets the index of the source chain for a given target chain index.

Inherited Members

Properties

hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.

Public Methods

GetInstanceIDGets the instance ID of the object.
ToStringReturns the name of the object.

Static Methods

DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindAnyObjectByTypeRetrieves any active loaded object of Type type.
FindFirstObjectByTypeRetrieves the first active loaded object of Type type.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsByTypeRetrieves a list of all loaded objects of Type type.
FindObjectsOfTypeGets a list of all loaded objects of Type type.
InstantiateClones the object original and returns the clone.
InstantiateAsyncCaptures a snapshot of the original object (that must be related to some GameObject) and returns the AsyncInstantiateOperation.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.