Navigation
| Name | IKRigEditor |
| Type | Editor |
| Part of Plugins | IK Rig |
| Location | /Engine/Plugins/Animation/IKRig/Source/IKRigEditor/ |
| Module Build Rules | IKRigEditor.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FAdditivePoseOpCustomization | Retarget Pose Op Customization |
| FAssetTypeActions_IKRetargeter | |
| FAssetTypeActions_IKRigDefinition | |
| FChainsFKOpCustomization | FK Chain Op Customization |
| FIKChainOpCustomization | IK Chains Op Customization |
| FIKRetargetApplicationMode | |
| FIKRetargetBoneDetailCustomization | |
| FIKRetargetCommands | |
| FIKRetargetDefaultMode | |
| FIKRetargetEditor | |
| FIKRetargetEditorController | A home for cross-widget communication to synchronize state across all tabs and viewport |
| FIKRetargetEditorStyle | |
| FIKRetargetEditPoseMode | |
| FIKRetargeterThumbnailScene | |
| FIKRetargetHierarchyElement | |
| FIKRetargetOpBaseSettingsCustomization | |
| FIKRetargetPoseExporter | |
| FIKRigCommands | |
| FIKRigEditMode | |
| FIKRigEditor | |
| FIKRigEditorController | A home for cross-widget communication to synchronize state across all tabs and viewport |
| FIKRigEditorStyle | |
| FIKRigEditorToolkit | |
| FIKRigGenericDetailCustomization | |
| FIKRigMode | |
| FIKRigSkeletonCommands | |
| FIKRigSkeletonDragDropOp | |
| FIKRigSolverStackDragDropOp | |
| FIKRigStructViewerCustomization | |
| FIKRigStructWrapperCustomization | |
| FIKRigTreeElement | |
| FPoleVectorOpCustomization | Pole Vector Op Customization |
| FRetargetChainElement | |
| FRetargetChainMapElement | |
| FRetargetOpStackDragDropOp | |
| FRetargetOpStackElement | SListView item-type for a single retarget op. |
| FRetargetPoseViewportClient | Client for SRetargetPoseViewport |
| FRunIKRigOpCustomization | Run IK Op Customization |
| FSolverStackElement | |
| FSpeedPlantOpCustomization | Speed Plant Op Customization |
| FStrideWarpOpCustomization | Stride Warp Op Customization |
| SBaseHierarchyTreeView | |
| SBatchExportOptionsDialog | Dialog to select batch export options |
| SBatchExportPathDialog | Dialog to select path to export to |
| SIKRetargetAssetBrowser | |
| SIKRetargetChainMapList | |
| SIKRetargetChainMapRow | |
| SIKRetargetHierarchy | |
| SIKRetargetHierarchyRow | |
| SIKRetargetPoseEditor | |
| SIKRigAssetBrowser | |
| SIKRigHierarchy | |
| SIKRigHierarchyItem | |
| SIKRigOutputLog | |
| SIKRigRetargetChainList | |
| SIKRigRetargetChainRow | |
| SIKRigSkeletonRow | |
| SIKRigSolverStack | |
| SIKRigSolverStackItem | |
| SParentRetargetOpItem | An SRetargetOpList item representing a single op with children op beneath it (contains an SRetgargetOpList to house children ops) |
| SRetargetAnimAssetsWindow | Window to display when configuring batch duplicate & retarget process |
| SRetargetExporterAssetBrowser | Asset browser for user to select animation assets to duplicate/retarget |
| SRetargetOpItem | Builds an UI element representing a single op |
| SRetargetOpList | An SListView customized for retarget ops Supports: |
| SRetargetOpSingleItem | An SRetargetOpList item representing a single op with no children |
| SRetargetOpStack | Top level view of a stack of ik retargeter ops shows the main menu for adding ops to the retargeting stack, and a list view of top-level ops |
| SRetargetPoseViewport | Viewport in retarget dialog that previews results of retargeting before exporting animations |
| UBatchExportOptions | Settings object used in details view of the batch retarget window |
| UBatchRetargetSettings | Settings object used in details view of the batch retarget window |
| UIKRetargetAnimInstance | |
| UIKRetargetBatchOperation | Encapsulate ability to batch duplicate and retarget a set of animation assets. |
| UIKRetargetBoneDetails | |
| UIKRetargeterController | A stateless singleton (1-per-asset) class used to make modifications to a UIKRetargeter asset. |
| UIKRetargeterThumbnailRenderer | This thumbnail renderer displays a given IK Rig in the asset icon |
| UIKRetargetFactory | |
| UIKRigAnimInstance | |
| UIKRigBoneDetails | |
| UIKRigController | A singleton (per-asset) class used to make modifications to a UIKRigDefinition asset |
| UIKRigDefinitionFactory | |
| UIKRigStructViewer | A thin wrapper around UStruct data to display in a details panel this is a generic wrapper that works for any struct it is intended to work with FIKRigStructViewerCustomization which simply puts the entire struct in the details panel if you need customization, you need to work with UIKRigStructWrapperBase which allows customized derived classes |
| UIKRigStructWrapperBase | This is meant to be subclassed by a type that contains a UProperty of a struct to be edited similar to UIKRigStructViewer but supports multi-struct editing and greater customization |
| UIKRigThumbnailRenderer | This thumbnail renderer displays a given IK Rig in the asset icon |
| UPoleVectorSettingsWrapper | |
| URetargetFKChainSettingsWrapper | |
| URetargetIKChainSettingsWrapper | |
| URetargetPoseOpSettingsWrapper | |
| URetargetSpeedPlantSettingsWrapper | |
| URetargetStrideWarpSettingsWrapper |
Structs
| Name | Remarks |
|---|---|
| FAbstractHierarchy | An abstract representation of a skeleton including just their names and hierarchy |
| FAdditiveRetargetSettings | |
| FAllBoneSettingsForIK | |
| FAnimNode_PreviewRetargetPose | A node just to preview a retarget pose |
| FAutoCharacterizer | Contains all the known hierarchies in popular usage, and provides a function to compare any given Skeletal Mesh against them if a template is matched to the input skeleton, then the retarget definition is adapted to the given skeleton |
| FAutoCharacterizeResults | The results of auto characterizing an input skeletal mesh |
| FAutoFBIKCreator | Given an IK Rig, will automatically generate an FBIK setup for use with retargeting |
| FAutoFBIKResults | The results of auto characterizing an input skeletal mesh |
| FAutoRetargetDefinition | |
| FBoneEdit | |
| FBoneSettingsForIK | |
| FBonesToPin | |
| FBoneToPin | |
| FBoundIKRig | |
| FChainFilterOptions | |
| FChainMapFilterOptions | |
| FChainMapListConfig | |
| FCharacterizationStandard | The central ground truth for standardized characterization labels used in Unreal |
| FIKRetargetAnimInstanceProxy | Proxy override for this UAnimInstance-derived class |
| FIKRetargetAssetBrowserTabSummoner | |
| FIKRetargetBatchOperationContext | Data needed to run a batch "duplicate and retarget" operation on a set of animation assets. |
| FIKRetargetHierarchyTabSummoner | |
| FIKRetargetOpMetaData | Meta data about an op type used to create filtered menus for creating ops with compatible child types in parent-op menus |
| FIKRetargetOpStackTabSummoner | |
| FIKRetargetOutputLogTabSummoner | |
| FIKRetargetTransformUIData | |
| FIKRetargetTransformWidgetData | |
| FIKRigAnimInstanceProxy | Proxy override for this UAnimInstance-derived class |
| FIKRigAssetBrowserTabSummoner | |
| FIKRigHierarchyFilterOptions | |
| FIKRigHierarchyImportSettings | |
| FIKRigOutputLogTabSummoner | |
| FIKRigRetargetChainSettings | |
| FIKRigRetargetChainTabSummoner | |
| FIKRigSkeletonTabSummoner | |
| FIKRigSolverMetaData | |
| FIKRigSolverStackTabSummoner | |
| FIKRigSolverTypeAndName | |
| FIKRigStructToView | |
| FKnownTemplateHierarchies | A collection of FTemplateHierarchy to compare against |
| FProceduralRetargetAssets | A container for procedurally generated retarget assets (used in memory and discarded after batch retarget operation) can optionally be saved to disk as well |
| FRetargetAutoPoseGenerator | A sub-system used by the IKRetargetEditorController for automatically generating a retarget pose |
| FRetargetChainAnalyzer | Use string matching and skeletal analysis to suggest a reasonable default name for retarget chains |
| FRetargetHierarchyFilterOptions | |
| FRetargetPlaybackManager | |
| FScopedReinitializeIKRetargeter | |
| FScopedReinitializeIKRig | |
| FTemplateHierarchy | A hard coded template representing a "known" hierarchy that is used in the world (ie UE5 Mannequin, Fortnite skeleton etc..) contains the recommended retarget definition to use for this template, including the pelvis, retarget chains and bone settings |
| HIKRetargetEditorBoneProxy | Allow bone selection to edit retarget pose |
| HIKRigEditorBoneProxy | |
| HIKRigEditorGoalProxy |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FRetargetChainMapElementPtr | TSharedPtr< FRetargetChainMapElement > | RetargetEditor/SIKRetargetChainMapList.h | |
| SIKRetargetHierarchyTreeView | SBaseHierarchyTreeView< FIKRetargetHierarchyElement > | RetargetEditor/SIKRetargetHierarchy.h | |
| SIKRigSkeletonTreeView | SBaseHierarchyTreeView< FIKRigTreeElement > | RigEditor/SIKRigHierarchy.h | |
| SRetargetChainListViewType | SListView< TSharedPtr< FRetargetChainElement > > | RigEditor/SIKRigRetargetChainList.h | |
| SRetargetChainMapListViewType | SListView< TSharedPtr< FRetargetChainMapElement > > | RetargetEditor/SIKRetargetChainMapList.h | |
| SSolverStackListViewType | SListView< TSharedPtr< FSolverStackElement > > | RigEditor/SIKRigSolverStack.h |
Enums
Public
| Name | Remarks |
|---|---|
| EAutoFBIKResult | What was the outcome of trying to automatically setup FBIK? |
| EBatchRetargetUIState | |
| EChainSide | |
| ECleanOrFullName | Clean names are used for comparison full names are used to resolve a retarget definition onto an actual skeleton (which may have prefixes) |
| EIKRetargetTransformType | |
| EIKRigSelectionType | |
| EPreferredAxis | |
| ERetargetAutoAlignMethod | A Note on Determining the "Direction" of a Bone... |
| ERetargeterOutputMode | Retarget editor modes |
| ERetargetRefreshMode | Retargeter can reinit just the processor or other UI as well depending on the data model modification type |
| ERetargetRootLockMode | Which skeleton are we referring to? |
| ESelectionEdit | |
| FIKRetargetTrackingState | |
| IKRigTreeElementType |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| IKRetargetApplicationMode | const FName | RetargetEditor/IKRetargetEditor.h | ||
| IKRigEditorMode | const FName | RigEditor/IKRigToolkit.h |