Navigation
API > API/Plugins > API/Plugins/IKRigEditor > API/Plugins/IKRigEditor/RetargetEditor
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UIKRetargeterController
References
| Module | IKRigEditor |
| Header | /Engine/Plugins/Animation/IKRig/Source/IKRigEditor/Public/RetargetEditor/IKRetargeterController.h |
| Include | #include "RetargetEditor/IKRetargeterController.h" |
Syntax
UCLASS (Config=Engine, HideCategories=UObject)
class UIKRetargeterController : public UObject
Remarks
A stateless singleton (1-per-asset) class used to make modifications to a UIKRetargeter asset. Use UIKRetargeter.GetController() to get the controller for the asset you want to modify.
Functions
| Type | Name | Description | |
|---|---|---|---|
| int32 | AddRetargetOp
(
TSubclassOf< URetargetOpBase > InOpClass |
Add a new retarget op of the given type to the bottom of the stack. Returns the stack index. | |
| void | AutoAlignAllBones
(
ERetargetSourceOrTarget SourceOrTarget |
Automatically align all bones in mapped chains and store in the current retarget pose. | |
| void | AutoAlignBones
(
const TArray< FName >& BonesToAlign, |
Automatically align an array of bones and store in the current retarget pose. Bones not in a mapped chain will be ignored. | |
| void | AutoMapChains
(
const EAutoMapChainType AutoMapType, |
Use fuzzy string search to find "best" Source chain to map to each Target chain. | |
| void | CleanAsset () |
GENERAL C++ ONLY API Ensures all internal data is compatible with assigned meshes and ready to edit. | |
| FName | CreateRetargetPose
(
const FName& NewPoseName, |
Add new retarget pose. Returns the name of the new retarget pose. | |
| FName | DuplicateRetargetPose
(
const FName PoseToDuplicate, |
Duplicate a retarget pose. Returns the name of the new, duplicate pose (or NAME_None if PoseToDuplicate is not found). | |
| const TArray< URetargetChainSettings * > & | Get read-only access to the list of settings for each target chain. | ||
| bool | GetAskedToFixRootHeightForMesh
(
USkeletalMesh* Mesh |
Get if we've already asked to fix the root height for the given skeletal mesh. | |
| UIKRetargeter * | GetAsset () |
Get access to the retargeter asset. | |
| TObjectPtr< UIKRetargeter > & | GetAssetPtr () |
||
| FName | GetChainGoal
(
const TObjectPtr< URetargetChainSettings > ChainSettings |
Get the name of the goal assigned to a chain. | |
| UIKRetargeterController * | GetController
(
const UIKRetargeter* InRetargeterAsset |
GENERAL PUBLIC/SCRIPTING API Use this to get the controller for the given retargeter asset | |
| FIKRetargetPose & | GetCurrentRetargetPose
(
const ERetargetSourceOrTarget SourceOrTarget |
Get the current retarget pose. | |
| FName | GetCurrentRetargetPoseName
(
const ERetargetSourceOrTarget SourceOrTarget |
Get the current retarget pose. | |
| FRetargetGlobalSettings | Get a copy of the global settings for this asset. | ||
| const UIKRigDefinition * | GetIKRig
(
const ERetargetSourceOrTarget SourceOrTarget |
Get either source or target IK Rig. | |
| UIKRigDefinition * | GetIKRigWriteable
(
const ERetargetSourceOrTarget SourceOrTarget |
Get either source or target IK Rig. | |
| int32 | GetIndexOfRetargetOp
(
URetargetOpBase* RetargetOp |
Get access to the given retarget operation. | |
| int32 | Get the number of Ops in the stack. | ||
| USkeletalMesh * | GetPreviewMesh
(
const ERetargetSourceOrTarget SourceOrTarget |
Get the preview skeletal mesh. | |
| FTargetChainSettings | GetRetargetChainSettings
(
const FName& TargetChainName |
Get a copy of the settings for the target chain by name. | |
| URetargetOpBase * | GetRetargetOpAtIndex
(
int32 Index |
Get access to the given retarget operation. | |
| bool | GetRetargetOpEnabled
(
int32 RetargetOpIndex |
Get enabled status of the given Op. | |
| TMap< FName, FIKRetargetPose > & | GetRetargetPoses
(
const ERetargetSourceOrTarget SourceOrTarget |
Get access to array of retarget poses. | |
| FName | GetRetargetRootBone
(
const ERetargetSourceOrTarget SourceOrTarget |
Get name of the Root bone used for retargeting. | |
| FVector | GetRootOffsetInRetargetPose
(
const ERetargetSourceOrTarget SourceOrTarget |
Get the translation offset on the retarget root bone for the current retarget pose. | |
| FTargetRootSettings | Get a copy of the retarget root settings for this asset. | ||
| FQuat | GetRotationOffsetForRetargetPoseBone
(
const FName& BoneName, |
Get a delta rotation for a given bone for the current retarget pose. | |
| FName | GetSourceChain
(
const FName& TargetChainName |
Get the name of the source chain mapped to a given target chain (the chain animation is copied FROM). | |
| void | HandleRetargetChainAdded
(
UIKRigDefinition* IKRig |
Call this when IK Rig chain is added or removed. | |
| void | HandleRetargetChainRemoved
(
UIKRigDefinition* IKRig, |
Call this when IK Rig chain is removed. | |
| void | HandleRetargetChainRenamed
(
UIKRigDefinition* IKRig, |
Call this when IK Rig chain is renamed. Retains existing mappings using the new name. | |
| bool | IsChainGoalConnectedToASolver
(
const FName& GoalName |
Get whether the given chain's IK goal is connected to a solver. | |
| FName | MakePoseNameUnique
(
const FString& PoseName, |
Add a numbered suffix to the given pose name to make it unique. | |
| bool | MoveRetargetOpInStack
(
int32 OpToMoveIndex, |
Move the retarget op at the given index to the target index. | |
| FOnIKRigReplaced & | Attach a delegate to be notified whenever either the source or target IK Rig asset's are swapped out. | ||
| FOnPreviewMeshReplaced & | Attach a delegate to be notified whenever either the source or target Preview Mesh asset's are swapped out. | ||
| FOnRetargeterNeedsInitialized & | Attach a delegate to be notified whenever the retargeter is modified in such a way that would require re-initialization of the processor. | ||
| bool | RemoveAllOps () |
Remove all ops in the stack. | |
| bool | RemoveRetargetOp
(
const int32 OpIndex |
Remove the retarget op at the given stack index. | |
| bool | RemoveRetargetPose
(
const FName& PoseToRemove, |
Remove a retarget pose. Returns true if the pose was found and removed. | |
| bool | RenameRetargetPose
(
const FName OldPoseName, |
Rename current retarget pose. Returns true if a pose was renamed. | |
| void | ResetRetargetPose
(
const FName& PoseToReset, |
Reset a retarget pose for the specified bones. | |
| void | SetAskedToFixRootHeightForMesh
(
USkeletalMesh* Mesh, |
Set if we've asked to fix the root height for the given skeletal mesh. | |
| bool | SetCurrentRetargetPose
(
FName CurrentPose, |
Change which retarget pose is used by the retargeter at runtime. | |
| void | SetGlobalSettings
(
const FRetargetGlobalSettings& GlobalSettings |
Get a copy of the global settings for this asset. | |
| void | SetIKRig
(
const ERetargetSourceOrTarget SourceOrTarget, |
Set the IK Rig to use as the source or target (to copy animation FROM/TO) | |
| void | SetPreviewMesh
(
const ERetargetSourceOrTarget SourceOrTarget, |
Set the preview skeletal mesh for either source or target. | |
| bool | SetRetargetChainSettings
(
const FName& TargetChainName, |
Set the settings for the target chain by name. Returns true if the chain settings were applied, false otherwise. | |
| bool | SetRetargetOpEnabled
(
int32 RetargetOpIndex, |
Set enabled/disabled status of the given retarget operation. | |
| void | SetRootOffsetInRetargetPose
(
const FVector& TranslationOffset, |
Set the translation offset on the retarget root bone for the current retarget pose. | |
| void | SetRootSettings
(
const FTargetRootSettings& RootSettings |
Set the retarget root settings for this asset. | |
| void | SetRotationOffsetForRetargetPoseBone
(
const FName& BoneName, |
Set a delta rotation for a given bone for the current retarget pose. | |
| bool | SetSourceChain
(
FName SourceChainName, |
Assign a source chain to the given target chain. Animation will be copied from the source to the target. | |
| void | SnapBoneToGround
(
FName ReferenceBone, |
Moves the entire skeleton vertically until the specified bone is the same height off the ground as in the reference pose. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | UObject. |
Typedefs
| Name | Description |
|---|---|
| FOnIKRigReplaced | |
| FOnPreviewMeshReplaced | |
| FOnRetargeterNeedsInitialized | DELEGATE CALLBACKS FOR OUTSIDE SYSTEMS |