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
sbsarmanager
class sbsarchive.sbsarmanager.SBSARManager(aArchive)
Bases: object
Class SBSARManager to manipulate sbsar file. Must be used with the with statement.
Parameters: | aArchive – an sbsarchive.SBSArchive or absolute file path |
---|
addIcon(aGraphIdentifier, aIconPath, replaceIfExists=False)
Add an icon file to the sbsar for the given graph identifier
Parameters: |
|
---|---|
Returns: |
|
changeInputValueFromName(aInputIndentifier, aType, aValue)
Parameters: |
|
---|---|
Type: | aType: sbsarenum.SBSARTypeEnum |
Returns: |
|
save()
Save the sbsar modification
Returns: |
---|
saveAs(aArchiveFilePath)
Save as the sbsar modification
Parameters: | aArchiveFilePath – a valid file path |
---|---|
Returns: |
saveIcon(aGraphIdentifier, aOutputDir)
extract the graph’s icon to the given output directory
Parameters: |
|
---|---|
Returns: |
|
class sbsarchive.sbsarmanager.SBSArchive
Bases: object