1. Epic GamesDeveloper
  3. UIKRigController

UIKRigController

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

API > API/Plugins > API/Plugins/IKRigEditor > API/Plugins/IKRigEditor/RigEditor

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Config&61;Engine, HideCategories&61;UObject&41;  
class UIKRigController : public UObject

Remarks

A singleton (per-asset) class used to make modifications to a UIKRigDefinition asset

All modifications to an IKRigDefinition must go through this controller.

Editors can subscribe to the callbacks on this controller to be notified of changes that require reinitialization of a running IK Rig processor instance. The API here is split into public/scripting sections which are accessible from Blueprint/Python and sections that are only relevant to editors in C++.

Functions

  Type Name Description
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool

AddBoneSetting ( const FName BoneName,
int32 SolverIndex
)

 Add settings to the given Bone/Solver. Does nothing if Bone already has settings in this Solver.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category FName

AddNewGoal ( const FName GoalName,
const FName BoneName
)

 Add a new Goal associated with the given Bone. GoalName must be unique. Bones can have multiple Goals (rare).
Public function Const FName

AddRetargetChain ( const FBoneChain& BoneChain
)

 Add a Chain with the given BoneChain settings. Returns newly created chain name.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category FName

AddRetargetChain ( const FName ChainName,
const FName StartBoneName,
const FName EndBoneName,
const FName GoalName
)

 RETARGETING PUBLIC/SCRIPTING APIAdd a new chain with the given Chain and Bone names.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category int32

AddSolver ( TSubclassOf< UIKRigSolver > InSolverClass
)

 Add a new solver of the given type to the bottom of the stack. Returns the stack index.
Public function Const void Force all currently connected processors to reinitialize using latest asset state
Public function Const bool

CanAddBoneSetting ( const FName BoneName,
int32 SolverIndex
)

 Returns true if this Bone can have settings in the given Solver.
Public function Const bool

CanRemoveBoneSetting ( const FName BoneName,
int32 SolverIndex
)

 Returns true if settings for this Bone can be removed from the given Solver.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool

ConnectGoalToSolver ( const FName GoalName,
int32 SolverIndex
)

 Connect the given Goal to the given Solver. This creates an "Effector" with settings specific to this Solver.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool

DisconnectGoalFromSolver ( const FName GoalToRemove,
int32 SolverIndex
)

 Disconnect the given Goal from the given Solver. This removes the Effector that associates the Goal with the Solver.
Public function Const bool

DoesBoneHaveSettings ( const FName BoneName
)

 Returns true if the given Bone has any settings in any Solver.
Public function Const UFunction BlueprintCallable, Category const TArray< UIKRigEffectorGoal * > & Get access to the list of Goals.
Public function Const UIKRigDefinition * GENERAL C++ ONLY APIGet the asset this controller controls.
Public function TObjectPtr< UIKRigDefinition > & GENERAL C++ ONLY APIGet the asset this controller controls.
Public function Const UFunction BlueprintCallable, Category bool

GetBoneExcluded ( const FName BoneName
)

 Returns true if the given Bone is excluded, false otherwise.
Public function Const UFunction BlueprintCallable, Category FName

GetBoneForGoal ( const FName GoalName
)

 The the Bone associated with the given Goal.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category UObject *

GetBoneSettings ( const FName BoneName,
int32 SolverIndex
)

 Get the generic (Solver-specific) Bone settings UObject for this Bone in the given Solver.
Public function Static UFunction BlueprintCallable, Category UIKRigController *

GetController ( const UIKRigDefinition* InIKRigDefinition
)

 Use this to get the controller for the given IKRig.
Public function Const UFunction BlueprintCallable, Category FName

GetEndBone ( int32 SolverIndex
)

 Get the name of the end bone on a given solver. (not all solvers require extra end bones, checks CanSetEndBone() first)
Public function Const UFunction BlueprintCallable, Category UIKRigEffectorGoal *

GetGoal ( const FName GoalName
)

 Get read-write access to the Goal with the given name.
Public function Const FTransform

