UIKRigController

A singleton (per-asset) class used to make modifications to a [UIKRigDefinition](API\Plugins\IKRig\UIKRigDefinition) asset.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UIKRigController

References

Module	IKRigEditor
Header	/Engine/Plugins/Animation/IKRig/Source/IKRigEditor/Public/RigEditor/IKRigController.h
Include	#include "RigEditor/IKRigController.h"

Syntax

UCLASS(Config=Engine, HideCategories=UObject)
class UIKRigController : public UObject

Remarks

A singleton (per-asset) class used to make modifications to a UIKRigDefinition asset. Call the static GetIKRigController() function to get the controller for the asset you want to modify.

Functions

	Name	Description
void	AddBoneSetting ( const FName& BoneName, int32 SolverIndex )	END Goals Bone SettingsAdd settings to the given Bone/Solver.
UIKRigEffect...	AddNewGoal ( const FName& GoalName, const FName& BoneName )	END SOLVERS GOALSAdd a new Goal associated with the given Bone.
void	AddRetargetChain ( const FName& ChainName, const FName& StartBone, const FName& EndBone )	END Bone Settings Retargeting Options and Retarget Bone ChainsAdd a Chain with the given Name and Start/End bones.
int32	AddSolver ( TSubclassOf< UIKRigSolver > InSolve... )	END SKELETON SOLVERSAdd a new solver of the given type to the bottom of the stack.
void	BroadcastNeedsReinitialized()	Force all currently connected processors to reinitialize using latest asset state
bool	CanAddBoneSetting ( const FName& BoneName, int32 SolverIndex )	Returns true if this Bone can have settings in the given Solver.
bool	CanRemoveBoneSetting ( const FName& BoneName, int32 SolverIndex )	Returns true if settings for this Bone can be removed from the given Solver.
bool	ConnectGoalToSolver ( const UIKRigEffectorGoal& Goal, int32 SolverIndex )	Connect the given Goal to the given Solver.
bool	DisconnectGoalFromSolver ( const FName& GoalToRemove, int32 SolverIndex )	Disconnect the given Goal from the given Solver.
bool	DoesBoneHaveSettings ( const FName& BoneName )	Returns true if the given Bone has any settings in any Solver.
const TArray...	GetAllGoals()	Get read-only access to the list of Goals.
UIKRigDefini...	GetAsset()	Get the asset this controller controls.
bool	GetBoneExcluded ( const FName& BoneName )	Returns true if the given Bone is excluded, false otherwise.
FName	GetBoneForGoal ( const FName& GoalName )	The the Bone associated with the given Goal.
const UIKRig...	GetGoal ( int32 GoalIndex )	Get read-only access to the Goal at the given index.
UIKRigEffect...	GetGoal ( const FName& GoalName )	Get read-write access to the Goal with the given name.
FTransform	GetGoalCurrentTransform ( const FName& GoalName )	Get the global-space transform of the given Goal.
int32	GetGoalIndex ( const FName& GoalName )	Get the index of the given Goal in the list of Goals.
FName	GetGoalName ( const int32& GoalIndex )	Get the name of Goal at the given index.
UObject *...	GetGoalSettingsForSolver ( const FName& GoalName, int32 SolverIndex )	Get the UObject for the settings associated with the given Goal in the given Solver.
UIKRigContro...	GetIKRigController ( UIKRigDefinition* InIKRigDefin... )	Use this to get the controller for the given IKRig
const FIKRig...	GetIKRigSkeleton()	Get read-access to the IKRig skeleton representation
int32	GetNumSolvers()	Get the number of solvers in the stack.
FTransform	GetRefPoseTransformOfBone ( const FName& BoneName )	Get the global-space retarget pose transform of the given Bone.
FName	GetRetargetChainEndBone ( const FName& ChainName )	Get the Start Bone name for the given Chain.
FName	GetRetargetChainGoal ( const FName& ChainName )	Get the Goal name for the given Chain.
const TArray...	GetRetargetChains()	Get read-only access to the list of Chains.
FName	GetRetargetChainStartBone ( const FName& ChainName )	Get the End Bone name for the given Chain.
FName	GetRetargetRoot()	Get the name of the Root Bone of the retargeting (can only be one).
UObject *...	GetSettingsForBone ( const FName& BoneName, int32 SolverIndex )	Get the generic (Solver-specific) Bone settings UObject for this Bone in the given Solver.
USkeletalMes...	GetSkeletalMesh()	Get the skeletal mesh asset this IK Rig was initialized with
USkeleton &#...	GetSkeleton()	Get the USkeleton asset this rig was initialized with
UIKRigSolver...	GetSolver ( int32 Index )	Get access to the given solver.
const TArray...	GetSolverArray()	Get read-only access to the array of solvers.
FString	GetSolverUniqueName ( int32 SolverIndex )	Get unique label for a given solver.
FName	GetUniqueRetargetChainName ( const FName& NameToMakeUnique )	Make unique name for a retargeting bone chain. Adds a numbered suffix to make it unique.
bool	IsGoalConnectedToSolver ( const FName& GoalName, int32 SolverIndex )	Returns true if the given Goal is connected to the given Solver. False otherwise.
bool	ModifyGoal ( const FName& GoalName )	Modify a Goal for a transaction. Returns true if Goal found.
bool	MoveSolverInStack ( int32 SolverToMoveIndex, int32 TargetSolverIndex )	Move the solver at the given index to the target index.
FOnIKRigNeed...	OnIKRigNeedsInitialized()
FOnRetargetC...	OnRetargetChainRemoved()
FOnRetargetC...	OnRetargetChainRenamed()
void	RemoveBoneSetting ( const FName& BoneName, int32 SolverIndex )	Remove settings for the given Bone/Solver.
bool	RemoveGoal ( const FName& GoalName )	Remove the Goal by name.
bool	RemoveRetargetChain ( const FName& ChainName )	Remove a Chain with the given name. Returns true if a Chain was removed.
void	RemoveSolver ( const int32 SolverIndex )	Remove the solver at the given stack index.
FName	RenameGoal ( const FName& OldName, const FName& PotentialNewName )	Rename a Goal.
FName	RenameRetargetChain ( const FName& ChainName, const FName& NewChainName )	Renamed the given Chain. Returns the new name (same as old if unsuccessful).
void	ResetGoalTransforms()	Reset all Goals back to their initial transforms.
void	SanitizeGoalName ( FString& InOutName )	Ensure that the given name adheres to required standards for Goal names (no special characters etc..)
void	SetBoneExcluded ( const FName& BoneName, const bool bExclude )	Include/exclude a bone from all the solvers. All bones are included by default.
void	SetEndBone ( const FName& EndBoneName, int32 SolverIndex )	Set the end bone on a given solver.
bool	SetGoalBone ( const FName& GoalName, const FName& NewBoneName )	The the Bone that the given Goal should be parented to / associated with.
void	SetGoalCurrentTransform ( const FName& GoalName, const FTransform& Transform )	Set the Goal to the given transform.
bool	SetRetargetChainEndBone ( const FName& ChainName, const FName& EndBoneName )	Set the End Bone for the given Chain. Returns true if operation was successful.
bool	SetRetargetChainGoal ( const FName& ChainName, const FName& GoalName )	Set the Goal for the given Chain. Returns true if operation was successful.
bool	SetRetargetChainStartBone ( const FName& ChainName, const FName& StartBoneName )	Set the Start Bone for the given Chain. Returns true if operation was successful.
void	SetRetargetRoot ( const FName& RootBoneName )	Set the Root Bone of the retargeting (can only be one).
void	SetRootBone ( const FName& RootBoneName, int32 SolverIndex )	Set the root bone on a given solver.
bool	SetSkeletalMesh ( USkeletalMesh* SkeletalMesh, bool bTransact )	SKELETON Sets the preview mesh to use, can optionally reinitialize the skeleton with bReImportBone=true.
bool	SetSolverEnabled ( int32 SolverIndex, bool bIsEnabled )	Enabled/disable the given solver.
void	SortRetargetChains()	Sorts the Chains from Root to tip based on the Start Bone of each Chain.
bool	ValidateChain ( const FName& ChainName, TSet< int32 >& OutChainIndices )	Returns true if this is a valid chain.

Typedefs

Name	Description
FOnIKRigNeedsInitialized	Called whenever the rig is modified in such a way that would require re-initialization by dependent systems.
FOnRetargetChainRemoved	Called whenever a retarget chain is removed.
FOnRetargetChainRenamed	Called whenever a retarget chain is renamed.

Constants

Name	Description
AssetToControllerMap	Lazy-generated map of Controllers to IK Rig Assets. Avoids duplicate controllers.