1. Epic GamesDeveloper
  3. FIKRetargetRootMotionOpSettings

FIKRetargetRootMotionOpSettings

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

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bMaintainOffsetFromPelvis bool Applies only when generating root motion from the Pelvis. Retargeter/RetargetOps/RootMotionGeneratorOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Offset"
bPropagateToNonRetargetedChildren bool Will transform all children of the target root that are not themselves part of a retarget chain. Retargeter/RetargetOps/RootMotionGeneratorOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Update Children"
bRotateWithPelvis bool Applies only when generating root motion from the Pelvis. Retargeter/RetargetOps/RootMotionGeneratorOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Motion Source"
GlobalOffset FTransform A manual offset to apply in global space to the root bone. Retargeter/RetargetOps/RootMotionGeneratorOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Offset"
RootHeightSource ERootMotionHeightSource How to set the height of the root bone. Retargeter/RetargetOps/RootMotionGeneratorOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Height Source"
RootMotionSource ERootMotionSource Where to copy the root motion from. Retargeter/RetargetOps/RootMotionGeneratorOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Motion Source"
SourceRoot FBoneReference The root of the source skeleton. Retargeter/RetargetOps/RootMotionGeneratorOp.h
  • EditAnywhere
  • Category="Bones"
  • Meta=(ReinitializeOnEdit)
TargetPelvis FBoneReference The pelvis of the target skeleton. Only used when "Root Motion Source" is set to target pelvis. Retargeter/RetargetOps/RootMotionGeneratorOp.h
  • EditAnywhere
  • Category="Motion Source"
  • Meta=(ReinitializeOnEdit)
TargetRoot FBoneReference The root of the target skeleton. Retargeter/RetargetOps/RootMotionGeneratorOp.h
  • EditAnywhere
  • Category="Bones"
  • Meta=(ReinitializeOnEdit)

Functions

Public

Name Remarks Include Path Unreal Specifiers

void PostSerialize ( const FArchive& Ar
)

 Patch to load old bone names into new FBoneReference 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  

virtual USkeleton * GetSkeleton ( const FName InPropertyName
)

 FBoneReference needs a skeleton for the UI widget. 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
  • Meta=(DeprecatedProperty)
TargetPelvisBone_DEPRECATED FName   Retargeter/RetargetOps/RootMotionGeneratorOp.h
  • Meta=(DeprecatedProperty)
TargetRootBone_DEPRECATED FName   Retargeter/RetargetOps/RootMotionGeneratorOp.h
  • Meta=(DeprecatedProperty)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page