1. Epic GamesDeveloper
  3. FIKRetargetEditorController

FIKRetargetEditorController

A home for cross-widget communication to synchronize state across all tabs and viewport

API > API/Plugins > API/Plugins/IKRigEditor > API/Plugins/IKRigEditor/RetargetEditor

Inheritance Hierarchy

References

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

Syntax

class FIKRetargetEditorController :  
    public TSharedFromThis< FIKRetargetEditorController >,  
    private FGCObject

Remarks

A home for cross-widget communication to synchronize state across all tabs and viewport

Variables

  Type Name Description
Public variable TObjectPtr< UIKRetargeterController > AssetController All modifications to the data model should go through this controller
Public variable TWeakPtr< FIKRetargetEditor > Editor The persona toolkit
Public variable FDelegateHandle IKRigReplacedDelegateHandle  
Public variable TSharedPtr< SEditableTextBox > NewNameEditableText  
Public variable TSharedPtr< SEditableTextBox > NewPoseEditableText  
Public variable TSharedPtr< SWindow > NewPoseWindow  
Public variable TUniquePtr< FRetargetPlaybackManager > PlaybackManager Manage playback of animation in the editor
Public variable TSharedPtr< FIKRetargetPoseExporter > PoseExporter Import / export retarget poses
Public variable TArray< TSharedPtr< FName > > PoseNames ------------------- RETARGET POSES ----------------------- toggle current retarget pose
Public variable FDelegateHandle PreviewMeshReplacedDelegateHandle  
Public variable TSharedPtr< SWindow > RenamePoseWindow  
Public variable FDelegateHandle RetargeterReInitDelegateHandle  
Public variable UProperty Transient nontransactional TObjectPtr< UIKRetargetAnimInstance > SourceAnimInstance  
Public variable UDebugSkelMeshComponent * SourceSkelMeshComponent  
Public variable UProperty Transient nontransactional TObjectPtr< UIKRetargetAnimInstance > TargetAnimInstance  
Public variable UDebugSkelMeshComponent * TargetSkelMeshComponent  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const void

AddOffsetToMeshComponent ( const FVector& Offset,
USceneComponent* MeshComponent
)

  
Public function void Bind callbacks to this IK Rig
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function void  
Public function Const void Clear the output log
Public function void

ClearSelection ( const bool bKeepBoneSelection
)

  
Public function void

Close ()

 Close the editor
Public function Const FReply  
Public function Const FReply  
Public function void

EditBoneSelection ( const TArray< FName >& InBoneNames,
ESelectionEdit EditMode,
const bool bFromHierarchyView
)

 ------------------- SELECTION ----------------------- SELECTION - BONES (viewport or hierarchy view)
Public function void

EditChainSelection ( const TArray< FName >& InChainNames,
ESelectionEdit EditMode,
const bool bFromChainsView
)

 SELECTION - CHAINS (viewport or chains view)
Public function Const void Detect and auto-fix retarget pose that causes root height to be on the ground
Public function Const UIKRetargetAnimInstance *

GetAnimInstance ( const ERetargetSourceOrTarget SourceOrTarget
)

 Viewport anim instance
Public function Const bool

GetCameraTargetForSelection ( FSphere& OutTarget
)

 To frame selection when pressing "f" in viewport
Public function Const FName

GetChainNameFromBone ( const FName& BoneName,
ERetargetSourceOrTarget SourceOrTarget
)

 Get the name of the chain that contains this bone
Public function Const const FRetargetSkeleton & Get the currently edited retarget skeleton
Public function Const FText  
Public function Const FSlateIcon  
Public function Const UDebugSkelMeshComponent * Get currently edited debug skeletal mesh
Public function Const FTransform

GetGlobalRetargetPoseOfBone ( const ERetargetSourceOrTarget SourceOrTarget,
const int32& BoneIndex,
const float& Scale,
const FVector& Offset
)

 Get world space pose of a bone (with component scale / offset applied)
Public function Static void

GetGlobalRetargetPoseOfImmediateChildren ( const FRetargetSkeleton& RetargetSkeleton,
const int32& BoneIndex,
const float& Scale,
const FVector& Offset,
TArray< int32 >& OutChildrenIndices,
TArray< FVector >& OutChildrenPositions
)

 Get world space positions of all immediate children of bone (with component scale / offset applied)
