Functions

active_document()	Return the active Document node.
active_document_filename()	Return the active document filename.
add_channels_to_layer(channels, layer)	Create the animation graph to make this channel animated in the layer.
animated_channel(animated_plug)	Return the animated channel connected to a layer.
animated_plug(plug)	Return the animated plug, regarding the current layer.
animated_plug_in_layer(plug, layer)	Return the animated plug in the specific layer.
animation_node_channel_plug(node)	Get the channel plug (input of the rig) from an animation node (like an AnimCurveFloat node)
apply_pose(pose, frame)	Apply a pose.
asset_child(asset, name)	Get the first child node named name of this asset.
asset_child_has_manipulator(asset, child)	Return true if the asset child has a manipulator.
asset_child_manipulator(asset, child)	Get the manipulator associated to the asset child.
asset_controllers(asset)	Get the asset controllers.
asset_has_child(asset, name)	Return true if the asset contain a child named name.
asset_has_manipulator(asset, manipulator_name)	Return true if the asset contain the manipulator.
asset_manipulator(asset, manipulator_name)	Get the manipulator with the name manipulator name from this asset.
asset_mirror(asset, name)	Return the mirrored name using the asset mirroring rules.
asset_mirror_node(asset, node)	Return the mirrored node using the asset mirroring rules.
background_start()	Start the background evaluation engine.
background_wait()	Wait for the baground evaluation engine.
bake_layer(layer, interval, offset, ...)	Bake the layer.
blend_poses(from_pose, to_pose, weight)	Blend from pose to pose using weight factor.
can_be_flatten(layer)	param layer The layer to be flatten
can_undo_blend()	Check if it's possible to undo blend.
constrain_node(constraint, node)	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.
create_tool_geometry(name, parent)	Create a geometry node for tools, i-e, not in a document.
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.
delegate_selection()	Return the active node delegate selection.
delete_animation_graph(node_to_delete)	Delete properly the node animation graph.
delete_channels_animation(channels, all_layers)	Reset the channels value in their target layer without removing the channel from the layer.
deserialize_nodes(buffer, parent, valid_types)	Deserialize the nodes from a string.
deserialize_pose(buffer)	Deserialize the pose from a string.
drm_hostid()	Return the system host id.
drm_init
drm_release()	Release the drm.
drm_status()	Return the drm status.
duplicate
duplicate_layer(layer)	Duplicate the layer and its animation.
end_profiling()	Stop the interactive profiling session.
enter_touch_group
error(format)	Log an error message using the Rumba logger.
export_plug_animation(plugs, filepath, ...)	Save the layer setup and plugs animation in a file.
export_plug_values(plugs, filepath)	Save the plugs values in a file.
export_settings(filepath)	Save workspace settings to a file.
extract_pose(channels, frame)	Extract a pose from a selection of plugs.
flatten_group(layer_group, mode, ...)	Flatten a group layer.
flatten_layer(layer, dest_layer, mode, ...)	Flatten a layer into the previous one.
flush_observers()	Make sure all the observers have been called.
has_animated_channel(animated_plug)	Check if the animated plug has an animated channel.
has_animated_plug(plug)	Check if the plug has an animated plug.
has_animated_plug_in_layer(plug, layer)	Check if the plug has an animated plug in the layer.
has_controller(plug)	Test if a controller is associated to a plug.
has_tag(tags, tag)	Check a tag exist in a comma separate tag list.
has_target_layer(plug)	Check if the plug has a layer that can receive the plug animation.
import_plug_animation(plugs, filename)	Import an animation from a file.
import_plug_values(plugs, filename)	Import the plugs values from a file and apply them.
import_settings(filepath)	Import workspace settings from a file.
increment_dirty_token
info(format)	Log an informative message using the Rumba logger.
init_crash_handler(message, send_report)	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/Guerilla is in demo mode.
is_left(asset, name)	Return true if the name is left using the asset mirroring rules.
is_paste_valid(to_paste, matched_channels, ...)	Test if the targeted channels are open to be modified by the clipboard in a layer.
is_right(asset, name)	Return true if the name is right using the asset mirroring rules.
key_layer(layer, frame, default_value)	Add a key frame on a layer.
leave_touch_group
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/Guerilla project.
load_node(root, filepath, root_name)	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.
manipulator_controller(manipulator)	Get the controller related to this manipulator.
match_channels(to_match)	Return the best match between the channels to be pasted and the active selection.
match_to_channels(channels_to_match, ...)	Return the best match between the channels to be pasted and the active selection.
matching_pose(pose, channels)	Match a pose to a set of channels.
modify_begin
modify_curve_begin(modification_name)	Begin a modification of the current document.
modify_end()	End a modification of the current document.
move_layer(layer, dest_id)	Re-order layers.
mul_dir(src, m)	A faster alternative to multiply a direction by a 4x4 matrix, ignoring the homogeneous normalization.
mul_pos(src, m)	A faster alternative to multiply a position by a 4x4 matrix, ignoring the homogeneous normalization.
new_document()	Close the current document and create a new one.
paste_keys(to_paste, matched_channels, ...)	Paste values onto matching channels in a targeted layer.
paste_keys_on_curve(anim_curve_node, curve, ...)	Paste the curve keys into an animation curve node.
path_variables()	Return the currently registered path variables.
plug_node(plug)	Get a plug node.
project_directory()	Return the project directory.
project_path(system_path)	Reduce a file system path to a project file path.
redo()	Make a redo step.
reference(root, filepath, reference_root_name)	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_channels_from_layer(channels, layer)	Remove the animation graph to remove this animated channel animated from the layer.
remove_keys(anim_layer, normalize)	Remove the active key selection in a layer.
reparent_layers(parent, layers)	Move layers.
rig_matrix(plug)	Rig a matrix plug.
select(nodes, mode)	Update the active selection with a list of nodes according to the selection mode.
select_delegate(paths, mode)	Update the active selection with a list of node paths 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.
selection_paths()	Return the paths of the active node delegate selection.
serialize_nodes(nodes, ...)	Serialize the nodes in a string.
serialize_pose(pose)	Serialize the pose in a string.
set_animated_plug_value(plug, value, frame, ...)	Set a value to plug, regarding the target layer and the current plug animation.
set_current_frame(frame)	set the current frame
set_path_variables(path_vars)	Register the path variables.
set_project_directory(path)	Set the project directory.
set_setting(path, value)	Set a setting value.
setting(path)	Get a setting value.
start_profiling()	Start an interactive profiling session.
system_path(path)	Expand a document file path in a file system path.
target_layer(plug)	Return the layer receiving the plug animation.
time_warp_keys(anim_layer)	Time warp the active key selection using the selection rubberband.
tool_selection()	Return the active tool delegate selection.
transform_keys(anim_layer)	Transform the active key selection using the selection rubberband.
undo()	Make a undo step.
undo_blend(undo_blend)	Set the undo blend factor of the last modification.
ungroup_layer(layer_group)	Ungroup layer.
warn(format)	Log a warning message using the Rumba logger.
workspace()	Return the workspace node.