Package mrv :: Module dge :: Class iPlug

[frames] | no frames]

Class iPlug

object --+
         |
        iPlug

Known Subclasses:

Defines an interface allowing to compare compatabilies according to types.

Plugs can either be input plugs or output plugs - output plugs affect no other plug on a node, but are affected by 0 or more plugs .

By convention, a plug has a name - that name must also be the name of the member attribute that stores the plag. Plugs, possibly different instances of it, need to be re-retrieved on freshly duplicated nodes to allow graph duplication to be done properly

Note: if your plug class supports the setName method, a metaclass will adjust the name of your plug to match the name it has in the parent class

Instance Methods

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Base Implementation

__str__(self)
str(x)

source code

Interface

name(self)
Returns: name of the plug ( the name that identifies it on the node

source code

affects(self, otherplug)
Set an affects relation ship between this plug and otherplug, saying that this plug affects otherplug.

source code

affected(self)
Returns: tuple containing affected plugs ( plugs that are affected by our value )

source code

affectedBy(self)
Returns: tuple containing plugs that affect us ( plugs affecting our value )

source code

providesOutput(self)
Returns: True if this is an output plug that can trigger computations

source code

providesInput(self)
Returns: True if this is an input plug that will never cause computations

source code

Class Variables

kGood = 127

kNo = 0

kPerfect = 255

Properties

Inherited from object: __class__

Method Details

str(self)
(Informal representation operator)

str(x)

Overrides: object.__str__: (inherited documentation)

name(self)

Returns:: name of the plug ( the name that identifies it on the node

affected(self)

Returns:: tuple containing affected plugs ( plugs that are affected by our value )

affectedBy(self)

Returns:: tuple containing plugs that affect us ( plugs affecting our value )

providesOutput(self)

Returns:: True if this is an output plug that can trigger computations

providesInput(self)

Returns:: True if this is an input plug that will never cause computations