1. Epic GamesDeveloper
  3. UIKRetargeter

UIKRetargeter

API > API/Plugins > API/Plugins/IKRig > API/Plugins/IKRig/Retargeter

Inheritance Hierarchy

References

   
Module IKRig
Header /Engine/Plugins/Animation/IKRig/Source/IKRig/Public/Retargeter/IKRetargeter.h
Include #include "Retargeter/IKRetargeter.h"

Syntax

UCLASS&40;BlueprintType&41;  
class UIKRetargeter : public UObject

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere bool bDebugDraw Toggle debug drawing for retargeting in the viewport.
Public variable UProperty Category, EditAnywhere bool bDrawFinalGoals Draw final IK goal locations.
Public variable UProperty Category, EditAnywhere bool bDrawSourceLocations Draw goal locations from source skeleton.
Public variable UProperty float BoneDrawSize The visual size of the bones in the viewport (saved between sessions). This is set from the viewport Character>Bones menu.
Public variable UProperty Category, EditAnywhere float ChainDrawSize The visual size of the IK goals in the viewport.
Public variable UProperty Category, EditAnywhere float ChainDrawThickness The thickness of lines on the IK goals in the viewport.
Public variable UProperty Transient duplicatetransient, nontransactional TObjectPtr< UObject > Controller The controller responsible for managing this asset's data (all editor mutation goes through this)
Public variable UProperty Category, EditAnywhere FVector SourceMeshOffset The offset applied to the source mesh in the editor viewport.
Public variable UProperty Category, EditAnywhere FVector TargetMeshOffset The offset applied to the target mesh in the editor viewport.
Public variable UProperty Category, EditAnywhere, Meta float TargetMeshScale Scale the target mesh in the viewport for easier visualization next to the source.

Constructors

  Type Name Description
Public function  

UIKRetargeter ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Static void

DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutConstructClasses,
const UClass* SpecificSubclass
)

 END UObject.
Public function Const const TArray< TObjectPtr< URetargetChainSettings > > & Get read-only access to the chain mapping.
Public function Const const TObjectPtr< URetargetChainSettings >

GetChainMapByName ( const FName& TargetChainName
)

 Get read-only access to the chain map for a given chain (null if chain not in retargeter)
Public function Const const FTargetChainSettings *

GetChainSettingsByName ( const FName& TargetChainName
)

 Get read-only access to the chain settings for a given chain (null if chain not in retargeter)
Public function Static UFunction BlueprintCallable, BlueprintPure, Category FTargetChainSettings

GetChainSettingsFromRetargetAsset ( const UIKRetargeter* RetargetAsset,
const FName TargetChainName,
const FName OptionalProfileName
)

 Returns the chain settings associated with a given target chain in an IK Retargeter Asset using the given profile name (optional)
Public function Static UFunction BlueprintCallable, BlueprintPure, Category FTargetChainSettings

GetChainSettingsFromRetargetProfile ( FRetargetProfile& RetargetProfile,
const FName TargetChainName
)

 Returns the chain settings associated with a given target chain in the supplied Retarget Profile.
Public function Static UFunction BlueprintCallable, BlueprintPure, Category FTargetChainSettings

GetChainUsingGoalFromRetargetAsset ( const UIKRetargeter* RetargetAsset,
const FName IKGoalName
)

 Returns the chain settings associated with a given Goal in an IK Retargeter Asset using the given profile name (optional)
Public function Const const FRetargetProfile * Get the current retarget profile (may be null)
Public function Const const FIKRetargetPose * Get read-only access to a retarget pose.
Public function Const FName Get name of the current retarget pose.
Public function Static const FName Get name of default pose.
Public function Const const FRetargetGlobalSettings & Get access to the global settings itself.
Public function Static UFunction BlueprintCallable, BlueprintPure, Category void

GetGlobalSettingsFromRetargetAsset ( const UIKRetargeter* RetargetAsset,
const FName OptionalProfileName,
FRetargetGlobalSettings& OutSettings
)

 Returns the global settings in an IK Retargeter Asset using the given profile name (optional)
