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.
sbsexporter
class sbsexporter.SBSExporter
Bases: object
Class used to provide useful functions when parsing a .sbs (=xml) file
export(aSBSDocument, aExportFolder, aBuildArchive = False, aAliasesToExport = None, aArchiveFormat = 'zip')
Exports the given SBSDocument with its dependencies (resources + packages) to the specified folder, including the packages referenced by the provided aliases. This is the equivalent of the function ‘Export with dependencies’ within Substance Designer. If aAliasesToExport is let None, all the packages referenced by an alias will not be included in the self-contained package.
| Parameters: |
|
|---|---|
| Returns: | The absolute path of the resulting exported package or archive |
| Raise: |
|
getExportedDependencies()
Allows to get the exported dependencies (resources + packages) of the last export
| Returns: | The exported dependencies as a dictionary of {oldAbsPath(string): newAbsPath(string)} |
|---|
getExportedPackages()
Allows to get the exported packages of the last export
| Returns: | The exported packages as a dictionary of {oldAbsPath(string): newAbsPath(string)} |
|---|
getExportedResources()
Allows to get the exported resources of the last export
| Returns: | The exported resources as a dictionary of {oldAbsPath(string): newAbsPath(string)} |
|---|
getMissingPackages()
Allows to get the missing packages of the last export (file not found)
| Returns: | The missing packages as a list string |
|---|
getMissingResources()
Allows to get the missing resources of the last export (file not found)
| Returns: | The missing resources as a list string |
|---|
reset()
Reset the exporter to its initial state
