Plug

class Plug

A node plug.

A Plug is a node attribute. It can hold a Value object.

A Plug can be an input Plug, in that case, another plug can be connected into it and propagate its value in it.

A plug can be an output Plug, in that case, its value is evaluated using dependancies on other plugs and an evaluation function. Output Plugs can’t have an input connection.

The Value of a Plug can be :

• The Plug stored Value

• The Value of the input connected Plug, for input Plugs.

• The computed Value for output Plugs.

Constructors

__init__

Methods

__eq__	Return self==value.
__ne__	Return self!=value.
add_notification_dependency(dependence, ...)	type dependence Plug
add_valued_dependency
as_Box3f()	Returns the plug value as a Box3f.
as_Color4f()	Returns the plug value as a Color4f.
as_M44d()	Returns the plug value as a M44d.
as_Quatd()	Returns the plug value as a Quatd.
as_V2d()	Returns the plug value as a V2d.
as_V2i()	Returns the plug value as a V2i.
as_V3d()	Returns the plug value as a V3d.
as_V3i()	Returns the plug value as a V3i.
as_V4d()	Returns the plug value as a V4d.
as_V4i()	Returns the plug value as a V4i.
as_bool()	Returns the plug value as a bool.
as_double()	Returns the plug value as a double.
as_float()	Returns the plug value as a float.
as_int()	Returns the plug value as an integer.
as_string()	Returns the plug value as a string.
can_connect(other)	Check if the plug can be connected.
channels()	Return this plug exposed channels.
connect(src, undo_stack, serialize)	Connect src to this plug.
default_value()	Return the default plug value.
description()	Returns the plug's description as a json-object formatted string.
disconnect(undo_stack)	If true, the connection is restored if an undo is performed.
document_path()	Returns the path of this plug starting at the document node.
flags()	Return the plug flags.
has_node()	rtype bool
input()	Get the input plug.
is_animable()	Return true if this plug is animable.
is_auto_connect()	Return true if the plug connects when a node is dropped over a connection.
is_channel()	Return true if this plug is a channel.
is_connected()	Return true if the plug has an input connection.
is_constant()	Return true if the plug value is constant in time.
is_dynamic()	Return true if the plug is dynamic.
is_evaluated()	Return true if this plug is evaluated.
is_internal()	Return true if this plug should be ignored by users and the UI.
is_keyable()	Return true if this plug is keyable.
is_main_plug()	Return true if the plug is a main plug, i-e, is displayed by default.
is_mutable()	Return true if this plug is mutable (i.e.
key_frames()	Get the plug keys in targeted layer.
key_frames_in_layer(layer)	Get the plug keys in the layer.
name()	Return the plug name.
nice_name()	Returns the name of this plug to be displayed in UI (extracted from the 'nice_name' poperty of the description).
node()	rtype Node
node_delegate()	Return a node delegate for this plug.
notification_dependencies()	rtype list(Plug)
outputs()	Return the node plugs iteration.
remove_all_valued_dependencies(undo_stack)	Remove all valued dependencies from this plug.
remove_notification_dependency(dependence, ...)	type dependence Plug
remove_valued_dependency
set_default_value(value)	Set the default value of this plug.
set_description(description)	Set the description of this plug.
set_flags(flags)	Set the plug flags.
set_value(value, undo_stack)	Set a value.
status()	Return the plug status.
touch
type_name()	Returns the name of the type the plug has been created with.
value(qc, mode)	Get the plug value.
valued_dependencies()	Return all valued dependencies of this plug, ordered by their indices.