IKRig

API > API/Plugins

   
Name IKRig
Type Plugin
Part of Plugins IK Rig
Location /Engine/Plugins/Animation/IKRig/Source/IKRig/
Module Build Rules IKRig.Build.cs

Classes

Name Remarks
FIKRigModule  
FPropertyPathParser A centralized utility for parsing a property path string Intended for property path strings with properties separated by "->" with support for array syntax like "[0]"
UCurveRemapOp NOTE: This type has been replaced with FIKRetargetCurveRemapOp.
UIKGoalCreatorInterface  
UIKRetargetAdditivePoseController The blueprint/python API for editing a Retarget Pose Op
UIKRetargetAlignPoleVectorController The blueprint/python API for editing an Align Pole Vector Op
UIKRetargetBlendToSourceController The blueprint/python API for editing a Blend to Source Op
UIKRetargetCopyBasePoseController The blueprint/python API for editing a Copy Base Pose Op
UIKRetargetCurveRemapController The blueprint/python API for editing a Curve Remap Op
UIKRetargeter  
UIKRetargetFilterBoneController The blueprint/python API for editing a Filter Bone Op
UIKRetargetFKChainsController The blueprint/python API for editing a FK Chains Op
UIKRetargetFloorConstraintController The blueprint/python API for editing a Floor Constraint Op
UIKRetargetGlobalSettings NOTE: Phase toggles replaced by op enabled flags. Stride warp settings replaced by Stride Warp op.
UIKRetargetIKChainsController The blueprint/python API for editing a IK Chains Op
UIKRetargetOffsetGoalsController The blueprint/python API for editing a Offset IK Goals Op
UIKRetargetOpControllerBase This is the base class for defining a custom controller for a given retarget op type.
UIKRetargetPelvisMotionController The blueprint/python API for editing a Pelvis Motion Op
UIKRetargetPinBoneController The blueprint/python API for editing a Pin Bone Op
UIKRetargetPoseController The blueprint/python API for editing a Retarget Pose Op
UIKRetargetProcessor BEGIN DEPRECATED UOBJECT-BASED PROCESSOR
UIKRetargetRootMotionController The blueprint/python API for editing a Root Motion Op
UIKRetargetRunIKRigController The blueprint/python API for editing a Run IK Rig Op
UIKRetargetScaleGoalsController The blueprint/python API for editing a Scale Goals Op
UIKRetargetScaleSourceController The blueprint/python API for editing a Scale Source Op
UIKRetargetSpeedPlantingController The blueprint/python API for editing a Speed Planting Op
UIKRetargetStretchChainController The blueprint/python API for editing an Align Pole Vector Op
UIKRetargetStrideWarpingController The blueprint/python API for editing a Stride Warping Op
UIKRetargetWeaponGoalsOpController The blueprint/python API for editing a Weapon Goals Op
UIKRig_BodyMover NOTE: This type has been replaced with FBodyMoverSolver.
UIKRig_BodyMoverEffector NOTE: This type has been replaced with FBodyMoverGoalSettings.
UIKRig_FBIKBoneSettings NOTE: This type has been replaced with FFBIKBoneSettings.
UIKRig_FBIKEffector NOTE: This type has been replaced with FFBIKGoalSettings.
UIKRig_LimbEffector NOTE: This type has been replaced with FIKRigLimbSolver.
UIKRig_LimbSolver NOTE: This type has been replaced with FIKRigLimbSolver.
UIKRig_PoleSolver NOTE: This type has been replaced with FPoleSolver.
UIKRig_PoleSolverEffector NOTE: This type has been replaced with FPoleSolver.
UIKRig_SetTransform NOTE: This is a legacy type that is converted into an FIKRigSetTransform on PostLoad()
UIKRig_SetTransformEffector NOTE: This is a legacy type that is converted into an FSetTransformGoalSettings on PostLoad()
UIKRigBodyMoverController The blueprint/python API for modifying a Body Mover solver's settings in an IK Rig.
UIKRigComponent  
UIKRigDefinition  
UIKRigEffectorGoal  
UIKRigFBIKController The blueprint/python API for modifying an Full-Body IK solver's settings in an IK Rig.
UIKRigFBIKSolver NOTE: This type has been replaced with FFBIKSolver.
UIKRigLimbSolverController The blueprint/python API for modifying an Full-Body IK solver's settings in an IK Rig.
UIKRigPoleSolverController The blueprint/python API for modifying a Pole solver's settings in an IK Rig.
UIKRigProcessor BEGIN DEPRECATED UOBJECT-BASED PROCESSOR
UIKRigSetTransformController The blueprint/python API for modifying Set Transform settings in an IK Rig.
UIKRigSolver BEGIN LEGACY CODE
UIKRigSolverControllerBase  
UPinBoneOp NOTE: This type has been replaced with FIKRetargetPinBoneOp.
URetargetChainSettings NOTE: Replaced with IK/FK Chains Op and new mapping data.
URetargetOpBase NOTE: This type has been replaced by FRetargetOpBase. URetargetOpBase-based ops no longer work, please refactor into the new FRetargetOpBase struct.
URetargetOpStack NOTE: This type is no longer in use except to load old stacks of UObject-based ops.
URetargetProfileLibrary  
URetargetRootSettings NOTE: Replaced by Pelvis Op and it's settings.
URootMotionGeneratorOp NOTE: This type has been replaced with FIKRetargetRootMotionOp.

