`unreal.RigHierarchyController`¶

add_available_space(control, space, display_label='None', setup_undo=False, print_python_command=False) → bool¶

Adds a new available space to the given control

Parameters:

control (RigElementKey) – The control to add the available space for
space (RigElementKey) – The space to add to the available spaces list
display_label (Name) – The optional display label to use for this space
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out

Returns:

Returns true if successful.

Return type:

add_bone(name, parent, transform, transform_in_global=True, bone_type=RigBoneType.USER, setup_undo=False, print_python_command=False) → RigElementKey¶

Adds a bone to the hierarchy

Parameters:

name (Name) – The suggested name of the new bone - will eventually be corrected by the namespace
parent (RigElementKey) – The (optional) parent of the new bone. If you don’t need a parent, pass FRigElementKey()
transform (Transform) – The transform for the new bone - either in local or global space, based on bTransformInGlobal
transform_in_global (bool) – Set this to true if the Transform passed is expressed in global space, false for local space.
bone_type (RigBoneType) – The type of bone to add. This can be used to differentiate between imported bones and user defined bones.
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out

Returns:

The key for the newly created bone.

Return type:

add_channel_host(channel, host, setup_undo=False, print_python_command=False) → bool¶

Adds a new channel host to the animation channel note: This is just an overload of AddAvailableSpace for readability

Parameters:

channel (RigElementKey) – The animation channel to add the channel host for
host (RigElementKey) – The host to add to the channel to
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out

Returns:

Returns true if successful.

Return type:

add_component(component_struct, name, element, content='', setup_undo=False, print_python_command=False) → RigComponentKey¶

Adds a component to the hierarchy

Parameters:

component_struct (ScriptStruct) – The script struct of the component to add
name (Name) – The suggested name of the new component.
element (RigElementKey) – The element the component will be added to.
content (str) – The (optional) serialized text default for the component
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out

Returns:

The name of the newly created component

Return type:

RigComponentKey

add_connector(name, settings=['', ConnectorType.PRIMARY, False, False, False, []], setup_undo=False, print_python_command=False) → RigElementKey¶

Adds a connector to the hierarchy

Parameters:

name (Name) – The suggested name of the new connector - will eventually be corrected by the namespace
settings (RigConnectorSettings) – All of the connector’s settings
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out

Returns:

The key for the newly created bone.

Return type:

add_control(name, parent, settings, value, setup_undo=True, print_python_command=False) → RigElementKey¶

Adds a control to the hierarchy

Parameters:

name (Name) – The suggested name of the new control - will eventually be corrected by the namespace
parent (RigElementKey) – The (optional) parent of the new control. If you don’t need a parent, pass FRigElementKey()
settings (RigControlSettings) – All of the control’s settings
value (RigControlValue) – The value to use for the control
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool)

Returns:

The key for the newly created control.

Return type:

add_curve(name, value=0.000000, setup_undo=True, print_python_command=False) → RigElementKey¶

Adds a curve to the hierarchy

Parameters:

name (Name) – The suggested name of the new curve - will eventually be corrected by the namespace
value (float) – The value to use for the curve
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out

Returns:

The key for the newly created curve.

Return type:

add_null(name, parent, transform, transform_in_global=True, setup_undo=False, print_python_command=False) → RigElementKey¶

Adds a null to the hierarchy

Parameters:

name (Name) – The suggested name of the new null - will eventually be corrected by the namespace
parent (RigElementKey) – The (optional) parent of the new null. If you don’t need a parent, pass FRigElementKey()
transform (Transform) – The transform for the new null - either in local or global null, based on bTransformInGlobal
transform_in_global (bool) – Set this to true if the Transform passed is expressed in global null, false for local null.
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out

Returns:

The key for the newly created null.

Return type:

add_parent(child, parent, weight=0.000000, maintain_global_transform=True, display_label='None', setup_undo=False) → bool¶

Adds a new parent to an element. For elements that allow only one parent the parent will be replaced (Same as ::SetParent).

Parameters:

child (RigElementKey) – The key of the element to add the parent for
parent (RigElementKey) – The key of the new parent to add
weight (float) – The initial weight to give to the parent
maintain_global_transform (bool) – If set to true the child will stay in the same place spatially, otherwise it will maintain it’s local transform (and potential move).
display_label (Name) – The optional display label to use for the parent constraint / space.
setup_undo (bool) – If set to true the stack will record the change for undo / redo

