ToolPlugin

Inheritance diagram of rumba.ToolPlugin
class ToolPlugin

A Tool node plug-in.

A tool node can be used to modify the document using viewport interactions.

Constructors

__init__

Methods

activate()

deactivate()

get_help(tool)

type tool

unicode

get_status(tool)

type tool

unicode

manipulates()

rtype

bool

node()

Returns the Node interface for this object.

on_add_to_document()

Callback called when the node is added to the document.

on_delete()

Prepare the node to be deleted.

on_first_init()

Perform the one shot initialization tasks for this node.

on_input_connection()

Callback called when an a connection has been done between an output plug and a plug of this node as input.

on_input_disconnection()

Callback called when an a connection has been broken between an output plug and a plug of this node as input.

on_key_press(key, modifiers)

Called when a key is pressed while the tool is active.

on_key_release(key, modifiers)

Called when a key is released while the tool is active.

on_mouse_move(camera, interaction)

type camera

CameraContext

on_mouse_press(camera, interaction)

type camera

CameraContext

on_mouse_release(camera, interaction)

type camera

CameraContext

on_output_connection()

Callback called when an a connection has been done between a plug of this node as output and an input plug.

on_output_disconnection()

Callback called when an a connection has been broken between a plug of this node as output and an input plug.

on_remove_from_document()

Callback called when the node is removed from the document.

override_selection()

rtype

bool

relationship(set)

Return the node relationships.

track_mouse()

rtype

bool