1. Epic GamesDeveloper
  3. FIKRigEditorController

FIKRigEditorController

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

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

Inheritance Hierarchy

References

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

Syntax

class FIKRigEditorController :  
    public TSharedFromThis< FIKRigEditorController >,  
    private FGCObject

Remarks

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

Variables

  Type Name Description
Public variable UProperty Transient nontransactional TObjectPtr< UIKRigAnimInstance > AnimInstance Viewport anim instance
Public variable UProperty Transient TObjectPtr< UIKRigController > AssetController All modifications to the data model should go through this controller
Public variable bool bManipulatingGoals UI and viewport selection state.
Public variable FRetargetChainAnalyzer ChainAnalyzer Used to analyze a retarget chain
Public variable TWeakPtr< FIKRigEditorToolkit > EditorToolkit The persona toolkit
Public variable UDebugSkelMeshComponent * SkelMeshComponent Viewport skeletal mesh

Functions

  Type Name Description
Public function void

AddNewGoals ( const TArray< FName >& GoalNames,
const TArray< FName >& BoneNames
)

 Create goals
Public function Const void Clear the output log
Public function void Clear all selected objects
Public function Const void

Close ()

 Cleanup when editor closed
Public function Const TObjectPtr< UIKRigBoneDetails >

CreateBoneDetails ( const TSharedPtr< FIKRigTreeElement const >& InItem
)

 UIKRigBoneDetails factory *.
Public function void Create new retarget chains from selected bones (or single empty chain if no selection)
Public function Const bool Is anything selected in the skeleton view?
Public function void Get chains selected in skeleton view
Public function Const const FIKRigSkeleton * Get the currently running IKRig skeleton (if there is a running processor)
Public function Const UIKRigProcessor * Get the currently active processor running the IK Rig in the editor
Public function Const EIKRigSelectionType Record which part of the UI was last selected
Public function Const int32 Return the number of selected goals
Public function Const void

GetSelectedBoneNames ( TArray< FName >& OutBoneNames
)

 Get names of all bones that are selected
Public function Const void Get all bones that are selected
Public function Const TArray< FName > Get name of the selected retargeting chain
Public function Const void

GetSelectedGoalNames ( TArray< FName >& OutGoalNames
)

 Get names of all goals that are selected
Public function int32 Get index of the first selected solver, return INDEX_None if nothing selected
Public function Const void Return list of those solvers in the stack that are selected by user
Public function Const void

HandleBoneSelectedInViewport ( const FName& BoneName,
bool bReplace
)

 Callback when bone is selected in the viewport
Public function Const void

HandleGoalSelectedInViewport ( const FName& GoalName,
bool bReplace
)

 Callback when goal is selected in the viewport
Public function Const void Callback when IK Rig requires re-initialization
Public function void Initialize the editor controller to an instance of the IK Rig editor
Public function Const bool

IsGoalSelected ( const FName& GoalName
)

 Returns true if Goal is currently selected
Public function Const void

OnFinishedChangingDetails ( const FPropertyChangedEvent& PropertyChangedEvent
)

 Callback when detail is edited
Public function void Play preview animation on running anim instance in editor (before IK)
Public function Const bool Right after importing a skeleton, we ask user what solver they want to use
Public function Const FName Show user the new retarget chain they are about to create (provides option to edit name)
Public function Const void Right after creating a goal, we ask user if they want it assigned to a retarget chain
Public function void Initial setup, used when asset is empty (no hierarchy, no mesh assigned)
Public function Const void Refresh all views
Public function Const void Refresh just the skeleton tree view
Public function Const void

Reset ()

 Reset all goals to initial transforms
Public function void

SetDetailsView ( const TSharedPtr< class IDetailsView >& InDetailsView
)

 Set details tab view
Public function void

SetHierarchyView ( const TSharedPtr< SIKRigHierarchy >& InSkeletonView
)

 Set skeleton tab view
Public function void  
Public function void

SetOutputLogView ( const TSharedPtr< SIKRigOutputLog >& InOutputLogView
)

 Set output log view
Public function void

SetRetargetingView ( const TSharedPtr< SIKRigRetargetChainList >& InRetargetingView
)

 Set retargeting tab view
Public function void

SetSolverStackView ( const TSharedPtr< SIKRigSolverStack >& InSolverStackView
)

 Set solver stack tab view
Public function Const void

ShowDetailsForBone ( const FName BoneName
)

 Show single transform of bone in details view
Public function Const void

ShowDetailsForBoneSettings ( const FName& BoneName,
int32 SolverIndex
)

 Show single BONE settings in details view
Public function Const void Show selected items in details view
Public function Const void

ShowDetailsForGoal ( const FName& GoalName
)

 Show single GOAL settings in details view
Public function Const void

ShowDetailsForGoalSettings ( const FName GoalName,
const int32 SolverIndex
)

 Show single EFFECTOR settings in details view
Public function Const void

ShowDetailsForSolver ( const int32 SolverIndex
)

 Show single SOLVER settings in details view
Public function Const void Show nothing in details view

Overridden from FGCObject

  Type Name Description
Public function Virtual void Pure virtual that must be overloaded by the inheriting class.
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