Structs

Name Remarks
FAnimNode_IKRig  
FAnimNode_RetargetPoseFromMesh  
FBoneChain  
FChainDebugData  
FChainDecoderCachedData  
FChainDecoderFK  
FChainEncoderFK  
FChainPairFK  
FChainStretcher  
FCurveRemapPair  
FFilterBoneData  
FFKChainDebugData  
FFloorConstraint  
FFloorConstraintChainSettings  
FFloorConstraintFootDefinition  
FFloorConstraintToeDefinition  
FFloorConstraintToesDefinition  
FFootConstraint  
FGoalBone  
FIKChainRetargeter  
FIKChainToBlend  
FIKChainToOffset  
FIKChainToScale  
FIKRetargetAdditivePoseOp  
FIKRetargetAdditivePoseOpSettings  
FIKRetargetAlignPoleVectorOp  
FIKRetargetAlignPoleVectorOpSettings  
FIKRetargetBlendToSourceChainSettings  
FIKRetargetBlendToSourceOp  
FIKRetargetBlendToSourceOpSettings  
FIKRetargetCopyBasePoseOp  
FIKRetargetCopyBasePoseOpSettings  
FIKRetargetCurveRemapOp  
FIKRetargetCurveRemapOpSettings  
FIKRetargetCurvesOpBase This is the base class for defining all animation curves operations including curve remapping and rig mapping.
FIKRetargetDebugDrawState  
FIKRetargetFilterBoneOp  
FIKRetargetFilterBoneOpSettings  
FIKRetargetFKChainsOp  
FIKRetargetFKChainsOpSettings  
FIKRetargetFloorConstraintOp  
FIKRetargetFloorConstraintOpSettings  
FIKRetargetIKChainsOp  
FIKRetargetIKChainsOpSettings  
FIKRetargetOffsetGoalsChainSettings  
FIKRetargetOffsetGoalsOp  
FIKRetargetOffsetGoalsOpSettings  
FIKRetargetOpBase This is the base class for defining operations that live in the retargeter "op" stack.
FIKRetargetOpSettingsBase This is the base class for defining editable settings for a custom retargeting operation.
FIKRetargetOpSkeletonProvider Because the settings structs in the retarget op stack are not UObjects, we cannot use the IBoneReferenceSkeletonProvider interface Instead, if Op settings require a FBoneReference with a bone selector widget then the settings must inherit either directly from this (in the case of sub structs), or indirectly from the FIKRetargetOpSettingBase for the op's main settings struct.
FIKRetargetPelvisMotionOp  
FIKRetargetPelvisMotionOpSettings  
FIKRetargetPinBoneOp  
FIKRetargetPinBoneOpSettings  
FIKRetargetPose  
FIKRetargetPoseOp  
FIKRetargetPoseOpSettings  
FIKRetargetProcessor The runtime processor that converts an input pose from a source skeleton into an output pose on a target skeleton.
FIKRetargetRootMotionOp  
FIKRetargetRootMotionOpSettings  
FIKRetargetRunIKRigChainSettings  
FIKRetargetRunIKRigOp  
FIKRetargetRunIKRigOpSettings  
FIKRetargetRuntimeOverrideManager  
FIKRetargetScaleGoalsChainSettings  
FIKRetargetScaleGoalsOp  
FIKRetargetScaleGoalsOpSettings  
FIKRetargetScaleSourceOp  
FIKRetargetScaleSourceOpSettings  
FIKRetargetSpeedPlantingOp  
FIKRetargetSpeedPlantingOpSettings  
FIKRetargetStretchChainOp  
FIKRetargetStretchChainOpSettings  
FIKRetargetStrideWarpingOp  
FIKRetargetStrideWarpingOpSettings  
FIKRetargetWeaponGoalOp  
FIKRetargetWeaponGoalsOpSettings  
FIKRigBodyMoverGoalSettings  
FIKRigBodyMoverSettings  
FIKRigBodyMoverSolver  
FIKRigBoneSettingsBase This is the base class for defining editable per-bone settings for your custom IKRig solver.
FIKRigFBIKBoneSettings  
FIKRigFBIKGoalSettings  
FIKRigFBIKSettings  
FIKRigFullBodyIKSolver  
FIKRigGoal  
FIKRigGoalContainer  
FIKRigGoalInput  
FIKRigGoalSettingsBase This is the base class for defining editable per-goal settings for your custom IKRig solver.
FIKRigInputSkeleton Data used just to initialize an IKRigSkeleton from outside systems
FIKRigLimbSolver  
FIKRigLimbSolverSettings  
FIKRigLogger  
FIKRigObjectVersion Custom serialization version for backwards compatibility during de-serialization.
FIKRigPoleSolver  
FIKRigPoleSolverSettings  
FIKRigProcessor The runtime for an IKRig to convert an input pose into a solved output pose given a set of IK Rig Goals:
FIKRigSettingsBase This is the base class for all types of settings used by IKRig.
FIKRigSetTransform  
FIKRigSetTransformSettings  
FIKRigSkeleton  
FIKRigSolverBase This is the base class for creating your own solver type that integrates into the IK Rig framework/editor.
FIKRigSolverSettingsBase This is the base class for defining editable settings for your custom IKRig solver.
FIKRigStretchLimbBoneSettings  
FIKRigStretchLimbSettings  
FIKRigStretchLimbSolver  
FIKRigWorkData  
FLimbLink  
FLimbSolver  
FLimbSolverSettings  
FOneEuroFilterSettings These are settings for an adaptive first-order low-pass filter based on the "One-Euro" 2012 paper: https://gery.casiez.net/1euro/.
FOneEuroQuatFilter Filter a quaternion over time using the "One Euro" method
FOneEuroScalarFilter Filter a double over time using the "One Euro" method
FOneEuroVectorFilter Filter a 3d vector over time using the "One Euro" method
FOpExecutionTimer  
FPelvisSource  
FPelvisTarget  
FPinBoneData  
FPoleVectorMatcher  
FResolvedBoneChain A "resolved" bone chain serves a few purposes:
FResolvedRetargetPose Cached retarget pose transforms (both local and global) after it has been applied/resolved on a specific skeletal mesh
FResolvedRetargetPoseSet The set of all resolved/cached retarget poses in use for a source or target skeleton
FRetargetChainMapping  
FRetargetChainPair  
FRetargetDefinition  
FRetargeterBoneChains A container for ALL the fully resolved bone chains on both the source and target skeletons, as well as the mapping between them
FRetargetFKChainSettings  
FRetargetGlobalSettings NOTE: Replaced IK/FK/Post toggle flags with Op-enabled flags. Warping settings now in Stride Warp Op.
FRetargetIKChainSettings  
FRetargetInitParameters * Parameters for initializing the IK Retargeter.
FRetargetOpOverrides A collection of property overrides to assign to a single op.
FRetargetOpProfile A wholesale copy of the settings in a retarget op.
FRetargetOpPropertyOverride Single property override for a retarget op
FRetargetOverrideSet  
FRetargetPoleVectorSettings  
FRetargetPoseScaleWithPivot  
FRetargetProfile A collection of FRetargetOpProfiles that can be applied at runtime to override settings for one or more ops.
FRetargetPropertyOverrideNode What is this for? This type is used to store a customized property tree that ops can supply to tell outside systems which of the op's settings can be overridden.
FRetargetRunParameters Parameters for running the retargeter to generate a new pose.
FRetargetSkeleton A retarget skeleton contains:
FRetargetSpeedPlantingSettings  
FRetargetStretchChainSettings  
FRetargetStrideWarpChainSettings  
FRetargetVariableContainer  
FRigUnit_IKRig Supply an IK Rig asset and provide goal transforms to run IK on the skeleton.
FRunIKRigChain  
FRunIKRigOpGoalDebugData  
FSpeedPlantingGoalState  
FStrideWarpGoalData  
FTargetChainFKSettings NOTE: Replaced by FK Chain Op.
FTargetChainIKSettings NOTE: Replaced by IK Chain Op.
FTargetChainSettings NOTE: Replaced by FK/IK Chain Ops and Speed Planting Op.
FTargetChainSpeedPlantSettings NOTE: Replaced by Speed Planting Op.
FTargetRootSettings NOTE: Replaced by Pelvis Motion Op.
FTargetSkeleton A retarget skeleton for the target skeleton.
FToeConstraint  
HIKRetargetEditorChainProxy Select chains/goals to edit chain settings
HIKRetargetEditorRootProxy Select root control to edit root settings