GetGoalCurrentTransform ( const FName GoalName
)

 Get the global-space transform of the given Goal. This may be set by the user in the editor, or at runtime.
Public function Const int32

GetGoalIndex ( const FName InGoalName,
const ENameCase CompareMethod
)

 Get the index of the given Goal in the list of Goals.
Public function Const UFunction BlueprintCallable, Category FName

GetGoalNameForBone ( const FName BoneName
)

 Get the Goal associated with the given Bone (may be NAME_None)
Public function Const UFunction BlueprintCallable, Category UObject *

GetGoalSettingsForSolver ( const FName GoalName,
int32 SolverIndex
)

 Get the UObject for the settings associated with the given Goal in the given Solver.
Public function Const const FIKRigSkeleton & Get read-access to the IKRig skeleton representation.
Public function Const UFunction BlueprintCallable, Category int32 Get access to the given solver.
Public function Const UFunction BlueprintCallable, Category int32 Get the number of solvers in the stack.
Public function Const UFunction BlueprintCallable, Category FTransform

GetRefPoseTransformOfBone ( const FName BoneName
)

 Get the global-space retarget pose transform of the given Bone.
Public function Const const FBoneChain *

GetRetargetChainByName ( const FName ChainName
)

 Get read-only access to a single retarget chain with the given name.
Public function Const UFunction BlueprintCallable, Category FName

GetRetargetChainEndBone ( const FName ChainName
)

 Get the Start Bone name for the given Chain.
Public function Const FName

GetRetargetChainFromBone ( const FName BoneName,
const FIKRigSkeleton* OptionalSkeleton
)

 Get the name of the retarget chain that contains the given Bone. Returns NAME_None if Bone not in a Chain.
Public function Const FName

GetRetargetChainFromGoal ( const FName GoalName
)

 Get the name of the retarget chain that contains the given Goal. Returns NAME_None if Goal not in a Chain.
Public function Const UFunction BlueprintCallable, Category FName

GetRetargetChainGoal ( const FName ChainName
)

 Get the Goal name for the given Chain.
Public function Const UFunction BlueprintCallable, Category const TArray< FBoneChain > & Get read-only access to the list of Chains.
Public function Const UFunction BlueprintCallable, Category FName

GetRetargetChainStartBone ( const FName ChainName
)

 Get the End Bone name for the given Chain.
Public function Const UFunction BlueprintCallable, Category FName Get the name of the Root Bone of the retargeting (can only be one).
Public function Const UFunction BlueprintCallable, Category FName

GetRootBone ( int32 SolverIndex
)

 Get the name of the root bone on a given solver. (not all solvers support root bones, checks CanSetRootBone() first)
Public function Const UFunction BlueprintCallable, Category USkeletalMesh * Get the skeletal mesh this asset is initialized with.
Public function Const const TArray< UIKRigSolver * > & Get read-only access to the array of solvers.
Public function Const UFunction BlueprintCallable, Category UIKRigSolver *

GetSolverAtIndex ( int32 Index
)

 Get access to the given solver.
Public function Const UFunction BlueprintCallable, Category bool

GetSolverEnabled ( int32 SolverIndex
)

 Get enabled status of the given solver.
Public function Const FString

GetSolverUniqueName ( int32 SolverIndex
)

 Get unique label for a given solver. Returns dash separated index and name like so, "0 - SolverName".
Public function Const FName

GetUniqueGoalName ( const FName NameToMakeUnique
)

 Add a suffix as needed to ensure the Goal name is unique.
Public function Const FName

GetUniqueRetargetChainName ( const FName NameToMakeUnique
)

 Make unique name for a retargeting bone chain. Adds a numbered suffix to make it unique.
Public function Const UFunction BlueprintCallable, Category bool

IsGoalConnectedToAnySolver ( const FName GoalName
)

 Returns true if the given Goal is connected to ANY solver. False otherwise.
Public function Const UFunction BlueprintCallable, Category bool

IsGoalConnectedToSolver ( const FName GoalName,
int32 SolverIndex
)

 Returns true if the given Goal is connected to the given Solver. False otherwise.
