FIKRetargetPelvisMotionOpSettings

API > API/Plugins > API/Plugins/IKRig

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

Syntax

USTRUCT (BlueprintType , Meta=(DisplayName="Pelvis Motion Settings"))  
struct FIKRetargetPelvisMotionOpSettings : public FIKRetargetOpSettingsBase

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AffectIKHorizontal double Range 0 to 1. Retargeter/RetargetOps/PelvisMotionOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Affect IK Settings"
  • Meta=(ClampMin="0.0", ClampMax="1.0", UIMin="0.0", UIMax="1.0", DisplayName="Affect IK Horizontal")
AffectIKVertical double Range 0 to 1. Retargeter/RetargetOps/PelvisMotionOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Affect IK Settings"
  • Meta=(ClampMin="0.0", ClampMax="1.0", UIMin="0.0", UIMax="1.0", DisplayName="Affect IK Vertical")
BlendToAbsoluteOffset FVector Blend from motion scaled by the size of the character, to the absolute delta motion from the source. Retargeter/RetargetOps/PelvisMotionOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Scaled or Absolute"
  • Meta=(ClampMin="0.0", UIMin="0.0", UIMax="1.0")
BlendToSourceTranslation double Range 0 to 1. Retargeter/RetargetOps/PelvisMotionOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Pelvis Translation"
  • Meta=(ClampMin="0.0", ClampMax="1.0", UIMin="0.0", UIMax="1.0")
BlendToSourceTranslationWeights FVector Per-axis weights for the Blend to Source. Retargeter/RetargetOps/PelvisMotionOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Pelvis Translation"
  • Meta=(ClampMin="0.0", ClampMax="1.0", UIMin="0.0", UIMax="1.0")
bUseGroundFalloff bool When true, the effect of the floor constraint decays as the pelvis gets further from the floor. Retargeter/RetargetOps/PelvisMotionOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Floor Constraint"
DebugDrawSize double Adjust size of the debug drawing Retargeter/RetargetOps/PelvisMotionOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Debug"
DebugDrawThickness double Adjust thickness of the debug drawing Retargeter/RetargetOps/PelvisMotionOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Debug"
FloorConstraintWeight double Range 0 to 1. Retargeter/RetargetOps/PelvisMotionOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Floor Constraint"
  • Meta=(ClampMin="0.0", ClampMax="1.0", UIMin="0.0", UIMax="1.0")
GroundFalloffHeightPercent double Controls the height at which the floor constraint will begin blending in as a percentage of the pelvis height in the retarget pose. Retargeter/RetargetOps/PelvisMotionOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Floor Constraint"
  • Meta=(ClampMin="0.1", ClampMax="1.0", UIMin="0.1", UIMax="1.0")
RotationAlpha double Range 0 to 1. Retargeter/RetargetOps/PelvisMotionOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Pelvis Rotation"
  • Meta=(ClampMin="0.0", ClampMax="1.0", UIMin="0.0", UIMax="1.0")
RotationOffsetGlobal FRotator Applies a static global-space rotation offset to the pelvis. Retargeter/RetargetOps/PelvisMotionOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Pelvis Rotation"
  • Meta=(ClampMin="-180.0", ClampMax="180.0", UIMin="-180.0", UIMax="180.0")
RotationOffsetLocal FRotator Applies a static local-space rotation offset to the pelvis. Retargeter/RetargetOps/PelvisMotionOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Pelvis Rotation"
  • Meta=(ClampMin="-180.0", ClampMax="180.0", UIMin="-180.0", UIMax="180.0")
ScaleHorizontal double Default 1. Scales the translation of the pelvis in the horizontal plane (X,Y). Retargeter/RetargetOps/PelvisMotionOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Scale Pelvis Translation"
  • Meta=(UIMin="0.0", UIMax="3.0")
ScaleVertical double Default 1. Scales the translation of the pelvis in the vertical direction (Z). Retargeter/RetargetOps/PelvisMotionOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Scale Pelvis Translation"
  • Meta=(UIMin="0.0", UIMax="3.0")
SourceCrotchOffset double A negative vertical offset in cm relative to the Pelvis bone of the SOURCE. Retargeter/RetargetOps/PelvisMotionOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Floor Constraint"
SourcePelvisBone FBoneReference The Pelvis bone on the source skeleton to copy motion FROM. Retargeter/RetargetOps/PelvisMotionOp.h
  • EditAnywhere
  • Category=Setup
  • Meta=(ReinitializeOnEdit, NotOverrideable)
TargetCrotchOffset double A negative vertical offset in cm relative to the Pelvis bone of the TARGET. Retargeter/RetargetOps/PelvisMotionOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Floor Constraint"
TargetPelvisBone FBoneReference The Pelvis bone on the target skeleton to copy motion TO. Retargeter/RetargetOps/PelvisMotionOp.h
  • EditAnywhere
  • Category=Setup
  • Meta=(ReinitializeOnEdit, NotOverrideable)
TranslationAlpha double Range 0 to 1. Retargeter/RetargetOps/PelvisMotionOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Pelvis Translation"
  • Meta=(ClampMin="0.0", ClampMax="1.0", UIMin="0.0", UIMax="1.0")
TranslationOffsetGlobal FVector Applies a static global-space translation offset to the pelvis. Retargeter/RetargetOps/PelvisMotionOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Pelvis Translation"
TranslationOffsetLocal FVector Applies a static local-space translation offset to the pelvis. Retargeter/RetargetOps/PelvisMotionOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Pelvis Translation"

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool Serialize ( FArchive& Ar
)

   Retargeter/RetargetOps/PelvisMotionOp.h  

Public Virtual

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/PelvisMotionOp.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/PelvisMotionOp.h  

virtual void PostLoad ( const FIKRigObjectVersion::Type InVersion
)

 (optional) called during the PostLoad of the owning asset. Retargeter/RetargetOps/PelvisMotionOp.h  

Overridden from FIKRetargetOpSkeletonProvider

Name Remarks Include Path Unreal Specifiers

virtual USkeleton * GetSkeleton ( const FName InPropertyName
)

 FBoneReference needs a skeleton for the UI widget. Retargeter/RetargetOps/PelvisMotionOp.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bEnableDebugDraw_DEPRECATED bool   Retargeter/RetargetOps/PelvisMotionOp.h
  • Meta=(DeprecatedProperty)
RotationOffset_DEPRECATED FRotator   Retargeter/RetargetOps/PelvisMotionOp.h
  • Meta=(DeprecatedProperty)
TranslationOffset_DEPRECATED FVector   Retargeter/RetargetOps/PelvisMotionOp.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