Documentation for Substance Automation Toolkit is now included in the SAT package. You can access the documentation by opening html-doc.zip inside your downloaded SAT package.
moduleconnection
Module moduleconnection aims to define SBSObjects that are relative to a module connection, mostly ModuleConnection.
class modulegraph.moduleconnection.ModuleConnection(aIdentifier='', aConnRef='', aConnRefOutput='')
Bases: pysbs.common_interfaces.sbsobject.SBSObject
Class that contains information on a connection between two node’s operand Connection object belongs the right node (input connection node) Be careful properties name do not have the same meaning as the other sbsobjects
- Members:
- mIdentifier (str): name of the right node’s input operand.
- mConnRef (str): left node’s uid
- mConnRefOutput (str): uid of the left node output
equals(other)
Check if this SBSObject is equivalent to the other SBSObject. Some members may be excluded from this check, the UIDs or GUILayout for instance.
getUidIsUsed(aUID)
Check if the given uid is already used in the context of this SBSObject.
| Parameters: | aUID (str) – UID to check |
|---|---|
| Returns: | True if the uid is already used, False otherwise |
| Raise: | AttributeError if the function getUidIsUsed in not properly overloaded on this SBSObject |
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
Parse recursively the given xml node to retrieve the content of the SBSObject.
write(aSBSWriter, aXmlNode)
Write recursively the content of the SBSObject into the given xml node.
| Parameters: |
|
|---|
