Last updated on
May 24, 2023
- 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
modulegraphregister
Module modulegraphregister manage registration of the various ModuleGraph implementations
class modulegraph.modulegraphregister.ModuleGraphRegister(register_file_path='')
Bases: object
getARegisteredClass(aRegisterClassEnum)
From a class identifier return the class object defined in the register with the key attribute “customimplementation”
| Parameters: | aRegisterClassId (str) – a class id name |
|---|---|
| Returns: | a class object |
getARegisteredClassInfo(aRegisterClassEnum)
Return register info for the class identifier
| Parameters: | aRegisterClassId (str) – a class id name |
|---|---|
| Returns: | a dict of info |
| Return type: | dict |
getARegisteredNodeClass(self, aNodeId)
From a node identifier return the class object defined in the register with the key attribute “customimplementation”
| Parameters: | aNodeId (str) – a node id name |
|---|---|
| Returns: | a class object |
getARegisteredNodeInfo(self, aNodeId)
Return register info for the node identifier
| Parameters: | aNodeId (str) – a node id name |
|---|---|
| Returns: | a dict of info |
| Return type: | dict |
getARegisteredNodeOperandInfo(aNodeId, aOperandName)
Return operand info for a given node and operand name
| Parameters: |
|
|---|---|
| Returns: | info dict |
| Return type: | dict |
getARegisteredNodeOutputInfo(aNodeId, aOutputName)
Return output info for a given node and output name
| Parameters: |
|
|---|---|
| Returns: | dict info |
| Return type: | dict |
getARegisteredOperandClass(aOperandId)
Return the operand class object from an operand type, defined by the key “customimplementation”
| Parameters: | aOperandIdType (str) – operand type, Float, Bool … |
|---|---|
| Returns: | a custom operand class object |
getARegisteredOperandInfo(aOperandId)
Return operand definition info by its type
| Parameters: | aOperandIdType (str) – operand type, Float, Bool … |
|---|---|
| Returns: | dict of info |
| Return type: | dict |
setRegister(file_path)
| Parameters: | file_path (str) – path of the json register file |
|---|
validRegister()
writeDataToJson(aFilePath)
Write data to a json file
| Parameters: | aFilePath (str) – path for the json file path location |
|---|