Returns:

Returns true if successful.

Return type:

add_socket(name, parent, transform, transform_in_global=True, color=[1.000000, 1.000000, 1.000000, 1.000000], description='', setup_undo=False, print_python_command=False) → RigElementKey¶

Adds a socket to the hierarchy

Parameters:

name (Name) – The suggested name of the new socket - will eventually be corrected by the namespace
parent (RigElementKey) – The (optional) parent of the new null. If you don’t need a parent, pass FRigElementKey()
transform (Transform) – The transform for the new socket - either in local or global space, based on bTransformInGlobal
transform_in_global (bool) – Set this to true if the Transform passed is expressed in global space, false for local space.
color (LinearColor) – The color of the socket
description (str) – The description of the socket
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out

Returns:

The key for the newly created bone.

Return type:

clear_selection(setup_undo=False) → bool¶

Clears the selection

Parameters:: setup_undo (bool) – If set to true the stack will record the change for undo / redo
Returns:: Returns true if the selection was applied
Return type:: bool

deselect_component(key) → bool¶

Deselects or deselects a component in the hierarchy

Parameters:: key (RigComponentKey) – The key of the component to deselect
Returns:: Returns true if the selection was applied
Return type:: bool

deselect_element(key) → bool¶

Deselects or deselects an element in the hierarchy

Parameters:: key (RigElementKey) – The key of the element to deselect
Returns:: Returns true if the selection was applied
Return type:: bool

deselect_hierarchy_key(key, setup_undo=False) → bool¶

Deselects or deselects a component or an element in the hierarchy

Parameters:

key (RigHierarchyKey) – The key of the component or element to deselect
setup_undo (bool) – If set to true the stack will record the change for undo / redo

Returns:

Returns true if the selection was applied

Return type:

duplicate_elements(keys, select_new_elements=True, setup_undo=False, print_python_commands=False) → Array[RigElementKey]¶

Duplicate the given elements

Parameters:

keys (Array[RigElementKey]) – The keys of the elements to duplicate
select_new_elements (bool) – If set to true the new elements will be selected
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_commands (bool) – If set to true a python command equivalent to this call will be printed out

Returns:

The keys of the 4d items

Return type:

export_selection_to_text() → str¶

Exports the selected items to text

Returns:: The text representation of the selected items
Return type:: str

export_to_text(keys) → str¶

Exports a list of items to text

Parameters:: keys (Array[RigElementKey]) – The keys to export to text
Returns:: The text representation of the requested elements
Return type:: str

generate_python_commands() → Array[str]¶

Generate Python Commands

Return type:: Array[str]

get_control_settings(key) → RigControlSettings¶

Returns the control settings of a given control

Parameters:: key (RigElementKey) – The key of the control to receive the settings for
Returns:: The settings of the given control
Return type:: RigControlSettings

get_hierarchy() → RigHierarchy¶

Returns the hierarchy currently linked to this controller

Return type:: RigHierarchy

import_bones(skeleton, name_space='None', replace_existing_bones=True, remove_obsolete_bones=True, select_bones=False, setup_undo=False, print_python_command=False) → Array[RigElementKey]¶

Imports an existing skeleton to the hierarchy

Parameters:

skeleton (Skeleton) – The skeleton to import
name_space (Name) – The namespace to prefix the bone names with
replace_existing_bones (bool) – If true existing bones will be removed
remove_obsolete_bones (bool) – If true bones non-existent in the skeleton will be removed from the hierarchy
select_bones (bool) – If true the bones will be selected upon import
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out

Returns:

The keys of the imported elements

Return type:

import_bones_from_asset(asset_path, name_space='None', replace_existing_bones=True, remove_obsolete_bones=True, select_bones=False, setup_undo=False) → Array[RigElementKey]¶

Imports an existing skeleton to the hierarchy

Parameters:

asset_path (str) – The path to the uasset to import from
name_space (Name) – The namespace to prefix the bone names with
replace_existing_bones (bool) – If true existing bones will be removed
remove_obsolete_bones (bool) – If true bones non-existent in the skeleton will be removed from the hierarchy
select_bones (bool) – If true the bones will be selected upon import
setup_undo (bool) – If set to true the stack will record the change for undo / redo

Returns:

