Navigation
API > API/Plugins > API/Plugins/ControlRig > API/Plugins/ControlRig/URigHierarchyController
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool RenameComponent
(
FRigBaseComponent* InComponent, |
Renames an existing component in the hierarchy | Rigs/RigHierarchyController.h | |
FRigComponentKey RenameComponent
(
FRigComponentKey InComponent, |
Renames an existing component in the hierarchy | Rigs/RigHierarchyController.h |
|
RenameComponent(FRigBaseComponent *, const FName &, bool, bool)
Description
Renames an existing component in the hierarchy
| Name | RenameComponent |
| Type | function |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Rigs/RigHierarchyController.h |
| Include Path | #include "Rigs/RigHierarchyController.h" |
| Source | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Private/Rigs/RigHierarchyController.cpp |
bool RenameComponent
(
FRigBaseComponent * InComponent,
const FName & InName,
bool bClearSelection,
bool bSetupUndoRedo
)
Returns true if successful.
Parameters
| Name | Remarks |
|---|---|
| InComponent | The component to rename |
| InName | The new name to set for the component |
| bClearSelection | True if the selection should be cleared after a rename |
RenameComponent(FRigComponentKey, FName, bool, bool, bool)
Description
Renames an existing component in the hierarchy
| Name | RenameComponent |
| Type | function |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Rigs/RigHierarchyController.h |
| Include Path | #include "Rigs/RigHierarchyController.h" |
| Source | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Private/Rigs/RigHierarchyController.cpp |
UFUNCTION (BlueprintCallable, Category=URigHierarchyController)
FRigComponentKey RenameComponent
(
FRigComponentKey InComponent,
FName InName,
bool bSetupUndo,
bool bPrintPythonCommand,
bool bClearSelection
)
Returns the new key used for the component
Parameters
| Name | Remarks |
|---|---|
| InComponent | The key of the component to rename |
| InName | The new name to set for the component |
| bSetupUndo | If set to true the stack will record the change for undo / redo |
| bPrintPythonCommand | If set to true a python command equivalent to this call will be printed out |
| bClearSelection | True if the selection should be cleared after a rename |