Public function Const ERetargetSelectionType  
Public function TObjectPtr< UIKRetargetBoneDetails >

GetOrCreateBoneDetailsObject ( const FName& BoneName
)

 Factory to get/create bone details UObject
Public function Const ERetargeterOutputMode  
Public function Const FSlateIcon  
Public function FText  
Public function Const float  
Public function Const UIKRetargetProcessor * Get the retargeter that is running in the viewport (which is a duplicate of the source asset)
Public function Const bool  
Public function Const const TArray< FName > &  
Public function Const const TArray< FName > &  
Public function Const UPrimitiveComponent *  
Public function Const USkeletalMesh *

GetSkeletalMesh ( const ERetargetSourceOrTarget SourceOrTarget
)

 Get the USkeletalMesh we are transferring animation between (either source or target)
Public function Const UDebugSkelMeshComponent * Viewport skeletal mesh
Public function Const const USkeleton *

GetSkeleton ( const ERetargetSourceOrTarget SourceOrTarget
)

 Get the USkeleton we are transferring animation between (either source or target)
Public function Const ERetargetSourceOrTarget END viewport / editor tool mode general editor mode can be either viewing/editing source or target
Public function void Delete retarget pose
Public function void Duplicate current retarget pose
Public function Const void Callback when IK Rig asset requires reinitialization
Public function void Callback when IK Rig asset has been swapped out
Public function void Create new retarget pose
Public function void Callback when Preview Mesh asset has been swapped out
Public function void Rename retarget pose
Public function Const void Reset retarget pose
Public function Const void  
Public function Const void  
Public function Const void Callback when IK Rig asset's retarget chain's have been added or removed
Public function Const void

HandleRetargetChainRemoved ( UIKRigDefinition* ModifiedIKRig,
const FName InChainRemoved
)

 Callback when IK Rig asset's retarget chain has been removed
Public function Const void

HandleRetargetChainRenamed ( UIKRigDefinition* ModifiedIKRig,
FName OldName,
FName NewName
)

 Callback when IK Rig asset's retarget chain has been renamed
Public function Const void Callback when IK Retargeter asset requires reinitialization
Public function void Initialize the editor
Public function Const bool

IsBoneRetargeted ( const FName& BoneName,
ERetargetSourceOrTarget SourceOrTarget
)

 ------------------- END SELECTION ----------------------- determine if bone in the specified skeleton is part of the retarget (in a mapped chain)
Public function Const bool  
Public function Const bool  
Public function bool  
Public function bool  
Public function bool

IsObjectInDetailsView ( const UObject* Object
)

  
Public function Const bool Retargeter state
Public function bool  
Public function bool  
Public function bool  
Public function Const void

OnPoseSelected ( TSharedPtr< FName > InPoseName,
ESelectInfo::Type SelectInfo
)

  
Public function void Prompt user to assign an IK Rig to this retargeter (either source or target), returns true if an IK Rig was assigned
Public function Const void Force refresh all views in the editor
Public function Const void  
Public function Const void  
Public function Const void  
Public function Const void  
Public function Const void  
Public function Const FReply Rename retarget pose
Public function Const void END FGCObject interface render the skeleton's in the viewport (either source or target)
Public function Const void Reset the planting state of the IK (when scrubbing or animation loops over)
Public function void  
Public function void  
Public function Const void

SetDetailsObject ( UObject* DetailsObject
)

  
Public function Const void

SetDetailsObjects ( const TArray< UObject* >& DetailsObjects
)

  
Public function void

SetDetailsView ( TSharedPtr< IDetailsView > InDetailsView
)

 Store pointers to various tabs of UI, have to manage access to these because they can be null if the tabs are closed
Public function void  
Public function void  
Public function void Set viewport / editor tool mode
Public function void  
Public function void

SetRetargetPoseAmount ( float InValue
)

  
Public function void

SetRootSelected ( const bool bIsSelected
)

  
Public function void SELECTION - MESHES (viewport view)
Public function void  
Public function void Display global settings in the details panel
Public function void Display root settings in the details panel
Public function void  
Public function void  
Public function void Toggle retarget passes

Overridden from FGCObject

  Type Name Description
Public function Virtual void ------------------- END RETARGET POSES -----------------------FGCObject interface
Public function Virtual Const FString Overload this method to report a name for your referencer

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page