Functions

QByteArray_to_str(d)	Convert a QByteArray to a base64 string
activate_camera(camera[, viewport])	Activate the camera in a viewport
active_channel_selection()	This method return the active channel selection
active_curve_selection()	This method return the active curve selection
active_selection()	This method return a tuple of the active curve selection and channel selection if needed
add_animation_layer([parent, name])	Add a new animation layer on the top of the layer stack and return it
add_channel_selection_to_layer(layer[, ...])
add_constraint_layer(constrain_node, target_node)	Add a new Constraint layer on the top of the layer stack and return it
add_deform_layer(asset_node, filename[, ...])	Add a new deformation layer on the top of the layer stack and return it
add_deform_layer_usd(usd_display, usd_path, ...)	Add a new deformation layer on the top of the layer stack for a USD prim and its children, and return it
add_layer_group([parent, name, index])	Add a new layer group on the top of the layer stack and return it
add_media_clip(media_layer, media_node[, ...])
add_setting(path, default_value[, description])	Add a new setting if it does not already exist.
add_to_set(selection_set, nodes)	Add the list of nodes to the selection set
args()
beautify(label)	Return a beautified version of label, basically replace _ by spaces and title the string when using a non-technical GUI.
call_on_context(method)
can_merge_nodes(nodes)	Check if we can create a merge node from selection.
can_toggle_node_state(nodes)	Check if we can toggle the state of nodes.
catch_constraint(constraint_layer)	Catch the constrained object at the current frame.
clear_selection_set(selection_set)	Clear the selection set content
clipboard_to_pose()
copy(nodes)
copy_pose()
create_asset_layers(asset[, parent_layer, ...])	Create layers for an Asset.
create_selection_set([name])	Create a Selection Set of the current selection
create_selection_set_layer(selection_set[, ...])	Create the animation layer hierarchy based on the selection set content and hierarchy
current_tool()
cut_media_clip(media_clip, frame)
debug(arg0)
debug(arg0)
dock(name)	Get a dock widget by its name.
edit_node(node)
edited_node()
error(arg0)
error(arg0)
expand_selection_set(node, mode)	Expand the selection with the content of all selection sets within the active selection
export_rumba_animation(filename[, ...])	Export the project animation in a .rumbaanim file.
first_auto_connect_output(node)	Return the first plug of the node that is an output that we can auto connect from, if there is none return None.
from_api(*args, **kwargs)	Overloaded function.
gather_auto_connect_outputs(type_name, nodes)	Create a list containing for each node a output plug able to auto connect with the type_name.
get_media(path[, document, undo_stack])
get_media_clip(media_layer, frame)
get_setting(path[, default_value])	Fetch a setting from its path.
get_tool()
get_tool_name()
get_tool_name()
group_layers(layers[, name])
has_feature(feature)
has_feature(feature)
has_layer()	Returns true if the document has at least one layer :return: True if the document has at least one layer :rtype: [bool]
has_tablet(tablet)
hide(nodes)	Hide the list of nodes.
hide_content(selection_set)	Hide the selection set content
import_rumba_animation(filename[, ...])	Import the .rumbaanim animation file in Rumba
info(arg0)
info(arg0)
is_animable(attribute)
is_content_hideable(selection_set)	Check if the content of the selection set is hideable
items()
layer_selection()
media_layer_clips(media_layer)
menu(parent, nodes, parent_node[, modifiers])
merge_nodes(nodes)	Create a merge node from selection.
message_box(msg[, title, level, widget])
open_file_path_manager(node[, if_required])
parent_asset(node)
parent_widget_by_class(widget, class_)	Return widget or one of its parents matching the class_
paste([parent, valid_types])
paste_pose()
pose_to_clipboard(pose)
quit([force, return_code])	Quit Rumba :param force: bool, if True, quit with no warning :param return_code: int, the return code
register_widget(widget_class, widget_name[, ...])	Register a dockable widget class
release_constraint(constraint_layer)	Release the constrained object and set its position
remove_from_set(selection_set, nodes)	Remove the list of nodes from the selection set
remove_layer(layer)	Remove this layer from the layer list
rename(node, new_name)
same_file(a, b)	Return true if the two document paths are pointing the same filesystem file.
save_import_recent(file_path)
save_open_recent(file_path)
save_recent_file(file_path, setting)	Save the file path in a recent file list hold in a setting.
save_reference_recent(file_path)
set_current_tool(tool)
set_tool_by_name(tool_name)
setting(path)	Get a setting value.
show_(nodes)	Show the list of nodes.
show_content(selection_set)	Show the selection set content
status_error(msg)	Set the status bar message with a red color background to signal an error to the user.
status_message(msg)	Set the status bar message.
str_to_QByteArray(s)	Convert a base64 string to QByteArray or return None in case of failure
switch_to_fk(arm_base_manipulator)
switch_to_ik(arm_base_manipulator)
to_api(*args, **kwargs)	Overloaded function.
toggle_node_state(nodes)	Toggle the state of nodes (enabled/disabled/passthrough...).
touch_group(func)
ui_plugins()	Return the list of ui plugins class
warn(arg0)
warn(arg0)
widget(name)	Get a widget by its name.
widget_plugins()	Return the list of widget plugins class