FIKRigFBIKSettings | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/IKRig


Name	FIKRigFBIKSettings
Type	struct
Header File	/Engine/Plugins/Animation/IKRig/Source/IKRig/Public/Rig/Solvers/IKRigFullBodyIK.h
Include Path	#include "Rig/Solvers/IKRigFullBodyIK.h"

Syntax

USTRUCT (BlueprintType , Meta=(UIWrapper="/Script/IKRigEditor.FBIKSettingsWrapper"))  
struct FIKRigFBIKSettings : public FIKRigSolverSettingsBase

Inheritance Hierarchy

FIKRigSettingsBase → FIKRigSolverSettingsBase → FIKRigFBIKSettings

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
bAllowStretch	bool	If true, joints will translate to reach the effectors; causing bones to lengthen if necessary.	Rig/Solvers/IKRigFullBodyIK.h	BlueprintReadWrite EditAnywhere Category=SolverSettings
GlobalPullChainAlpha	float	A global multiplier for all Pull Chain Alpha values on all effectors.	Rig/Solvers/IKRigFullBodyIK.h	BlueprintReadWrite EditAnywhere Category=AdvancedSettings Meta=(ClampMin="0", ClampMax="1", UIMin="0.0", UIMax="1.0")
Iterations	int32	High iteration counts can help solve complex joint configurations with competing constraints, but will increase runtime cost.	Rig/Solvers/IKRigFullBodyIK.h	BlueprintReadWrite EditAnywhere Category=SolverSettings Meta=(ClampMin="0", ClampMax="1000", UIMin="0.0", UIMax="200.0")
MassMultiplier	float	A global mass multiplier; higher values will make the joints more stiff, but require more iterations.	Rig/Solvers/IKRigFullBodyIK.h	BlueprintReadWrite EditAnywhere Category=SolverSettings Meta=(ClampMin="0", UIMin="0.0", UIMax="10.0")
MaxAngle	float	Maximum angle that a joint can be rotated per constraint iteration.	Rig/Solvers/IKRigFullBodyIK.h	BlueprintReadWrite EditAnywhere Category=AdvancedSettings Meta=(ClampMin="0", ClampMax="45", UIMin="0.0", UIMax="180.0")
OverRelaxation	float	Pushes constraints beyond their normal amount to speed up convergence.	Rig/Solvers/IKRigFullBodyIK.h	BlueprintReadWrite EditAnywhere Category=AdvancedSettings Meta=(ClampMin="1", ClampMax="2", UIMin="1.0", UIMax="2.0")
PrePullRootSettings	FRootPrePullSettings	Settings only applicable when Root Behavior is set to "PrePull".	Rig/Solvers/IKRigFullBodyIK.h	BlueprintReadWrite EditAnywhere Category=RootBehavior
RootBehavior	EPBIKRootBehavior	(Default is PrePull) Set the behavior of the solver root.	Rig/Solvers/IKRigFullBodyIK.h	BlueprintReadWrite EditAnywhere Category=RootBehavior
RootBone	FName	All bones above this bone in the hierarchy will be completely ignored by the solver.	Rig/Solvers/IKRigFullBodyIK.h	BlueprintReadOnly VisibleAnywhere Category="Full Body IK Settings"
SubIterations	int32	Iterations used for sub-chains defined by the Chain Depth of the effectors.	Rig/Solvers/IKRigFullBodyIK.h	BlueprintReadWrite EditAnywhere Category=SolverSettings Meta=(ClampMin="0", ClampMax="1000", UIMin="0.0", UIMax="200.0")

Navigation

Syntax

Inheritance Hierarchy

Variables

Public