Public function Static UFunction BlueprintCallable, BlueprintPure, Category FRetargetGlobalSettings Returns the global settings in the supplied Retarget Profile.
Public function Const UIKRetargetGlobalSettings * Get access to the global settings uobject.
Public function Const const FRetargetProfile *

GetProfileByName ( const FName& ProfileName
)

 Get the retarget profile by name (may be null)
Public function Const const FIKRetargetPose *

GetRetargetPoseByName ( const ERetargetSourceOrTarget& SourceOrTarget,
const FName PoseName
)

 Get read-only access to a retarget pose.
Public function Static UFunction BlueprintCallable, BlueprintPure, Category void

GetRootSettingsFromRetargetAsset ( const UIKRetargeter* RetargetAsset,
const FName OptionalProfileName,
FTargetRootSettings& OutSettings
)

 Returns the root settings in an IK Retargeter Asset using the given profile name (optional)
Public function Static UFunction BlueprintCallable, BlueprintPure, Category FTargetRootSettings Returns the root settings in the supplied Retarget Profile.
Public function Const URetargetRootSettings * Get access to the root settings.
Public function Const const UIKRigDefinition * Get read-only access to the source IK Rig asset.
Public function Static const FName Get name of Source IK Rig property.
Public function Const UIKRigDefinition * Get read-write access to the source IK Rig asset.
Public function Static const FName Get name of Source Preview Mesh property.
Public function Const void

GetSpeedCurveNames ( TArray< FName >& OutSpeedCurveNames
)

 Get the names of the all the speed curves the retargeter will be looking for.
Public function Const const UIKRigDefinition * Get read-only access to the target IK Rig asset.
Public function Static const FName Get name of Target IK Rig property.
Public function Const UIKRigDefinition * Get read-write access to the target IK Rig asset.
Public function Static const FName Get name of Target Preview Mesh property.
Public function Static UFunction BlueprintCallable, Category void

SetChainFKSettingsInRetargetProfile ( FRetargetProfile& RetargetProfile,
const FTargetChainFKSettings& FKSettings,
const FName TargetChainName
)

 Set the chain FK settings in a retarget profile (will set bApplyChainSettings to true).
Public function Static UFunction BlueprintCallable, Category void

SetChainIKSettingsInRetargetProfile ( FRetargetProfile& RetargetProfile,
const FTargetChainIKSettings& IKSettings,
const FName TargetChainName
)

 Set the chain IK settings in a retarget profile (will set bApplyChainSettings to true).
Public function Static UFunction BlueprintCallable, Category void

SetChainSettingsInRetargetProfile ( FRetargetProfile& RetargetProfile,
const FTargetChainSettings& ChainSettings,
const FName TargetChainName
)

 Set the chain settings in a retarget profile (will set bApplyChainSettings to true).
Public function Static UFunction BlueprintCallable, Category void

SetChainSpeedPlantSettingsInRetargetProfile ( FRetargetProfile& RetargetProfile,
const FTargetChainSpeedPlantSettings& SpeedPlantSettings,
const FName TargetChainName
)

 Set the chain Speed Plant settings in a retarget profile (will set bApplyChainSettings to true).
Public function Static UFunction BlueprintCallable, Category void Set the global settings in a retarget profile (will set bApplyGlobalSettings to true).
Public function Static UFunction BlueprintCallable, Category void

SetRootSettingsInRetargetProfile ( FRetargetProfile& RetargetProfile,
const FTargetRootSettings& RootSettings
)

 Set the root settings in a retarget profile (will set bApplyRootSettings to true).

Overridden from UObject

  Type Name Description
Public function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

 UObject.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

  Type Name Description
Public variable UProperty bool bRetargetFK_DEPRECATED  
Public variable UProperty bool bRetargetIK_DEPRECATED  
Public variable UProperty bool bRetargetRoot_DEPRECATED  
Public variable UProperty float TargetActorOffset_DEPRECATED  
Public variable UProperty float TargetActorScale_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page