The keys of the imported elements

Return type:

import_bones_from_skeletal_mesh(skeletal_mesh, name_space, replace_existing_bones=True, remove_obsolete_bones=True, select_bones=False, setup_undo=False, print_python_command=False) → Array[RigElementKey]¶

Imports an existing skeleton to the hierarchy, restricting the bone list to the ones that exist in the provided Skeletal Mesh

Parameters:

skeletal_mesh (SkeletalMesh) – The skeletal mesh asset to import
name_space (Name) – The namespace to prefix the bone names with
replace_existing_bones (bool) – If true existing bones will be removed
remove_obsolete_bones (bool) – If true bones non-existent in the skeleton will be removed from the hierarchy
select_bones (bool) – If true the bones will be selected upon import
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool)

Returns:

The keys of the imported elements

Return type:

import_curves(skeleton, name_space='None', select_curves=False, setup_undo=False, print_python_command=False) → Array[RigElementKey]¶

Imports all curves from a skeleton to the hierarchy

Parameters:

skeleton (Skeleton) – The skeleton to import the curves from
name_space (Name) – The namespace to prefix the bone names with
select_curves (bool) – If true the curves will be selected upon import
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool)

Returns:

The keys of the imported elements

Return type:

import_curves_from_asset(asset_path, name_space='None', select_curves=False, setup_undo=False) → Array[RigElementKey]¶

Imports all curves from a skeleton to the hierarchy

Parameters:

asset_path (str) – The path to the uasset to import from
name_space (Name) – The namespace to prefix the bone names with
select_curves (bool) – If true the curves will be selected upon import
setup_undo (bool) – If set to true the stack will record the change for undo / redo

Returns:

The keys of the imported elements

Return type:

import_curves_from_skeletal_mesh(skeletal_mesh, name_space='None', select_curves=False, setup_undo=False, print_python_command=False) → Array[RigElementKey]¶

Imports all curves from a skeletalmesh to the hierarchy

Parameters:

skeletal_mesh (SkeletalMesh) – The skeletalmesh to import the curves from
name_space (Name) – The namespace to prefix the bone names with
select_curves (bool) – If true the curves will be selected upon import
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool)

Returns:

The keys of the imported elements

Return type:

import_from_text(content, replace_existing_elements=False, select_new_elements=True, setup_undo=False, print_python_commands=False) → Array[RigElementKey]¶

Imports the content of a text buffer to the hierarchy

Parameters:

content (str) – The string buffer representing the content to import
replace_existing_elements (bool) – If set to true existing items will be replaced / updated with the content in the buffer
select_new_elements (bool) – If set to true the new elements will be selected
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_commands (bool) – If set to true a python command equivalent to this call will be printed out

Return type:

import_preview_skeletal_mesh(skeletal_mesh, replace_existing_bones=True, remove_obsolete_bones=True, select_bones=False, setup_undo=False) → Array[RigElementKey]¶

Imports all bones from a preview skeletal mesh. Used for rig modules and their preview skeleton

Parameters:

skeletal_mesh (SkeletalMesh)
replace_existing_bones (bool) – If true existing bones will be removed
remove_obsolete_bones (bool) – If true bones non-existent in the skeleton will be removed from the hierarchy
select_bones (bool) – If true the bones will be selected upon import
setup_undo (bool) – If set to true the stack will record the change for undo / redo

Returns:

The keys of the imported elements

Return type:

import_sockets_from_skeletal_mesh(skeletal_mesh, name_space, replace_existing_sockets=True, remove_obsolete_sockets=True, select_sockets=False, setup_undo=False, print_python_command=False) → Array[RigElementKey]¶

Imports the sockets from existing skeleton to the hierarchy as nulls

Parameters:

skeletal_mesh (SkeletalMesh) – The skeletal mesh asset to import
name_space (Name) – The namespace to prefix the socket names with
replace_existing_sockets (bool) – If true existing sockets will be removed
remove_obsolete_sockets (bool) – If true sockets non-existent in the skeleton will be removed from the hierarchy
select_sockets (bool) – If true the sockets will be selected upon import
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool)

Returns:

The keys of the imported elements

Return type:

mirror_elements(keys, settings, select_new_elements=True, setup_undo=False, print_python_commands=False) → Array[RigElementKey]¶

Mirrors the given elements

Parameters:

