- Substance 3D home
- Home
- Command Line Tools
- Command Line overview
- sbsbaker
- sbscooker
- sbsmtools
- sbsmutator
- sbsrender
- sbsupdater
- Command Line overview
- Pysbs - Python API
- Pysbs - Python API overview
- Getting started
- General topics
- Examples
- API Content
- API Content overview
- Substance definitions
- Common interfaces
- compnode
- context projectmgr
- graph
- mdl
- modelgraphindex
- modelannotationnames
- modelgraph
- modelgraphgenerator
- modelgraphimplementation
- modelnodenames
- modeloperand
- modulegraphindex
- moduleannotation
- moduleconnection
- modulegraph
- modulegraphgenerator
- modulegraphimplementation
- modulegraphlibrary
- modulegraphregister
- modulenode
- modulenodeimplementation
- modulenodeinstance
- moduleoperand
- moduleoutputbridging
- moduleparaminput
- params
- projectmgrdoc
- sbsarchive
- sbscommon
- sbspreset
- sbsproject
- substance
- Libraries
- sbsenum
- sbslibrary
- sbsbakerslibrary
- Helpers
- Execution context
- API Change log
- Samples
- Setup and Getting Started
- Integrations
- Substance Maya toolset
- Changelog overview
modulenodeimplementation
Module modulegraph aims to define SBSObjects that are relative to a module graph, mostly ModuleGraph.
class modulegraph.modulenodeimplementation.ModuleNodeImplementation(aPath='', aOperands=None, aOutputBridgings=None)
Bases: pysbs.common_interfaces.sbsobject.SBSObject
Abstract class used to provide an interface for derived implementation, and to ensure that each derived implementation implements the functions ‘parse’ and ‘write’
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.
getOperand(aName)
Return the corresponding operand
| Parameters: | aName (str) – the operand’s name to get |
|---|---|
| Returns: | ModuleOperand |
| Return type: | ModuleOperand |
getUidIsUsed(aUID)
Parse the CompOutputs list to find a SBSCompNode with the given uid
| Parameters: | aUID (str) – UID to check |
|---|---|
| Returns: | True if this uid is already used, False otherwise |
listOperandNames()
list all operand’s name
| Returns: | a list of name |
|---|---|
| Return type: | list |
listOutputNames()
list all output’s name
| Returns: | a list of name |
|---|---|
| Return type: | list |
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: |
|
|---|
