IKRig


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

Name	Remarks
FIKRigModule
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
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
UIKRetargetFloorGoalsController	The blueprint/python API for editing a Floor Goal 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
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
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
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
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.

Name	Remarks
FAnimNode_IKRig
FAnimNode_RetargetPoseFromMesh
FBoneChain
FChainDebugData
FChainDecoderCachedData
FChainDecoderFK
FChainEncoderFK
FChainPairFK
FChainStretcher
FCurveRemapPair
FFilterBoneData
FFKChainDebugData
FFloorConstraint
FFloorConstraintChainSettings
FGoalBone
FIKChainRetargeter
FIKRetargetAdditivePoseOp
FIKRetargetAdditivePoseOpSettings
FIKRetargetAlignPoleVectorOp
FIKRetargetAlignPoleVectorOpSettings
FIKRetargetCopyBasePoseOp
FIKRetargetCopyBasePoseOpSettings
FIKRetargetCurveRemapOp
FIKRetargetCurveRemapOpSettings
FIKRetargetDebugDrawState
FIKRetargetFilterBoneOp
FIKRetargetFilterBoneOpSettings
FIKRetargetFKChainsOp
FIKRetargetFKChainsOpSettings
FIKRetargetFloorConstraintOp
FIKRetargetFloorConstraintOpSettings
FIKRetargetIKChainsOp
FIKRetargetIKChainsOpSettings
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 your custom retargeting operation.
FIKRetargetPelvisMotionOp
FIKRetargetPelvisMotionOpSettings
FIKRetargetPinBoneOp
FIKRetargetPinBoneOpSettings
FIKRetargetPose
FIKRetargetProcessor	The runtime processor that converts an input pose from a source skeleton into an output pose on a target skeleton.
FIKRetargetRootMotionOp
FIKRetargetRootMotionOpSettings
FIKRetargetRunIKRigOp
FIKRetargetRunIKRigOpSettings
FIKRetargetScaleSourceOp
FIKRetargetScaleSourceOpSettings
FIKRetargetSpeedPlantingOp
FIKRetargetSpeedPlantingOpSettings
FIKRetargetStretchChainOp
FIKRetargetStretchChainOpSettings
FIKRetargetStrideWarpingOp
FIKRetargetStrideWarpingOpSettings
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
FOneEuroRotationFilter
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
FRetargetOpProfile
FRetargetPoleVectorSettings
FRetargetPoseScaleWithPivot
FRetargetProfile
FRetargetSkeleton	A retarget skeleton contains:
FRetargetSpeedPlantingSettings
FRetargetStretchChainSettings
FRetargetStrideWarpChainSettings
FRigUnit_IKRig	Supply an IK Rig asset and provide goal transforms to run IK on the skeleton.
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.
HIKRetargetEditorChainProxy	Select chains/goals to edit chain settings
HIKRetargetEditorRootProxy	Select root control to edit root settings

Name	Remarks
IIKGoalCreatorInterface

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.
ERootMotionHeightSource	Where to copy the height of the root from
ERootMotionSource	Where to copy the motion of the root from
EScaleSourcePivot
EStretchLimbRotationMode
EStretchLimbSquashMode
EWarpingDirectionSource

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

Name	Remarks	Include Path
DECLARE_CYCLE_STAT ( TEXT("IK Retarget Goals"), STAT_IKRetargetGoals, STATGROUP_Anim )		Retargeter/RetargetOps/IKChainsOp.h
uint32 GetTypeHash ( FIKRigGoal ObjectRef )		Rig/IKRigDataTypes.h
void IKRetargetOpUtils::OnRetargetChainRenamed ( TArray< T >& InOutChainSettings, const FName InOldChainName, const FName InNewChainName )	This is a convenience function for retarget ops that need to respond to an IK Rig chain being renamed.	Retargeter/IKRetargetOpUtils.h
void IKRetargetOpUtils::SynchronizeChainSettingsWithIKRig ( TArray< T >& InOutChainSettings, const FIKRetargetOpBase* InRetargetOp, const bool bSkipUnmappedChains, const bool bSkipNonIKChains )	This is a convenience function for retarget ops that need to keep an array of custom chain settings in-sync with the chains in and IK Rig asset.	Retargeter/IKRetargetOpUtils.h

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

Navigation

Classes

Structs

Interfaces

Enums

Public

Constants

Functions

Public

Static