keys (Array[RigElementKey]) – The keys of the elements to mirror
settings (RigVMMirrorSettings) – The settings to use for the mirror operation
select_new_elements (bool) – If set to true the new elements will be selected
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_commands (bool) – If set to true a python command equivalent to this call will be printed out

Returns:

The keys of the mirrored items

Return type:

remove_all_parents(child, maintain_global_transform=True, setup_undo=False, print_python_command=False) → bool¶

Removes all parents from an element in the hierarchy.

Parameters:

child (RigElementKey) – The key of the element to remove all parents for
maintain_global_transform (bool) – If set to true the child will stay in the same place spatially, otherwise it will maintain it’s local transform (and potential move).
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out

Returns:

Returns true if successful.

Return type:

remove_available_space(control, space, setup_undo=False, print_python_command=False) → bool¶

Removes an available space from the given control

Parameters:

control (RigElementKey) – The control to remove the available space from
space (RigElementKey) – The space to remove from the available spaces list
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out

Returns:

Returns true if successful.

Return type:

remove_channel_host(channel, host, setup_undo=False, print_python_command=False) → bool¶

Removes an channel host from the animation channel note: This is just an overload of RemoveAvailableSpace for readability

Parameters:

channel (RigElementKey) – The animation channel to remove the channel host from
host (RigElementKey) – The host to remove from the channel from
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out

Returns:

Returns true if successful.

Return type:

remove_component(component, setup_undo=False, print_python_command=False) → bool¶

Removes a component from the hierarchy

Parameters:

component (RigComponentKey) – The component to remove
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out

Returns:

True if the component was removed successfully

Return type:

remove_element(element, setup_undo=False, print_python_command=False) → bool¶

Removes an existing element from the hierarchy

Parameters:

element (RigElementKey) – The key of the element to remove
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out

Returns:

Returns true if successful.

Return type:

remove_parent(child, parent, maintain_global_transform=True, setup_undo=False, print_python_command=False) → bool¶

Removes an existing parent from an element in the hierarchy. For elements that allow only one parent the element will be unparented (same as ::RemoveAllParents)

Parameters:

child (RigElementKey) – The key of the element to remove the parent for
parent (RigElementKey) – The key of the parent to remove
maintain_global_transform (bool) – If set to true the child will stay in the same place spatially, otherwise it will maintain it’s local transform (and potential move).
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out

Returns:

Returns true if successful.

Return type:

rename_component(component, name, setup_undo=False, print_python_command=False, clear_selection=True) → RigComponentKey¶

Renames an existing component in the hierarchy

Parameters:

component (RigComponentKey) – The key of the component to rename
name (Name) – The new name to set for the component
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out
clear_selection (bool) – True if the selection should be cleared after a rename

Returns:

Returns the new key used for the component

Return type:

RigComponentKey

rename_element(element, name, setup_undo=False, print_python_command=False, clear_selection=True) → RigElementKey¶

Renames an existing element in the hierarchy

Parameters:

element (RigElementKey) – The key of the element to rename
name (Name) – The new name to set for the element
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out
clear_selection (bool) – True if the selection should be cleared after a rename

Returns:

Returns the new element key used for the element

Return type:

reorder_element(element, index, setup_undo=False, print_python_command=False) → bool¶

Changes the element’s index within its default parent (or the top level)

Parameters:

element (RigElementKey) – The key of the element to rename
index (int32) – The new index of the element to take within its default parent (or the top level)
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out

Returns:

Returns true if the element has been reordered accordingly

Return type:

reparent_component(component_key, parent_element_key, setup_undo=False, print_python_command=False, clear_selection=True) → RigComponentKey¶

Reparents an existing component in the hierarchy

Parameters:

component_key (RigComponentKey) – The component key to reparent
parent_element_key (RigElementKey) – The new element key to reparent to
setup_undo (bool)
print_python_command (bool)
clear_selection (bool) – True if the selection should be cleared after a reparenting

Returns:

Returns the new component key if successful or an invalid key if unsuccessful

Return type:

RigComponentKey

select_component(key, select=True, clear_selection=False, setup_undo=False) → bool¶

Selects or deselects a component in the hierarchy

Parameters:

key (RigComponentKey) – The key of the component to select
select (bool) – If set to false the component will be deselected
clear_selection (bool) – If this is true the selection will be cleared
setup_undo (bool) – If set to true the stack will record the change for undo / redo

