unreal.IKRigFBIKController

class unreal.IKRigFBIKController(outer: Object | None = None, name: Name | str = 'None')

Bases: IKRigSolverControllerBase

The blueprint/python API for modifying an Full-Body IK solver’s settings in an IK Rig. Can adjust Solver, Goal and Bone settings.

C++ Source:

  • Plugin: IKRig

  • Module: IKRig

  • File: IKRigFullBodyIK.h

get_bone_settings(bone_name) → IKRigFBIKBoneSettings

Get the settings associated with a particular bone. Note that you must AddBoneSettings() using the IK Rig controller before a bone will have settings on it.

Parameters:

bone_name (Name) – the name of the bone to get settings for

Returns:

FIKRigFBIKBoneSettings struct holding all the settings for the specified bone (or empty if the bone did not have settings)

Return type:

IKRigFBIKBoneSettings

get_goal_settings(goal_name) → IKRigFBIKGoalSettings

Get the settings for the specified goal.

Parameters:

goal_name (Name) – the name of the goal to get settings for

Returns:

FIKRigFBIKGoalSettings struct (empty if the specified goal does not belong to this solver)

Return type:

IKRigFBIKGoalSettings

get_solver_settings() → IKRigFBIKSettings

Get the current solver settings as a struct.

Returns:

FIKRigFBIKSettings struct with the current settings used by the solver.

Return type:

IKRigFBIKSettings

set_bone_settings(bone_name, settings) → None

Apply settings to a given bone

Parameters:

  • bone_name (Name) – the name of the bone to apply the settings to

  • settings (IKRigFBIKBoneSettings) – a FIKRigFBIKBoneSettings struct containing the settings

set_goal_settings(goal_name, settings) → None

Set the settings for the specified goal.

Parameters:
set_solver_settings(settings) → None

Set the solver settings. Input is a custom struct type for this solver.

Parameters:

settings (IKRigFBIKSettings) – a FIKRigFBIKSettings struct containing all the settings to apply to this solver