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.
sbsobject
Module sbsobject provides the definition of a SBSObject, the base class for all objects of a .sbs package.
class common_interfaces.sbsobject.SBSObject
Bases: common_interfaces.sbsarobject.SBSARObject
Abstract class used to provide a common interface for all derived SBSObjects, and to ensure that each derived object 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.
getUidIsUsed(aUID)
Check if the given uid is already used in the context of this SBSObject.
| Parameters: | aUID (str) – UID to check |
|---|---|
| Returns: | True if the uid is already used, False otherwise |
| Raise: | AttributeError if the function getUidIsUsed in not properly overloaded on this SBSObject |
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: |
|
|---|
class common_interfaces.sbsobject.UIDGenerator
Bases: object
Class used to generate unique ID for new SBSObjects, in the context of their parent.
static generateUID(aSBSObject)
Generate a unique 10-digit UID in the context of the given SBSObject
| Parameters: | aSBSObject (SBSObject) – the SBSObject in which the new uid must be unique |
|---|---|
| Returns: | The UID, as a string |
