1. Epic GamesDeveloper
  3. UIKRigFBIKSolver

UIKRigFBIKSolver

API > API/Plugins > API/Plugins/IKRig > API/Plugins/IKRig/Rig > API/Plugins/IKRig/Rig/Solvers

Inheritance Hierarchy

References

   
Module IKRig
Header /Engine/Plugins/Animation/IKRig/Source/IKRig/Public/Rig/Solvers/IKRig_FBIKSolver.h
Include #include "Rig/Solvers/IKRig_FBIKSolver.h"

Syntax

UCLASS&40;BlueprintType, EditInlineNew, Config&61;Engine, HideCategories&61;UObject&41;  
class UIKRigFBIKSolver : public UIKRigSolver

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bAllowStretch If true, joints will translate to reach the effectors; causing bones to lengthen if necessary.
Public variable UProperty TArray< TObjectPtr< UIKRig_FBIKBoneSettings > > BoneSettings  
Public variable UProperty TArray< TObjectPtr< UIKRig_FBIKEffector > > Effectors  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite int32 Iterations High iteration counts can help solve complex joint configurations with competing constraints, but will increase runtime cost.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float MassMultiplier A global mass multiplier; higher values will make the joints more stiff, but require more iterations.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float MaxAngle Maximum angle that a joint can be rotated per constraint iteration.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float OverRelaxation Pushes constraints beyond their normal amount to speed up convergence.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FRootPrePullSettings PrePullRootSettings Settings only applicable when Root Behavior is set to "PrePull".
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float PullChainAlpha A global multiplier for all Pull Chain Alpha values on all effectors.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EPBIKRootBehavior RootBehavior (Default is PrePull) Set the behavior of the solver root.
Public variable UProperty Category BlueprintReadWrite visibleanywhere FName RootBone All bones above this bone in the hierarchy will be completely ignored by the solver.

Overridden from UIKRigSolver

  Type Name Description
Public function Virtual void

AddBoneSetting ( const FName& BoneName
)

 Bone settings
Public function Virtual void

AddGoal ( const UIKRigEffectorGoal& NewGoal
)

 Goals
Public function Virtual Const void

DrawBoneSettings ( const FName& BoneName,
const FIKRigSkeleton& IKRigSkeleton,
FPrimitiveDrawInterface* PDI
)

 Todo override to draw custom per-bone settings in the editor viewport
Public function Virtual Const UObject *

GetBoneSetting ( const FName& BoneName
)

 Override to support supplying per-bone settings to outside systems for editing/UI NOTE: This must be overriden on solvers that use bone settings.
Public function Virtual Const void

GetBonesWithSettings ( TSet< FName >& OutBonesWithSettings
)

 Override to support telling outside systems which bones this solver has setting for.
Public function Virtual Const UObject *

GetGoalSettings ( const FName& GoalName
)

 Override to support supplying goals settings specific to this solver to outside systems for editing/UI
Public function Virtual Const FText Override to give your solver a nice name to display in the UI
Public function Virtual Const FName If solver requires a root bone, then override this to return it.
Public function Virtual Const bool

GetWarningMessage ( FText& OutWarningMessage
)

 Override to provide warning to user during setup of any missing components.
Public function Virtual void

Initialize ( const FIKRigSkeleton& IKRigSkeleton
)

 Runtime
Public function Virtual Const bool

IsBoneAffectedBySolver ( const FName& BoneName,
const FIKRigSkeleton& IKRigSkeleton
)

 Return true if the supplied Bone is affected by this solver - this provides UI feedback for user
Public function Virtual Const bool

IsGoalConnected ( const FName& GoalName
)

 Override to support QUERY for a connected goal
Public function Virtual void

RemoveBoneSetting ( const FName& BoneName
)

 Override to support ADDING PER-BONE settings for this solver
Public function Virtual void

RemoveGoal ( const FName& GoalName
)

 Override to support REMOVING a goal from custom solver
Public function Virtual void

RenameGoal ( const FName& OldName,
const FName& NewName
)

 Override to support RENAMING an existing goal
Public function Virtual Const bool Root bone can be set on this solver
Public function Virtual void

SetGoalBone ( const FName& GoalName,
const FName& NewBoneName
)

 Override to support CHANGING BONE for an existing goal
Public function Virtual void

SetRootBone ( const FName& RootBoneName
)

 Override to support SETTING ROOT BONE for the solver
Public function Virtual void

Solve ( FIKRigSkeleton& IKRigSkeleton,
const FIKRigGoalContainer& Goals
)

 Override Solve() to evaluate new output pose (InOutGlobalTransform)
Public function Virtual void Override to support RECEIVING modified solver settings from outside systems for editing/UI.
Public function Virtual Const bool Override to tell systems if this solver supports per-bone settings

Overridden from UObject

  Type Name Description
Public function Virtual void END UIKRigSolver interface

Deprecated Variables

  Type Name Description
Public variable UProperty bool bStartSolveFromInputPose_DEPRECATED DEPRECATED: When true, the solver is reset each tick to start from the current input pose.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page