1. Epic GamesDeveloper
  3. FIKRigFullBodyIKSolver

FIKRigFullBodyIKSolver

API > API/Plugins > API/Plugins/IKRig

   
Name FIKRigFullBodyIKSolver
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 )  
struct FIKRigFullBodyIKSolver : public FIKRigSolverBase

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AllBoneSettings TArray< FIKRigFBIKBoneSettings >   Rig/Solvers/IKRigFullBodyIK.h  
AllGoalSettings TArray< FIKRigFBIKGoalSettings >   Rig/Solvers/IKRigFullBodyIK.h  
Settings FIKRigFBIKSettings   Rig/Solvers/IKRigFullBodyIK.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
Solver FPBIKSolver   Rig/Solvers/IKRigFullBodyIK.h  

Functions

Public

Overridden from FIKRigSolverBase

Name Remarks Include Path Unreal Specifiers

virtual void AddGoal ( const UIKRigEffectorGoal& InNewGoal
)

 Goals Rig/Solvers/IKRigFullBodyIK.h  

virtual void AddSettingsToBone ( const FName& InBoneName
)

 (required if UsesCustomBoneSettings()) override to support ADDING settings to a particular bone Rig/Solvers/IKRigFullBodyIK.h  

virtual FIKRigBoneSettingsBase * GetBoneSettings ( const FName& InBoneName
)

 (required if UsesCustomBoneSettings()) override to support supplying per-bone settings to outside systems for editing/UI NOTE: This must be overriden on solvers that use bone setting and return nullptr if no settings for the given bone Rig/Solvers/IKRigFullBodyIK.h  

virtual const UScriptStruct * GetBoneSettingsType()

 (required if UsesCustomBoneSettings()) returns the type used for the bone settings in this solver Rig/Solvers/IKRigFullBodyIK.h  

virtual void GetBonesWithSettings ( TSet< FName >& OutBonesWithSettings
) const

 (required if UsesCustomBoneSettings()) override to support telling outside systems which bones this solver has settings for. Rig/Solvers/IKRigFullBodyIK.h  

virtual FIKRigGoalSettingsBase * GetGoalSettings ( const FName& InGoalName
)

 (required if UsesCustomGoalSettings()) override to support supplying goals settings specific to this solver to outside systems for editing/UI returns a pointer to the settings stored for the given bone (null if bone does not have settings) Rig/Solvers/IKRigFullBodyIK.h  

virtual const UScriptStruct * GetGoalSettingsType()

 (required if UsesCustomGoalSettings()) returns the type used for the goal settings in this solver Rig/Solvers/IKRigFullBodyIK.h  

virtual void GetGoalsWithSettings ( TSet< FName >& OutGoalsWithSettings
) const

 (required if UsesCustomGoalSettings()) override to support telling outside systems which goals this solver has settings for. Rig/Solvers/IKRigFullBodyIK.h  

virtual FText GetNiceName()

 Ui Rig/Solvers/IKRigFullBodyIK.h  

virtual void GetRequiredBones ( TSet< FName >& OutRequiredBones
) const

 (required) override to add any bones which this solver requires (helps validate skeleton compatibility) Rig/Solvers/IKRigFullBodyIK.h  

virtual void GetRequiredGoals ( TSet< FName >& OutRequiredGoals
) const

 (required) override to add any goals that have been added to this solver Rig/Solvers/IKRigFullBodyIK.h  

virtual UIKRigSolverControllerBase * GetSolverController ( UObject* Outer
)

 Return custom controller for scripting this solver Rig/Solvers/IKRigFullBodyIK.h  

virtual FIKRigSolverSettingsBase * GetSolverSettings()

 Solver settings Rig/Solvers/IKRigFullBodyIK.h  

virtual const UScriptStruct * GetSolverSettingsType()

 (required) override this and return the type your solver uses to store its settings Rig/Solvers/IKRigFullBodyIK.h  

virtual FName GetStartBone()

 (required if UsesStartBone()) if solver requires a start bone, then override this to return it. Rig/Solvers/IKRigFullBodyIK.h  

virtual bool GetWarningMessage ( FText& OutWarningMessage
) const

 (optional, but recommended) override to provide warning to user during setup of any missing components. return false if no warnings. Rig/Solvers/IKRigFullBodyIK.h  

virtual bool HasSettingsOnBone ( const FName& InBoneName
) const

 (required if UsesCustomBoneSettings()) override to inform outside systems if the given bone has custom settings on it Rig/Solvers/IKRigFullBodyIK.h  

virtual void Initialize ( const FIKRigSkeleton& InIKRigSkeleton
)

 RUNTIME (required) override to setup internal data based on ref pose Rig/Solvers/IKRigFullBodyIK.h  

virtual bool IsBoneAffectedBySolver ( const FName& InBoneName,
const FIKRigSkeleton& InIKRigSkeleton
) const

 (optional, but recommended) return true if the supplied Bone is affected by this solver - this provides UI feedback for user Rig/Solvers/IKRigFullBodyIK.h  

virtual void OnGoalMovedToDifferentBone ( const FName& InGoalName,
const FName& InNewBoneName
)

 (required) override to support CHANGING BONE for an existing goal Rig/Solvers/IKRigFullBodyIK.h  

virtual void OnGoalRemoved ( const FName& InGoalName
)

 (required) override to support REMOVING a goal from custom solver Rig/Solvers/IKRigFullBodyIK.h  

virtual void OnGoalRenamed ( const FName& InOldName,
const FName& InNewName
)

 (required) override to support RENAMING an existing goal Rig/Solvers/IKRigFullBodyIK.h  

virtual void RemoveSettingsOnBone ( const FName& InBoneName
)

 (required if UsesCustomBoneSettings()) override to support REMOVING settings on a particular bone Rig/Solvers/IKRigFullBodyIK.h  

virtual void SetStartBone ( const FName& InRootBoneName
)

 (required if UsesStartBone()) override to support SETTING ROOT BONE for the solver Rig/Solvers/IKRigFullBodyIK.h  

virtual void Solve ( FIKRigSkeleton& InIKRigSkeleton,
const FIKRigGoalContainer& InGoals
)

 (required) override Solve() to evaluate new output pose (InOutGlobalTransform) Rig/Solvers/IKRigFullBodyIK.h  

virtual bool UsesCustomBoneSettings()

 Bone settings Rig/Solvers/IKRigFullBodyIK.h  

virtual bool UsesCustomGoalSettings()

 Goal settings Rig/Solvers/IKRigFullBodyIK.h  

virtual bool UsesStartBone()

 Start bone Rig/Solvers/IKRigFullBodyIK.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page