1. Epic GamesDeveloper
  3. UIKRig_LimbSolver

UIKRig_LimbSolver

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_LimbSolver.h
Include #include "Rig/Solvers/IKRig_LimbSolver.h"

Syntax

UCLASS&40;BlueprintType, EditInlineNew&41;  
class UIKRig_LimbSolver : public UIKRigSolver

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bAveragePull Pull averaging only has a visual impact when we have more than 2 bones (3 links).
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bEnableLimit Enable/Disable rotational limits
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bEnableTwistCorrection Enable Knee Twist correction, by comparing Foot FK with Foot IK orientation.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite TEnumAsByte< EAxis::Type > EndBoneForwardAxis Forward Axis for Foot bone.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TEnumAsByte< EAxis::Type > HingeRotationAxis Hinge Bones Rotation Axis. This is essentially the plane normal for (hip - knee - foot).
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite int32 MaxIterations Number of Max Iterations to reach the target
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float MinRotationAngle Only used if bEnableRotationLimit is enabled.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float PullDistribution Re-position limb to distribute pull: 0 = foot, 0.5 = balanced, 1.f = hip
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float ReachPrecision Precision (distance to the target)
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float ReachStepAlpha Move end effector towards target. If we are compressing the chain, limit displacement.
Public variable UProperty Category BlueprintReadOnly displayname, visibleanywhere FName RootName  

Constructors

  Type Name Description
Public function    

Overridden from UIKRigSolver

  Type Name Description
Public function Virtual void

AddGoal ( const UIKRigEffectorGoal& NewGoal
)

 Goals
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
)

 UIKRigSolver interface
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

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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page