Functions

active_document()	Return the active Document node.
active_document_filename()	Return the active document filename.
animation_node_channel_plug(node)	Get the channel plug (input of the rig) from an animation node (like an AnimCurveFloat node)
apply_pose(pose)	Apply a pose.
blend_poses(from_pose)	Blend from pose to pose using weight factor.
constrain_node(constraint)	Constrain the node to the constraint.
controller(plug)	Return the controller associated to a plug.
copy_keys(anim_layer)	Return a copy of the active key selection in a layer.
current_frame()	Shortcut for the active document current frame.
debug(format)	Log a debug message using the Rumba logger.
default_rig_value(plug)	Return the default value if available.
delete_animation(node_to_delete)	Delete properly the node animation graph.
drm_hostid()	Return the system host id.
drm_init
drm_release()	Release the drm.
drm_status()	Return the drm status.
end_profiling()	Stop the interactive profiling session.
error(format)	Log an error message using the Rumba logger.
export_plug_animation(plugs)	Save the layer setup and plugs animation in a file.
export_plug_values(plugs)	Save the plugs values in a file.
export_settings(filepath)	Save workspace settings to a file.
extract_pose(channels)	Extract a pose from a selection of plugs.
flatten_layer(layer)	Flatten a layer into the previous one.
has_controller(plug)	Test if a controller is associated to a plug.
import_plug_animation(plugs)	Import an animation from a file.
import_plug_values(plugs)	Import the plugs values from a file and apply them.
import_settings(filepath)	Import workspace settings from a file.
info(format)	Log an informative message using the Rumba logger.
init_crash_handler(message)	Init the crash handler with the message to attach to the crash reports.
initialize()	When the Rumba Engine is embedded in an application, this function should be called before any Rumba API calls.
is_demo_mode()	Test if Rumba is in demo mode.
is_paste_valid(matched_channels,dest_layer)	Test if the targeted channels are open to be modified by the clipboard in a layer.
key_layer(layer)	Add a key frame on a layer.
load_animation_pose(filename)	Import the animation pose from a file, in this case the value of the pose is not relevant.
load_document(path)	Open a new Rumba project.
load_node(root)	Load the content of a file into the project.
load_plugins(plugin_directories)	Load all the Rumba plug-ins from directories.
load_pose(filename)	Import the plugs values from a file.
match_channels
match_to_channels(…)	Return the best match between the channels to be pasted and the active selection.
matching_pose(pose)	Match a pose to a set of channels.
modify_begin(modification_name)	Begin a modification of the current document.
modify_curve_begin(modification_name)	Begin a modification of the current document.
modify_end()	End a modification of the current document.
move_layer(layer)	Re-order layers.
new_document()	Close the current document and create a new one.
paste_keys(to_paste,matched_channels,dest_layer)	Paste values onto matching channels in a targeted layer.
paste_keys_on_curve(anim_curve_node)	Paste the curve keys into an animation curve node.
plug_node(plug)	Get a plug node.
redo()	rtype:None
reference(root)	Reference the content of a file into the project.
release()	When the Rumba Engine is embedded in an application, this function should be called before to leave the application.
remove_keys(anim_layer)	Remove the active key selection in a layer.
rig_matrix(plug)	Rig a matrix plug.
select(nodes)	Update the active selection with a list of nodes according to the selection mode.
selected_keys_channels(anim_layer)	Return the channels associated with the active key selection in a layer.
selection()	Return the active selection.
set_animated_plug_value(plug)	Set a value to plug, regarding the current layer and the current plug animation.
start_profiling()	Start an interactive profiling session.
system_path(path)	Expand a Rumba file path in a file system path.
time_warp_keys(anim_layer)	Time warp the active key selection using the selection rubberband.
transform_keys(anim_layer)	Transform the active key selection using the selection rubberband.
undo()	rtype:None
undo_blend(undo_blend)	Set the undo blend factor of the last modification.
warn(format)	Log a warning message using the Rumba logger.
workspace()	Return the workspace node.