Navigation
API > API/Plugins > API/Plugins/IKRig
BEGIN LEGACY CODE
NOTE: As of Unreal 5.6, the old UObject based IK Rig system has been replaced. These are left here to load old UObject data into the new format. NOTE on UIKRigSolver upgrade path: In 5.6 the UObject's in IK Rig have been replaced with runtime-friendly UStruct based data structures As part of this change, solvers based on UIKRigSolver will no longer function and must be upgraded to the new base FIKRigSolverBase. Old assets using UIKRigSolver-based solvers can be loaded and patched using the ConvertToInstancedStruct() function (see below) All solvers that ship with the IKRig plugin have been ported to the new system and should work exactly as before.
| Name | UIKRigSolver |
| Type | class |
| Header File | /Engine/Plugins/Animation/IKRig/Source/IKRig/Public/Rig/Solvers/IKRigSolverBase.h |
| Include Path | #include "Rig/Solvers/IKRigSolverBase.h" |
Syntax
UCLASS (MinimalAPI)
class UIKRigSolver : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UIKRigSolver
Derived Classes
UIKRigSolver derived class hierarchy
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsEnabled | bool | Rig/Solvers/IKRigSolverBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddBoneSetting
(
const FName& BoneName |
Rig/Solvers/IKRigSolverBase.h | ||
virtual void AddGoal
(
const UIKRigEffectorGoal& NewGoal |
Rig/Solvers/IKRigSolverBase.h | ||
virtual void ConvertToInstancedStruct
(
FInstancedStruct& OutInstancedStruct |
This is the legacy upgrade path for solvers that inherit from UIKRigSolver to convert them to FIKRigSolverBase override this and supply a struct into OutInstancedStruct that derives from FIKRigSolverBase that implements your custom solver. | Rig/Solvers/IKRigSolverBase.h | |
virtual void DrawBoneSettings
(
const FName& BoneName, |
Rig/Solvers/IKRigSolverBase.h | ||
| Rig/Solvers/IKRigSolverBase.h | |||
virtual void GetBonesWithSettings
(
TSet< FName >& OutBonesWithSettings |
Rig/Solvers/IKRigSolverBase.h | ||
virtual FName GetEndBone() |
Rig/Solvers/IKRigSolverBase.h | ||
| Rig/Solvers/IKRigSolverBase.h | |||
virtual FText GetNiceName() |
Rig/Solvers/IKRigSolverBase.h | ||
virtual FName GetRootBone() |
Rig/Solvers/IKRigSolverBase.h | ||
virtual bool GetWarningMessage
(
FText& OutWarningMessage |
Rig/Solvers/IKRigSolverBase.h | ||
virtual void Initialize
(
const FIKRigSkeleton& IKRigSkeleton |
Rig/Solvers/IKRigSolverBase.h | ||
virtual bool IsBoneAffectedBySolver
(
const FName& BoneName, |
Rig/Solvers/IKRigSolverBase.h | ||
bool IsEnabled() |
Rig/Solvers/IKRigSolverBase.h | ||
virtual bool IsGoalConnected
(
const FName& GoalName |
Rig/Solvers/IKRigSolverBase.h | ||
virtual void RemoveBoneSetting
(
const FName& BoneName |
Rig/Solvers/IKRigSolverBase.h | ||
virtual void RemoveGoal
(
const FName& GoalName |
Rig/Solvers/IKRigSolverBase.h | ||
| Rig/Solvers/IKRigSolverBase.h | |||
virtual bool RequiresEndBone() |
Rig/Solvers/IKRigSolverBase.h | ||
virtual bool RequiresRootBone() |
Rig/Solvers/IKRigSolverBase.h | ||
void SetEnabled
(
const bool bEnabled |
Rig/Solvers/IKRigSolverBase.h | ||
virtual void SetEndBone
(
const FName& EndBoneName |
Rig/Solvers/IKRigSolverBase.h | ||
| Rig/Solvers/IKRigSolverBase.h | |||
virtual void SetRootBone
(
const FName& RootBoneName |
Rig/Solvers/IKRigSolverBase.h | ||
virtual void Solve
(
FIKRigSkeleton& IKRigSkeleton, |
Rig/Solvers/IKRigSolverBase.h | ||
virtual void UpdateSolverSettings
(
UIKRigSolver* InSettings |
Rig/Solvers/IKRigSolverBase.h | ||
virtual bool UsesBoneSettings() |
Rig/Solvers/IKRigSolverBase.h |