Navigation
API > API/Plugins > API/Plugins/IKRig
| Name | FIKRetargetRootMotionOpSettings |
| Type | struct |
| Header File | /Engine/Plugins/Animation/IKRig/Source/IKRig/Public/Retargeter/RetargetOps/RootMotionGeneratorOp.h |
| Include Path | #include "Retargeter/RetargetOps/RootMotionGeneratorOp.h" |
Syntax
USTRUCT (BlueprintType , Meta=(DisplayName="Root Motion Settings"))
struct FIKRetargetRootMotionOpSettings : public FIKRetargetOpSettingsBase
Inheritance Hierarchy
- FIKRetargetOpSettingsBase → FIKRetargetRootMotionOpSettings
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bMaintainOffsetFromPelvis | bool | Applies only when generating root motion from the Pelvis. | Retargeter/RetargetOps/RootMotionGeneratorOp.h |
|
| bPropagateToNonRetargetedChildren | bool | Will transform all children of the target root that are not themselves part of a retarget chain. | Retargeter/RetargetOps/RootMotionGeneratorOp.h |
|
| bRotateWithPelvis | bool | Applies only when generating root motion from the Pelvis. | Retargeter/RetargetOps/RootMotionGeneratorOp.h |
|
| GlobalOffset | FTransform | A manual offset to apply in global space to the root bone. | Retargeter/RetargetOps/RootMotionGeneratorOp.h |
|
| RootHeightSource | ERootMotionHeightSource | How to set the height of the root bone. | Retargeter/RetargetOps/RootMotionGeneratorOp.h |
|
| RootMotionSource | ERootMotionSource | Where to copy the root motion from. | Retargeter/RetargetOps/RootMotionGeneratorOp.h |
|
| SourceRoot | FBoneReference | The root of the source skeleton. | Retargeter/RetargetOps/RootMotionGeneratorOp.h |
|
| TargetPelvis | FBoneReference | The pelvis of the target skeleton. Only used when "Root Motion Source" is set to target pelvis. | Retargeter/RetargetOps/RootMotionGeneratorOp.h |
|
| TargetRoot | FBoneReference | The root of the target skeleton. | Retargeter/RetargetOps/RootMotionGeneratorOp.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool Serialize
(
FArchive& Ar |
Retargeter/RetargetOps/RootMotionGeneratorOp.h |
Overridden from FIKRetargetOpSettingsBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CopySettingsAtRuntime
(
const FIKRetargetOpSettingsBase* InSettingsToCopyFrom |
(required) override to specify how settings should be applied in a way that will not require reinitialization (ie runtime compatible) | Retargeter/RetargetOps/RootMotionGeneratorOp.h | |
virtual const UClass * GetControllerType() |
(optional, but recommended) provide a custom controller type (deriving from UIKRetargetOpControllerBase) as an API for editing the op NOTE: this type will automatically be lazy instantiated when/if the user calls GetController() on the op. | Retargeter/RetargetOps/RootMotionGeneratorOp.h | |
| FBoneReference needs a skeleton for the UI widget. | Retargeter/RetargetOps/RootMotionGeneratorOp.h | ||
virtual void PostLoad
(
const FIKRigObjectVersion::Type InVersion |
(optional) called during the PostLoad of the owning asset. | Retargeter/RetargetOps/RootMotionGeneratorOp.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| SourceRootBone_DEPRECATED | FName | Changed to FBoneReference to support bone selector UI. | Retargeter/RetargetOps/RootMotionGeneratorOp.h |
|
| TargetPelvisBone_DEPRECATED | FName | Retargeter/RetargetOps/RootMotionGeneratorOp.h |
|
|
| TargetRootBone_DEPRECATED | FName | Retargeter/RetargetOps/RootMotionGeneratorOp.h |
|