Returns:

Returns true if the selection was applied

Return type:

select_element(key, select=True, clear_selection=False, setup_undo=False) → bool¶

Selects or deselects an element in the hierarchy

Parameters:

key (RigElementKey) – The key of the element to select
select (bool) – If set to false the element will be deselected
clear_selection (bool) – If this is true the selection will be cleared
setup_undo (bool) – If set to true the stack will record the change for undo / redo

Returns:

Returns true if the selection was applied

Return type:

select_hierarchy_key(key, select=True, clear_selection=False, setup_undo=False) → bool¶

Selects or deselects a component or an element in the hierarchy

Parameters:

key (RigHierarchyKey) – The key of the component or an element to select
select (bool) – If set to false the component or an element will be deselected
clear_selection (bool) – If this is true the selection will be cleared
setup_undo (bool) – If set to true the stack will record the change for undo / redo

Returns:

Returns true if the selection was applied

Return type:

set_available_space_index(control, space, index, setup_undo=False, print_python_command=False) → bool¶

Reorders an available space for the given control

Parameters:

control (RigElementKey) – The control to reorder the host for
space (RigElementKey) – The space to set the new index for
index (int32) – The new index of the available space
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out

Returns:

Returns true if successful.

Return type:

set_available_space_label(control, space, display_label, setup_undo=False, print_python_command=False) → bool¶

Updates the label on an available space

Parameters:

control (RigElementKey) – The control to reorder the host for
space (RigElementKey) – The space to set the new index for
display_label (Name) – The new label of the available space
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out

Returns:

Returns true if successful.

Return type:

set_component_content(component, content, setup_undo=False, print_python_command=False) → bool¶

Updates the content of a component in the hierarchy

Parameters:

component (RigComponentKey) – The component to change the content for
content (str) – The serialized text default for the component
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out

Returns:

True if the component was updated correctly

Return type:

set_component_selection(keys, print_python_command=False) → bool¶

Sets the selection based on a list of component keys

Parameters:

keys (Array[RigComponentKey]) – The array of keys of the component to select
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out

Returns:

Returns true if the selection was applied

Return type:

set_control_settings(key, settings, setup_undo=False) → bool¶

Sets a control’s settings given a control key

Parameters:

key (RigElementKey) – The key of the control to set the settings for
settings (RigControlSettings) – The settings to set
setup_undo (bool)

Returns:

Returns true if the settings have been set correctly

Return type:

set_display_name(control, display_name, rename_element=False, setup_undo=False, print_python_command=False) → Name¶

Sets the display name on a control

Parameters:

control (RigElementKey) – The key of the control to change the display name for
display_name (Name) – The new display name to set for the control
rename_element (bool) – True if the control should also be renamed
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out

Returns:

Returns the new display name used for the control

Return type:

Name

set_hierarchy(hierarchy) → None¶

Sets the hierarchy currently linked to this controller

Parameters:: hierarchy (RigHierarchy)

set_hierarchy_selection(keys, print_python_command=False, setup_undo=False) → bool¶

Sets the selection based on a list of component keys

Parameters:

keys (Array[RigHierarchyKey]) – The array of keys of the component to select
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out
setup_undo (bool) – If set to true the stack will record the change for undo / redo

Returns:

Returns true if the selection was applied

Return type:

set_parent(child, parent, maintain_global_transform=True, setup_undo=False, print_python_command=False) → bool¶

Sets a new parent to an element. For elements that allow more than one parent the parent list will be replaced.

Parameters:

child (RigElementKey) – The key of the element to set the parent for
parent (RigElementKey) – The key of the new parent to set
maintain_global_transform (bool) – If set to true the child will stay in the same place spatially, otherwise it will maintain it’s local transform (and potential move).
setup_undo (bool) – If set to true the stack will record the change for undo / redo
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out

Returns:

Returns true if successful.

Return type:

set_selection(keys, print_python_command=False, setup_undo=False) → bool¶

Sets the selection based on a list of element keys

Parameters:

keys (Array[RigElementKey]) – The array of keys of the elements to select
print_python_command (bool) – If set to true a python command equivalent to this call will be printed out
setup_undo (bool) – If set to true the stack will record the change for undo / redo

Returns:

Returns true if the selection was applied

Return type: