Navigation
API > API/Plugins > API/Plugins/ControlRig > API/Plugins/ControlRig/URigHierarchyController
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TArray< FRigElementKey > ImportBones
(
const FReferenceSkeleton& InSkeleton, |
Imports an existing skeleton to the hierarchy | Rigs/RigHierarchyController.h | |
TArray< FRigElementKey > ImportBones
(
USkeletalMesh* InSkeletalMesh, |
Imports an existing skeleton to the hierarchy, restricting the bone list to the ones that exist in the provided Skeletal Mesh | Rigs/RigHierarchyController.h | |
TArray< FRigElementKey > ImportBones
(
const TArray< FMeshBoneInfo >& BoneInfos, |
Imports the provided bone list to the hierarchy | Rigs/RigHierarchyController.h | |
TArray< FRigElementKey > ImportBones
(
USkeleton* InSkeleton, |
Imports an existing skeleton to the hierarchy | Rigs/RigHierarchyController.h |
|
ImportBones(const FReferenceSkeleton &, const FName &, bool, bool, bool, bool)
Description
Imports an existing skeleton to the hierarchy
| Name | ImportBones |
| 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 |
TArray < FRigElementKey > ImportBones
(
const FReferenceSkeleton & InSkeleton,
const FName & InNameSpace,
bool bReplaceExistingBones,
bool bRemoveObsoleteBones,
bool bSelectBones,
bool bSetupUndo
)
The keys of the imported elements
Parameters
| Name | Remarks |
|---|---|
| InSkeleton | The skeleton to import |
| InNameSpace | The namespace to prefix the bone names with |
| bReplaceExistingBones | If true existing bones will be removed |
| bRemoveObsoleteBones | If true bones non-existent in the skeleton will be removed from the hierarchy |
| bSelectBones | If true the bones will be selected upon import |
| bSetupUndo | If set to true the stack will record the change for undo / redo |
ImportBones(USkeletalMesh *, const FName &, bool, bool, bool, bool)
Description
Imports an existing skeleton to the hierarchy, restricting the bone list to the ones that exist in the provided Skeletal Mesh
| Name | ImportBones |
| 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 |
TArray < FRigElementKey > ImportBones
(
USkeletalMesh * InSkeletalMesh,
const FName & InNameSpace,
bool bReplaceExistingBones,
bool bRemoveObsoleteBones,
bool bSelectBones,
bool bSetupUndo
)
The keys of the imported elements
Parameters
| Name | Remarks |
|---|---|
| InSkeletalMesh | The skeletal mesh asset to import |
| InNameSpace | The namespace to prefix the bone names with |
| bReplaceExistingBones | If true existing bones will be removed |
| bRemoveObsoleteBones | If true bones non-existent in the skeleton will be removed from the hierarchy |
| bSelectBones | If true the bones will be selected upon import |
| bSetupUndo | If set to true the stack will record the change for undo / redo |
ImportBones(const TArray< FMeshBoneInfo > &, const TArray< FTransform > &, const FName &, bool, bool, bool, bool)
Description
Imports the provided bone list to the hierarchy
| Name | ImportBones |
| 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 |
TArray < FRigElementKey > ImportBones
(
const TArray < FMeshBoneInfo > & BoneInfos,
const TArray < FTransform > & BoneTransforms,
const FName & InNameSpace,
bool bReplaceExistingBones,
bool bRemoveObsoleteBones,
bool bSelectBones,
bool bSetupUndo
)
The keys of the imported elements
Parameters
| Name | Remarks |
|---|---|
| BoneInfos | The array of MeshBoneInfos to use as source. Bones with name set to NAME_Mone are bones that have been excluded. |
| BoneTransforms | The transforms to initialize the hierarchy elements |
| bReplaceExistingBones | If true existing bones will be removed |
| bRemoveObsoleteBones | If true bones non-existent in the skeleton will be removed from the hierarchy |
| bSelectBones | If true the bones will be selected upon import |
| bSetupUndo | If set to true the stack will record the change for undo / redo |
ImportBones(USkeleton *, FName, bool, bool, bool, bool, bool)
Description
Imports an existing skeleton to the hierarchy
| Name | ImportBones |
| 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)
TArray < FRigElementKey > ImportBones
(
USkeleton * InSkeleton,
FName InNameSpace,
bool bReplaceExistingBones,
bool bRemoveObsoleteBones,
bool bSelectBones,
bool bSetupUndo,
bool bPrintPythonCommand
)
The keys of the imported elements
Parameters
| Name | Remarks |
|---|---|
| InSkeleton | The skeleton to import |
| InNameSpace | The namespace to prefix the bone names with |
| bReplaceExistingBones | If true existing bones will be removed |
| bRemoveObsoleteBones | If true bones non-existent in the skeleton will be removed from the hierarchy |
| bSelectBones | If true the bones will be selected upon import |
| 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 |