Public function Const UFunction BlueprintCallable, Category bool

IsSkeletalMeshCompatible ( USkeletalMesh* SkeletalMeshToCheck
)

 Returns true if the provided skeletal mesh could be used with this IK Rig.
Public function Const bool

ModifyGoal ( const FName GoalName
)

 Modify a Goal for a transaction. Returns true if Goal found.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool

MoveSolverInStack ( int32 SolverToMoveIndex,
int32 TargetSolverIndex
)

 Move the solver at the given index to the target index.
Public function FOnIKRigNeedsInitialized &  
Public function FOnRetargetChainAdded &  
Public function FOnRetargetChainRemoved &  
Public function FOnRetargetChainRenamed &  
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool

RemoveBoneSetting ( const FName BoneName,
int32 SolverIndex
)

 Remove settings for the given Bone/Solver. Does nothing if Bone doesn't have setting in this Solver.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool

RemoveGoal ( const FName GoalName
)

 Remove the Goal by name.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool

RemoveRetargetChain ( const FName ChainName
)

 Remove a Chain with the given name. Returns true if a Chain was removed.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool

RemoveSolver ( const int32 SolverIndex
)

 Remove the solver at the given stack index.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category FName

RenameGoal ( const FName OldName,
const FName PotentialNewName
)

 Rename a Goal. Returns new name, which may be different after being sanitized. Returns NAME_None if this fails.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category FName

RenameRetargetChain ( const FName ChainName,
const FName NewChainName
)

 Renamed the given Chain. Returns the new name (same as old if unsuccessful).
Public function Const void Reset all Goals back to their initial transforms.
Public function Const void Reset initial goal transform.
Public function Static void

SanitizeGoalName ( FString& InOutName
)

 Ensure that the given name adheres to required standards for Goal names (no special characters etc..)
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool

SetBoneExcluded ( const FName BoneName,
const bool bExclude
)

 Include/exclude a bone from all the solvers. All bones are included by default.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool

SetEndBone ( const FName EndBoneName,
int32 SolverIndex
)

 Set the end bone on a given solver. (not all solvers require extra end bones, checks CanSetEndBone() first)
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool

SetGoalBone ( const FName GoalName,
const FName NewBoneName
)

 The the Bone that the given Goal should be parented to / associated with.
Public function Const void

SetGoalCurrentTransform ( const FName GoalName,
const FTransform& Transform
)

 Set the Goal to the given transform.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool

SetRetargetChainEndBone ( const FName ChainName,
const FName EndBoneName
)

 Set the End Bone for the given Chain. Returns true if operation was successful.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool

SetRetargetChainGoal ( const FName ChainName,
const FName GoalName
)

 Set the Goal for the given Chain. Returns true if operation was successful.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool

SetRetargetChainStartBone ( const FName ChainName,
const FName StartBoneName
)

 Set the Start Bone for the given Chain. Returns true if operation was successful.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool

SetRetargetRoot ( const FName RootBoneName
)

 Set the Root Bone of the retargeting (can only be one).
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool

SetRootBone ( const FName RootBoneName,
int32 SolverIndex
)

 Set the root bone on a given solver. (not all solvers support root bones, checks CanSetRootBone() first)
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool

SetSkeletalMesh ( USkeletalMesh* SkeletalMesh,
bool bTransact
)

 Sets the preview mesh to use.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool

SetSolverEnabled ( int32 SolverIndex,
bool bIsEnabled
)

 Set enabled/disabled status of the given solver.
Public function Const void Sorts the Chains from Root to tip based on the Start Bone of each Chain.
Public function Const bool

ValidateChain ( const FName ChainName,
const FIKRigSkeleton* OptionalSkeleton,
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.
FOnRetargetChainAdded Called whenever a retarget chain is added.
FOnRetargetChainRemoved Called whenever a retarget chain is removed.
FOnRetargetChainRenamed Called whenever a retarget chain is renamed.

Constants

Name Description
Controllers Static global map of assets to their associated controller.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page