Interfaces

Name Remarks
IIKGoalCreatorInterface  

Enums

Public

Name Remarks
EAutoMapChainType  
EBasicAxis  
ECopyOpSettingsContext  
EFKChainRotationMode  
EFKChainTranslationMode  
EIKRigGoalPreviewMode  
EIKRigGoalSpace  
EIKRigGoalTransformSource  
EIKRigTransformType::Type  
EPinBoneRotationMode  
EPinBoneTranslationMode  
EPinBoneType  
ERetargetBoneSpace  
ERetargetOpsToSearch  
ERetargetRotationMode NOTE: Replaced by FK Chain Op.
ERetargetSelectionType  
ERetargetSourceMode  
ERetargetSourceOrTarget Which skeleton are we referring to?
ERetargetTranslationMode NOTE: Replaced by FK Chain Op.
ERetargetWeaponBone  
ERootMotionHeightSource Where to copy the height of the root from
ERootMotionSource Where to copy the motion of the root from
EScaleSourcePivot  
ESpeedPlantBlendMethod  
EStretchLimbRotationMode  
EStretchLimbSquashMode  
EWarpingDirectionSource  

Constants

Name Type Remarks Include Path
IKRigDebugRendering::CubeEdges TArray 12 edges of cube IKRigDebugRendering.h
IKRigDebugRendering::CubeVertices TArray 8 vertices of cube IKRigDebugRendering.h
IKRigNonOverrideableMetaLabel const TCHAR * A UProperty metadata tag used to indicate that a property can not be overridden by a profile IKRig.h
IKRigReinitOnEditMetaLabel const TCHAR * A UProperty metadata tag used to indicate that a property should trigger reinitialization when edited IKRig.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

