Functions

_document_paths
active_document()	Return the active Document node.
active_document_directory()	Get the directory of the active document.
active_document_filename()	Return the active document filename.
add_document(path, progress)	Add a new document in the current project and return it.
add_media_layer(parent, name, undo_stack)	Create a media layer.
add_new_document()	Add a new, empty document in the current project and return it.
add_plugs_to_layer(plugs, layer, ...)	Update the animation graph so that these plug channels are animated in the layer.
add_shader_glsl(code)	type code unicode
anim_curve_keys_selected()	Return true if the curve editor is open and keys are selected in it.
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_controller(asset, controller_name)	Get an asset controller if it exists, else return null.
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.
asset_mirror_path(asset, path)	Return the mirrored path 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.
beautify
blend_poses(from_pose, to_pose, weight)	Blend from pose to pose using weight factor.
cameras()	Return the available cameras.
can_be_flatten(layer)	param layer The layer to be flatten
can_undo_blend()	Check if it's possible to undo blend.
channel_path_to_channel_plug(channel_path, ...)	Get the channel plug using a channel path.
channel_plug_to_channel_path(channel_plug)	Get the channel path on a channel plug.
channel_plug_to_controller_plug(channel_plug)	Get the channel path on a channel plug.
channel_selection(channel_mode_filter)	Return the selected channels.
channel_type_name(channel_type)	Return the ChannelType as a string.
channels_in_layer(layer)	Return the list of channels that are animated in the layer.
clear_profiling()	Clear the profiling session data.
configure_tty()	Configure the process console to accept utf-8 and ANSI colors.
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.
default_value(type_name)	Return the default value of a type.
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.
document(path, comparable)	Return the document node associated to that file path.
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.
enable_plug_listener(enable)	If enable is false, stop flushing the plug listener handlers.
end_profiling()	Stop the interactive profiling session.
enter_touch_group
error(format)	Log an error message using the Rumba logger.
expand_string(path)	Expand a string containing
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_channel_path(channel_path, ...)	Parse the channel path and extract the asset, controller, plug and subchannel strings.
extract_pose(channels, frame)	Extract a pose from a selection of plugs.
file_default_directory(file_type)	Get the directory associated to the file type.
file_filter(name)	Get the file filters using a file type name.
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.
frame_camera(camera, selection)	Move a camera to contain a node selection.
grow_component_selection(grow)	Grow or shrink the current component selection.
grow_edge_loop(grow)	Grow or shrink the current edge loop selection.
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_component_selection()	Return true if there is an active component selection.
has_controller(plug)	Test if a controller is associated to a plug.
has_loader(filepath)	Is there a loader for this file type ?
has_tag()
has_target_layer(plug)	Check if the plug has a layer that can receive the plug animation.
imath_rotate_order(ro)	Convert a RotateOrder in Imath::Eulerd::Order.
import_plug_animation(plugs, filename, ...)	Import an animation from a file.
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_modifying()	Return true if modify_begin has been called but not modify_end yet.
is_paste_valid(to_paste, matched_channels, ...)	Test if the targeted channels are open to be modified by the clipboard in a layer.
is_picking()	Return true if the picking is started.
is_profiling
is_right(asset, name)	Return true if the name is right using the asset mirroring rules.
is_shot_internal_path
key_layer(layer, frame, default_value)	Add a key frame on a layer.
leave_touch_group
lerp
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, progress)	Open a new Rumba/Guerilla project.
load_node(root, filepath, root_name, progress)	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, mirror_mode)	Match a pose to a set of channels.
media_root(document, undo_stack)	Return the document media root node.
modify_abort()	Cancel and rollback current modification.
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 documents and create a new document.
node_asset(node)	Return the asset node associated with another node.
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.
pick(picking_callback)	Start the picking process: register a function to call the next time a node delegate is selected or the picking process aborted.
plug_node(plug)	Get a plug node.
profile_frame_start
profile_viewport_end
profile_viewport_start
profile_zone_end
profile_zone_start
project_directory()	Return the project directory.
project_path(system_path)	Converts a file system path to a project-relative path.
redo()	Make a redo step.
reference(root, filepath, ...)	Reference the content of a file into the project.
register_event_callback(event_type, callback)	Register an event callback, returns its ID for unregistering.
register_file_type(name, file_filters)	Register a new file type name with a collection of file filters.
register_shader(name, stream, parameters, ...)	Register a new hardware shader.
register_shading_node
register_shading_token(s, token)	type s unicode
release()	When the Rumba Engine is embedded in an application, this function should be called before to leave the application.
remap_attribute(new_scene, old_scene, ...)	Remaps an attribute from a deprecated Scene version to a new one.
remove_channels_from_layer(channels, layer, ...)	Update the animation graph so that these plug channels are not animated anymore in the layer.
remove_keys(anim_layer, normalize)	Remove the active key selection in a layer.
reparent_layers(parent, layers)	Move layers.
rig_matrix(plug, srt_class_name)	Rig a matrix plug.
same_file(a, b)	Return true if the two document paths are pointing the same filesystem file.
save_default_directory(file_type, ...)	Save the last directory used with this file type.
save_recent_file(file_path, setting)	Save the file path in a recent file list hold in a setting.
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.
select_edge_loop()	Select an edge loop.
select_sub_component(selection, mode, ...)	Update the active sub component selection with a node paths associated to selection weights.
selected_keys_channels(anim_layer)	Return the channels associated with the active key selection in a layer.
selection()	Return the active selected maquina::Node objects.
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_active_document(document)	Set the active Document node.
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_document_factory(factory)	Set a factory to create document plugin.
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.
setting_plug(path)	Get a setting plug.
smooth_component_selection()	Smooth the component selection.
start_profiling()	Start an interactive profiling session.
sub_component_selection()	Return the selected geometry components.
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.
trigger_event(event_type, value)	Trigger an event, return an Array value with the triggered event returned values.
tty_colors()	Return true if colors should be used on the tty.
undo()	Make a undo step.
undo_blend(undo_blend)	Set the undo blend factor of the last modification.
ungroup_layer(layer_group)	Ungroup layer.
unregister_event_callback(callback_id)	Unregister an event callback.
warn(format)	Log a warning message using the Rumba logger.
weighted_sum(values, weights, quat_iter, ...)	Computes the weighted sum of a set of values.
widget_setting_plug(setting_name, ...)	type setting_name unicode
workspace()	Return the workspace node.