1. Epic GamesDeveloper
  3. FRetargetProfile

FRetargetProfile

API > API/Plugins > API/Plugins/IKRig

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

Syntax

USTRUCT (BlueprintType )  
struct FRetargetProfile

Constructors

Name Remarks Include Path Unreal Specifiers

PRAGMA_DISABLE_DEPRECATION_WARNINGS FRetargetProfile ()

 Implicit copy assignment operator raises deprecation warnings (remove this once the deprecated properties are gone) Retargeter/IKRetargetProfile.h  
  Retargeter/IKRetargetProfile.h  
  Retargeter/IKRetargetProfile.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bApplyChainSettings PRAGMA_DISABLE_DEPRECATION_WARNINGSbool BEGIN DEPRECATED PROFILE SETTINGS NOTE: these are still stored and applied but should be removed and replaced with Op profiles NOTE: I cannot use the _DEPRECATED suffix on these properties because they live in a USTRUCT and UBT will complain that deprecated properties cannot be blueprint exposed without a getter but USTRUCT does not support UFUNCTIONS/getters (Deprecated) If true, the Chain Settings stored in this profile will be applied to the Retargeter (when plugged into the Retargeter). Retargeter/IKRetargetProfile.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Deprecated"
  • Meta=(DisplayName="Apply Chain Settings (Deprecated)")
bApplyGlobalSettings bool (Deprecated) If true, the global settings stored in this profile will be applied to the Retargeter (when plugged into the Retargeter). Retargeter/IKRetargetProfile.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Deprecated"
  • Meta=(DisplayName="Apply Global Settings (Deprecated)")
bApplyRootSettings bool (Deprecated) If true, the root settings stored in this profile will be applied to the Retargeter (when plugged into the Retargeter). Retargeter/IKRetargetProfile.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Deprecated"
  • Meta=(DisplayName="Apply Root Settings (Deprecated)")
bApplySourceRetargetPose bool If true, the Source Retarget Pose specified in this profile will be applied to the Retargeter (when plugged into the Retargeter). Retargeter/IKRetargetProfile.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Retarget Poses"
  • Meta=(DisplayName="Override Source Retarget Pose")
bApplyTargetRetargetPose bool If true, the TARGET Retarget Pose specified in this profile will be applied to the Retargeter (when plugged into the Retargeter). Retargeter/IKRetargetProfile.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Retarget Poses"
  • Meta=(DisplayName="Override Target Retarget Pose")
bForceAllIKOff bool Globally forces all IK solving off Retargeter/IKRetargetProfile.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="IK Retarget Settings"
  • DisplayName="Force All IK Off"
ChainSettings TMap< FName, FTargetChainSettings > (Deprecated) A (potentially sparse) set of setting overrides for the target chains (only applied when bApplyChainSettings is true). Retargeter/IKRetargetProfile.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Deprecated"
  • Meta=(DisplayName="Chain Settings (Deprecated)")
GlobalSettings FRetargetGlobalSettings (Deprecated) Retarget settings to control global behavior, like Stride Warping (not applied unless bApplyGlobalSettings is true) Retargeter/IKRetargetProfile.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Deprecated"
  • Meta=(DisplayName="Global Settings (Deprecated)")
RetargetOpProfiles TArray< FRetargetOpProfile > A polymorphic list of override settings to apply to retargeting operations in the stack Retargeter/IKRetargetProfile.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Op Settings"
RootSettings FTargetRootSettings (Deprecated) Retarget settings to control behavior of the retarget root motion (not applied unless bApplyRootSettings is true) Retargeter/IKRetargetProfile.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Deprecated"
  • Meta=(DisplayName="Root Settings (Deprecated)")
SourceRetargetPoseName FName Override the SOURCE Retarget Pose to use when this profile is active. Retargeter/IKRetargetProfile.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Retarget Poses"
  • Meta=(EditCondition="bApplySourceRetargetPose")
TargetRetargetPoseName FName Override the TARGET Retarget Pose to use when this profile is active. Retargeter/IKRetargetProfile.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Retarget Poses"
  • Meta=(EditCondition="bApplyTargetRetargetPose")

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool ApplyOpProfilesToOpStruct ( FInstancedStruct& InOutOpStruct,
const ECopyOpSettingsContext InCopyContext
) const

   Retargeter/IKRetargetProfile.h  

void FillProfileWithAssetSettings ( const UIKRetargeter* InAsset
)

   Retargeter/IKRetargetProfile.h  

FRetargetOpProfile * FindMatchingOpProfile ( const FRetargetOpProfile& OtherOpProfile
)

   Retargeter/IKRetargetProfile.h  

FRetargetOpProfile * GetOpProfileByName ( const FName InOpName
)

   Retargeter/IKRetargetProfile.h  

void GetOpSettingsByTypeInProfile ( TArray< T* >& OutMatchingOpSettings
)

 Search all the op profiles and get an array of all the settings of a particular type Retargeter/IKRetargetProfile.h  

void MergeWithOtherProfile ( const FRetargetProfile& OtherProfile
)

   Retargeter/IKRetargetProfile.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Retargeter/IKRetargetProfile.h  
  Retargeter/IKRetargetProfile.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page