DECLARE_CYCLE_STAT ( TEXT("IK Retarget Goals")
)

   Retargeter/RetargetOps/IKChainsOp.h  

uint32 GetTypeHash ( FIKRigGoal ObjectRef
)

   Rig/IKRigDataTypes.h  

bool IKRetargetOpUtils::AreChainSettingsAtDefault ( const TArray< T >& InChainSettingsArray,
const FName& InChainName
)

 Checks whether the settings for a specific chain are at their default values. Retargeter/IKRetargetOpUtils.h  

void IKRetargetOpUtils::CopyChainSettingsAtRuntime ( const TArray< T >& InSettingsToCopyFrom,
TArray< T >& InSettingsToCopyTo
)

 Copies matching chain settings from one array to another at runtime. Retargeter/IKRetargetOpUtils.h  

uint8 * IKRetargetOpUtils::GetChainSettingsMemory ( TArray< T >& InChainSettingsArray,
const FName& InChainName
)

 Returns a raw pointer to the memory of a specific chain’s settings instance. Retargeter/IKRetargetOpUtils.h  

void IKRetargetOpUtils::OnRetargetChainRenamed ( TArray< T >& InOutChainSettings,
const FName InOldChainName,
const FName InNewChainName
)

 Responds to an IK Rig chain being renamed by updating the corresponding entry in a settings array. Retargeter/IKRetargetOpUtils.h  

void IKRetargetOpUtils::ResetChainSettingsToDefault ( TArray< T >& InChainSettingsArray,
const FName& InChainName
)

 Resets the settings for a specific IK chain to its default values. Retargeter/IKRetargetOpUtils.h  

void IKRetargetOpUtils::SynchronizeChainSettingsWithIKRig ( TArray< T >& InOutChainSettings,
const FIKRetargetOpBase* InRetargetOp,
const bool bSkipUnmappedChains,
const bool bSkipNonIKChains
)

 Synchronizes a custom chain settings array with the chains in an IK Rig asset. Retargeter/IKRetargetOpUtils.h  

Static

Name Remarks Include Path Unreal Specifiers

static FQuat GetRotationFromDeformedPoints ( const TArray< FVector >& InInitialPoints,
const TArray< FVector >& InCurrentPoints,
FVector& OutInitialCentroid,
FVector& OutCurrentCentroid
)

 Given a set of points in an initial configuration and the same set of points in a deformed configuration, this function outputs a quaternion that represents the "best fit" rotation that rotates the initial points to the current points. Rig/Solvers/PointsToRotation.h  

static void IKRigDebugRendering::DrawWireCube ( FPrimitiveDrawInterface* PDI,
const FTransform& Transform,
FLinearColor Color,
float Size,
float Thickness
)

   IKRigDebugRendering.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page