User Guide Cancel

sbsarmanager | Substance 3D Automation ToolKit

sbsarmanager

class sbsarchive.sbsarmanager.SBSARManager(aArchive)
class sbsarchive.sbsarmanager.SBSARManager(aArchive)
 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)
addIcon(aGraphIdentifier, aIconPath, replaceIfExists=False)
 addIcon(aGraphIdentifier, aIconPath, replaceIfExists=False)  

Add an icon file to the sbsar for the given graph identifier

Parameters:
  • aGraphIdentifier – the graph identifier to which attach the icon
  • aIconPath – icon file path
  • replaceIfExists – if True the already existing icon will be replaced otherwise error will be raised
Returns:

changeInputValueFromName(aInputIndentifier, aType, aValue)
changeInputValueFromName(aInputIndentifier, aType, aValue)
 changeInputValueFromName(aInputIndentifier, aType, aValue)  
Parameters:
  • aInputIndentifier (str) – input value identifier
  • aType – a type from sbsarenum.SBSARTypeEnum
  • aValue (depend the value type) – the new value to set
Type:

aType: sbsarenum.SBSARTypeEnum

Returns:

save()
save()
 save()  

Save the sbsar modification

Returns:
saveAs(aArchiveFilePath)
saveAs(aArchiveFilePath)
 saveAs(aArchiveFilePath)  

Save as the sbsar modification

Parameters:aArchiveFilePath – a valid file path
Returns:
saveIcon(aGraphIdentifier, aOutputDir)
saveIcon(aGraphIdentifier, aOutputDir)
 saveIcon(aGraphIdentifier, aOutputDir)  

extract the graph’s icon to the given output directory

Parameters:
  • aGraphIdentifier – graph’s identifier
  • aOutputDir – output directory path
Returns:

class sbsarchive.sbsarmanager.SBSArchive
class sbsarchive.sbsarmanager.SBSArchive
 class sbsarchive.sbsarmanager.SBSArchive  

Bases: object

Get help faster and easier

New user?